blob: 54ee56f0b5f8a1428fec382509a0bcb32f72cab0 [file] [log] [blame]
dundargoc82f19732023-12-16 14:53:52 +01001*options.txt* For Vim version 9.0. Last change: 2023 Dec 16
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010079 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 The old value can be inserted by typing 'wildchar' (by
81 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020082 set). Many string options with fixed syntax and names
83 also support completing known values. See
84 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 White space between {option} and '=' is allowed and
86 will be ignored. White space between '=' and {value}
87 is not allowed.
88 See |option-backslash| for using white space and
89 backslashes in {value}.
90
91:se[t] {option}+={value} *:set+=*
92 Add the {value} to a number option, or append the
93 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010094 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 value was empty.
96 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000097 are removed. When adding a flag that was already
98 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000099 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:se[t] {option}^={value} *:set^=*
102 Multiply the {value} to a number option, or prepend
103 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100104 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105 value was empty.
106 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
108:se[t] {option}-={value} *:set-=*
109 Subtract the {value} from a number option, or remove
110 the {value} from a string option, if it is there.
111 If the {value} is not found in a string option, there
112 is no error or warning. When the option is a comma
113 separated list, a comma is deleted, unless the option
114 becomes empty.
115 When the option is a list of flags, {value} must be
116 exactly as they appear in the option. Remove flags
117 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200118 The individual values from a comma separated list or
119 list of flags can be inserted by typing 'wildchar'.
120 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123The {option} arguments to ":set" may be repeated. For example: >
124 :set ai nosi sw=3 ts=3
125If you make an error in one of the arguments, an error message will be given
126and the following arguments will be ignored.
127
128 *:set-verbose*
129When 'verbose' is non-zero, displaying an option value will also tell where it
130was last set. Example: >
131 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200132< shiftwidth=4 ~
133 Last set from modeline line 1 ~
134 cindent ~
135 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136This is only done when specific option values are requested, not for ":verbose
137set all" or ":verbose set" without an argument.
138When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139When the option was set while executing a function, user command or
140autocommand, the script in which it was defined is reported.
141Note that an option may also have been set as a side effect of setting
142'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000143A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200144 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000145 Option was set in a |modeline|.
146 Last set from --cmd argument ~
147 Option was set with command line argument |--cmd| or +.
148 Last set from -c argument ~
149 Option was set with command line argument |-c|, +, |-S| or
150 |-q|.
151 Last set from environment variable ~
152 Option was set from an environment variable, $VIMINIT,
153 $GVIMINIT or $EXINIT.
154 Last set from error handler ~
155 Option was cleared when evaluating it resulted in an error.
156
Bram Moolenaardb84e452010-08-15 13:50:43 +0200157{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158
159 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000160For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161override the value from the termcap. You can then use it in a mapping. If
162the "xx" part contains special characters, use the <t_xx> form: >
163 :set <t_#4>=^[Ot
164This can also be used to translate a special code for a normal key. For
165example, if Alt-b produces <Esc>b, use this: >
166 :set <M-b>=^[b
167(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
168The advantage over a mapping is that it works in all situations.
169
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100170You can define any key codes, e.g.: >
171 :set t_xy=^[foo;
172There is no warning for using a name that isn't recognized. You can map these
173codes as you like: >
174 :map <t_xy> something
175< *E846*
176When a key code is not set, it's like it does not exist. Trying to get its
177value will result in an error: >
178 :set t_kb=
179 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000180< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100181
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000182The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
183security reasons.
184
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000186at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187"set all" probably does not fit on the screen, causing Vim to give the
188|more-prompt|.
189
190 *option-backslash*
191To include white space in a string option value it has to be preceded with a
192backslash. To include a backslash you have to use two. Effectively this
193means that the number of backslashes in an option value is halved (rounded
194down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200195In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
196backslashes instead for compatibility with version 3.0 where the options can
197be separated by either commas or spaces.
198Comma-separated options like 'backupdir' and 'tags' will also require commas
199to be escaped with two backslashes, whereas this is not needed for
200non-comma-separated ones like 'makeprg'.
201When setting options using |:let| and |literal-string|, you need to use one
202fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200204 :set makeprg=make\ file results in "make file"
205 :let &makeprg='make file' (same as above)
206 :set makeprg=make\\\ file results in "make\ file"
207 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
208 :set tags=tags\\\ file results in "tags file"
209 :let &tags='tags\ file' (same as above)
210
211 :set makeprg=make,file results in "make,file"
212 :set makeprg=make\\,file results in "make\,file"
213 :set tags=tags,file results in "tags" and "file"
214 :set tags=tags\\,file results in "tags,file"
215 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217The "|" character separates a ":set" command from a following command. To
218include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219'titlestring' option to "hi|there": >
220 :set titlestring=hi\|there
221This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
222 :set titlestring=hi|set iconstring=there
223
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200224Similarly, in legacy script the double quote character starts a comment. To
225include the '"' in the option value, use '\"' instead. This example sets the
226'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000227 :set titlestring=hi\ \"there\"
228
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200229In |Vim9| script it's simpler, comments start with a '#' character, and only
230when preceded by white space. A backslash is needed less often: >
231 vim9script
232 set titlestring=hi\ "there"
233 set titlestring=hi#there#
234 set titlestring=hi\ \#there#
235
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100236For Win32 backslashes in file names are mostly not removed. More precise: For
237options that expect a file name (those where environment variables are
238expanded) a backslash before a normal file name character is not removed. But
239a backslash before a special character (space, backslash, comma, etc.) is used
240like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241There is one special situation, when the value starts with "\\": >
242 :set dir=\\machine\path results in "\\machine\path"
243 :set dir=\\\\machine\\path results in "\\machine\path"
244 :set dir=\\path\\file results in "\\path\file" (wrong!)
245For the first one the start is kept, but for the second one the backslashes
246are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000247halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248result which is probably not what you want. Avoid it.
249
250 *add-option-flags* *remove-option-flags*
251 *E539* *E550* *E551* *E552*
252Some options are a list of flags. When you want to add a flag to such an
253option, without changing the existing ones, you can do it like this: >
254 :set guioptions+=a
255Remove a flag from an option like this: >
256 :set guioptions-=a
257This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000258Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
260doesn't appear.
261
262 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000263Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264environment variable exists the '$' and the following environment variable
265name is replaced with its value. If it does not exist the '$' and the name
266are not modified. Any non-id character (not a letter, digit or '_') may
267follow the environment variable name. That character and what follows is
268appended to the value of the environment variable. Examples: >
269 :set term=$TERM.new
270 :set path=/usr/$INCLUDE,$HOME/include,.
271When adding or removing a string from an option with ":set opt-=val" or ":set
272opt+=val" the expansion is done before the adding or removing.
273
274
275Handling of local options *local-options*
276
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200277Note: The following also applies to |global-local| options.
278
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100280has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281allows you to set 'list' in one window but not in another. And set
282'shiftwidth' to 3 in one buffer and 4 in another.
283
284The following explains what happens to these local options in specific
285situations. You don't really need to know all of this, since Vim mostly uses
286the option values you would expect. Unfortunately, doing what the user
287expects is a bit complicated...
288
289When splitting a window, the local options are copied to the new window. Thus
290right after the split the contents of the two windows look the same.
291
292When editing a new buffer, its local option values must be initialized. Since
293the local options of the current buffer might be specifically for that buffer,
294these are not used. Instead, for each buffer-local option there also is a
295global value, which is used for new buffers. With ":set" both the local and
296global value is changed. With "setlocal" only the local value is changed,
297thus this value is not used when editing a new buffer.
298
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200299When editing a buffer that has been edited before, the options from the window
300that was last closed are used again. If this buffer has been edited in this
301window, the values from back then are used. Otherwise the values from the
302last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304It's possible to set a local window option specifically for a type of buffer.
305When you edit another buffer in the same window, you don't want to keep
306using these local window options. Therefore Vim keeps a global value of the
307local window options, which is used when editing another buffer. Each window
308has its own copy of these values. Thus these are local to the window, but
309global to all buffers in the window. With this you can do: >
310 :e one
311 :set list
312 :e two
313Now the 'list' option will also be set in "two", since with the ":set list"
314command you have also set the global value. >
315 :set nolist
316 :e one
317 :setlocal list
318 :e two
319Now the 'list' option is not set, because ":set nolist" resets the global
320value, ":setlocal list" only changes the local value and ":e two" gets the
321global value. Note that if you do this next: >
322 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200323You will get back the 'list' value as it was the last time you edited "one".
324The options local to a window are remembered for each buffer. This also
325happens when the buffer is not loaded, but they are lost when the buffer is
326wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
Christian Brabandt596ad662023-08-16 00:11:09 +0200328Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200329
330The following local window options won't be copied over when new windows are
331created, thus they behave slightly differently:
332
333 Option Reason ~
334 'previewwindow' there can only be a single one
335 'scroll' specific to existing window
336 'winfixheight' specific to existing window
337 'winfixwidth' specific to existing window
338
Christian Brabandt596ad662023-08-16 00:11:09 +0200339Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200340
341The following local buffer options won't be copied over when new buffers are
342created, thus they behave slightly differently:
343
344 Option Reason ~
345 'filetype' explicitly set by autocommands
346 'syntax' explicitly set by autocommands
347 'bufhidden' denote |special-buffers|
348 'buftype' denote |special-buffers|
349 'readonly' will be detected automatically
350 'modified' will be detected automatically
351
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100353:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 current buffer or window. Not all options have a
355 local value. If the option does not have a local
356 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200357 With the "all" argument: display local values for all
358 local options.
359 Without argument: Display local values for all local
360 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000362 local value. For a global/local boolean option, when
363 the global value is being used, "--" is displayed
364 before the option name.
365 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368:setl[ocal] {option}< Set the local value of {option} to its global value by
369 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000370
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100371:se[t] {option}< For |global-local| options: Remove the local value of
372 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373
374 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100375:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 option without changing the local value.
377 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200378 With the "all" argument: display global values for all
379 local options.
380 Without argument: display global values for all local
381 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382
383For buffer-local and window-local options:
384 Command global value local value ~
385 :set option=value set set
386 :setlocal option=value - set
387:setglobal option=value set -
388 :set option? - display
389 :setlocal option? - display
390:setglobal option? display -
391
392
393Global options with a local value *global-local*
394
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000395Options are global when you mostly use one value for all buffers and windows.
396For some global options it's useful to sometimes have a different local value.
397You can set the local value with ":setlocal". That buffer or window will then
398use the local value, while other buffers and windows continue using the global
399value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400
401For example, you have two windows, both on C source code. They use the global
402'makeprg' option. If you do this in one of the two windows: >
403 :set makeprg=gmake
404then the other window will switch to the same value. There is no need to set
405the 'makeprg' option in the other C source window too.
406However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000407another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000408files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 :setlocal makeprg=perlmake
410You can switch back to using the global value by making the local value empty: >
411 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100412This only works for a string option. For a number or boolean option you need
413to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100415Note that for non-boolean and non-number options using "<" copies the global
416value to the local value, it doesn't switch back to using the global value
417(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000418 :set path<
419This will make the local value of 'path' empty, so that the global value is
420used. Thus it does the same as: >
421 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000422Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423":setlocal" on a global option might work differently then.
424
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000425 *option-value-function*
426Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000427'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000428a function name or a function reference or a lambda function. When using a
429lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000430>
431 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000432 set opfunc=function('MyOpFunc')
433 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000434 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000435
436Set to a script-local function: >
437 set opfunc=s:MyLocalFunc
438 set opfunc=<SID>MyLocalFunc
439In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
440the script: >
441 set opfunc=MyLocalFunc
442
443Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000444 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000445 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000446
447Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000448 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000449
450Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000452 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000453
454In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300455closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000456context of where it was defined.
457
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000458
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459Setting the filetype
460
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200461:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462 Set the 'filetype' option to {filetype}, but only if
463 not done yet in a sequence of (nested) autocommands.
464 This is short for: >
465 :if !did_filetype()
466 : setlocal filetype={filetype}
467 :endif
468< This command is used in a filetype.vim file to avoid
469 setting the 'filetype' option twice, causing different
470 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200471
472 When the optional FALLBACK argument is present, a
473 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100474 'filetype'. This is to be used for filetype
475 detections that are just a guess. |did_filetype()|
476 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200477
Bram Moolenaard58e9292011-02-09 17:07:58 +0100478 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
480:opt[ions] Open a window for viewing and setting all options.
481 Options are grouped by function.
482 Offers short help for each option. Hit <CR> on the
483 short help to open a help window with more help for
484 the option.
485 Modify the value of the option and hit <CR> on the
486 "set" line to set the new value. For window and
487 buffer specific options, the last accessed window is
488 used to set the option value in, unless this is a help
489 window, in which case the window below help window is
490 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100491 {not available when compiled without the |+eval|
492 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493
494 *$HOME*
495Using "~" is like using "$HOME", but it is only recognized at the start of an
496option and after a space or comma.
497
498On Unix systems "~user" can be used too. It is replaced by the home directory
499of user "user". Example: >
500 :set path=~mool/include,/usr/include,.
501
502On Unix systems the form "${HOME}" can be used too. The name between {} can
503contain non-id characters then. Note that if you want to use this for the
504"gf" command, you need to add the '{' and '}' characters to 'isfname'.
505
506NOTE: expanding environment variables and "~/" is only done with the ":set"
507command, not when assigning a value to an option with ":let".
508
Bram Moolenaarc572da52017-08-27 16:52:01 +0200509 *$HOME-windows*
510On MS-Windows, if $HOME is not defined as an environment variable, then
511at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200512If $HOMEDRIVE is not set then $USERPROFILE is used.
513
514This expanded value is not exported to the environment, this matters when
515running an external command: >
516 :echo system('set | findstr ^HOME=')
517and >
518 :echo luaeval('os.getenv("HOME")')
519should echo nothing (an empty string) despite exists('$HOME') being true.
520When setting $HOME to a non-empty string it will be exported to the
521subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200522
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
524Note the maximum length of an expanded option is limited. How much depends on
525the system, mostly it is something like 256 or 1024 characters.
526
527 *:fix* *:fixdel*
528:fix[del] Set the value of 't_kD':
529 't_kb' is 't_kD' becomes ~
530 CTRL-? CTRL-H
531 not CTRL-? CTRL-?
532
Bram Moolenaar82be4842021-01-11 19:40:15 +0100533 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534
535 If your delete key terminal code is wrong, but the
536 code for backspace is alright, you can put this in
537 your .vimrc: >
538 :fixdel
539< This works no matter what the actual code for
540 backspace is.
541
542 If the backspace key terminal code is wrong you can
543 use this: >
544 :if &term == "termname"
545 : set t_kb=^V<BS>
546 : fixdel
547 :endif
548< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000549 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 with your terminal name.
551
552 If your <Delete> key sends a strange key sequence (not
553 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
554 :if &term == "termname"
555 : set t_kD=^V<Delete>
556 :endif
557< Where "^V" is CTRL-V and "<Delete>" is the delete key
558 (don't type eight characters!). Replace "termname"
559 with your terminal name.
560
561 *Linux-backspace*
562 Note about Linux: By default the backspace key
563 produces CTRL-?, which is wrong. You can fix it by
564 putting this line in your rc.local: >
565 echo "keycode 14 = BackSpace" | loadkeys
566<
567 *NetBSD-backspace*
568 Note about NetBSD: If your backspace doesn't produce
569 the right code, try this: >
570 xmodmap -e "keycode 22 = BackSpace"
571< If this works, add this in your .Xmodmap file: >
572 keysym 22 = BackSpace
573< You need to restart for this to take effect.
574
575==============================================================================
5762. Automatically setting options *auto-setting*
577
578Besides changing options with the ":set" command, there are three alternatives
579to set options automatically for one or more files:
580
5811. When starting Vim initializations are read from various places. See
582 |initialization|. Most of them are performed for all editing sessions,
583 and some of them depend on the directory where Vim is started.
584 You can create an initialization file with |:mkvimrc|, |:mkview| and
585 |:mksession|.
5862. If you start editing a new file, the automatic commands are executed.
587 This can be used to set options for files matching a particular pattern and
588 many other things. See |autocommand|.
5893. If you start editing a new file, and the 'modeline' option is on, a
590 number of lines at the beginning and end of the file are checked for
591 modelines. This is explained here.
592
593 *modeline* *vim:* *vi:* *ex:* *E520*
594There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100595 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100597[text{white}] empty or any text followed by at least one blank
598 character (<Space> or <Tab>); "ex:" always requires at
599 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200600{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200601[white] optional white space
602{options} a list of option settings, separated with white space
603 or ':', where each part between ':' is the argument
604 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605
Bram Moolenaar14b69452013-06-29 23:05:20 +0200606Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000607 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200608 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610The second form (this is compatible with some versions of Vi):
611
Bram Moolenaarade0d392020-01-21 22:33:58 +0100612 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaarade0d392020-01-21 22:33:58 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200617{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
618[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200619se[t] the string "set " or "se " (note the space); When
620 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200621{options} a list of options, separated with white space, which
622 is the argument for a ":set" command
623: a colon
624[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
Bram Moolenaar14b69452013-06-29 23:05:20 +0200626Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200628 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200630The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
631chance that a normal word like "lex:" is caught. There is one exception:
632"vi:" and "vim:" can also be at the start of the line (for compatibility with
633version 3.0). Using "ex:" at the start of the line will be ignored (this
634could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635
Hu Jialun9dcd3492021-08-28 20:42:50 +0200636If the modeline is disabled within a modeline, subsequent modelines will be
637ignored. This is to allow turning off modeline on a per-file basis. This is
638useful when a line looks like a modeline but isn't. For example, it would be
639good to start a YAML file containing strings like "vim:" with
640 # vim: nomodeline ~
641so as to avoid modeline misdetection. Following options on the same line
642after modeline deactivation, if any, are still evaluated (but you would
643normally not have any).
644
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 *modeline-local*
646The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000647buffer and window that contain the file. Although it's possible to set global
648options from a modeline, this is unusual. If you have two windows open and
649the files in it set the same global option to a different value, the result
650depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000652When editing a file that was already loaded, only the window-local options
653from the modeline are used. Thus if you manually changed a buffer-local
654option after opening the file, it won't be changed if you edit the same buffer
655in another window. But window-local options will be set.
656
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *modeline-version*
658If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200659number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 vim{vers}: version {vers} or later
661 vim<{vers}: version before {vers}
662 vim={vers}: version {vers}
663 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100664{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
665For example, to use a modeline only for Vim 7.0:
666 /* vim700: set foldmethod=marker */ ~
667To use a modeline for Vim after version 7.2:
668 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669There can be no blanks between "vim" and the ":".
670
671
672The number of lines that are checked can be set with the 'modelines' option.
673If 'modeline' is off or 'modelines' is 0 no lines are checked.
674
675Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000676like:
677 /* vi:ts=4: */ ~
678will give an error message for the trailing "*/". This line is OK:
679 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681If an error is detected the rest of the line is skipped.
682
683If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000684backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100685 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
686This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
687before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200688 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000690might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200691can be set. For some options a flag is set, so that when the value is used
692the |sandbox| is effective. Some options can only be set from the modeline
693when 'modelineexpr' is set (the default is off).
694
695Still, there is always a small risk that a modeline causes trouble. E.g.,
696when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
697So disable modelines before editing untrusted text. The mail ftplugin does
698this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700Hint: If you would like to do something else than setting an option, you could
701define an autocommand that checks the file for a specific string. For
702example: >
703 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
704And define a function SetVar() that does something with the line containing
705"VAR".
706
707==============================================================================
7083. Options summary *option-summary*
709
710In the list below all the options are mentioned with their full name and with
711an abbreviation if there is one. Both forms may be used.
712
713In this document when a boolean option is "set" that means that ":set option"
714is entered. When an option is "reset", ":set nooption" is used.
715
716For some options there are two default values: The "Vim default", which is
717used when 'compatible' is not set, and the "Vi default", which is used when
718'compatible' is set.
719
720Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000721are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722different value in each window. For example the 'list' option can be set in
723one window and reset in another for the same text, giving both types of view
724at the same time. There are a few options that are specific to a certain
725file. These can have a different value for each file or buffer. For example
726the 'textwidth' option can be 78 for a normal text file and 0 for a C
727program.
728
729 global one option for all buffers and windows
730 local to window each window has its own copy of this option
731 local to buffer each buffer has its own copy of this option
732
733When creating a new window the option values from the currently active window
734are used as a default value for the window-specific options. For the
735buffer-specific options this depends on the 's' and 'S' flags in the
736'cpoptions' option. If 's' is included (which is the default) the values for
737buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738first entered. If 'S' is present the options are copied each time the buffer
739is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740present, the options are copied from the currently active buffer when the
741buffer is created.
742
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000743Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000745Not all options are supported in all versions. This depends on the supported
746features and sometimes on the system. A remark about this is in curly braces
747below. When an option is not supported it may still be set without getting an
748error, this is called a hidden option. You can't get the value of a hidden
749option though, it is not stored.
750
751To test if option "foo" can be used with ":set" use something like this: >
752 if exists('&foo')
753This also returns true for a hidden option. To test if option "foo" is really
754supported use something like this: >
755 if exists('+foo')
756<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 *E355*
758A jump table for the options with a short description can be found at |Q_op|.
759
760 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100761'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 {only available when compiled with the |+rightleft|
764 feature}
765 The ASCII code for the first letter of the Hebrew alphabet. The
766 routine that maps the keyboard in Hebrew mode, both in Insert mode
767 (when hkmap is set) and on the command-line (when hitting CTRL-_)
768 outputs the Hebrew characters in the range [aleph..aleph+26].
769 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
770 See |rileft.txt|.
771
772 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
773'allowrevins' 'ari' boolean (default off)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with the |+rightleft|
776 feature}
777 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
778 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
779 into reverse Insert mode, and don't know how to get out. See
780 'revins'.
781 NOTE: This option is reset when 'compatible' is set.
782
783 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
784'altkeymap' 'akm' boolean (default off)
785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 {only available when compiled with the |+farsi|
787 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100788 This option was for using Farsi, which has been removed. See
789 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *'ambiwidth'* *'ambw'*
792'ambiwidth' 'ambw' string (default: "single")
793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
795 Tells Vim what to do with characters with East Asian Width Class
796 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
797 letters, Cyrillic letters).
798
799 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000800 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 expected by most users.
802 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200803 *E834* *E835*
804 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100805 contains a character that would be double width. These errors may
806 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200807
808 The values are overruled for characters specified with
809 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810
811 There are a number of CJK fonts for which the width of glyphs for
812 those characters are solely based on how many octets they take in
813 legacy/traditional CJK encodings. In those encodings, Euro,
814 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000815 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 Vim is running inside a terminal (emulators) that uses a CJK font
819 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
820 this option should be set to "double" to match the width perceived
821 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100822 to be set to "double" under CJK MS-Windows when the system locale is
823 set to one of CJK locales. See Unicode Standard Annex #11
824 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100826 Vim may set this option automatically at startup time when Vim is
827 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200828 escape sequence to request cursor position report. The response can
829 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100830
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
832'antialias' 'anti' boolean (default: off)
833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200835 on macOS}
836 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
838 which can be easier to read at certain sizes on certain displays.
839 Setting this option can sometimes cause problems if 'guifont' is set
840 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100841 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
844'arabic' 'arab' boolean (default off)
845 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 {only available when compiled with the |+arabic|
847 feature}
848 This option can be set to start editing Arabic text.
849 Setting this option will:
850 - Set the 'rightleft' option, unless 'termbidi' is set.
851 - Set the 'arabicshape' option, unless 'termbidi' is set.
852 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
853 between typing English and Arabic key mapping.
854 - Set the 'delcombine' option
855 Note that 'encoding' must be "utf-8" for working with Arabic text.
856
857 Resetting this option will:
858 - Reset the 'rightleft' option.
859 - Disable the use of 'keymap' (without changing its value).
860 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200861 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100862 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 Also see |arabic.txt|.
864
865 *'arabicshape'* *'arshape'*
866 *'noarabicshape'* *'noarshape'*
867'arabicshape' 'arshape' boolean (default on)
868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 {only available when compiled with the |+arabic|
870 feature}
871 When on and 'termbidi' is off, the required visual character
872 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200873 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 one which encompasses:
875 a) the changing/morphing of characters based on their location
876 within a word (initial, medial, final and stand-alone).
877 b) the enabling of the ability to compose characters
878 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100879 When disabled the display shows each character's true stand-alone
880 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 Arabic is a complex language which requires other settings, for
882 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100883 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884
laburnumT3f7855a2023-12-05 18:37:03 +0100885 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
886'autochdir' 'acd' boolean (default off)
887 global
888 {only available when compiled with it, use
889 exists("+autochdir") to check}
890 When on, Vim will change the current working directory whenever you
891 open a file, switch buffers, delete a buffer or open/close a window.
892 It will change to the directory containing the file which was opened
893 or selected. When a buffer has no name it also has no directory, thus
894 the current directory won't change when navigating to it.
895 Note: When this option is on some plugins may not work.
896
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
898'autoindent' 'ai' boolean (default off)
899 local to buffer
900 Copy indent from current line when starting a new line (typing <CR>
901 in Insert mode or when using the "o" or "O" command). If you do not
902 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000903 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
904 to another line has the same effect, unless the 'I' flag is included
905 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 When autoindent is on, formatting (with the "gq" command or when you
907 reach 'textwidth' in Insert mode) uses the indentation of the first
908 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 When 'smartindent' or 'cindent' is on the indent is changed in
910 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200911 The 'autoindent' option is reset when the 'paste' option is set and
912 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913
914 *'autoread'* *'ar'* *'noautoread'* *'noar'*
915'autoread' 'ar' boolean (default off)
916 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 When a file has been detected to have been changed outside of Vim and
918 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200919 When the file has been deleted this is not done, so you have the text
920 from before it was deleted. When it appears again then it is read.
921 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 If this option has a local value, use this command to switch back to
923 using the global value: >
924 :set autoread<
925<
laburnumT3f7855a2023-12-05 18:37:03 +0100926
927 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
928'autoshelldir' 'asd' boolean (default off)
929 global
930 When on, Vim will change the current working directory whenever you
931 change the directory of the shell running in a terminal window. You
932 need proper setting-up, so whenever the shell's pwd changes an OSC 7
933 escape sequence will be emitted. For example, on Linux, you can
934 source /etc/profile.d/vte.sh in your shell profile if you use bash or
935 zsh. For bash this should work (put it in a bash init file): >
936 if [[ -n "$VIM_TERMINAL" ]]; then
937 PROMPT_COMMAND='_vim_sync_PWD'
938 function _vim_sync_PWD() {
939 printf '\033]7;file://%s\033\\' "$PWD"
940 }
941 fi
942<
943 Or, in a zsh init file: >
944 if [[ -n "$VIM_TERMINAL" ]]; then
945 autoload -Uz add-zsh-hook
946 add-zsh-hook -Uz chpwd _vim_sync_PWD
947 function _vim_sync_PWD() {
948 printf '\033]7;file://%s\033\\' "$PWD"
949 }
950 fi
951<
952 In a fish init file: >
953 if test -n "$VIM_TERMINAL"
954 function _vim_sync_PWD --on-variable=PWD
955 printf '\033]7;file://%s\033\\' "$PWD"
956 end
957 end
958<
959 You can find an alternative method at |terminal-autoshelldir|.
960 When the parsing of the OSC sequence fails you get *E1179* .
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
963'autowrite' 'aw' boolean (default off)
964 global
965 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000966 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000967 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
968 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000969 to another file.
970 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000971 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 Note that for some commands the 'autowrite' option is not used, see
973 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200974 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200975 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100976 USE WITH CARE: If you make temporary changes to a buffer that you
977 don't want to be saved this option may cause it to be saved anyway.
978 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979
980 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
981'autowriteall' 'awa' boolean (default off)
982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
984 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
985 Setting this option also implies that Vim behaves like 'autowrite' has
986 been set.
987
988 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200989'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 When set to "dark", Vim will try to use colors that look good on a
992 dark background. When set to "light", Vim will try to use colors that
993 look good on a light background. Any other value is illegal.
994 Vim tries to set the default value according to the terminal used.
995 This will not always be correct.
996 Setting this option does not change the background color, it tells Vim
997 what the background color looks like. For changing the background
998 color, see |:hi-normal|.
999
1000 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001001 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +00001002 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001003 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 setting 'background' will cause the color scheme to be reloaded. If
1005 the color scheme adjusts to the value of 'background' this will work.
1006 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001007 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
1009 When setting 'background' to the default value with: >
1010 :set background&
1011< Vim will guess the value. In the GUI this should work correctly,
1012 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001013 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001014 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001016 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001017 color from the terminal. If the returned RGB value is dark/light and
1018 'background' is not dark/light, 'background' will be set and the
1019 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001020 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001021 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001022
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 When starting the GUI, the default value for 'background' will be
1024 "light". When the value is not set in the .gvimrc, and Vim detects
1025 that the background is actually quite dark, 'background' is set to
1026 "dark". But this happens only AFTER the .gvimrc file has been read
1027 (because the window needs to be opened to find the actual background
1028 color). To get around this, force the GUI window to be opened by
1029 putting a ":gui" command in the .gvimrc file, before where the value
1030 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001031
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001032 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001033 For other systems "dark" is used when 'term' is "linux",
1034 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1035 background. Otherwise the default is "light".
1036
Bram Moolenaarc572da52017-08-27 16:52:01 +02001037 The |:terminal| command and the |term_start()| function use the
1038 'background' value to decide whether the terminal window will start
1039 with a white or black background.
1040
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 Normally this option would be set in the .vimrc file. Possibly
1042 depending on the terminal name. Example: >
1043 :if &term == "pcterm"
1044 : set background=dark
1045 :endif
1046< When this option is set, the default settings for the highlight groups
1047 will change. To use other settings, place ":highlight" commands AFTER
1048 the setting of the 'background' option.
1049 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1050 to select the colors for syntax highlighting. After changing this
1051 option, you must load syntax.vim again to see the result. This can be
1052 done with ":syntax on".
1053
1054 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001055'backspace' 'bs' string (default "", set to "indent,eol,start"
1056 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1059 mode. This is a list of items, separated by commas. Each item allows
1060 a way to backspace over something:
1061 value effect ~
1062 indent allow backspacing over autoindent
1063 eol allow backspacing over line breaks (join lines)
1064 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1065 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001066 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1067 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068
Bram Moolenaar46eea442022-03-30 10:51:39 +01001069 When the value is empty, Vi compatible backspacing is used, none of
1070 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
1072 For backwards compatibility with version 5.4 and earlier:
1073 value effect ~
1074 0 same as ":set backspace=" (Vi compatible)
1075 1 same as ":set backspace=indent,eol"
1076 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001077 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078
1079 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1080 NOTE: This option is set to "" when 'compatible' is set.
1081
1082 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1083'backup' 'bk' boolean (default off)
1084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 Make a backup before overwriting a file. Leave it around after the
1086 file has been successfully written. If you do not want to keep the
1087 backup file, but you do want a backup while the file is being
1088 written, reset this option and set the 'writebackup' option (this is
1089 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001090 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 |backup-table| for more explanations.
1092 When the 'backupskip' pattern matches, a backup is not made anyway.
1093 When 'patchmode' is set, the backup may be renamed to become the
1094 oldest version of a file.
1095 NOTE: This option is reset when 'compatible' is set.
1096
1097 *'backupcopy'* *'bkc'*
1098'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001099 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001101 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102
1103 The main values are:
1104 "yes" make a copy of the file and overwrite the original one
1105 "no" rename the file and write a new one
1106 "auto" one of the previous, what works best
1107
1108 Extra values that can be combined with the ones above are:
1109 "breaksymlink" always break symlinks when writing
1110 "breakhardlink" always break hardlinks when writing
1111
1112 Making a copy and overwriting the original file:
1113 - Takes extra time to copy the file.
1114 + When the file has special attributes, is a (hard/symbolic) link or
1115 has a resource fork, all this is preserved.
1116 - When the file is a link the backup will have the name of the link,
1117 not of the real file.
1118
1119 Renaming the file and writing a new one:
1120 + It's fast.
1121 - Sometimes not all attributes of the file can be copied to the new
1122 file.
1123 - When the file is a link the new file will not be a link.
1124
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001125 The "auto" value is the middle way: When Vim sees that renaming the
1126 file is possible without side effects (the attributes can be passed on
1127 and the file is not a link) that is used. When problems are expected,
1128 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
1130 The "breaksymlink" and "breakhardlink" values can be used in
1131 combination with any of "yes", "no" and "auto". When included, they
1132 force Vim to always break either symbolic or hard links by doing
1133 exactly what the "no" option does, renaming the original file to
1134 become the backup and writing a new file in its place. This can be
1135 useful for example in source trees where all the files are symbolic or
1136 hard links and any changes should stay in the local source tree, not
1137 be propagated back to the original source.
1138 *crontab*
1139 One situation where "no" and "auto" will cause problems: A program
1140 that opens a file, invokes Vim to edit that file, and then tests if
1141 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001142 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 example.
1144
1145 When a copy is made, the original file is truncated and then filled
1146 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001147 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001148 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 group of the backup is set to the group of the original file. If this
1150 fails, the protection bits for the group are made the same as for
1151 others.
1152
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001153 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 the same attributes of the original file, and the newly written file
1155 is owned by the current user. When the file was a (hard/symbolic)
1156 link, the new file will not! That's why the "auto" value doesn't
1157 rename when the file is a link. The owner and group of the newly
1158 written file will be set to the same ones as the original file, but
1159 the system may refuse to do this. In that case the "auto" value will
1160 again not rename the file.
1161
Bram Moolenaar036986f2017-03-16 17:41:02 +01001162 NOTE: This option is set to the Vi default value when 'compatible' is
1163 set and to the Vim default value when 'compatible' is reset.
1164
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 *'backupdir'* *'bdir'*
1166'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001167 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 for Unix: ".,~/tmp,~/")
1169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 List of directories for the backup file, separated with commas.
1171 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001172 where this is possible. The directory must exist, Vim will not
1173 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001174 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 impossible!). Writing may fail because of this.
1176 - A directory "." means to put the backup file in the same directory
1177 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001178 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1179 the backup file relative to where the edited file is. The leading
1180 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 ("." inside a directory name has no special meaning).
1182 - Spaces after the comma are ignored, other spaces are considered part
1183 of the directory name. To have a space at the start of a directory
1184 name, precede it with a backslash.
1185 - To include a comma in a directory name precede it with a backslash.
1186 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001187 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001188 the backup file name will be built from the complete path to the
1189 file with all path separators changed to percent '%' signs. This
1190 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001191 On Win32, it is also possible to end with "\\". However, When a
1192 separating comma is following, you must use "//", since "\\" will
1193 include the comma in the file name. Therefore it is recommended to
1194 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 - Environment variables are expanded |:set_env|.
1196 - Careful with '\' characters, type one before a space, type two to
1197 get one in the option (see |option-backslash|), for example: >
1198 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1199< - For backwards compatibility with Vim version 3.0 a '>' at the start
1200 of the option is removed.
1201 See also 'backup' and 'writebackup' options.
1202 If you want to hide your backup files on Unix, consider this value: >
1203 :set backupdir=./.backup,~/.backup,.,/tmp
1204< You must create a ".backup" directory in each directory and in your
1205 home directory for this to work properly.
1206 The use of |:set+=| and |:set-=| is preferred when adding or removing
1207 directories from the list. This avoids problems when a future version
1208 uses another default.
1209 This option cannot be set from a |modeline| or in the |sandbox|, for
1210 security reasons.
1211
1212 *'backupext'* *'bex'* *E589*
1213'backupext' 'bex' string (default "~", for VMS: "_")
1214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 String which is appended to a file name to make the name of the
1216 backup file. The default is quite unusual, because this avoids
1217 accidentally overwriting existing files with a backup file. You might
1218 prefer using ".bak", but make sure that you don't have files with
1219 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001220 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001222 If you like to keep a lot of backups, you could use a BufWritePre
1223 autocommand to change 'backupext' just before writing the file to
1224 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001225 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001226< Use 'backupdir' to put the backup in a different directory.
1227
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001229'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1230 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1231 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 A list of file patterns. When one of the patterns matches with the
1234 name of the file which is written, no backup file is created. Both
1235 the specified file name and the full path name of the file are used.
1236 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1237 Watch out for special characters, see |option-backslash|.
1238 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001239 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001240
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001241 WARNING: Not having a backup file means that when Vim fails to write
1242 your buffer correctly and then, for whatever reason, Vim exits, you
1243 lose both the original file and what you were writing. Only disable
1244 backups if you don't care about losing the file.
1245
Bram Moolenaar02467872007-05-06 13:22:01 +00001246 Note that environment variables are not expanded. If you want to use
1247 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001248 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001249
1250< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001251 backup would be made by renaming the original file crontab won't see
1252 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253
1254 *'balloondelay'* *'bdlay'*
1255'balloondelay' 'bdlay' number (default: 600)
1256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 {only available when compiled with the |+balloon_eval|
1258 feature}
1259 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1260
1261 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1262'ballooneval' 'beval' boolean (default off)
1263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001265 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001266 Switch on the |balloon-eval| functionality for the GUI.
1267
1268 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1269 *'nobevalterm'*
1270'balloonevalterm' 'bevalterm' boolean (default off)
1271 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001272 {only available when compiled with the
1273 |+balloon_eval_term| feature}
1274 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001276 *'balloonexpr'* *'bexpr'*
1277'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001278 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001279 {only available when compiled with the |+balloon_eval|
1280 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001281 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001282 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1283 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001284
1285 v:beval_bufnr number of the buffer in which balloon is going to show
1286 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001287 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001288 v:beval_lnum line number
1289 v:beval_col column number (byte index)
1290 v:beval_text word under or after the mouse pointer
1291
Bram Moolenaar54775062019-07-31 21:07:14 +02001292 Instead of showing a balloon, which is limited to plain text, consider
1293 using a popup window, see |popup_beval_example|. A popup window can
1294 use highlighting and show a border.
1295
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001296 The evaluation of the expression must not have side effects!
1297 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001298 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001299 return 'Cursor is at line ' .. v:beval_lnum ..
1300 \ ', column ' .. v:beval_col ..
1301 \ ' of file ' .. bufname(v:beval_bufnr) ..
1302 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001303 endfunction
1304 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001305 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001307 Also see |balloon_show()|, it can be used if the content of the balloon
1308 is to be fetched asynchronously. In that case evaluating
1309 'balloonexpr' should result in an empty string. If you get a balloon
1310 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001311
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001312 NOTE: The balloon is displayed only if the cursor is on a text
1313 character. If the result of evaluating 'balloonexpr' is not empty,
1314 Vim does not try to send a message to an external debugger (Netbeans
1315 or Sun Workshop).
1316
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001317 If the expression starts with s: or |<SID>|, then it is replaced with
1318 the script ID (|local-function|). Example: >
1319 set bexpr=s:MyBalloonExpr()
1320 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001321< Otherwise, the expression is evaluated in the context of the script
1322 where the option was set, thus script-local items are available.
1323
Bram Moolenaar30b65812012-07-12 22:01:11 +02001324 The expression will be evaluated in the |sandbox| when set from a
1325 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001326 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001327
1328 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001329 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001330
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001331 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001332 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001333< When they are supported "\n" characters will start a new line. If the
1334 expression evaluates to a |List| this is equal to using each List item
1335 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001336 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001337
Bram Moolenaar165bc692015-07-21 17:53:25 +02001338 *'belloff'* *'bo'*
1339'belloff' 'bo' string (default "")
1340 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001341 Specifies for which events the bell will not be rung. It is a comma
1342 separated list of items. For each item that is present, the bell
1343 will be silenced. This is most useful to specify specific events in
1344 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001345 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001346
1347 item meaning when present ~
1348 all All events.
1349 backspace When hitting <BS> or <Del> and deleting results in an
1350 error.
1351 cursor Fail to move around using the cursor keys or
1352 <PageUp>/<PageDown> in |Insert-mode|.
1353 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1354 |i_CTRL-X_CTRL-T|.
1355 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1356 |i_CTRL-E|.
1357 ctrlg Unknown Char after <C-G> in Insert mode.
1358 error Other Error occurred (e.g. try to join last line)
1359 (mostly used in |Normal-mode| or |Cmdline-mode|).
1360 esc hitting <Esc> in |Normal-mode|.
1361 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001362 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001363 insertmode Pressing <Esc> in 'insertmode'.
1364 lang Calling the beep module for Lua/Mzscheme/TCL.
1365 mess No output available for |g<|.
1366 showmatch Error occurred for 'showmatch' function.
1367 operator Empty region error |cpo-E|.
1368 register Unknown register after <C-R> in |Insert-mode|.
1369 shell Bell from shell output |:!|.
1370 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001371 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001372 wildmode More matches in |cmdline-completion| available
1373 (depends on the 'wildmode' setting).
1374
Bram Moolenaar036986f2017-03-16 17:41:02 +01001375 This is most useful to fine tune when in Insert mode the bell should
1376 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001377 indicate that an error occurred. It can be silenced by adding the
1378 "error" keyword.
1379
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1381'binary' 'bin' boolean (default off)
1382 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 This option should be set before editing a binary file. You can also
1384 use the |-b| Vim argument. When this option is switched on a few
1385 options will be changed (also when it already was on):
1386 'textwidth' will be set to 0
1387 'wrapmargin' will be set to 0
1388 'modeline' will be off
1389 'expandtab' will be off
1390 Also, 'fileformat' and 'fileformats' options will not be used, the
1391 file is read and written like 'fileformat' was "unix" (a single <NL>
1392 separates lines).
1393 The 'fileencoding' and 'fileencodings' options will not be used, the
1394 file is read without conversion.
1395 NOTE: When you start editing a(nother) file while the 'bin' option is
1396 on, settings from autocommands may change the settings again (e.g.,
1397 'textwidth'), causing trouble when editing. You might want to set
1398 'bin' again when the file has been loaded.
1399 The previous values of these options are remembered and restored when
1400 'bin' is switched from on to off. Each buffer has its own set of
1401 saved option values.
1402 To edit a file with 'binary' set you can use the |++bin| argument.
1403 This avoids you have to do ":set bin", which would have effect for all
1404 files you edit.
1405 When writing a file the <EOL> for the last line is only written if
1406 there was one in the original file (normally Vim appends an <EOL> to
1407 the last line if there is none; this would make the file longer). See
1408 the 'endofline' option.
1409
1410 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1411'bioskey' 'biosk' boolean (default on)
1412 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001413 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001414 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
1416 *'bomb'* *'nobomb'*
1417'bomb' boolean (default off)
1418 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 When writing a file and the following conditions are met, a BOM (Byte
1420 Order Mark) is prepended to the file:
1421 - this option is on
1422 - the 'binary' option is off
1423 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1424 endian variants.
1425 Some applications use the BOM to recognize the encoding of the file.
1426 Often used for UCS-2 files on MS-Windows. For other applications it
1427 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001428 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1430 check for the presence of the BOM is done and 'bomb' set accordingly.
1431 Unless 'binary' is set, it is removed from the first line, so that you
1432 don't see it when editing. When you don't change the options, the BOM
1433 will be restored when writing the file.
1434
1435 *'breakat'* *'brk'*
1436'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1437 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001438 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 feature}
1440 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001441 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1442 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001444 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001445'breakindent' 'bri' boolean (default off)
1446 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001447 {not available when compiled without the |+linebreak|
1448 feature}
1449 Every wrapped line will continue visually indented (same amount of
1450 space as the beginning of that line), thus preserving horizontal blocks
1451 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001453
1454 *'breakindentopt'* *'briopt'*
1455'breakindentopt' 'briopt' string (default empty)
1456 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001457 {not available when compiled without the |+linebreak|
1458 feature}
1459 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001460 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001461 min:{n} Minimum text width that will be kept after
1462 applying 'breakindent', even if the resulting
1463 text should normally be narrower. This prevents
1464 text indented almost to the right window border
1465 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001466 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001467 shift:{n} After applying 'breakindent', the wrapped line's
1468 beginning will be shifted by the given number of
1469 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001470 indentation (negative) or emphasizing the line
1471 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001472 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001473 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001474 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001475 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001476 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001477 numbered or bulleted list (using the
1478 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001479 list:-1 Uses the length of a match with 'formatlistpat'
1480 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001481 (default: 0)
1482 column:{n} Indent at column {n}. Will overrule the other
1483 sub-options. Note: an additional indent may be
1484 added for the 'showbreak' setting.
1485 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001486
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001488'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001490 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001492 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001493 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 buffer Use the directory of the related buffer.
1495 current Use the current directory.
1496 {path} Use the specified directory
1497
1498 *'bufhidden'* *'bh'*
1499'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001500 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 This option specifies what happens when a buffer is no longer
1502 displayed in a window:
1503 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001504 hide hide the buffer (don't unload it), even if 'hidden' is
1505 not set
1506 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001507 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 delete delete the buffer from the buffer list, even if
1509 'hidden' is set; the |:hide| command will also delete
1510 the buffer, making it behave like |:bdelete|
1511 wipe wipe the buffer from the buffer list, even if
1512 'hidden' is set; the |:hide| command will also wipe
1513 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001515 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001516 are lost without a warning. Also, these values may break autocommands
1517 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 This option is used together with 'buftype' and 'swapfile' to specify
1519 special kinds of buffers. See |special-buffers|.
1520
1521 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1522'buflisted' 'bl' boolean (default: on)
1523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 When this option is set, the buffer shows up in the buffer list. If
1525 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1526 This option is reset by Vim for buffers that are only used to remember
1527 a file name or marks. Vim sets it when starting to edit a buffer.
1528 But not when moving to a buffer with ":buffer".
1529
1530 *'buftype'* *'bt'* *E382*
1531'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001532 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 The value of this option specifies the type of a buffer:
1534 <empty> normal buffer
1535 nofile buffer which is not related to a file and will not be
1536 written
1537 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001538 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001539 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001541 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 help help buffer (you are not supposed to set this
1543 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001544 terminal buffer for a |terminal| (you are not supposed to set
1545 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001546 prompt buffer where only the last line can be edited, meant
1547 to be used by a plugin, see |prompt-buffer|
1548 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001549 popup buffer used in a popup window, see |popup|.
1550 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551
1552 This option is used together with 'bufhidden' and 'swapfile' to
1553 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001554 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555
1556 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001557 One such effect is that Vim will not check the timestamp of the file,
1558 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559
Bram Moolenaar280f1262006-01-30 00:14:18 +00001560 A "quickfix" buffer is only used for the error list and the location
1561 list. This value is set by the |:cwindow| and |:lwindow| commands and
1562 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563
1564 "nofile" and "nowrite" buffers are similar:
1565 both: The buffer is not to be written to disk, ":w" doesn't
1566 work (":w filename" does work though).
1567 both: The buffer is never considered to be |'modified'|.
1568 There is no warning when the changes will be lost, for
1569 example when you quit Vim.
1570 both: A swap file is only created when using too much memory
1571 (when 'swapfile' has been reset there is never a swap
1572 file).
1573 nofile only: The buffer name is fixed, it is not handled like a
1574 file name. It is not modified in response to a |:cd|
1575 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001576 both: When using ":e bufname" and already editing "bufname"
1577 the buffer is made empty and autocommands are
1578 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001579 *E676*
1580 "acwrite" implies that the buffer name is not related to a file, like
1581 "nofile", but it will be written. Thus, in contrast to "nofile" and
1582 "nowrite", ":w" does work and a modified buffer can't be abandoned
1583 without saving. For writing there must be matching |BufWriteCmd|,
1584 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585
1586 *'casemap'* *'cmp'*
1587'casemap' 'cmp' string (default: "internal,keepascii")
1588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 Specifies details about changing the case of letters. It may contain
1590 these words, separated by a comma:
1591 internal Use internal case mapping functions, the current
1592 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001593 matters when 'encoding' is a Unicode encoding,
1594 "latin1" or "iso-8859-15". When "internal" is
1595 omitted, the towupper() and towlower() system library
1596 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1598 case mapping, the current locale is not effective.
1599 This probably only matters for Turkish.
1600
Bram Moolenaar938ae282023-02-20 20:44:55 +00001601 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001602'cdhome' 'cdh' boolean (default: off)
1603 global
1604 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1605 current working directory to the |$HOME| directory like in Unix.
1606 When off, those commands just print the current directory name.
1607 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001608 This option cannot be set from a |modeline| or in the |sandbox|, for
1609 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001610 NOTE: This option is reset when 'compatible' is set.
1611
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 *'cdpath'* *'cd'* *E344* *E346*
1613'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001616 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1617 searched for has a relative path, not an absolute part starting with
1618 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 The 'cdpath' option's value has the same form and semantics as
1620 |'path'|. Also see |file-searching|.
1621 The default value is taken from $CDPATH, with a "," prepended to look
1622 in the current directory first.
1623 If the default value taken from $CDPATH is not what you want, include
1624 a modified version of the following command in your vimrc file to
1625 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001626 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627< This option cannot be set from a |modeline| or in the |sandbox|, for
1628 security reasons.
1629 (parts of 'cdpath' can be passed to the shell to expand file names).
1630
1631 *'cedit'*
1632'cedit' string (Vi default: "", Vim default: CTRL-F)
1633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 The key used in Command-line Mode to open the command-line window.
1635 The default is CTRL-F when 'compatible' is off.
1636 Only non-printable keys are allowed.
1637 The key can be specified as a single character, but it is difficult to
1638 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001639 :exe "set cedit=\<C-Y>"
1640 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641< |Nvi| also has this option, but it only uses the first character.
1642 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001643 NOTE: This option is set to the Vim default value when 'compatible'
1644 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645
1646 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1647'charconvert' 'ccv' string (default "")
1648 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001649 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 An expression that is used for character encoding conversion. It is
1651 evaluated when a file that is to be read or has been written has a
1652 different encoding from what is desired.
1653 'charconvert' is not used when the internal iconv() function is
1654 supported and is able to do the conversion. Using iconv() is
1655 preferred, because it is much faster.
1656 'charconvert' is not used when reading stdin |--|, because there is no
1657 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001658 The expression must return zero, false or an empty string for success,
1659 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 The possible encoding names encountered are in 'encoding'.
1661 Additionally, names given in 'fileencodings' and 'fileencoding' are
1662 used.
1663 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1664 is done internally by Vim, 'charconvert' is not used for this.
1665 'charconvert' is also used to convert the viminfo file, if the 'c'
1666 flag is present in 'viminfo'. Also used for Unicode conversion.
1667 Example: >
1668 set charconvert=CharConvert()
1669 fun CharConvert()
1670 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001671 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1672 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 return v:shell_error
1674 endfun
1675< The related Vim variables are:
1676 v:charconvert_from name of the current encoding
1677 v:charconvert_to name of the desired encoding
1678 v:fname_in name of the input file
1679 v:fname_out name of the output file
1680 Note that v:fname_in and v:fname_out will never be the same.
1681 Note that v:charconvert_from and v:charconvert_to may be different
1682 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001683
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001684 The advantage of using a function call without arguments is that it is
1685 faster, see |expr-option-function|.
1686
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 Encryption is not done by Vim when using 'charconvert'. If you want
1688 to encrypt the file after conversion, 'charconvert' should take care
1689 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001690
1691 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1692 replaced with the script ID (|local-function|). Example: >
1693 set charconvert=s:MyConvert()
1694 set charconvert=<SID>SomeConvert()
1695< Otherwise the expression is evaluated in the context of the script
1696 where the option was set, thus script-local items are available.
1697
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 This option cannot be set from a |modeline| or in the |sandbox|, for
1699 security reasons.
1700
1701 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1702'cindent' 'cin' boolean (default off)
1703 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001704 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 that trigger reindenting in insert mode and 'cinoptions' to set your
1706 preferred indent style.
1707 If 'indentexpr' is not empty, it overrules 'cindent'.
1708 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1709 the "=" operator indents using this algorithm rather than calling an
1710 external program.
1711 See |C-indenting|.
1712 When you don't like the way 'cindent' works, try the 'smartindent'
1713 option or 'indentexpr'.
1714 This option is not used when 'paste' is set.
1715 NOTE: This option is reset when 'compatible' is set.
1716
1717 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001718'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 A list of keys that, when typed in Insert mode, cause reindenting of
1721 the current line. Only used if 'cindent' is on and 'indentexpr' is
1722 empty.
1723 For the format of this option see |cinkeys-format|.
1724 See |C-indenting|.
1725
1726 *'cinoptions'* *'cino'*
1727'cinoptions' 'cino' string (default "")
1728 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1730 program. See |cinoptions-values| for the values of this option, and
1731 |C-indenting| for info on C indenting in general.
1732
laburnumT3f7855a2023-12-05 18:37:03 +01001733 *'cinscopedecls'* *'cinsd'*
1734'cinscopedecls' 'cinsd' string (default "public,protected,private")
1735 local to buffer
1736 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1737 Useful e.g. for working with the Qt framework that defines additional
1738 scope declarations "signals", "public slots" and "private slots": >
1739 set cinscopedecls+=signals,public\ slots,private\ slots
1740<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 *'cinwords'* *'cinw'*
1742'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1743 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 These keywords start an extra indent in the next line when
1745 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1746 an appropriate place (inside {}).
1747 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1748 matter, include the keyword both the uppercase and lowercase:
1749 "if,If,IF".
1750
laburnumT3f7855a2023-12-05 18:37:03 +01001751 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1753 for X-windows, "" otherwise)
1754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 {only in GUI versions or when the |+xterm_clipboard|
1756 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001757 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001758 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001759 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001760 prepend, e.g.: >
1761 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001762< When using the GUI see |'go-A'|.
1763 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001765 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 unnamed When included, Vim will use the clipboard register '*'
1767 for all yank, delete, change and put operations which
1768 would normally go to the unnamed register. When a
1769 register is explicitly specified, it will always be
1770 used regardless of whether "unnamed" is in 'clipboard'
1771 or not. The clipboard register can always be
1772 explicitly accessed using the "* notation. Also see
1773 |gui-clipboard|.
1774
Bram Moolenaar30b65812012-07-12 22:01:11 +02001775 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001776 unnamedplus A variant of the "unnamed" flag which uses the
1777 clipboard register '+' (|quoteplus|) instead of
1778 register '*' for all yank, delete, change and put
1779 operations which would normally go to the unnamed
1780 register. When "unnamed" is also included to the
1781 option, yank operations (but not delete, change or
1782 put) will additionally copy the text into register
1783 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001784 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001785 Availability can be checked with: >
1786 if has('unnamedplus')
1787<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001788 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 autoselect Works like the 'a' flag in 'guioptions': If present,
1790 then whenever Visual mode is started, or the Visual
1791 area extended, Vim tries to become the owner of the
1792 windowing system's global selection or put the
1793 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001794 register "*. See |'go-a'| and |quotestar| for details.
1795 When the GUI is active, the 'a' flag in 'guioptions'
1796 is used, when the GUI is not active, this "autoselect"
1797 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 Also applies to the modeless selection.
1799
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001800 *clipboard-autoselectplus*
1801 autoselectplus Like "autoselect" but using the + register instead of
1802 the * register. Compare to the 'P' flag in
1803 'guioptions'.
1804
1805 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 autoselectml Like "autoselect", but for the modeless selection
1807 only. Compare to the 'A' flag in 'guioptions'.
1808
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001809 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001810 html When the clipboard contains HTML, use this when
1811 pasting. When putting text on the clipboard, mark it
1812 as HTML. This works to copy rendered HTML from
1813 Firefox, paste it as raw HTML in Vim, select the HTML
1814 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001815 You probably want to add this only temporarily,
1816 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001817 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 exclude:{pattern}
1821 Defines a pattern that is matched against the name of
1822 the terminal 'term'. If there is a match, no
1823 connection will be made to the X server. This is
1824 useful in this situation:
1825 - Running Vim in a console.
1826 - $DISPLAY is set to start applications on another
1827 display.
1828 - You do not want to connect to the X server in the
1829 console, but do want this in a terminal emulator.
1830 To never connect to the X server use: >
1831 exclude:.*
1832< This has the same effect as using the |-X| argument.
1833 Note that when there is no connection to the X server
1834 the window title won't be restored and the clipboard
1835 cannot be accessed.
1836 The value of 'magic' is ignored, {pattern} is
1837 interpreted as if 'magic' was on.
1838 The rest of the option value will be used for
1839 {pattern}, this must be the last entry.
1840
1841 *'cmdheight'* *'ch'*
1842'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001843 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001844 Number of screen lines to use for the command-line. A larger value
1845 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001846 The value of this option is stored with the tab page, so that each tab
1847 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848
1849 *'cmdwinheight'* *'cwh'*
1850'cmdwinheight' 'cwh' number (default 7)
1851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 Number of screen lines to use for the command-line window. |cmdwin|
1853
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001854 *'colorcolumn'* *'cc'*
1855'colorcolumn' 'cc' string (default "")
1856 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001857 {not available when compiled without the |+syntax|
1858 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001859 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001860 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1861 text. Will make screen redrawing slower.
1862 The screen column can be an absolute number, or a number preceded with
1863 '+' or '-', which is added to or subtracted from 'textwidth'. >
1864
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001865 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001866 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1867 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1868<
1869 When 'textwidth' is zero then the items with '-' and '+' are not used.
1870 A maximum of 256 columns are highlighted.
1871
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *'columns'* *'co'* *E594*
1873'columns' 'co' number (default 80 or terminal width)
1874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001876 initialization and does not have to be set by hand. Also see
1877 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 When Vim is running in the GUI or in a resizable window, setting this
1879 option will cause the window size to be changed. When you only want
1880 to use the size for the GUI, put the command in your |gvimrc| file.
1881 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001882 number of columns of the display, the display may be messed up. For
1883 the GUI it is always possible and Vim limits the number of columns to
1884 what fits on the screen. You can use this command to get the widest
1885 window possible: >
1886 :set columns=9999
1887< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888
1889 *'comments'* *'com'* *E524* *E525*
1890'comments' 'com' string (default
1891 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1892 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001893 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 |format-comments|. See |option-backslash| about using backslashes to
1895 insert a space.
1896
1897 *'commentstring'* *'cms'* *E537*
1898'commentstring' 'cms' string (default "/*%s*/")
1899 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 {not available when compiled without the |+folding|
1901 feature}
1902 A template for a comment. The "%s" in the value is replaced with the
1903 comment text. Currently only used to add markers for folding, see
1904 |fold-marker|.
1905
1906 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001907'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001908 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 This option has the effect of making Vim either more Vi-compatible, or
1911 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001912
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 other options are also changed as a side effect.
1915 NOTE: Setting or resetting this option can have a lot of unexpected
1916 effects: Mappings are interpreted in another way, undo behaves
1917 differently, etc. If you set this option in your vimrc file, you
1918 should probably put it at the very start.
1919
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 By default this option is on and the Vi defaults are used for the
1921 options. This default was chosen for those people who want to use Vim
1922 just like Vi, and don't even (want to) know about the 'compatible'
1923 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001924 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001925 this option is switched off, and all options that have not been
1926 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001928 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001929 happen for the system-wide vimrc or gvimrc file, nor for a file given
1930 with the |-u| argument). Also see |compatible-default| and
1931 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 You can also set this option with the "-C" argument, and reset it with
1933 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935
Bram Moolenaar214641f2017-03-05 17:04:09 +01001936 When this option is set, numerous other options are set to make Vim as
1937 Vi-compatible as possible. When this option is unset, various options
1938 are set to make Vim more useful. The table below lists all the
1939 options affected.
1940 The {?} column indicates when the options are affected:
1941 + Means that the option is set to the value given in {set value} when
1942 'compatible' is set.
1943 & Means that the option is set to the value given in {set value} when
1944 'compatible' is set AND is set to its Vim default value when
1945 'compatible' is unset.
1946 - Means the option is NOT changed when setting 'compatible' but IS
1947 set to its Vim default when 'compatible' is unset.
1948 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
Bram Moolenaar036986f2017-03-16 17:41:02 +01001950 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001951
1952 'allowrevins' + off no CTRL-_ command
1953 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001954 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001955 'arabicshape' + on correct character shapes
1956 'backspace' + "" normal backspace
1957 'backup' + off no backup file
1958 'backupcopy' & Unix: "yes" backup file is a copy
1959 else: "auto" copy or rename backup file
1960 'balloonexpr' + "" text to show in evaluation balloon
1961 'breakindent' + off don't indent when wrapping lines
1962 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001963 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001964 'cindent' + off no C code indentation
1965 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1966 'copyindent' + off don't copy indent structure
1967 'cpoptions' & (all flags) Vi-compatible flags
1968 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001969 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001971 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001972 'cscopeverbose' + off see |cscopeverbose|
1973 'delcombine' + off unicode: delete whole char combination
1974 'digraph' + off no digraphs
1975 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001976 this also disables |modifyOtherKeys|
1977 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001978 'expandtab' + off tabs not expanded to spaces
1979 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001980 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001981 'formatexpr' + "" use 'formatprg' for auto-formatting
1982 'formatoptions' & "vt" Vi compatible formatting
1983 'gdefault' + off no default 'g' flag for ":s"
1984 'history' & 0 no commandline history
1985 'hkmap' + off no Hebrew keyboard mapping
1986 'hkmapp' + off no phonetic Hebrew keyboard mapping
1987 'hlsearch' + off no highlighting of search matches
1988 'incsearch' + off no incremental searching
1989 'indentexpr' + "" no indenting by expression
1990 'insertmode' + off do not start in Insert mode
1991 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001993 'joinspaces' + on insert 2 spaces after period
1994 'modeline' & off no modelines
1995 'more' & off no pauses in listings
1996 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1997 'numberwidth' & 8 min number of columns for line number
1998 'preserveindent'+ off don't preserve current indent structure
1999 when changing it
2000 'revins' + off no reverse insert
2001 'ruler' + off no ruler
2002 'scrolljump' + 1 no jump scroll
2003 'scrolloff' + 0 no scroll offset
2004 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2005 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002006 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002007 'showcmd' & off command characters not shown
2008 'showmode' & off current mode not shown
2009 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2010 'smartcase' + off no automatic ignore case switch
2011 'smartindent' + off no smart indentation
2012 'smarttab' + off no smart tab size
2013 'softtabstop' + 0 tabs are always 'tabstop' positions
2014 'startofline' + on goto startofline with some commands
2015 'tagcase' & "followic" 'ignorecase' when searching tags file
2016 'tagrelative' & off tag file names are not relative
2017 'termguicolors' + off don't use highlight-(guifg|guibg)
2018 'textauto' & off no automatic textmode detection
2019 'textwidth' + 0 no automatic line wrap
2020 'tildeop' + off tilde is not an operator
2021 'ttimeout' + off no terminal timeout
2022 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002023 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002024 'virtualedit' + "" cursor can only be placed on characters
2025 'whichwrap' & "" left-right movements don't wrap
2026 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002028 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029
2030 *'complete'* *'cpt'* *E535*
2031'complete' 'cpt' string (default: ".,w,b,u,t,i")
2032 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 This option specifies how keyword completion |ins-completion| works
2034 when CTRL-P or CTRL-N are used. It is also used for whole-line
2035 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002036 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002037 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 w scan buffers from other windows
2039 b scan other loaded buffers that are in the buffer list
2040 u scan the unloaded buffers that are in the buffer list
2041 U scan the buffers that are not in the buffer list
2042 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002043 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 k{dict} scan the file {dict}. Several "k" flags can be given,
2045 patterns are valid too. For example: >
2046 :set cpt=k/usr/dict/*,k~/spanish
2047< s scan the files given with the 'thesaurus' option
2048 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2049 are valid too.
2050 i scan current and included files
2051 d scan current and included files for defined name or macro
2052 |i_CTRL-X_CTRL-D|
2053 ] tag completion
2054 t same as "]"
2055
2056 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2057 not executed, this may lead to unexpected completions from some files
2058 (gzipped files for example). Unloaded buffers are not scanned for
2059 whole-line completion.
2060
2061 The default is ".,w,b,u,t,i", which means to scan:
2062 1. the current buffer
2063 2. buffers in other windows
2064 3. other loaded buffers
2065 4. unloaded buffers
2066 5. tags
2067 6. included files
2068
2069 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002070 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2071 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002073 *'completefunc'* *'cfu'*
2074'completefunc' 'cfu' string (default: empty)
2075 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002076 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002077 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002078 This option specifies a function to be used for Insert mode completion
2079 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002080 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002081 invoked and what it should return. The value can be the name of a
2082 function, a |lambda| or a |Funcref|. See |option-value-function| for
2083 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002084 This option cannot be set from a |modeline| or in the |sandbox|, for
2085 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002086
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002087 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002088'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002089 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002090 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002091 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002092
2093 menu Use a popup menu to show the possible completions. The
2094 menu is only shown when there is more than one match and
2095 sufficient colors are available. |ins-completion-menu|
2096
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002097 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002098 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002099 match, e.g., what file it comes from.
2100
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002101 longest Only insert the longest common text of the matches. If
2102 the menu is displayed you can use CTRL-L to add more
2103 characters. Whether case is ignored depends on the kind
2104 of completion. For buffer text the 'ignorecase' option is
2105 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002106
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002107 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002108 completion in the preview window. Only works in
2109 combination with "menu" or "menuone".
2110
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002111 popup Show extra information about the currently selected
2112 completion in a popup window. Only works in combination
2113 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002114 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002115 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002116
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002117 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002118 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002119 |CompleteChanged| autocommand to fetch the info and call
2120 |popup_show()| once the popup has been filled.
2121 See the example at |complete-popuphidden|.
2122 {only works when compiled with the |+textprop| feature}
2123
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002124 noinsert Do not insert any text for a match until the user selects
2125 a match from the menu. Only works in combination with
2126 "menu" or "menuone". No effect if "longest" is present.
2127
2128 noselect Do not select a match in the menu, force the user to
2129 select one from the menu. Only works in combination with
2130 "menu" or "menuone".
2131
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002132 *'completepopup'* *'cpp'*
2133'completepopup' 'cpp' string (default empty)
2134 global
2135 {not available when compiled without the |+textprop|
2136 or |+quickfix| feature}
2137 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002138 properties of the info popup when it is created. If an info popup
2139 window already exists it is closed, so that the option value is
2140 applied when it is created again.
2141 You can also use |popup_findinfo()| and then set properties for an
2142 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002143
laburnumT3f7855a2023-12-05 18:37:03 +01002144 *'completeslash'* *'csl'*
2145'completeslash' 'csl' string (default: "")
2146 local to buffer
2147 {only for MS-Windows}
2148 When this option is set it overrules 'shellslash' for completion:
2149 - When this option is set to "slash", a forward slash is used for path
2150 completion in insert mode. This is useful when editing HTML tag, or
2151 Makefile with 'noshellslash' on MS-Windows.
2152 - When this option is set to "backslash", backslash is used. This is
2153 useful when editing a batch file with 'shellslash' set on MS-Windows.
2154 - When this option is empty, same character is used as for
2155 'shellslash'.
2156 For Insert mode completion the buffer-local value is used. For
2157 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002158
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002159 *'concealcursor'* *'cocu'*
2160'concealcursor' 'cocu' string (default: "")
2161 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002162 {not available when compiled without the |+conceal|
2163 feature}
2164 Sets the modes in which text in the cursor line can also be concealed.
2165 When the current mode is listed then concealing happens just like in
2166 other lines.
2167 n Normal mode
2168 v Visual mode
2169 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002170 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002171
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002172 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002173 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002174 are moving around text is concealed, but when starting to insert text
2175 or selecting a Visual area the concealed text is displayed, so that
2176 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002177 Keep in mind that the cursor position is not always where it's
2178 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002179
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002180 *'conceallevel'* *'cole'*
2181'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002182 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002183 {not available when compiled without the |+conceal|
2184 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002185 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2186 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002187
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002188 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002189 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002190 1 Each block of concealed text is replaced with one
2191 character. If the syntax item does not have a custom
2192 replacement character defined (see |:syn-cchar|) the
2193 character defined in 'listchars' is used (default is a
2194 space).
2195 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002196 2 Concealed text is completely hidden unless it has a
2197 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002198 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002199 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002200
Bram Moolenaara7781e02010-07-19 20:13:22 +02002201 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002202 edit and copy the text. This can be changed with the 'concealcursor'
2203 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002204
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2206'confirm' 'cf' boolean (default off)
2207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 When 'confirm' is on, certain operations that would normally
2209 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2210 instead raise a |dialog| asking if you wish to save the current
2211 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2212 If 'confirm' is off you can still activate confirmation for one
2213 command only (this is most useful in mappings) with the |:confirm|
2214 command.
2215 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2216
2217 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2218'conskey' 'consk' boolean (default off)
2219 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002220 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221
2222 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2223'copyindent' 'ci' boolean (default off)
2224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 Copy the structure of the existing lines indent when autoindenting a
2226 new line. Normally the new indent is reconstructed by a series of
2227 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2228 in which case only spaces are used). Enabling this option makes the
2229 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002230 existing line. 'expandtab' has no effect on these characters, a Tab
2231 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002233 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 Also see 'preserveindent'.
2235
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002236 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237'cpoptions' 'cpo' string (Vim default: "aABceFs",
2238 Vi default: all flags)
2239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002241 this indicates Vi-compatible behavior. This is used for things where
2242 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 'cpoptions' stands for "compatible-options".
2244 Commas can be added for readability.
2245 To avoid problems with flags that are added in the future, use the
2246 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002247
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 NOTE: This option is set to the Vi default value when 'compatible' is
2249 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002250
2251 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2252 is saved, 'cpoptions' is set to the Vim default, and the saved value
2253 is restored at the end of the script. Changes to the value of
2254 'cpoptions' will be applied to the saved value, but keep in mind that
2255 removing a flag that is not present when 'cpoptions' is changed has no
2256 effect. In the |.vimrc| file the value is not restored, thus using
2257 `vim9script` in the |.vimrc| file results in using the Vim default.
2258
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002259 NOTE: This option is set to the POSIX default value at startup when
2260 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002261 variable exists |posix|. This means Vim tries to behave like the
2262 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263
2264 contains behavior ~
2265 *cpo-a*
2266 a When included, a ":read" command with a file name
2267 argument will set the alternate file name for the
2268 current window.
2269 *cpo-A*
2270 A When included, a ":write" command with a file name
2271 argument will set the alternate file name for the
2272 current window.
2273 *cpo-b*
2274 b "\|" in a ":map" command is recognized as the end of
2275 the map command. The '\' is included in the mapping,
2276 the text after the '|' is interpreted as the next
2277 command. Use a CTRL-V instead of a backslash to
2278 include the '|' in the mapping. Applies to all
2279 mapping, abbreviation, menu and autocmd commands.
2280 See also |map_bar|.
2281 *cpo-B*
2282 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002283 abbreviations, user commands and the "to" part of the
2284 menu commands. Remove this flag to be able to use a
2285 backslash like a CTRL-V. For example, the command
2286 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 'B' included: "\^[" (^[ is a real <Esc>)
2288 'B' excluded: "<Esc>" (5 characters)
2289 ('<' excluded in both cases)
2290 *cpo-c*
2291 c Searching continues at the end of any match at the
2292 cursor position, but not further than the start of the
2293 next line. When not present searching continues
2294 one character from the cursor position. With 'c'
2295 "abababababab" only gets three matches when repeating
2296 "/abab", without 'c' there are five matches.
2297 *cpo-C*
2298 C Do not concatenate sourced lines that start with a
2299 backslash. See |line-continuation|.
2300 *cpo-d*
2301 d Using "./" in the 'tags' option doesn't mean to use
2302 the tags file relative to the current file, but the
2303 tags file in the current directory.
2304 *cpo-D*
2305 D Can't use CTRL-K to enter a digraph after Normal mode
2306 commands with a character argument, like |r|, |f| and
2307 |t|.
2308 *cpo-e*
2309 e When executing a register with ":@r", always add a
2310 <CR> to the last line, also when the register is not
2311 linewise. If this flag is not present, the register
2312 is not linewise and the last line does not end in a
2313 <CR>, then the last line is put on the command-line
2314 and can be edited before hitting <CR>.
2315 *cpo-E*
2316 E It is an error when using "y", "d", "c", "g~", "gu" or
2317 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002318 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 This makes "y0" fail in the first column.
2320 *cpo-f*
2321 f When included, a ":read" command with a file name
2322 argument will set the file name for the current buffer,
2323 if the current buffer doesn't have a file name yet.
2324 *cpo-F*
2325 F When included, a ":write" command with a file name
2326 argument will set the file name for the current
2327 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002328 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 *cpo-g*
2330 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002331 *cpo-H*
2332 H When using "I" on a line with only blanks, insert
2333 before the last blank. Without this flag insert after
2334 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 *cpo-i*
2336 i When included, interrupting the reading of a file will
2337 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 *cpo-I*
2339 I When moving the cursor up or down just after inserting
2340 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 *cpo-j*
2342 j When joining lines, only add two spaces after a '.',
2343 not after '!' or '?'. Also see 'joinspaces'.
2344 *cpo-J*
2345 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002346 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 white space.
2348 *cpo-k*
2349 k Disable the recognition of raw key codes in
2350 mappings, abbreviations, and the "to" part of menu
2351 commands. For example, if <Key> sends ^[OA (where ^[
2352 is <Esc>), the command ":map X ^[OA" results in X
2353 being mapped to:
2354 'k' included: "^[OA" (3 characters)
2355 'k' excluded: "<Key>" (one key code)
2356 Also see the '<' flag below.
2357 *cpo-K*
2358 K Don't wait for a key code to complete when it is
2359 halfway a mapping. This breaks mapping <F1><F1> when
2360 only part of the second <F1> has been read. It
2361 enables cancelling the mapping by typing <F1><Esc>.
2362 *cpo-l*
2363 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002364 literally, only "\]", "\^", "\-" and "\\" are special.
2365 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2367 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002368 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 *cpo-L*
2370 L When the 'list' option is set, 'wrapmargin',
2371 'textwidth', 'softtabstop' and Virtual Replace mode
2372 (see |gR|) count a <Tab> as two characters, instead of
2373 the normal behavior of a <Tab>.
2374 *cpo-m*
2375 m When included, a showmatch will always wait half a
2376 second. When not included, a showmatch will wait half
2377 a second or until a character is typed. |'showmatch'|
2378 *cpo-M*
2379 M When excluded, "%" matching will take backslashes into
2380 account. Thus in "( \( )" and "\( ( \)" the outer
2381 parenthesis match. When included "%" ignores
2382 backslashes, which is Vi compatible.
2383 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002384 n When included, the column used for 'number' and
2385 'relativenumber' will also be used for text of wrapped
2386 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *cpo-o*
2388 o Line offset to search command is not remembered for
2389 next search.
2390 *cpo-O*
2391 O Don't complain if a file is being overwritten, even
2392 when it didn't exist when editing it. This is a
2393 protection against a file unexpectedly created by
2394 someone else. Vi didn't complain about this.
2395 *cpo-p*
2396 p Vi compatible Lisp indenting. When not present, a
2397 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002398 *cpo-P*
2399 P When included, a ":write" command that appends to a
2400 file will set the file name for the current buffer, if
2401 the current buffer doesn't have a file name yet and
2402 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002403 *cpo-q*
2404 q When joining multiple lines leave the cursor at the
2405 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 *cpo-r*
2407 r Redo ("." command) uses "/" to repeat a search
2408 command, instead of the actually used search string.
2409 *cpo-R*
2410 R Remove marks from filtered lines. Without this flag
2411 marks are kept like |:keepmarks| was used.
2412 *cpo-s*
2413 s Set buffer options when entering the buffer for the
2414 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002415 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 set when the buffer is created.
2417 *cpo-S*
2418 S Set buffer options always when entering a buffer
2419 (except 'readonly', 'fileformat', 'filetype' and
2420 'syntax'). This is the (most) Vi compatible setting.
2421 The options are set to the values in the current
2422 buffer. When you change an option and go to another
2423 buffer, the value is copied. Effectively makes the
2424 buffer options global to all buffers.
2425
2426 's' 'S' copy buffer options
2427 no no when buffer created
2428 yes no when buffer first entered (default)
2429 X yes each time when buffer entered (vi comp.)
2430 *cpo-t*
2431 t Search pattern for the tag command is remembered for
2432 "n" command. Otherwise Vim only puts the pattern in
2433 the history for search pattern, but doesn't change the
2434 last used search pattern.
2435 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002436 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 *cpo-v*
2438 v Backspaced characters remain visible on the screen in
2439 Insert mode. Without this flag the characters are
2440 erased from the screen right away. With this flag the
2441 screen newly typed text overwrites backspaced
2442 characters.
2443 *cpo-w*
2444 w When using "cw" on a blank character, only change one
2445 character and not all blanks until the start of the
2446 next word.
2447 *cpo-W*
2448 W Don't overwrite a readonly file. When omitted, ":w!"
2449 overwrites a readonly file, if possible.
2450 *cpo-x*
2451 x <Esc> on the command-line executes the command-line.
2452 The default in Vim is to abandon the command-line,
2453 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002454 *cpo-X*
2455 X When using a count with "R" the replaced text is
2456 deleted only once. Also when repeating "R" with "."
2457 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002459 y A yank command can be redone with ".". Think twice if
2460 you really want to use this, it may break some
2461 plugins, since most people expect "." to only repeat a
2462 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002463 *cpo-Z*
2464 Z When using "w!" while the 'readonly' option is set,
2465 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 *cpo-!*
2467 ! When redoing a filter command, use the last used
2468 external command, whatever it was. Otherwise the last
2469 used -filter- command is used.
2470 *cpo-$*
2471 $ When making a change to one line, don't redisplay the
2472 line, but put a '$' at the end of the changed text.
2473 The changed text will be overwritten when you type the
2474 new text. The line is redisplayed if you type any
2475 command that moves the cursor from the insertion
2476 point.
2477 *cpo-%*
2478 % Vi-compatible matching is done for the "%" command.
2479 Does not recognize "#if", "#endif", etc.
2480 Does not recognize "/*" and "*/".
2481 Parens inside single and double quotes are also
2482 counted, causing a string that contains a paren to
2483 disturb the matching. For example, in a line like
2484 "if (strcmp("foo(", s))" the first paren does not
2485 match the last one. When this flag is not included,
2486 parens inside single and double quotes are treated
2487 specially. When matching a paren outside of quotes,
2488 everything inside quotes is ignored. When matching a
2489 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002490 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002491 This flag is also used for other features, such as
2492 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002493 *cpo--*
2494 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002495 it would go above the first line or below the last
2496 line. Without it the cursor moves to the first or
2497 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002498 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002499 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002500 *cpo-+*
2501 + When included, a ":write file" command will reset the
2502 'modified' flag of the buffer, even though the buffer
2503 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002504 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 * Use ":*" in the same way as ":@". When not included,
2506 ":*" is an alias for ":'<,'>", select the Visual area.
2507 *cpo-<*
2508 < Disable the recognition of special key codes in |<>|
2509 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002510 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 ":map X <Tab>" results in X being mapped to:
2512 '<' included: "<Tab>" (5 characters)
2513 '<' excluded: "^I" (^I is a real <Tab>)
2514 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002515 *cpo->*
2516 > When appending to a register, put a line break before
2517 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002518 *cpo-;*
2519 ; When using |,| or |;| to repeat the last |t| search
2520 and the cursor is right in front of the searched
2521 character, the cursor won't move. When not included,
2522 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002523 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002524
2525 POSIX flags. These are not included in the Vi default value, except
2526 when $VIM_POSIX was set on startup. |posix|
2527
2528 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002529 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002530 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002531 *cpo-&*
2532 & When ":preserve" was used keep the swap file when
2533 exiting normally while this buffer is still loaded.
2534 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002535 *cpo-\*
2536 \ Backslash in a [] range in a search pattern is taken
2537 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002538 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2539 '\' excluded: "/[ \-]" finds <Space> and '-'
2540 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002541 *cpo-/*
2542 / When "%" is used as the replacement string in a |:s|
2543 command, use the previous replacement string. |:s%|
2544 *cpo-{*
2545 { The |{| and |}| commands also stop at a "{" character
2546 at the start of a line.
2547 *cpo-.*
2548 . The ":chdir" and ":cd" commands fail if the current
2549 buffer is modified, unless ! is used. Vim doesn't
2550 need this, since it remembers the full path of an
2551 opened file.
2552 *cpo-bar*
2553 | The value of the $LINES and $COLUMNS environment
2554 variables overrule the terminal size values obtained
2555 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002556
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002557 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002558'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002559 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002560 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002561 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002562 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002563 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002564 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002565 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002566 blowfish Blowfish method. Medium strong encryption but it has
2567 an implementation flaw. Requires Vim 7.3 or later,
2568 files can NOT be read by Vim 7.2 and older. This adds
2569 a "seed" to the file, every time you write the file
2570 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002571 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002572 *blowfish2*
2573 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002574 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002575 and older. This adds a "seed" to the file, every time
2576 you write the file the encrypted bytes will be
2577 different. The whole undo file is encrypted, not just
2578 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002579 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002580 *E1197* *E1198* *E1199* *E1200* *E1201*
2581 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2582 Code. Medium strong till strong encryption.
2583 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002584 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002585 It adds a seed and a message authentication code (MAC)
2586 to the file. This needs at least a Vim 8.2.3022 to
2587 read the encrypted file.
2588 Encryption of swap files is not supported, therefore
2589 no swap file will be used when xchacha20 encryption is
2590 enabled.
2591 Encryption of undo files is not yet supported,
2592 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002593 CAREFUL: Files written with this method might have to
2594 be read back with the same version of Vim if the
2595 binary format changes later.
2596 Obsolete, please do no longer use.
2597 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2598 stores the key derivation parameters together with the
2599 encrypted file. Should work better in case the
2600 parameters in the libsodium library ever change.
2601 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002602 might have to be read back with the same version of
2603 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002604
Christian Brabandtaae58342023-04-23 17:50:22 +01002605 You should use "blowfish2", also to re-encrypt older files. The
2606 "xchacha20" method provides better encryption, but it does not work
2607 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002608
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002609 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002610 to the detected method of the file being read. Thus if you write it
2611 without changing 'cryptmethod' the same method will be used.
2612 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002613 explicitly write it, you don't get a warning unless there are other
2614 modifications. Also see |:X|.
2615
2616 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002617 the value "blowfish2". When setting the local value to an empty
2618 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002619
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002620 When a new encryption method is added in a later version of Vim, and
2621 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002622 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002623
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 *'cscopepathcomp'* *'cspc'*
2625'cscopepathcomp' 'cspc' number (default 0)
2626 global
2627 {not available when compiled without the |+cscope|
2628 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 Determines how many components of the path to show in a list of tags.
2630 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002631 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632
2633 *'cscopeprg'* *'csprg'*
2634'cscopeprg' 'csprg' string (default "cscope")
2635 global
2636 {not available when compiled without the |+cscope|
2637 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 Specifies the command to execute cscope. See |cscopeprg|.
2639 This option cannot be set from a |modeline| or in the |sandbox|, for
2640 security reasons.
2641
2642 *'cscopequickfix'* *'csqf'*
2643'cscopequickfix' 'csqf' string (default "")
2644 global
2645 {not available when compiled without the |+cscope|
2646 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 Specifies whether to use quickfix window to show cscope results.
2648 See |cscopequickfix|.
2649
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002650 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002651'cscoperelative' 'csre' boolean (default off)
2652 global
2653 {not available when compiled without the |+cscope|
2654 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002655 In the absence of a prefix (-P) for cscope. setting this option enables
2656 to use the basename of cscope.out path as the prefix.
2657 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002658 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002659
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2661'cscopetag' 'cst' boolean (default off)
2662 global
2663 {not available when compiled without the |+cscope|
2664 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 Use cscope for tag commands. See |cscope-options|.
2666 NOTE: This option is reset when 'compatible' is set.
2667
2668 *'cscopetagorder'* *'csto'*
2669'cscopetagorder' 'csto' number (default 0)
2670 global
2671 {not available when compiled without the |+cscope|
2672 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 Determines the order in which ":cstag" performs a search. See
2674 |cscopetagorder|.
2675 NOTE: This option is set to 0 when 'compatible' is set.
2676
2677 *'cscopeverbose'* *'csverb'*
2678 *'nocscopeverbose'* *'nocsverb'*
2679'cscopeverbose' 'csverb' boolean (default off)
2680 global
2681 {not available when compiled without the |+cscope|
2682 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 Give messages when adding a cscope database. See |cscopeverbose|.
2684 NOTE: This option is reset when 'compatible' is set.
2685
Bram Moolenaar860cae12010-06-05 23:22:07 +02002686 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2687'cursorbind' 'crb' boolean (default off)
2688 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002689 When this option is set, as the cursor in the current
2690 window moves other cursorbound windows (windows that also have
2691 this option set) move their cursors to the corresponding line and
2692 column. This option is useful for viewing the
2693 differences between two versions of a file (see 'diff'); in diff mode,
2694 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002695 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002696
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002697 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2698'cursorcolumn' 'cuc' boolean (default off)
2699 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002700 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002701 feature}
2702 Highlight the screen column of the cursor with CursorColumn
2703 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2704 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002705 If you only want the highlighting in the current window you can use
2706 these autocommands: >
2707 au WinLeave * set nocursorline nocursorcolumn
2708 au WinEnter * set cursorline cursorcolumn
2709<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002710
2711 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2712'cursorline' 'cul' boolean (default off)
2713 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002714 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002715 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002716 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2717 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002718 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002719 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002720
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002721 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002722'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002723 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002724 {not available when compiled without the |+syntax|
2725 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002726 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002727 Valid values:
2728 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002729 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002730 "screenline" Highlight only the screen line of the cursor with
2731 CursorLine |hl-CursorLine|.
2732 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002733 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002734
2735 Special value:
2736 "both" Alias for the values "line,number".
2737
2738 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002739
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 *'debug'*
2741'debug' string (default "")
2742 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002743 These values can be used:
2744 msg Error messages that would otherwise be omitted will be given
2745 anyway.
2746 throw Error messages that would otherwise be omitted will be given
2747 anyway and also throw an exception and set |v:errmsg|.
2748 beep A message will be given when otherwise only a beep would be
2749 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002750 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002751 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2752 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753
2754 *'define'* *'def'*
2755'define' 'def' string (default "^\s*#\s*define")
2756 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002757 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 pattern, just like for the "/" command. This option is used for the
2759 commands like "[i" and "[d" |include-search|. The 'isident' option is
2760 used to recognize the defined name after the match:
2761 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2762 See |option-backslash| about inserting backslashes to include a space
2763 or backslash.
2764 The default value is for C programs. For C++ this value would be
2765 useful, to include const type declarations: >
2766 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002767< You can also use "\ze" just before the name and continue the pattern
2768 to check what is following. E.g. for Javascript, if a function is
2769 defined with "func_name = function(args)": >
2770 ^\s*\ze\i\+\s*=\s*function(
2771< If the function is defined with "func_name : function() {...": >
2772 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002774 To avoid that use `:let` with a single quote string: >
2775 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002776<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777
2778 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2779'delcombine' 'deco' boolean (default off)
2780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 If editing Unicode and this option is set, backspace and Normal mode
2782 "x" delete each combining character on its own. When it is off (the
2783 default) the character along with its combining characters are
2784 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002785 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786
2787 This is useful for Arabic, Hebrew and many other languages where one
2788 may have combining characters overtop of base characters, and want
2789 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002790 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
2792 *'dictionary'* *'dict'*
2793'dictionary' 'dict' string (default "")
2794 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 List of file names, separated by commas, that are used to lookup words
2796 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2797 contain a list of words. This can be one word per line, or several
2798 words per line, separated by non-keyword characters (white space is
2799 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002800
2801 When this option is empty or an entry "spell" is present, and spell
2802 checking is enabled, words in the word lists for the currently active
2803 'spelllang' are used. See |spell|.
2804
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002805 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 after a comma are ignored, otherwise spaces are included in the file
2807 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002808 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 Where to find a list of words?
2810 - On FreeBSD, there is the file "/usr/share/dict/words".
2811 - In the Simtel archive, look in the "msdos/linguist" directory.
2812 - In "miscfiles" of the GNU collection.
2813 The use of |:set+=| and |:set-=| is preferred when adding or removing
2814 directories from the list. This avoids problems when a future version
2815 uses another default.
2816 Backticks cannot be used in this option for security reasons.
2817
2818 *'diff'* *'nodiff'*
2819'diff' boolean (default off)
2820 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 {not available when compiled without the |+diff|
2822 feature}
2823 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002824 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825
2826 *'dex'* *'diffexpr'*
2827'diffexpr' 'dex' string (default "")
2828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 {not available when compiled without the |+diff|
2830 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002831 Expression which is evaluated to obtain a diff file (either ed-style
2832 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 This option cannot be set from a |modeline| or in the |sandbox|, for
2834 security reasons.
2835
2836 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002837'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 {not available when compiled without the |+diff|
2840 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002841 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 All are optional. Items must be separated by a comma.
2843
2844 filler Show filler lines, to keep the text
2845 synchronized with a window that has inserted
2846 lines at the same position. Mostly useful
2847 when windows are side-by-side and 'scrollbind'
2848 is set.
2849
2850 context:{n} Use a context of {n} lines between a change
2851 and a fold that contains unchanged lines.
2852 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002853 When using zero the context is actually one,
2854 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002855 for a deleted line. Set it to a very large
2856 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 See |fold-diff|.
2858
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002859 iblank Ignore changes where lines are all blank. 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.
2864 NOTE: the diff windows will get out of sync,
2865 because no differences between blank lines are
2866 taken into account.
2867
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 icase Ignore changes in case of text. "a" and "A"
2869 are considered the same. Adds the "-i" flag
2870 to the "diff" command if 'diffexpr' is empty.
2871
2872 iwhite Ignore changes in amount of white space. Adds
2873 the "-b" flag to the "diff" command if
2874 'diffexpr' is empty. Check the documentation
2875 of the "diff" command for what this does
2876 exactly. It should ignore adding trailing
2877 white space, but not leading white space.
2878
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002879 iwhiteall Ignore all white space changes. Adds
2880 the "-w" flag to the "diff" command if
2881 'diffexpr' is empty. Check the documentation
2882 of the "diff" command for what this does
2883 exactly.
2884
2885 iwhiteeol Ignore white space changes at end of line.
2886 Adds the "-Z" flag to the "diff" command if
2887 'diffexpr' is empty. Check the documentation
2888 of the "diff" command for what this does
2889 exactly.
2890
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002891 horizontal Start diff mode with horizontal splits (unless
2892 explicitly specified otherwise).
2893
2894 vertical Start diff mode with vertical splits (unless
2895 explicitly specified otherwise).
2896
Bram Moolenaarc8234772019-11-10 21:00:27 +01002897 closeoff When a window is closed where 'diff' is set
2898 and there is only one window remaining in the
2899 same tab page with 'diff' set, execute
2900 `:diffoff` in that window. This undoes a
2901 `:diffsplit` command.
2902
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002903 hiddenoff Do not use diff mode for a buffer when it
2904 becomes hidden.
2905
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002906 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2907 starting diff mode. Without this 2 is used.
2908
Bram Moolenaar4223d432021-02-10 13:18:17 +01002909 followwrap Follow the 'wrap' option and leave as it is.
2910
Bram Moolenaare828b762018-09-10 17:51:58 +02002911 internal Use the internal diff library. This is
2912 ignored when 'diffexpr' is set. *E960*
2913 When running out of memory when writing a
2914 buffer this item will be ignored for diffs
2915 involving that buffer. Set the 'verbose'
2916 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
Bram Moolenaare828b762018-09-10 17:51:58 +02002918 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002919 Use the indent heuristic for the internal
2920 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002921
2922 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002923 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002924 algorithms are:
2925 myers the default algorithm
2926 minimal spend extra time to generate the
2927 smallest possible diff
2928 patience patience diff algorithm
2929 histogram histogram diff algorithm
2930
2931 Examples: >
2932 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002934 :set diffopt=internal,filler,foldcolumn:3
2935 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936<
2937 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2938'digraph' 'dg' boolean (default off)
2939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 {not available when compiled without the |+digraphs|
2941 feature}
2942 Enable the entering of digraphs in Insert mode with {char1} <BS>
2943 {char2}. See |digraphs|.
2944 NOTE: This option is reset when 'compatible' is set.
2945
2946 *'directory'* *'dir'*
2947'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002948 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 for Unix: ".,~/tmp,/var/tmp,/tmp")
2950 global
2951 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002952 Recommended value: ".,~/vimswap//" - this will put the swap file next
2953 to the edited file if possible, and in your personal swap directory
2954 otherwise. Make sure "~/vimswap//" is only readable for you.
2955
2956 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 - The swap file will be created in the first directory where this is
2958 possible.
2959 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002960 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 - A directory "." means to put the swap file in the same directory as
2962 the edited file. On Unix, a dot is prepended to the file name, so
2963 it doesn't show in a directory listing. On MS-Windows the "hidden"
2964 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002965 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2966 the swap file relative to where the edited file is. The leading "."
2967 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002968 - For Unix and Win32, if a directory ends in two path separators "//",
2969 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002970 with all path separators replaced by percent '%' signs (including
2971 the colon following the drive letter on Win32). This will ensure
2972 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002973 On Win32, it is also possible to end with "\\". However, When a
2974 separating comma is following, you must use "//", since "\\" will
2975 include the comma in the file name. Therefore it is recommended to
2976 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 - Spaces after the comma are ignored, other spaces are considered part
2978 of the directory name. To have a space at the start of a directory
2979 name, precede it with a backslash.
2980 - To include a comma in a directory name precede it with a backslash.
2981 - A directory name may end in an ':' or '/'.
2982 - Environment variables are expanded |:set_env|.
2983 - Careful with '\' characters, type one before a space, type two to
2984 get one in the option (see |option-backslash|), for example: >
2985 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2986< - For backwards compatibility with Vim version 3.0 a '>' at the start
2987 of the option is removed.
2988 Using "." first in the list is recommended. This means that editing
2989 the same file twice will result in a warning. Using "/tmp" on Unix is
2990 discouraged: When the system crashes you lose the swap file.
2991 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002992 choice than "/tmp". But others on the computer may be able to see the
2993 files, and it can contain a lot of files, your swap files get lost in
2994 the crowd. That is why a "tmp" directory in your home directory is
2995 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 The use of |:set+=| and |:set-=| is preferred when adding or removing
2997 directories from the list. This avoids problems when a future version
2998 uses another default.
2999 This option cannot be set from a |modeline| or in the |sandbox|, for
3000 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001
3002 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003003'display' 'dy' string (default "", set to "truncate" in
3004 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003006 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 flags:
3008 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003009 in a window will be displayed. "@@@" is put in the
3010 last columns of the last screen line to indicate the
3011 rest of the line is not displayed.
3012 truncate Like "lastline", but "@@@" is displayed in the first
3013 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 uhex Show unprintable characters hexadecimal as <xx>
3015 instead of using ^C and ~C.
3016
Bram Moolenaard0796902016-09-16 20:02:31 +02003017 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003018 doesn't fit is replaced with "@" lines.
3019
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003020 The "@" character can be changed by setting the "lastline" item in
3021 'fillchars'. The character is highlighted with |hl-NonText|.
3022
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 *'eadirection'* *'ead'*
3024'eadirection' 'ead' string (default "both")
3025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 Tells when the 'equalalways' option applies:
3027 ver vertically, width of windows is not affected
3028 hor horizontally, height of windows is not affected
3029 both width and height of windows is affected
3030
3031 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3032'edcompatible' 'ed' boolean (default off)
3033 global
3034 Makes the 'g' and 'c' flags of the ":substitute" command to be
3035 toggled each time the flag is given. See |complex-change|. See
3036 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003037 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003038 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
Bram Moolenaar03413f42016-04-12 21:07:15 +02003040 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003041'emoji' 'emo' boolean (default: on)
3042 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003043 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003044 This excludes "text emoji" characters, which are normally displayed as
3045 single width. Unfortunately there is no good specification for this
3046 and it has been determined on trial-and-error basis. Use the
3047 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003048
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003050'encoding' 'enc' string (default for MS-Windows: "utf-8",
3051 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 Sets the character encoding used inside Vim. It applies to text in
3054 the buffers, registers, Strings in expressions, text stored in the
3055 viminfo file, etc. It sets the kind of characters which Vim can work
3056 with. See |encoding-names| for the possible values.
3057
3058 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003059 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003061 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062
Bram Moolenaar865242e2010-07-14 21:12:05 +02003063 This option cannot be set from a |modeline|. It would most likely
3064 corrupt the text.
3065
Bram Moolenaar3df01732017-02-17 22:47:16 +01003066 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3067 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 'encoding', "utf-8" is the natural choice for the environment and
3069 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 versions, and to avoid changing the encoding of newly created files
3072 without your knowledge (in case 'fileencodings' is empty).
3073
3074 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003075 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 iconv() or as specified with 'charconvert'.
3077
Bram Moolenaar207f0092020-08-30 17:20:20 +02003078 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003079 can use: >
3080 if has("multi_byte_encoding")
3081<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 Normally 'encoding' will be equal to your current locale. This will
3083 be the default if Vim recognizes your environment settings. If
3084 'encoding' is not set to the current locale, 'termencoding' must be
3085 set to convert typed and displayed text. See |encoding-table|.
3086
3087 When you set this option, it fires the |EncodingChanged| autocommand
3088 event so that you can set up fonts if necessary.
3089
3090 When the option is set, the value is converted to lowercase. Thus
3091 you can set it with uppercase values too. Underscores are translated
3092 to '-' signs.
3093 When the encoding is recognized, it is changed to the standard name.
3094 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3095 "iso-8859-2" and "utf8" becomes "utf-8".
3096
3097 Note: "latin1" is also used when the encoding could not be detected.
3098 This only works when editing files in the same encoding! When the
3099 actual character set is not latin1, make sure 'fileencoding' and
3100 'fileencodings' are empty. When conversion is needed, switch to using
3101 utf-8.
3102
3103 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3104 You don't notice this while editing, but it does matter for the
3105 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3106 setting 'encoding' to one of these values instead of utf-8 only has
3107 effect for encoding used for files when 'fileencoding' is empty.
3108
Bram Moolenaar661b1822005-07-28 22:36:45 +00003109 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3110 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003112 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003113'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003115 Indicates that a CTRL-Z character was found at the end of the file
3116 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003118 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003119 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003120 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003121
3122 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3123'endofline' 'eol' boolean (default on)
3124 local to buffer
3125 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003126 is on, or 'fixeol' option is off, no <EOL> will be written for the
3127 last line in the file. This option is automatically set or reset when
3128 starting to edit a new file, depending on whether file has an <EOL>
3129 for the last line in the file. Normally you don't have to set or
3130 reset this option.
3131 When 'binary' is off and 'fixeol' is on the value is not used when
3132 writing the file. When 'binary' is on or 'fixeol' is off it is used
3133 to remember the presence of a <EOL> for the last line in the file, so
3134 that when you write the file the situation from the original file can
3135 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003136 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137
3138 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3139'equalalways' 'ea' boolean (default on)
3140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003142 splitting or closing a window. This also happens the moment the
3143 option is switched on. When off, splitting a window will reduce the
3144 size of the current window and leave the other windows the same. When
3145 closing a window the extra lines are given to the window next to it
3146 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 When mixing vertically and horizontally split windows, a minimal size
3148 is computed and some windows may be larger if there is room. The
3149 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003150 Changing the height and width of a window can be avoided by setting
3151 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003152 If a window size is specified when creating a new window sizes are
3153 currently not equalized (it's complicated, but may be implemented in
3154 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155
3156 *'equalprg'* *'ep'*
3157'equalprg' 'ep' string (default "")
3158 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003160 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003161 or 'indentexpr'. When Vim was compiled without internal formatting,
3162 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003163 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 about including spaces and backslashes.
3165 This option cannot be set from a |modeline| or in the |sandbox|, for
3166 security reasons.
3167
3168 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3169'errorbells' 'eb' boolean (default off)
3170 global
3171 Ring the bell (beep or screen flash) for error messages. This only
3172 makes a difference for error messages, the bell will be used always
3173 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003174 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003175 screen flash or do nothing. See 'belloff' to finetune when to ring the
3176 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177
3178 *'errorfile'* *'ef'*
3179'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3180 others: "errors.err")
3181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 {not available when compiled without the |+quickfix|
3183 feature}
3184 Name of the errorfile for the QuickFix mode (see |:cf|).
3185 When the "-q" command-line argument is used, 'errorfile' is set to the
3186 following argument. See |-q|.
3187 NOT used for the ":make" command. See 'makeef' for that.
3188 Environment variables are expanded |:set_env|.
3189 See |option-backslash| about including spaces and backslashes.
3190 This option cannot be set from a |modeline| or in the |sandbox|, for
3191 security reasons.
3192
3193 *'errorformat'* *'efm'*
3194'errorformat' 'efm' string (default is very long)
3195 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 {not available when compiled without the |+quickfix|
3197 feature}
3198 Scanf-like description of the format for the lines in the error file
3199 (see |errorformat|).
3200
3201 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3202'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 Function keys that start with an <Esc> are recognized in Insert
3205 mode. When this option is off, the cursor and function keys cannot be
3206 used in Insert mode if they start with an <Esc>. The advantage of
3207 this is that the single <Esc> is recognized immediately, instead of
3208 after one second. Instead of resetting this option, you might want to
3209 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3210 when 'esckeys' is off, you can still map anything, but the cursor keys
3211 won't work by default.
3212 NOTE: This option is set to the Vi default value when 'compatible' is
3213 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003214 NOTE: when this option is off then the |modifyOtherKeys| and
3215 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3216 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217
3218 *'eventignore'* *'ei'*
3219'eventignore' 'ei' string (default "")
3220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003222 When set to "all" or when "all" is one of the items, all autocommand
3223 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003224 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 :set ei=WinEnter,WinLeave
3226<
3227 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3228'expandtab' 'et' boolean (default off)
3229 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3233 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003234 This option is reset when the 'paste' option is set and restored when
3235 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 NOTE: This option is reset when 'compatible' is set.
3237
3238 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3239'exrc' 'ex' boolean (default off)
3240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003242 directory.
3243
3244 Setting this option is a potential security leak. E.g., consider
3245 unpacking a package or fetching files from github, a .vimrc in there
3246 might be a trojan horse. BETTER NOT SET THIS OPTION!
3247 Instead, define an autocommand in your .vimrc to set options for a
3248 matching directory.
3249
3250 If you do switch this option on you should also consider setting the
3251 'secure' option (see |initialization|).
3252 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 This option cannot be set from a |modeline| or in the |sandbox|, for
3254 security reasons.
3255
3256 *'fileencoding'* *'fenc'* *E213*
3257'fileencoding' 'fenc' string (default: "")
3258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003260
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003262 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 When 'fileencoding' is empty, the same value as 'encoding' will be
3264 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003265 No error will be given when the value is set, only when it is used,
3266 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003267 Conversion will also be done when 'encoding' and 'fileencoding' are
3268 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3269 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003271 'encoding' is "utf-8" or another Unicode encoding, conversion
3272 is most likely done in a way that the reverse conversion
3273 results in the same text. When 'encoding' is not "utf-8" some
3274 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003275
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 See 'encoding' for the possible values. Additionally, values may be
3277 specified that can be handled by the converter, see
3278 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003279
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 When reading a file 'fileencoding' will be set from 'fileencodings'.
3281 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003282 'fileencoding', use the |++enc| argument. One exception: when
3283 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003284 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003285
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3287 When the option is set, the value is converted to lowercase. Thus
3288 you can set it with uppercase values too. '_' characters are
3289 replaced with '-'. If a name is recognized from the list for
3290 'encoding', it is replaced by the standard name. For example
3291 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003292
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 When this option is set, after starting to edit a file, the 'modified'
3294 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003295
3296 Keep in mind that changing 'fenc' from a modeline happens
3297 AFTER the text has been read, thus it applies to when the file will be
3298 written. If you do set 'fenc' in a modeline, you might want to set
3299 'nomodified' to avoid not being able to ":q".
3300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 This option can not be changed when 'modifiable' is off.
3302
3303 *'fe'*
3304 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003305 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 old short name was 'fe', which is no longer used.
3307
3308 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003309'fileencodings' 'fencs' string (default: "ucs-bom",
3310 "ucs-bom,utf-8,default,latin1" when
3311 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 This is a list of character encodings considered when starting to edit
3314 an existing file. When a file is read, Vim tries to use the first
3315 mentioned character encoding. If an error is detected, the next one
3316 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003317 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 an empty string, which means the value of 'encoding' is used.
3319 WARNING: Conversion can cause loss of information! When
3320 'encoding' is "utf-8" (or one of the other Unicode variants)
3321 conversion is most likely done in a way that the reverse
3322 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003323 "utf-8" some non-ASCII characters may be lost! You can use
3324 the |++bad| argument to specify what is done with characters
3325 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 For an empty file or a file with only ASCII characters most encodings
3327 will work and the first entry of 'fileencodings' will be used (except
3328 "ucs-bom", which requires the BOM to be present). If you prefer
3329 another encoding use an BufReadPost autocommand event to test if your
3330 preferred encoding is to be used. Example: >
3331 au BufReadPost * if search('\S', 'w') == 0 |
3332 \ set fenc=iso-2022-jp | endif
3333< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3334 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003335 When the |++enc| argument is used then the value of 'fileencodings' is
3336 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003337 Note that 'fileencodings' is not used for a new file, the global value
3338 of 'fileencoding' is used instead. You can set it with: >
3339 :setglobal fenc=iso-8859-2
3340< This means that a non-existing file may get a different encoding than
3341 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 The special value "ucs-bom" can be used to check for a Unicode BOM
3343 (Byte Order Mark) at the start of the file. It must not be preceded
3344 by "utf-8" or another Unicode encoding for this to work properly.
3345 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3346 because Vim cannot detect an error, thus the encoding is always
3347 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003348 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003349 environment. On MS-Windows this is the system encoding. Otherwise
3350 this is the default value for 'encoding'. It is useful when
3351 'encoding' is set to "utf-8" and your environment uses a non-latin1
3352 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003353 When 'encoding' is "utf-8" and a file contains an illegal byte
3354 sequence it won't be recognized as UTF-8. You can use the |8g8|
3355 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 WRONG VALUES: WHAT'S WRONG:
3357 latin1,utf-8 "latin1" will always be used
3358 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3359 file
3360 cp1250,latin1 "cp1250" will always be used
3361 If 'fileencodings' is empty, 'fileencoding' is not modified.
3362 See 'fileencoding' for the possible values.
3363 Setting this option does not have an effect until the next time a file
3364 is read.
3365
3366 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003367'fileformat' 'ff' string (MS-Windows default: "dos",
3368 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 This gives the <EOL> of the current buffer, which is used for
3371 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003372 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 unix <NL>
3374 mac <CR>
3375 When "dos" is used, CTRL-Z at the end of a file is ignored.
3376 See |file-formats| and |file-read|.
3377 For the character encoding of the file see 'fileencoding'.
3378 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003379 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 This option is set automatically when starting to edit a file and
3381 'fileformats' is not empty and 'binary' is off.
3382 When this option is set, after starting to edit a file, the 'modified'
3383 option is set, because the file would be different when written.
3384 This option can not be changed when 'modifiable' is off.
3385 For backwards compatibility: When this option is set to "dos",
3386 'textmode' is set, otherwise 'textmode' is reset.
3387
3388 *'fileformats'* *'ffs'*
3389'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003390 Vim+Vi MS-Windows: "dos,unix",
3391 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 Vi Cygwin: "unix,dos",
3393 Vi others: "")
3394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 This gives the end-of-line (<EOL>) formats that will be tried when
3396 starting to edit a new buffer and when reading a file into an existing
3397 buffer:
3398 - When empty, the format defined with 'fileformat' will be used
3399 always. It is not set automatically.
3400 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003401 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 'fileformats' name will be used when a file is read into an existing
3403 buffer, no matter what 'fileformat' for that buffer is set to.
3404 - When more than one name is present, separated by commas, automatic
3405 <EOL> detection will be done when reading a file. When starting to
3406 edit a file, a check is done for the <EOL>:
3407 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3408 'fileformat' is set to "dos".
3409 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003410 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003412 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3413 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003414 This means that "mac" is only chosen when:
3415 "unix" is not present or no <NL> is found in the file, and
3416 "dos" is not present or no <CR><NL> is found in the file.
3417 Except: if "unix" was chosen, but there is a <CR> before
3418 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003419 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 4. If 'fileformat' is still not set, the first name from
3421 'fileformats' is used.
3422 When reading a file into an existing buffer, the same is done, but
3423 this happens like 'fileformat' has been set appropriately for that
3424 file only, the option is not changed.
3425 When 'binary' is set, the value of 'fileformats' is not used.
3426
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003427 When Vim starts up with an empty buffer the first item is used. You
3428 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003429
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3431 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3432 done:
3433 - When 'fileformats' is empty, there is no automatic detection. Dos
3434 format will be used.
3435 - When 'fileformats' is set to one or more names, automatic detection
3436 is done. This is based on the first <NL> in the file: If there is a
3437 <CR> in front of it, Dos format is used, otherwise Unix format is
3438 used.
3439 Also see |file-formats|.
3440 For backwards compatibility: When this option is set to an empty
3441 string or one format (no comma is included), 'textauto' is reset,
3442 otherwise 'textauto' is set.
3443 NOTE: This option is set to the Vi default value when 'compatible' is
3444 set and to the Vim default value when 'compatible' is reset.
3445
Bram Moolenaarbf884932013-04-05 22:26:15 +02003446 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3447'fileignorecase' 'fic' boolean (default on for systems where case in file
3448 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003449 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003450 When set case is ignored when using file names and directories.
3451 See 'wildignorecase' for only ignoring case when doing completion.
3452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 *'filetype'* *'ft'*
3454'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003455 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 When this option is set, the FileType autocommand event is triggered.
3457 All autocommands that match with the value of this option will be
3458 executed. Thus the value of 'filetype' is used in place of the file
3459 name.
3460 Otherwise this option does not always reflect the current file type.
3461 This option is normally set when the file type is detected. To enable
3462 this use the ":filetype on" command. |:filetype|
3463 Setting this option to a different value is most useful in a modeline,
3464 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003465 Example, for in an IDL file:
3466 /* vim: set filetype=idl : */ ~
3467 |FileType| |filetypes|
3468 When a dot appears in the value then this separates two filetype
3469 names. Example:
3470 /* vim: set filetype=c.doxygen : */ ~
3471 This will use the "c" filetype first, then the "doxygen" filetype.
3472 This works both for filetype plugins and for syntax files. More than
3473 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 This option is not copied to another buffer, independent of the 's' or
3475 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003476 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477
3478 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003479'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003480 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003481 {not available when compiled without the |+folding|
3482 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003483 Characters to fill the statuslines, vertical separators and special
3484 lines in the window.
3485 It is a comma-separated list of items. Each item has a name, a colon
3486 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003488 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003489 stl ' ' statusline of the current window
3490 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003491 vert '|' vertical separators |:vsplit|
3492 fold '-' filling 'foldtext'
3493 foldopen '-' mark the beginning of a fold
3494 foldclose '+' show a closed fold
3495 foldsep '|' open fold middle character
3496 diff '-' deleted lines of the 'diff' option
3497 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003498 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003500 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501
3502 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003503 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3504<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003505 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3506 single-byte and multibyte characters are supported. But double-width
3507 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003508
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003510 item name highlight group ~
3511 stl StatusLine |hl-StatusLine|
3512 stlnc StatusLineNC |hl-StatusLineNC|
3513 vert VertSplit |hl-VertSplit|
3514 fold Folded |hl-Folded|
3515 diff DiffDelete |hl-DiffDelete|
3516 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003517 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003519 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3520'fixendofline' 'fixeol' boolean (default on)
3521 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003522 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003523 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003524 preserve the situation from the original file.
3525 When the 'binary' option is set the value of this option doesn't
3526 matter.
3527 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003528 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003529
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003531'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 {only available when compiled with the |+rightleft|
3534 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003535 This option was for using Farsi, which has been removed. See
3536 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
3538 *'foldclose'* *'fcl'*
3539'foldclose' 'fcl' string (default "")
3540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {not available when compiled without the |+folding|
3542 feature}
3543 When set to "all", a fold is closed when the cursor isn't in it and
3544 its level is higher than 'foldlevel'. Useful if you want folds to
3545 automatically close when moving out of them.
3546
3547 *'foldcolumn'* *'fdc'*
3548'foldcolumn' 'fdc' number (default 0)
3549 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 {not available when compiled without the |+folding|
3551 feature}
3552 When non-zero, a column with the specified width is shown at the side
3553 of the window which indicates open and closed folds. The maximum
3554 value is 12.
3555 See |folding|.
3556
3557 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3558'foldenable' 'fen' boolean (default on)
3559 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 {not available when compiled without the |+folding|
3561 feature}
3562 When off, all folds are open. This option can be used to quickly
3563 switch between showing all text unfolded and viewing the text with
3564 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 'foldenable' is off.
3567 This option is set by commands that create a new fold or close a fold.
3568 See |folding|.
3569
3570 *'foldexpr'* *'fde'*
3571'foldexpr' 'fde' string (default: "0")
3572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003574 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003576 for each line to obtain its fold level. The context is set to the
3577 script where 'foldexpr' was set, script-local items can be accessed.
3578 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003579
Bram Moolenaar30b65812012-07-12 22:01:11 +02003580 The expression will be evaluated in the |sandbox| if set from a
3581 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003582 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003583 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003584
3585 It is not allowed to change text or jump to another window while
3586 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587
3588 *'foldignore'* *'fdi'*
3589'foldignore' 'fdi' string (default: "#")
3590 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 {not available when compiled without the |+folding|
3592 feature}
3593 Used only when 'foldmethod' is "indent". Lines starting with
3594 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003595 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 The default "#" works well for C programs. See |fold-indent|.
3597
3598 *'foldlevel'* *'fdl'*
3599'foldlevel' 'fdl' number (default: 0)
3600 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 {not available when compiled without the |+folding|
3602 feature}
3603 Sets the fold level: Folds with a higher level will be closed.
3604 Setting this option to zero will close all folds. Higher numbers will
3605 close fewer folds.
3606 This option is set by commands like |zm|, |zM| and |zR|.
3607 See |fold-foldlevel|.
3608
3609 *'foldlevelstart'* *'fdls'*
3610'foldlevelstart' 'fdls' number (default: -1)
3611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {not available when compiled without the |+folding|
3613 feature}
3614 Sets 'foldlevel' when starting to edit another buffer in a window.
3615 Useful to always start editing with all folds closed (value zero),
3616 some folds closed (one) or no folds closed (99).
3617 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003618 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 ignores this option and closes all folds.
3620 It is also done before BufReadPre autocommands, to allow an autocmd to
3621 overrule the 'foldlevel' value for specific files.
3622 When the value is negative, it is not used.
3623
3624 *'foldmarker'* *'fmr'* *E536*
3625'foldmarker' 'fmr' string (default: "{{{,}}}")
3626 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 {not available when compiled without the |+folding|
3628 feature}
3629 The start and end marker used when 'foldmethod' is "marker". There
3630 must be one comma, which separates the start and end marker. The
3631 marker is a literal string (a regular expression would be too slow).
3632 See |fold-marker|.
3633
3634 *'foldmethod'* *'fdm'*
3635'foldmethod' 'fdm' string (default: "manual")
3636 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 {not available when compiled without the |+folding|
3638 feature}
3639 The kind of folding used for the current window. Possible values:
3640 |fold-manual| manual Folds are created manually.
3641 |fold-indent| indent Lines with equal indent form a fold.
3642 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3643 |fold-marker| marker Markers are used to specify folds.
3644 |fold-syntax| syntax Syntax highlighting items specify folds.
3645 |fold-diff| diff Fold text that is not changed.
3646
3647 *'foldminlines'* *'fml'*
3648'foldminlines' 'fml' number (default: 1)
3649 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 {not available when compiled without the |+folding|
3651 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003652 Sets the number of screen lines above which a fold can be displayed
3653 closed. Also for manually closed folds. With the default value of
3654 one a fold can only be closed if it takes up two or more screen lines.
3655 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003656 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 "zc" to close a fold, which is displayed open because it's smaller
3658 than 'foldminlines', a following "zc" may close a containing fold.
3659
3660 *'foldnestmax'* *'fdn'*
3661'foldnestmax' 'fdn' number (default: 20)
3662 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 {not available when compiled without the |+folding|
3664 feature}
3665 Sets the maximum nesting of folds for the "indent" and "syntax"
3666 methods. This avoids that too many folds will be created. Using more
3667 than 20 doesn't work, because the internal limit is 20.
3668
3669 *'foldopen'* *'fdo'*
3670'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3671 search,tag,undo")
3672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {not available when compiled without the |+folding|
3674 feature}
3675 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003676 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003678 NOTE: When the command is part of a mapping this option is not used.
3679 Add the |zv| command to the mapping to get the same effect.
3680 (rationale: the mapping may want to control opening folds itself)
3681
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 item commands ~
3683 all any
3684 block "(", "{", "[[", "[{", etc.
3685 hor horizontal movements: "l", "w", "fx", etc.
3686 insert any command in Insert mode
3687 jump far jumps: "G", "gg", etc.
3688 mark jumping to a mark: "'m", CTRL-O, etc.
3689 percent "%"
3690 quickfix ":cn", ":crew", ":make", etc.
3691 search search for a pattern: "/", "n", "*", "gd", etc.
3692 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003693 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 tag jumping to a tag: ":ta", CTRL-T, etc.
3695 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 When a movement command is used for an operator (e.g., "dl" or "y%")
3697 this option is not used. This means the operator will include the
3698 whole closed fold.
3699 Note that vertical movements are not here, because it would make it
3700 very difficult to move onto a closed fold.
3701 In insert mode the folds containing the cursor will always be open
3702 when text is inserted.
3703 To close folds you can re-apply 'foldlevel' with the |zx| command or
3704 set the 'foldclose' option to "all".
3705
3706 *'foldtext'* *'fdt'*
3707'foldtext' 'fdt' string (default: "foldtext()")
3708 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 {not available when compiled without the |+folding|
3710 feature}
3711 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003712 fold. The context is set to the script where 'foldexpr' was set,
3713 script-local items can be accessed. See |fold-foldtext| for the
3714 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715
Bram Moolenaar30b65812012-07-12 22:01:11 +02003716 The expression will be evaluated in the |sandbox| if set from a
3717 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003718 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003719
3720 It is not allowed to change text or jump to another window while
3721 evaluating 'foldtext' |textlock|.
3722
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003723 *'formatexpr'* *'fex'*
3724'formatexpr' 'fex' string (default "")
3725 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003726 {not available when compiled without the |+eval|
3727 feature}
3728 Expression which is evaluated to format a range of lines for the |gq|
3729 operator or automatic formatting (see 'formatoptions'). When this
3730 option is empty 'formatprg' is used.
3731
3732 The |v:lnum| variable holds the first line to be formatted.
3733 The |v:count| variable holds the number of lines to be formatted.
3734 The |v:char| variable holds the character that is going to be
3735 inserted if the expression is being evaluated due to
3736 automatic formatting. This can be empty. Don't insert
3737 it yet!
3738
3739 Example: >
3740 :set formatexpr=mylang#Format()
3741< This will invoke the mylang#Format() function in the
3742 autoload/mylang.vim file in 'runtimepath'. |autoload|
3743
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003744 The advantage of using a function call without arguments is that it is
3745 faster, see |expr-option-function|.
3746
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003747 The expression is also evaluated when 'textwidth' is set and adding
3748 text beyond that limit. This happens under the same conditions as
3749 when internal formatting is used. Make sure the cursor is kept in the
3750 same spot relative to the text then! The |mode()| function will
3751 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003752
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003753 When the expression evaluates to non-zero Vim will fall back to using
3754 the internal format mechanism.
3755
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003756 If the expression starts with s: or |<SID>|, then it is replaced with
3757 the script ID (|local-function|). Example: >
3758 set formatexpr=s:MyFormatExpr()
3759 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003760< Otherwise, the expression is evaluated in the context of the script
3761 where the option was set, thus script-local items are available.
3762
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003763 The expression will be evaluated in the |sandbox| when set from a
3764 modeline, see |sandbox-option|. That stops the option from working,
3765 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003766 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003767 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003768
Bram Moolenaar86b68352004-12-27 21:59:20 +00003769 *'formatlistpat'* *'flp'*
3770'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3771 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003772 A pattern that is used to recognize a list header. This is used for
3773 the "n" flag in 'formatoptions'.
3774 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003775 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003776 while still checking more characters. There must be a character
3777 following the pattern, when it matches the whole line it is handled
3778 like there is no match.
3779 The default recognizes a number, followed by an optional punctuation
3780 character and white space.
3781
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003782 *'formatoptions'* *'fo'*
3783'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3784 local to buffer
3785 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003786 formatting is to be done.
3787 See |fo-table| for possible values and |gq| for how to format text.
3788 When the 'paste' option is on, no formatting is done (like
3789 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003790 To avoid problems with flags that are added in the future, use the
3791 "+=" and "-=" feature of ":set" |add-option-flags|.
3792 NOTE: This option is set to the Vi default value when 'compatible' is
3793 set and to the Vim default value when 'compatible' is reset.
3794
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 *'formatprg'* *'fp'*
3796'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003797 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003799 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003801 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003802 If the 'formatexpr' option is not empty it will be used instead.
3803 Otherwise, if 'formatprg' option is an empty string, the internal
3804 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003805 Environment variables are expanded |:set_env|. See |option-backslash|
3806 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003807 This option cannot be set from a |modeline| or in the |sandbox|, for
3808 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809
Bram Moolenaard94464e2015-11-02 15:28:18 +01003810 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003811'fsync' 'fs' boolean (default on)
3812 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003813 When on, the library function fsync() will be called after writing a
3814 file. This will flush a file to disk, ensuring that it is safely
3815 written even on filesystems which do metadata-only journaling. This
3816 will force the harddrive to spin up on Linux systems running in laptop
3817 mode, so it may be undesirable in some situations. Be warned that
3818 turning this off increases the chances of data loss after a crash. On
3819 systems without an fsync() implementation, this variable is always
3820 off.
3821 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003822 'fsync' also applies to |writefile()| (unless a flag is used to
3823 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003824 This option cannot be set from a |modeline| or in the |sandbox|, for
3825 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003826
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3828'gdefault' 'gd' boolean (default off)
3829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 When on, the ":substitute" flag 'g' is default on. This means that
3831 all matches in a line are substituted instead of one. When a 'g' flag
3832 is given to a ":substitute" command, this will toggle the substitution
3833 of all or one match. See |complex-change|.
3834
3835 command 'gdefault' on 'gdefault' off ~
3836 :s/// subst. all subst. one
3837 :s///g subst. one subst. all
3838 :s///gg subst. all subst. one
3839
3840 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003841 Setting this option may break plugins that rely on the default
3842 behavior of the 'g' flag. This will also make the 'g' flag have the
3843 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003844 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845
3846 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003847'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 Format to recognize for the ":grep" command output.
3850 This is a scanf-like string that uses the same format as the
3851 'errorformat' option: see |errorformat|.
3852
3853 *'grepprg'* *'gp'*
3854'grepprg' 'gp' string (default "grep -n ",
3855 Unix: "grep -n $* /dev/null",
3856 Win32: "findstr /n" or "grep -n",
3857 VMS: "SEARCH/NUMBERS ")
3858 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003859 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 and '#' characters, which are expanded like when used in a command-
3861 line. The placeholder "$*" is allowed to specify where the arguments
3862 will be included. Environment variables are expanded |:set_env|. See
3863 |option-backslash| about including spaces and backslashes.
3864 When your "grep" accepts the "-H" argument, use this to make ":grep"
3865 also work well with a single file: >
3866 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003867< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003868 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3869 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003870 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 apply equally to 'grepprg'.
3872 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3873 otherwise it's "grep -n".
3874 This option cannot be set from a |modeline| or in the |sandbox|, for
3875 security reasons.
3876
3877 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3878'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3879 ve:ver35-Cursor,
3880 o:hor50-Cursor,
3881 i-ci:ver25-Cursor/lCursor,
3882 r-cr:hor20-Cursor/lCursor,
3883 sm:block-Cursor
3884 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003885 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 "n-v-c:block,o:hor50,i-ci:hor15,
3887 r-cr:hor30,sm:block")
3888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003890 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003892 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003893 height of the cursor can be changed. This can be done by specifying a
3894 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003895 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3896 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003898 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 mode-list and an argument-list:
3900 mode-list:argument-list,mode-list:argument-list,..
3901 The mode-list is a dash separated list of these modes:
3902 n Normal mode
3903 v Visual mode
3904 ve Visual mode with 'selection' "exclusive" (same as 'v',
3905 if not specified)
3906 o Operator-pending mode
3907 i Insert mode
3908 r Replace mode
3909 c Command-line Normal (append) mode
3910 ci Command-line Insert mode
3911 cr Command-line Replace mode
3912 sm showmatch in Insert mode
3913 a all modes
3914 The argument-list is a dash separated list of these arguments:
3915 hor{N} horizontal bar, {N} percent of the character height
3916 ver{N} vertical bar, {N} percent of the character width
3917 block block cursor, fills the whole character
3918 [only one of the above three should be present]
3919 blinkwait{N} *cursor-blinking*
3920 blinkon{N}
3921 blinkoff{N}
3922 blink times for cursor: blinkwait is the delay before
3923 the cursor starts blinking, blinkon is the time that
3924 the cursor is shown and blinkoff is the time that the
3925 cursor is not shown. The times are in msec. When one
3926 of the numbers is zero, there is no blinking. The
3927 default is: "blinkwait700-blinkon400-blinkoff250".
3928 These numbers are used for a missing entry. This
3929 means that blinking is enabled by default. To switch
3930 blinking off you can use "blinkon0". The cursor only
3931 blinks when Vim is waiting for input, not while
3932 executing a command.
3933 To make the cursor blink in an xterm, see
3934 |xterm-blink|.
3935 {group-name}
3936 a highlight group name, that sets the color and font
3937 for the cursor
3938 {group-name}/{group-name}
3939 Two highlight group names, the first is used when
3940 no language mappings are used, the other when they
3941 are. |language-mapping|
3942
3943 Examples of parts:
3944 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3945 block cursor with colors from the "nCursor"
3946 highlight group
3947 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3948 In Insert and Command-line Insert mode, use a
3949 30% vertical bar cursor with colors from the
3950 "iCursor" highlight group. Blink a bit
3951 faster.
3952
3953 The 'a' mode is different. It will set the given argument-list for
3954 all modes. It does not reset anything to defaults. This can be used
3955 to do a common setting for all modes. For example, to switch off
3956 blinking: "a:blinkon0"
3957
3958 Examples of cursor highlighting: >
3959 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3960 :highlight Cursor gui=NONE guifg=bg guibg=fg
3961<
3962 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003963 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964'guifont' 'gfn' string (default "")
3965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 {only available when compiled with GUI enabled}
3967 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003968 In its simplest form the value is just one font name.
3969 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970
3971 *'guifontset'* *'gfs'*
3972 *E250* *E252* *E234* *E597* *E598*
3973'guifontset' 'gfs' string (default "")
3974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 {only available when compiled with GUI enabled and
3976 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003977 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 When not empty, specifies two (or more) fonts to be used. The first
3979 one for normal English, the second one for your special language. See
3980 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003981
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3983'guifontwide' 'gfw' string (default "")
3984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 {only available when compiled with GUI enabled}
3986 When not empty, specifies a comma-separated list of fonts to be used
3987 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003988 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003989
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 *'guiheadroom'* *'ghr'*
3991'guiheadroom' 'ghr' number (default 50)
3992 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003993 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 The number of pixels subtracted from the screen height when fitting
3995 the GUI window on the screen. Set this before the GUI is started,
3996 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003997 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 lines will be left for window decorations and other items on the
3999 screen. Set it to a negative value to allow windows taller than the
4000 screen.
4001
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004002 *'guiligatures'* *'gli'* *E1243*
4003'guiligatures' 'gli' string (default "")
4004 global
4005 {only for GTK GUI}
4006 List of ASCII characters that, when combined together, can create more
4007 complex shapes. Each character must be a printable ASCII character
4008 with a value in the 32-127 range.
4009 Example: >
4010 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4011< Changing this option updates screen output immediately. Set it to an
4012 empty string to disable ligatures.
4013
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004015'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4016 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004017 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004018 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004021 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 sequence of letters which describes what components and options of the
4023 GUI should be used.
4024 To avoid problems with flags that are added in the future, use the
4025 "+=" and "-=" feature of ":set" |add-option-flags|.
4026
Bram Moolenaar13568252018-03-16 20:46:58 +01004027 Valid characters are as follows:
4028 *'go-!'*
4029 '!' External commands are executed in a terminal window. Without
4030 this flag the MS-Windows GUI will open a console window to
4031 execute the command. The Unix GUI will simulate a dumb
4032 terminal to list the command output.
4033 The terminal window will be positioned at the bottom, and grow
4034 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004035 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 'a' Autoselect: If present, then whenever VISUAL mode is started,
4037 or the Visual area extended, Vim tries to become the owner of
4038 the windowing system's global selection. This means that the
4039 Visually highlighted text is available for pasting into other
4040 applications as well as into Vim itself. When the Visual mode
4041 ends, possibly due to an operation on the text, or when an
4042 application wants to paste the selection, the highlighted text
4043 is automatically yanked into the "* selection register.
4044 Thus the selection is still available for pasting into other
4045 applications after the VISUAL mode has ended.
4046 If not present, then Vim won't become the owner of the
4047 windowing system's global selection unless explicitly told to
4048 by a yank or delete operation for the "* register.
4049 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004050 *'go-P'*
4051 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004052 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004053 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 applies to the modeless selection.
4056
4057 'guioptions' autoselect Visual autoselect modeless ~
4058 "" - -
4059 "a" yes yes
4060 "A" - yes
4061 "aA" yes yes
4062
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004063 When using a terminal see the 'clipboard' option.
4064
Bram Moolenaar02467872007-05-06 13:22:01 +00004065 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 'c' Use console dialogs instead of popup dialogs for simple
4067 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004068 *'go-d'*
4069 'd' Use dark theme variant if available. Currently only works for
4070 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004071 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004072 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004073 'guitablabel' can be used to change the text in the labels.
4074 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004075 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004076 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004077 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 'f' Foreground: Don't use fork() to detach the GUI from the shell
4079 where it was started. Use this for programs that wait for the
4080 editor to finish (e.g., an e-mail program). Alternatively you
4081 can use "gvim -f" or ":gui -f" to start the GUI in the
4082 foreground. |gui-fork|
4083 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004084 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004085 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4087 corner of the window. It's black&white on non-GTK, because of
4088 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004089 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004091 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004092 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004094 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004096 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004097 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 'g' Grey menu items: Make menu items that are not active grey. If
4099 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004100 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 't' Include tearoff menu items. Currently only works for Win32,
4102 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004103 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004104 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4105 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004106 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004108 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 'R' Right-hand scrollbar is present when there is a vertically
4110 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004111 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004113 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 'L' Left-hand scrollbar is present when there is a vertically
4115 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004116 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4118 the longest visible line, or on the cursor line if the 'h'
4119 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004120 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 'h' Limit horizontal scrollbar size to the length of the cursor
4122 line. Reduces computations. |gui-horiz-scroll|
4123
4124 And yes, you may even have scrollbars on the left AND the right if
4125 you really want to :-). See |gui-scrollbars| for more information.
4126
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004127 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 'v' Use a vertical button layout for dialogs. When not included,
4129 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004130 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004131 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 'p' Use Pointer callbacks for X11 GUI. This is required for some
4133 window managers. If the cursor is not blinking or hollow at
4134 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004135 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004137 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004138 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004139 *'go-k'*
4140 'k' Keep the GUI window size when adding/removing a scrollbar, or
4141 toolbar, tabline, etc. Instead, the behavior is similar to
4142 when the window is maximized and will adjust 'lines' and
4143 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004144 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004145 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004146
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 *'guipty'* *'noguipty'*
4148'guipty' boolean (default on)
4149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 {only available when compiled with GUI enabled}
4151 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4152 I/O to/from shell commands. See |gui-pty|.
4153
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004154 *'guitablabel'* *'gtl'*
4155'guitablabel' 'gtl' string (default empty)
4156 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004157 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004158 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004159 pages line. When empty and when the result is empty Vim will use a
4160 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004161
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004162 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004163 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004164 The expression will be evaluated in the |sandbox| when set from a
4165 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004166 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004167
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004168 Only used when the GUI tab pages line is displayed. 'e' must be
4169 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4170 used.
4171
Bram Moolenaar57657d82006-04-21 22:12:41 +00004172 *'guitabtooltip'* *'gtt'*
4173'guitabtooltip' 'gtt' string (default empty)
4174 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004175 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004176 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004177 pages line. When empty Vim will use a default tooltip.
4178 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004179 You can include a line break. Simplest method is to use |:let|: >
4180 :let &guitabtooltip = "line one\nline two"
4181<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004182
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004184'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 (others) "$VIMRUNTIME/doc/help.txt")
4186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 Name of the main help file. All distributed help files should be
4188 placed together in one directory. Additionally, all "doc" directories
4189 in 'runtimepath' will be used.
4190 Environment variables are expanded |:set_env|. For example:
4191 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004192 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 spaces and backslashes.
4194 This option cannot be set from a |modeline| or in the |sandbox|, for
4195 security reasons.
4196
4197 *'helpheight'* *'hh'*
4198'helpheight' 'hh' number (default 20)
4199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 Minimal initial height of the help window when it is opened with the
4201 ":help" command. The initial height of the help window is half of the
4202 current window, or (when the 'ea' option is on) the same as other
4203 windows. When the height is less than 'helpheight', the height is
4204 set to 'helpheight'. Set to zero to disable.
4205
4206 *'helplang'* *'hlg'*
4207'helplang' 'hlg' string (default: messages language or empty)
4208 global
4209 {only available when compiled with the |+multi_lang|
4210 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004211 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 for which the desired help can be found. The English help will always
4213 be used as a last resort. You can add "en" to prefer English over
4214 another language, but that will only find tags that exist in that
4215 language and not in the English help.
4216 Example: >
4217 :set helplang=de,it
4218< This will first search German, then Italian and finally English help
4219 files.
4220 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4221 try to find the tag in the current language before using this option.
4222 See |help-translated|.
4223
4224 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4225'hidden' 'hid' boolean (default off)
4226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 When off a buffer is unloaded when it is |abandon|ed. When on a
4228 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4229 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004230
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004232 hidden even if the 'hidden' option is off when these three are true:
4233 - the buffer is modified
4234 - 'autowrite' is off or writing is not possible
4235 - the '!' flag was used
4236 Also see |windows.txt|.
4237
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004238 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 This option is set for one command with ":hide {command}" |:hide|.
4240 WARNING: It's easy to forget that you have changes in hidden buffers.
4241 Think twice when using ":q!" or ":qa!".
4242
4243 *'highlight'* *'hl'*
4244'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004245 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4246 d:Directory,e:ErrorMsg,i:IncSearch,
4247 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004248 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004249 N:CursorLineNr,r:Question,s:StatusLine,
4250 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004251 v:Visual,V:VisualNOS,w:WarningMsg,
4252 W:WildMenu,f:Folded,F:FoldColumn,
4253 A:DiffAdd,C:DiffChange,D:DiffDelete,
4254 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004255 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004256 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004257 [:PmenuKind,]:PmenuKindSel,
4258 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004259 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4260 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004261 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004262 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004265 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004267 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004269 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4270 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 characters from 'showbreak'
4272 |hl-Directory| d directories in CTRL-D listing and other special
4273 things in listings
4274 |hl-ErrorMsg| e error messages
4275 h (obsolete, ignored)
4276 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004277 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4279 |hl-MoreMsg| m |more-prompt|
4280 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004281 |hl-LineNr| n line number for ":number" and ":#" commands, and
4282 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004283 |hl-LineNrAbove| a line number above the cursor for when the
4284 'relativenumber' option is set.
4285 |hl-LineNrBelow| b line number below the cursor for when the
4286 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004287 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4288 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 |hl-Question| r |hit-enter| prompt and yes/no questions
4290 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004291 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4293 |hl-VertSplit| c column used to separate vertically split windows
4294 |hl-Visual| v Visual mode
4295 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4296 Selection" Only X11 Gui's |gui-x11| and
4297 |xterm-clipboard|.
4298 |hl-WarningMsg| w warning messages
4299 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4300 |hl-Folded| f line used for closed folds
4301 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004302 |hl-DiffAdd| A added line in diff mode
4303 |hl-DiffChange| C changed line in diff mode
4304 |hl-DiffDelete| D deleted line in diff mode
4305 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004307 |hl-Conceal| - the placeholders used for concealed characters
4308 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004309 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004310 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004311 |hl-SpellRare| R rare word |spell|
4312 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004313 |hl-Pmenu| + popup menu normal line
4314 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004315 |hl-PmenuKind| [ popup menu "kind" normal line
4316 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004317 |hl-PmenuExtra| { popup menu "extra" normal line
4318 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004319 |hl-PmenuSbar| x popup menu scrollbar
4320 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321
4322 The display modes are:
4323 r reverse (termcap entry "mr" and "me")
4324 i italic (termcap entry "ZH" and "ZR")
4325 b bold (termcap entry "md" and "me")
4326 s standout (termcap entry "so" and "se")
4327 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004328 c undercurl (termcap entry "Us" and "Ce")
4329 2 double underline (termcap entry "Ds" and "Ce")
4330 d dotted underline (termcap entry "ds" and "Ce")
4331 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004332 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 n no highlighting
4334 - no highlighting
4335 : use a highlight group
4336 The default is used for occasions that are not included.
4337 If you want to change what the display modes do, see |dos-colors|
4338 for an example.
4339 When using the ':' display mode, this must be followed by the name of
4340 a highlight group. A highlight group can be used to define any type
4341 of highlighting, including using color. See |:highlight| on how to
4342 define one. The default uses a different group for each occasion.
4343 See |highlight-default| for the default highlight groups.
4344
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004346'history' 'hi' number (Vim default: 50, Vi default: 0,
4347 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004350 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004352 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 NOTE: This option is set to the Vi default value when 'compatible' is
4354 set and to the Vim default value when 'compatible' is reset.
4355
4356 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4357'hkmap' 'hk' 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, the keyboard is mapped for the Hebrew character set.
4362 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4363 toggle this option. See |rileft.txt|.
4364 NOTE: This option is reset when 'compatible' is set.
4365
4366 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4367'hkmapp' 'hkp' boolean (default off)
4368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 {only available when compiled with the |+rightleft|
4370 feature}
4371 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4372 This is useful if you have a non-Hebrew keyboard.
4373 See |rileft.txt|.
4374 NOTE: This option is reset when 'compatible' is set.
4375
Bram Moolenaar036986f2017-03-16 17:41:02 +01004376 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4377'hlsearch' 'hls' boolean (default off)
4378 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004379 {not available when compiled without the
4380 |+extra_search| feature}
4381 When there is a previous search pattern, highlight all its matches.
4382 The type of highlighting used can be set with the 'l' occasion in the
4383 'highlight' option. This uses the "Search" highlight group by
4384 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004385 are not applied. If the "CurSearch" highlight group is set then the
4386 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004387 See also: 'incsearch' and |:match|.
4388 When you get bored looking at the highlighted matches, you can turn it
4389 off with |:nohlsearch|. This does not change the option value, as
4390 soon as you use a search command, the highlighting comes back.
4391 'redrawtime' specifies the maximum time spent on finding matches.
4392 When the search pattern can match an end-of-line, Vim will try to
4393 highlight all of the matched text. However, this depends on where the
4394 search starts. This will be the first line in the window or the first
4395 line below a closed fold. A match in a previous line which is not
4396 drawn may not continue in a newly drawn line.
4397 You can specify whether the highlight status is restored on startup
4398 with the 'h' flag in 'viminfo' |viminfo-h|.
4399 NOTE: This option is reset when 'compatible' is set.
4400
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 *'icon'* *'noicon'*
4402'icon' boolean (default off, on when title can be restored)
4403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 When on, the icon text of the window will be set to the value of
4405 'iconstring' (if it is not empty), or to the name of the file
4406 currently being edited. Only the last part of the name is used.
4407 Overridden by the 'iconstring' option.
4408 Only works if the terminal supports setting window icons (currently
4409 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4410 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4411 builtin termcap).
4412 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004413 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004415 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416
4417 *'iconstring'*
4418'iconstring' string (default "")
4419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 When this option is not empty, it will be used for the icon text of
4421 the window. This happens only when the 'icon' option is on.
4422 Only works if the terminal supports setting window icon text
4423 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004424 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 When Vim was compiled with HAVE_X11 defined, the original icon will be
4426 restored if possible |X11|.
4427 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004428 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004430 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 {not available when compiled without the |+statusline| feature}
4432
4433 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4434'ignorecase' 'ic' boolean (default off)
4435 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004436 Ignore case in search patterns, |cmdline-completion|, when
4437 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004438 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 Can be overruled by using "\c" or "\C" in the pattern, see
4440 |/ignorecase|.
4441
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004442 *'imactivatefunc'* *'imaf'*
4443'imactivatefunc' 'imaf' string (default "")
4444 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004445 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004446 activate or deactivate the Input Method. The value can be the name of
4447 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4448 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004449 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004450 The expression will be evaluated in the |sandbox| when set from a
4451 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004452
4453 Example: >
4454 function ImActivateFunc(active)
4455 if a:active
4456 ... do something
4457 else
4458 ... do something
4459 endif
4460 " return value is not used
4461 endfunction
4462 set imactivatefunc=ImActivateFunc
4463<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 *'imactivatekey'* *'imak'*
4465'imactivatekey' 'imak' string (default "")
4466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004468 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 Specifies the key that your Input Method in X-Windows uses for
4470 activation. When this is specified correctly, vim can fully control
4471 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4472 You can't use this option to change the activation key, the option
4473 tells Vim what the key is.
4474 Format:
4475 [MODIFIER_FLAG-]KEY_STRING
4476
4477 These characters can be used for MODIFIER_FLAG (case is ignored):
4478 S Shift key
4479 L Lock key
4480 C Control key
4481 1 Mod1 key
4482 2 Mod2 key
4483 3 Mod3 key
4484 4 Mod4 key
4485 5 Mod5 key
4486 Combinations are allowed, for example "S-C-space" or "SC-space" are
4487 both shift+ctrl+space.
4488 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4489
4490 Example: >
4491 :set imactivatekey=S-space
4492< "S-space" means shift+space. This is the activation key for kinput2 +
4493 canna (Japanese), and ami (Korean).
4494
4495 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4496'imcmdline' 'imc' boolean (default off)
4497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 When set the Input Method is always on when starting to edit a command
4499 line, unless entering a search pattern (see 'imsearch' for that).
4500 Setting this option is useful when your input method allows entering
4501 English characters directly, e.g., when it's used to type accented
4502 characters with dead keys.
4503
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004504 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 When set the Input Method is never used. This is useful to disable
4508 the IM when it doesn't work properly.
4509 Currently this option is on by default for SGI/IRIX machines. This
4510 may change in later releases.
4511
4512 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004513'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 Specifies whether :lmap or an Input Method (IM) is to be used in
4516 Insert mode. Valid values:
4517 0 :lmap is off and IM is off
4518 1 :lmap is ON and IM is off
4519 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 To always reset the option to zero when leaving Insert mode with <Esc>
4521 this can be used: >
4522 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4523< This makes :lmap and IM turn off automatically when leaving Insert
4524 mode.
4525 Note that this option changes when using CTRL-^ in Insert mode
4526 |i_CTRL-^|.
4527 The value is set to 1 when setting 'keymap' to a valid keymap name.
4528 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004529 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 methods. Use 'imdisable' to disable XIM then.
4531
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004532 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004533 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004534 |+multi_byte_ime| or |global-ime|.
4535
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004537'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 Specifies whether :lmap or an Input Method (IM) is to be used when
4540 entering a search pattern. Valid values:
4541 -1 the value of 'iminsert' is used, makes it look like
4542 'iminsert' is also used when typing a search pattern
4543 0 :lmap is off and IM is off
4544 1 :lmap is ON and IM is off
4545 2 :lmap is off and IM is ON
4546 Note that this option changes when using CTRL-^ in Command-line mode
4547 |c_CTRL-^|.
4548 The value is set to 1 when it is not -1 and setting the 'keymap'
4549 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004550 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 methods. Use 'imdisable' to disable XIM then.
4552
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004553 *'imstatusfunc'* *'imsf'*
4554'imstatusfunc' 'imsf' string (default "")
4555 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004556 This option specifies a function that is called to obtain the status
4557 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004558 The value can be the name of a function, a |lambda| or a |Funcref|.
4559 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004560 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004561
4562 Example: >
4563 function ImStatusFunc()
4564 let is_active = ...do something
4565 return is_active ? 1 : 0
4566 endfunction
4567 set imstatusfunc=ImStatusFunc
4568<
4569 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004570 The expression will be evaluated in the |sandbox| when set from a
4571 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004572
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004573 *'imstyle'* *'imst'*
4574'imstyle' 'imst' number (default 1)
4575 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004576 {only available when compiled with |+xim| and
4577 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004578 This option specifies the input style of Input Method:
4579 0 use on-the-spot style
4580 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004581 See: |xim-input-style|
4582
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004583 For a long time on-the-spot style had been used in the GTK version of
4584 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004585 |single-repeat|, etc. Therefore over-the-spot style becomes the
4586 default now. This should work fine for most people, however if you
4587 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004588 The expression will be evaluated in the |sandbox| when set from a
4589 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004590
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 *'include'* *'inc'*
4592'include' 'inc' string (default "^\s*#\s*include")
4593 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 {not available when compiled without the
4595 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004596 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 pattern, just like for the "/" command (See |pattern|). The default
4598 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004599 "]I", "[d", etc.
4600 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004601 comes after the matched pattern. But if "\zs" appears in the pattern
4602 then the text matched from "\zs" to the end, or until "\ze" if it
4603 appears, is used as the file name. Use this to include characters
4604 that are not in 'isfname', such as a space. You can then use
4605 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004606 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607
4608 *'includeexpr'* *'inex'*
4609'includeexpr' 'inex' string (default "")
4610 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004612 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004614 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004615 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004617 Note the double backslash: the `:set` command first halves them, then
4618 one remains it the value, where "\." matches a dot literally. For
4619 simple character replacements `tr()` avoids the need for escaping: >
4620 :setlocal includeexpr=tr(v:fname,'.','/')
4621<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004623 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 Also used for |<cfile>|.
4625
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004626 If the expression starts with s: or |<SID>|, then it is replaced with
4627 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004628 setlocal includeexpr=s:MyIncludeExpr()
4629 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004630< Otherwise, the expression is evaluated in the context of the script
4631 where the option was set, thus script-local items are available.
4632
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004633 It is more efficient if the value is just a function call without
4634 arguments, see |expr-option-function|.
4635
Bram Moolenaar30b65812012-07-12 22:01:11 +02004636 The expression will be evaluated in the |sandbox| when set from a
4637 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004638 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004639
4640 It is not allowed to change text or jump to another window while
4641 evaluating 'includeexpr' |textlock|.
4642
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004644'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004645 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004648 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004649 While typing a search command, show where the pattern, as it was typed
4650 so far, matches. The matched string is highlighted. If the pattern
4651 is invalid or not found, nothing is shown. The screen will be updated
4652 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004653 Also applies to the pattern in commands: >
4654 :global
4655 :lvimgrep
4656 :lvimgrepadd
4657 :smagic
4658 :snomagic
4659 :sort
4660 :substitute
4661 :vglobal
4662 :vimgrep
4663 :vimgrepadd
4664< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004665 original position when no match is found and when pressing <Esc>. You
4666 still need to finish the search command with <Enter> to move the
4667 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004668 You can use the CTRL-G and CTRL-T keys to move to the next and
4669 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004670 When compiled with the |+reltime| feature Vim only searches for about
4671 half a second. With a complicated pattern and/or a lot of text the
4672 match may not be found. This is to avoid that Vim hangs while you
4673 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004674 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004675 When 'hlsearch' is on, all matched strings are highlighted too while
4676 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004677 If you don't want to turn 'hlsearch' on, but want to highlight all
4678 matches while searching, you can turn on and off 'hlsearch' with
4679 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004680 augroup vimrc-incsearch-highlight
4681 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004682 autocmd CmdlineEnter /,\? :set hlsearch
4683 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004684 augroup END
4685<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004686 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004687 to the command line. If 'ignorecase' and 'smartcase' are set and the
4688 command line has no uppercase characters, the added character is
4689 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004690 CTRL-R CTRL-W can be used to add the word at the end of the current
4691 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 NOTE: This option is reset when 'compatible' is set.
4693
4694 *'indentexpr'* *'inde'*
4695'indentexpr' 'inde' string (default "")
4696 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004697 {not available when compiled without the |+eval|
4698 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 Expression which is evaluated to obtain the proper indent for a line.
4700 It is used when a new line is created, for the |=| operator and
4701 in Insert mode as specified with the 'indentkeys' option.
4702 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004703 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004704 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 When 'paste' is set this option is not used for indenting.
4706 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004707 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004709
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004710 If the expression starts with s: or |<SID>|, then it is replaced with
4711 the script ID (|local-function|). Example: >
4712 set indentexpr=s:MyIndentExpr()
4713 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004714< Otherwise, the expression is evaluated in the context of the script
4715 where the option was set, thus script-local items are available.
4716
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004717 The advantage of using a function call without arguments is that it is
4718 faster, see |expr-option-function|.
4719
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 The expression must return the number of spaces worth of indent. It
4721 can return "-1" to keep the current indent (this means 'autoindent' is
4722 used for the indent).
4723 Functions useful for computing the indent are |indent()|, |cindent()|
4724 and |lispindent()|.
4725 The evaluation of the expression must not have side effects! It must
4726 not change the text, jump to another window, etc. Afterwards the
4727 cursor position is always restored, thus the cursor may be moved.
4728 Normally this option would be set to call a function: >
4729 :set indentexpr=GetMyIndent()
4730< Error messages will be suppressed, unless the 'debug' option contains
4731 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004732 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004733 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
Bram Moolenaar30b65812012-07-12 22:01:11 +02004735 The expression will be evaluated in the |sandbox| when set from a
4736 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004737 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004738
4739 It is not allowed to change text or jump to another window while
4740 evaluating 'indentexpr' |textlock|.
4741
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004743'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 A list of keys that, when typed in Insert mode, cause reindenting of
4746 the current line. Only happens if 'indentexpr' isn't empty.
4747 The format is identical to 'cinkeys', see |indentkeys-format|.
4748 See |C-indenting| and |indent-expression|.
4749
4750 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4751'infercase' 'inf' boolean (default off)
4752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004754 'ignorecase' is also on, the case of the match is adjusted depending
4755 on the typed text. If the typed text contains a lowercase letter
4756 where the match has an upper case letter, the completed part is made
4757 lowercase. If the typed text has no lowercase letters and the match
4758 has a lowercase letter where the typed text has an uppercase letter,
4759 and there is a letter before it, the completed part is made uppercase.
4760 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761
4762 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4763'insertmode' 'im' boolean (default off)
4764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 Makes Vim work in a way that Insert mode is the default mode. Useful
4766 if you want to use Vim as a modeless editor. Used for |evim|.
4767 These Insert mode commands will be useful:
4768 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004769 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 this is a mapping, it is executed as if 'insertmode' was off.
4771 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004773 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4774 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775
4776 These items change when 'insertmode' is set:
4777 - when starting to edit of a file, Vim goes to Insert mode.
4778 - <Esc> in Insert mode is a no-op and beeps.
4779 - <Esc> in Normal mode makes Vim go to Insert mode.
4780 - CTRL-L in Insert mode is a command, it is not inserted.
4781 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4782 However, when <Esc> is used inside a mapping, it behaves like
4783 'insertmode' was not set. This was done to be able to use the same
4784 mappings with 'insertmode' set or not set.
4785 When executing commands with |:normal| 'insertmode' is not used.
4786
4787 NOTE: This option is reset when 'compatible' is set.
4788
4789 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004790'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4792 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4793 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4794 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4795 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 The characters specified by this option are included in file names and
4798 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004799 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 Multi-byte characters 256 and above are always included, only the
4801 characters up to 255 are specified with this option.
4802 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004803 Think twice before adding white space to this option. Although a
4804 space may appear inside a file name, the effect will be that Vim
4805 doesn't know where a file name starts or ends when doing completion.
4806 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 Note that on systems using a backslash as path separator, Vim tries to
4809 do its best to make it work as you would expect. That is a bit
4810 tricky, since Vi originally used the backslash to escape special
4811 characters. Vim will not remove a backslash in front of a normal file
4812 name character on these systems, but it will on Unix and alikes. The
4813 '&' and '^' are not included by default, because these are special for
4814 cmd.exe.
4815
4816 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004817 Each part can be a single character number or a range. A range is two
4818 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 decimal number between 0 and 255 or the ASCII character itself (does
4820 not work for digits). Example:
4821 "_,-,128-140,#-43" (include '_' and '-' and the range
4822 128 to 140 and '#' to 43)
4823 If a part starts with '^', the following character number or range
4824 will be excluded from the option. The option is interpreted from left
4825 to right. Put the excluded character after the range where it is
4826 included. To include '^' itself use it as the last character of the
4827 option or the end of a range. Example:
4828 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4829 If the character is '@', all characters where isalpha() returns TRUE
4830 are included. Normally these are the characters a to z and A to Z,
4831 plus accented characters. To include '@' itself use "@-@". Examples:
4832 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004833 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 "a-z,A-Z,@-@" All letters plus the '@' character.
4835 A comma can be included by using it where a character number is
4836 expected. Example:
4837 "48-57,,,_" Digits, comma and underscore.
4838 A comma can be excluded by prepending a '^'. Example:
4839 " -~,^,,9" All characters from space to '~', excluding
4840 comma, plus <Tab>.
4841 See |option-backslash| about including spaces and backslashes.
4842
4843 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004844'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 "@,48-57,_,128-167,224-235"
4846 otherwise: "@,48-57,_,192-255")
4847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 The characters given by this option are included in identifiers.
4849 Identifiers are used in recognizing environment variables and after a
4850 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004851 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004852 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004854 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4856
4857 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004858'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 "@,48-57,_,128-167,224-235"
4860 otherwise: "@,48-57,_,192-255"
4861 Vi default: "@,48-57,_")
4862 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004864 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004865 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004866 characters above 255 check the "word" character class (any character
4867 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004868 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 For a help file it is set to all non-blank printable characters except
4870 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4871 command).
4872 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004873 This option also influences syntax highlighting, unless the syntax
4874 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 NOTE: This option is set to the Vi default value when 'compatible' is
4876 set and to the Vim default value when 'compatible' is reset.
4877
4878 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004879'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 "@,~-255"; otherwise: "@,161-255")
4881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 The characters given by this option are displayed directly on the
4883 screen. It is also used for "\p" in a |pattern|. The characters from
4884 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4885 even when they are not included in 'isprint' or excluded. See
4886 'isfname' for a description of the format of this option.
4887
4888 Non-printable characters are displayed with two characters:
4889 0 - 31 "^@" - "^_"
4890 32 - 126 always single characters
4891 127 "^?"
4892 128 - 159 "~@" - "~_"
4893 160 - 254 "| " - "|~"
4894 255 "~?"
4895 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4896 displayed as <xx>, with the hexadecimal value of the byte.
4897 When 'display' contains "uhex" all unprintable characters are
4898 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004899 The SpecialKey highlighting will be used for unprintable characters.
4900 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901
4902 Multi-byte characters 256 and above are always included, only the
4903 characters up to 255 are specified with this option. When a character
4904 is printable but it is not available in the current font, a
4905 replacement character will be shown.
4906 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4907 There is no option to specify these characters.
4908
4909 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4910'joinspaces' 'js' boolean (default on)
4911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 Insert two spaces after a '.', '?' and '!' with a join command.
4913 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4914 Otherwise only one space is inserted.
4915 NOTE: This option is set when 'compatible' is set.
4916
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004917 *'jumpoptions'* *'jop'*
4918'jumpoptions' 'jop' string (default "")
4919 global
4920 List of words that change the behavior of the |jumplist|.
4921 stack Make the jumplist behave like the tagstack.
4922 Relative location of entries in the jumplist is
4923 preserved at the cost of discarding subsequent entries
4924 when navigating backwards in the jumplist and then
4925 jumping to a location. |jumplist-stack|
4926
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 *'key'*
4928'key' string (default "")
4929 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004930 {only available when compiled with the |+cryptv|
4931 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004933 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 Careful: Do not set the key value by hand, someone might see the typed
4935 key. Use the |:X| command. But you can make 'key' empty: >
4936 :set key=
4937< It is not possible to get the value of this option with ":set key" or
4938 "echo &key". This is to avoid showing it to someone who shouldn't
4939 know. It also means you cannot see it yourself once you have set it,
4940 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004941 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4942 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004943 You can use "&key" in an expression to detect whether encryption is
4944 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
4946 *'keymap'* *'kmp'* *E544*
4947'keymap' 'kmp' string (default "")
4948 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 {only available when compiled with the |+keymap|
4950 feature}
4951 Name of a keyboard mapping. See |mbyte-keymap|.
4952 Setting this option to a valid keymap name has the side effect of
4953 setting 'iminsert' to one, so that the keymap becomes effective.
4954 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004955 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'keymodel'* *'km'*
4958'keymodel' 'km' string (default "")
4959 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004960 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 can do. These values can be used:
4962 startsel Using a shifted special key starts selection (either
4963 Select mode or Visual mode, depending on "key" being
4964 present in 'selectmode').
4965 stopsel Using a not-shifted special key stops selection.
4966 Special keys in this context are the cursor keys, <End>, <Home>,
4967 <PageUp> and <PageDown>.
4968 The 'keymodel' option is set by the |:behave| command.
4969
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004970 *'keyprotocol'* *'kpc'*
4971'keyprotocol' 'kpc' string (default: see below)
4972 global
4973 Specifies what keyboard protocol to use depending on the value of
4974 'term'. The supported keyboard protocols names are:
4975 none whatever the terminal uses
4976 mok2 modifyOtherKeys level 2, as supported by xterm
4977 kitty Kitty keyboard protocol, as supported by Kitty
4978
Bram Moolenaara87749e2022-11-30 10:23:17 +00004979 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004980 a pattern that is matched against the 'term' option, a colon and the
4981 protocol name to be used. To illustrate this, the default value would
4982 be set with: >
4983 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4984
4985< This means that when 'term' contains "kitty, "foot" or "wezterm"
4986 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004987 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004988
4989 The first match is used, thus if you want to have "kitty" use the
4990 kitty protocol, but "badkitty" not, then you should match "badkitty"
4991 first and use the "none" value: >
4992 set keyprotocol=badkitty:none,kitty:kitty
4993<
4994 The option is used after 'term' has been changed. First the termcap
4995 entries are set, possibly using the builtin list, see |builtin-terms|.
4996 Then this option is inspected and if there is a match and a protocol
4997 is specified the following happens:
4998 none Nothing, the regular t_TE and t_TI values remain
4999
5000 mok2 The t_TE value is changed to:
5001 CSI >4;m disables modifyOtherKeys
5002 The t_TI value is changed to:
5003 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005004 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005005
5006 kitty The t_TE value is changed to:
5007 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005008 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005009 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005010 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005011 CSI ?u request kitty keyboard protocol state
5012 CSI >c request the termresponse
5013
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005014 If you notice problems, such as characters being displayed that
5015 disappear after `CTRL-L`, you might want to try making this option
5016 empty. Then set the 'term' option to have it take effect: >
5017 set keyprotocol=
5018 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005019<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005020
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 *'keywordprg'* *'kp'*
5022'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005023 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 Program to use for the |K| command. Environment variables are
5026 expanded |:set_env|. ":help" may be used to access the Vim internal
5027 help. (Note that previously setting the global option to the empty
5028 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005029 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005030 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005031 When "man", "man -s" or an Ex command is used, Vim will automatically
5032 translate a count for the "K" command and pass it as the first
5033 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 See |option-backslash| about including spaces and backslashes.
5035 Example: >
5036 :set keywordprg=man\ -s
5037< This option cannot be set from a |modeline| or in the |sandbox|, for
5038 security reasons.
5039
5040 *'langmap'* *'lmap'* *E357* *E358*
5041'langmap' 'lmap' string (default "")
5042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 {only available when compiled with the |+langmap|
5044 feature}
5045 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005046 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005047 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 care of translating these special characters to the original meaning
5049 of the key. This means you don't have to change the keyboard mode to
5050 be able to execute Normal mode commands.
5051 This is the opposite of the 'keymap' option, where characters are
5052 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005053 Also consider setting 'langremap' to off, to prevent 'langmap' from
5054 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005055 This option cannot be set from a |modeline| or in the |sandbox|, for
5056 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005058 Example (for Greek, in UTF-8): *greek* >
5059 :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 +00005060< Example (exchanges meaning of z and y for commands): >
5061 :set langmap=zy,yz,ZY,YZ
5062<
5063 The 'langmap' option is a list of parts, separated with commas. Each
5064 part can be in one of two forms:
5065 1. A list of pairs. Each pair is a "from" character immediately
5066 followed by the "to" character. Examples: "aA", "aAbBcC".
5067 2. A list of "from" characters, a semi-colon and a list of "to"
5068 characters. Example: "abc;ABC"
5069 Example: "aA,fgh;FGH,cCdDeE"
5070 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005071 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072
5073 This will allow you to activate vim actions without having to switch
5074 back and forth between the languages. Your language characters will
5075 be understood as normal vim English characters (according to the
5076 langmap mappings) in the following cases:
5077 o Normal/Visual mode (commands, buffer/register names, user mappings)
5078 o Insert/Replace Mode: Register names after CTRL-R
5079 o Insert/Replace Mode: Mappings
5080 Characters entered in Command-line mode will NOT be affected by
5081 this option. Note that this option can be changed at any time
5082 allowing to switch between mappings for different languages/encodings.
5083 Use a mapping to avoid having to type it each time!
5084
5085 *'langmenu'* *'lm'*
5086'langmenu' 'lm' string (default "")
5087 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 {only available when compiled with the |+menu| and
5089 |+multi_lang| features}
5090 Language to use for menu translation. Tells which file is loaded
5091 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005092 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093< (without the spaces). For example, to always use the Dutch menus, no
5094 matter what $LANG is set to: >
5095 :set langmenu=nl_NL.ISO_8859-1
5096< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005097 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 If your $LANG is set to a non-English language but you do want to use
5099 the English menus: >
5100 :set langmenu=none
5101< This option must be set before loading menus, switching on filetype
5102 detection or syntax highlighting. Once the menus are defined setting
5103 this option has no effect. But you could do this: >
5104 :source $VIMRUNTIME/delmenu.vim
5105 :set langmenu=de_DE.ISO_8859-1
5106 :source $VIMRUNTIME/menu.vim
5107< Warning: This deletes all menus that you defined yourself!
5108
Bram Moolenaard94464e2015-11-02 15:28:18 +01005109 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005110'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005111 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005112 {only available when compiled with the |+langmap|
5113 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005114 This is just like 'langremap' but with the value inverted. It only
5115 exists for backwards compatibility. When setting 'langremap' then
5116 'langnoremap' is set to the inverted value, and the other way around.
5117
5118 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005119'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005120 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005121 {only available when compiled with the |+langmap|
5122 feature}
5123 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005124 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005125 'langmap' disables some of your mappings, try resetting this option.
5126 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005127 that works for you to avoid mappings to break.
5128
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 *'laststatus'* *'ls'*
5130'laststatus' 'ls' number (default 1)
5131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 The value of this option influences when the last window will have a
5133 status line:
5134 0: never
5135 1: only if there are at least two windows
5136 2: always
5137 The screen looks nicer with a status line if you have several
5138 windows, but it takes another screen line. |status-line|
5139
5140 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5141'lazyredraw' 'lz' boolean (default off)
5142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 When this option is set, the screen will not be redrawn while
5144 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005145 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005147 This may occasionally cause display errors. It is only meant to be set
5148 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005149 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150
5151 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5152'linebreak' 'lbr' boolean (default off)
5153 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005154 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005156 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 than at the last character that fits on the screen. Unlike
5158 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005159 it only affects the way the file is displayed, not its contents.
5160 If 'breakindent' is set, line is visually indented. Then, the value
5161 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005162 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 Note that <Tab> characters after an <EOL> are mostly not displayed
5164 with the right amount of white space.
5165
5166 *'lines'* *E593*
5167'lines' number (default 24 or terminal height)
5168 global
5169 Number of lines of the Vim window.
5170 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005171 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 When Vim is running in the GUI or in a resizable window, setting this
5173 option will cause the window size to be changed. When you only want
5174 to use the size for the GUI, put the command in your |gvimrc| file.
5175 Vim limits the number of lines to what fits on the screen. You can
5176 use this command to get the tallest window possible: >
5177 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005178< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005179 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 When you set this option and Vim is unable to change the physical
5181 number of lines of the display, the display may be messed up.
5182
5183 *'linespace'* *'lsp'*
5184'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 {only in the GUI}
5187 Number of pixel lines inserted between characters. Useful if the font
5188 uses the full character cell height, making lines touch each other.
5189 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005190 With some fonts there can be too much room between lines (to have
5191 space for ascents and descents). Then it makes sense to set
5192 'linespace' to a negative value. This may cause display problems
5193 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 *'lisp'* *'nolisp'*
5196'lisp' boolean (default off)
5197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 Lisp mode: When <Enter> is typed in insert mode set the indent for
5199 the next line to Lisp standards (well, sort of). Also happens with
5200 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5201 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5202 better. Also see 'lispwords'.
5203 The '-' character is included in keyword characters. Redefines the
5204 "=" operator to use this same indentation algorithm rather than
5205 calling an external program if 'equalprg' is empty.
5206 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005208 *'lispoptions'* *'lop'*
5209'lispoptions' 'lop' string (default "")
5210 local to buffer
5211 Comma-separated list of items that influence the Lisp indenting when
5212 enabled with the |'lisp'| option. Currently only one item is
5213 supported:
5214 expr:1 use 'indentexpr' for Lisp indenting when it is set
5215 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5216 Note that when using 'indentexpr' the `=` operator indents all the
5217 lines, otherwise the first line is not indented (Vi-compatible).
5218
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 *'lispwords'* *'lw'*
5220'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005221 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005222 Comma-separated list of words that influence the Lisp indenting when
5223 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224
5225 *'list'* *'nolist'*
5226'list' boolean (default off)
5227 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005228 List mode: By default show tabs as CTRL-I is displayed, display $
5229 after end of line. Useful to see the difference between tabs and
5230 spaces and for trailing blanks. Further changed by the 'listchars'
5231 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005232
5233 The cursor is displayed at the start of the space a Tab character
5234 occupies, not at the end as usual in Normal mode. To get this cursor
5235 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005236 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005237<
5238 Note that list mode will also affect formatting (set with 'textwidth'
5239 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 changing the way tabs are displayed.
5241
5242 *'listchars'* *'lcs'*
5243'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005244 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005245 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005246 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005247 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 eol:c Character to show at the end of each line. When
5249 omitted, there is no extra character at the end of the
5250 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005251 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005252 tab:xy[z] Two or three characters to be used to show a tab.
5253 The third character is optional.
5254
5255 tab:xy The 'x' is always used, then 'y' as many times as will
5256 fit. Thus "tab:>-" displays:
5257 >
5258 >-
5259 >--
5260 etc.
5261
5262 tab:xyz The 'z' is always used, then 'x' is prepended, and
5263 then 'y' is used as many times as will fit. Thus
5264 "tab:<->" displays:
5265 >
5266 <>
5267 <->
5268 <-->
5269 etc.
5270
5271 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005272 *lcs-space*
5273 space:c Character to show for a space. When omitted, spaces
5274 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005275 *lcs-multispace*
5276 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005277 One or more characters to use cyclically to show for
5278 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005279 setting, except for single spaces. When omitted, the
5280 "space" setting is used. For example,
5281 `:set listchars=multispace:---+` shows ten consecutive
5282 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005283 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005284 *lcs-lead*
5285 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005286 leading spaces are blank. Overrides the "space" and
5287 "multispace" settings for leading spaces. You can
5288 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005289 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005290< *lcs-leadmultispace*
5291 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005292 Like the |lcs-multispace| value, but for leading
5293 spaces only. Also overrides |lcs-lead| for leading
5294 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005295 `:set listchars=leadmultispace:---+` shows ten
5296 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005297 ---+---+--XXX ~
5298 Where "XXX" denotes the first non-blank characters in
5299 the line.
5300 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005301 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005302 trailing spaces are blank. Overrides the "space" and
5303 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005304 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 extends:c Character to show in the last column, when 'wrap' is
5306 off and the line continues beyond the right of the
5307 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005308 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005309 precedes:c Character to show in the first visible column of the
5310 physical line, when there is text preceding the
5311 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005312 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005313 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005314 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005315 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005316 nbsp:c Character to show for a non-breakable space character
5317 (0xA0 (160 decimal) and U+202F). Left blank when
5318 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005320 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005322 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005324 Each character can be specified as hex: >
5325 set listchars=eol:\\x24
5326 set listchars=eol:\\u21b5
5327 set listchars=eol:\\U000021b5
5328< Note that a double backslash is used. The number of hex characters
5329 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5330
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 Examples: >
5332 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005333 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 :set lcs=extends:>,precedes:<
5335< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005336 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5337 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005338 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339
5340 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5341'loadplugins' 'lpl' boolean (default on)
5342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 When on the plugin scripts are loaded when starting up |load-plugins|.
5344 This option can be reset in your |vimrc| file to disable the loading
5345 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005346 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5347 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348
Bram Moolenaard94464e2015-11-02 15:28:18 +01005349 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005350'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005351 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005352 {only available when compiled with the |+lua/dyn|
5353 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005354 Specifies the name of the Lua shared library. The default is
5355 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005356 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005357 This option cannot be set from a |modeline| or in the |sandbox|, for
5358 security reasons.
5359
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005360 *'macatsui'* *'nomacatsui'*
5361'macatsui' boolean (default on)
5362 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005363 {not supported}
5364 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005365
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 *'magic'* *'nomagic'*
5367'magic' boolean (default on)
5368 global
5369 Changes the special characters that can be used in search patterns.
5370 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005371 WARNING: Switching this option off most likely breaks plugins! That
5372 is because many patterns assume it's on and will fail when it's off.
5373 Only switch it off when working with old Vi scripts. In any other
5374 situation write patterns that work when 'magic' is on. Include "\M"
5375 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005376 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5377 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
5379 *'makeef'* *'mef'*
5380'makeef' 'mef' string (default: "")
5381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 {not available when compiled without the |+quickfix|
5383 feature}
5384 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5385 and the |:grep| command.
5386 When it is empty, an internally generated temp file will be used.
5387 When "##" is included, it is replaced by a number to make the name
5388 unique. This makes sure that the ":make" command doesn't overwrite an
5389 existing file.
5390 NOT used for the ":cf" command. See 'errorfile' for that.
5391 Environment variables are expanded |:set_env|.
5392 See |option-backslash| about including spaces and backslashes.
5393 This option cannot be set from a |modeline| or in the |sandbox|, for
5394 security reasons.
5395
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005396 *'makeencoding'* *'menc'*
5397'makeencoding' 'menc' string (default "")
5398 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005399 Encoding used for reading the output of external commands. When empty,
5400 encoding is not converted.
5401 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5402 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5403 and `:laddfile`.
5404
5405 This would be mostly useful when you use MS-Windows and set 'encoding'
5406 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5407 'makeencoding' to "char" has the same effect as setting to the system
5408 locale encoding. Example: >
5409 :set encoding=utf-8
5410 :set makeencoding=char " system locale is used
5411<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 *'makeprg'* *'mp'*
5413'makeprg' 'mp' string (default "make", VMS: "MMS")
5414 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005415 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005416 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5417 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005418 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005419 Environment variables are expanded |:set_env|. See |option-backslash|
5420 about including spaces and backslashes.
5421 Note that a '|' must be escaped twice: once for ":set" and once for
5422 the interpretation of a command. When you use a filter called
5423 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 :set makeprg=gmake\ \\\|\ myfilter
5425< The placeholder "$*" can be given (even multiple times) to specify
5426 where the arguments will be included, for example: >
5427 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5428< This option cannot be set from a |modeline| or in the |sandbox|, for
5429 security reasons.
5430
5431 *'matchpairs'* *'mps'*
5432'matchpairs' 'mps' string (default "(:),{:},[:]")
5433 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005435 other.
5436 Only character pairs are allowed that are different, thus you cannot
5437 jump between two double quotes.
5438 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005439 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005440 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 :set mps+=<:>
5442
5443< A more exotic example, to jump between the '=' and ';' in an
5444 assignment, useful for languages like C and Java: >
5445 :au FileType c,cpp,java set mps+==:;
5446
5447< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005448 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449
5450 *'matchtime'* *'mat'*
5451'matchtime' 'mat' number (default 5)
5452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 Tenths of a second to show the matching paren, when 'showmatch' is
5454 set. Note that this is not in milliseconds, like other options that
5455 set a time. This is to be compatible with Nvi.
5456
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005457 *'maxcombine'* *'mco'*
5458'maxcombine' 'mco' number (default 2)
5459 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005460 The maximum number of combining characters supported for displaying.
5461 Only used when 'encoding' is "utf-8".
5462 The default is OK for most languages. Hebrew may require 4.
5463 Maximum value is 6.
5464 Even when this option is set to 2 you can still edit text with more
5465 combining characters, you just can't see them. Use |g8| or |ga|.
5466 See |mbyte-combining|.
5467
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 *'maxfuncdepth'* *'mfd'*
5469'maxfuncdepth' 'mfd' number (default 100)
5470 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005471 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005472 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 Maximum depth of function calls for user functions. This normally
5474 catches endless recursion. When using a recursive function with
5475 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5476 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005477 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005478 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 See also |:function|.
5480
5481 *'maxmapdepth'* *'mmd'* *E223*
5482'maxmapdepth' 'mmd' number (default 1000)
5483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 Maximum number of times a mapping is done without resulting in a
5485 character to be used. This normally catches endless mappings, like
5486 ":map x y" with ":map y x". It still does not catch ":map g wg",
5487 because the 'w' is used before the next mapping is done. See also
5488 |key-mapping|.
5489
5490 *'maxmem'* *'mm'*
5491'maxmem' 'mm' number (default between 256 to 5120 (system
5492 dependent) or half the amount of memory
5493 available)
5494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5496 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005497 other memory to be freed.
5498 The maximum usable value is about 2000000. Use this to work without a
5499 limit.
5500 The value is ignored when 'swapfile' is off.
5501 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005503 *'maxmempattern'* *'mmp'*
5504'maxmempattern' 'mmp' number (default 1000)
5505 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005506 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005507 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005508 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005509 When Vim runs into the limit it gives an error message and mostly
5510 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005511 Running into the limit often means that the pattern is very
5512 inefficient or too complex. This may already happen with the pattern
5513 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005514 Might also happen on redraw, when syntax rules try to match a complex
5515 text structure.
5516 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5517 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005518
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 *'maxmemtot'* *'mmt'*
5520'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5521 dependent) or half the amount of memory
5522 available)
5523 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005524 Maximum amount of memory in Kbyte to use for all buffers together.
5525 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005526 without a limit.
5527 On 64 bit machines higher values might work. But hey, do you really
5528 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005529 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005530 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005531 Buffers with 'swapfile' off still count to the total amount of memory
5532 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005533 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
5535 *'menuitems'* *'mis'*
5536'menuitems' 'mis' number (default 25)
5537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 {not available when compiled without the |+menu|
5539 feature}
5540 Maximum number of items to use in a menu. Used for menus that are
5541 generated from a list of items, e.g., the Buffers menu. Changing this
5542 option has no direct effect, the menu must be refreshed first.
5543
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005544 *'mkspellmem'* *'msm'*
5545'mkspellmem' 'msm' string (default "460000,2000,500")
5546 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005547 {not available when compiled without the |+syntax|
5548 feature}
5549 Parameters for |:mkspell|. This tunes when to start compressing the
5550 word tree. Compression can be slow when there are many words, but
5551 it's needed to avoid running out of memory. The amount of memory used
5552 per word depends very much on how similar the words are, that's why
5553 this tuning is complicated.
5554
5555 There are three numbers, separated by commas:
5556 {start},{inc},{added}
5557
5558 For most languages the uncompressed word tree fits in memory. {start}
5559 gives the amount of memory in Kbyte that can be used before any
5560 compression is done. It should be a bit smaller than the amount of
5561 memory that is available to Vim.
5562
5563 When going over the {start} limit the {inc} number specifies the
5564 amount of memory in Kbyte that can be allocated before another
5565 compression is done. A low number means compression is done after
5566 less words are added, which is slow. A high number means more memory
5567 will be allocated.
5568
5569 After doing compression, {added} times 1024 words can be added before
5570 the {inc} limit is ignored and compression is done when any extra
5571 amount of memory is needed. A low number means there is a smaller
5572 chance of hitting the {inc} limit, less memory is used but it's
5573 slower.
5574
5575 The languages for which these numbers are important are Italian and
5576 Hungarian. The default works for when you have about 512 Mbyte. If
5577 you have 1 Gbyte you could use: >
5578 :set mkspellmem=900000,3000,800
5579< If you have less than 512 Mbyte |:mkspell| may fail for some
5580 languages, no matter what you set 'mkspellmem' to.
5581
dkearns8ebdbc92023-10-29 06:26:19 +11005582 This option cannot be set from a |modeline| or in the |sandbox|, for
5583 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005584
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005586'modeline' 'ml' boolean (Vim default: on (off for root),
5587 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005589 If 'modeline' is on 'modelines' gives the number of lines that is
5590 checked for set commands. If 'modeline' is off or 'modelines' is zero
5591 no lines are checked. See |modeline|.
5592
5593 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5594'modelineexpr' 'mle' boolean (default: off)
5595 global
5596 When on allow some options that are an expression to be set in the
5597 modeline. Check the option for whether it is affected by
5598 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005599 This option cannot be set from a |modeline| or in the |sandbox|, for
5600 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005601
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 *'modelines'* *'mls'*
5603'modelines' 'mls' number (default 5)
5604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 If 'modeline' is on 'modelines' gives the number of lines that is
5606 checked for set commands. If 'modeline' is off or 'modelines' is zero
5607 no lines are checked. See |modeline|.
5608 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5609 set and to the Vim default value when 'compatible' is reset.
5610
5611 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005612 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613'modifiable' 'ma' boolean (default on)
5614 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 When off the buffer contents cannot be changed. The 'fileformat' and
5616 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005617 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618
5619 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5620'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005621 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 When on, the buffer is considered to be modified. This option is set
5623 when:
5624 1. A change was made to the text since it was last written. Using the
5625 |undo| command to go back to the original text will reset the
5626 option. But undoing changes that were made before writing the
5627 buffer will set the option again, since the text is different from
5628 when it was written.
5629 2. 'fileformat' or 'fileencoding' is different from its original
5630 value. The original value is set when the buffer is read or
5631 written. A ":set nomodified" command also resets the original
5632 values to the current values and the 'modified' option will be
5633 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005634 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005635 This option is not set when a change is made to the buffer as the
5636 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5637 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5638 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5640 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005641 Note that the text may actually be the same, e.g. 'modified' is set
5642 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643
5644 *'more'* *'nomore'*
5645'more' boolean (Vim default: on, Vi default: off)
5646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 When on, listings pause when the whole screen is filled. You will get
5648 the |more-prompt|. When this option is off there are no pauses, the
5649 listing continues until finished.
5650 NOTE: This option is set to the Vi default value when 'compatible' is
5651 set and to the Vim default value when 'compatible' is reset.
5652
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005653 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005654'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005655 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005657 Enable the use of the mouse. Works for most terminals (xterm, Win32
5658 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5659 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5660 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005661 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 v Visual mode
5663 i Insert mode
5664 c Command-line mode
5665 h all previous modes when editing a help file
5666 a all previous modes
5667 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005668 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005670< If your terminal can't overrule the mouse events going to the
5671 application, use: >
5672 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005673< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005674 back to Vim using the mouse events.
5675 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5676 "xterm".
5677
5678 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 modeless selection. This doesn't move the text cursor.
5680
5681 See |mouse-using|. Also see |'clipboard'|.
5682
5683 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 the mouse buttons can still be used by keeping the shift key pressed.
5686 Also see the 'clipboard' option.
5687
5688 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5689'mousefocus' 'mousef' boolean (default off)
5690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 {only works in the GUI}
5692 The window that the mouse pointer is on is automatically activated.
5693 When changing the window layout or window focus in another way, the
5694 mouse pointer is moved to the window with keyboard focus. Off is the
5695 default because it makes using the pull down menus a little goofy, as
5696 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005697 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005698 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699
5700 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5701'mousehide' 'mh' boolean (default on)
5702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 {only works in the GUI}
5704 When on, the mouse pointer is hidden when characters are typed.
5705 The mouse pointer is restored when the mouse is moved.
5706
5707 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005708'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 Sets the model to use for the mouse. The name mostly specifies what
5711 the right mouse button is used for:
5712 extend Right mouse button extends a selection. This works
5713 like in an xterm.
5714 popup Right mouse button pops up a menu. The shifted left
5715 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005716 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 popup_setpos Like "popup", but the cursor will be moved to the
5718 position where the mouse was clicked, and thus the
5719 selected operation will act upon the clicked object.
5720 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005721 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 course, that right clicking outside a selection will
5723 end Visual mode.
5724 Overview of what button does what for each model:
5725 mouse extend popup(_setpos) ~
5726 left click place cursor place cursor
5727 left drag start selection start selection
5728 shift-left search word extend selection
5729 right click extend selection popup menu (place cursor)
5730 right drag extend selection -
5731 middle click paste paste
5732
5733 In the "popup" model the right mouse button produces a pop-up menu.
5734 You need to define this first, see |popup-menu|.
5735
5736 Note that you can further refine the meaning of buttons with mappings.
5737 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5738 selection (because that's handled in the GUI code directly).
5739
5740 The 'mousemodel' option is set by the |:behave| command.
5741
h_east59858792023-10-25 22:47:05 +09005742 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005743'mousemoveevent' 'mousemev' boolean (default off)
5744 global
5745 {only works in the GUI}
5746 When on, mouse move events are delivered to the input queue and are
5747 available for mapping. The default, off, avoids the mouse movement
5748 overhead except when needed. See |gui-mouse-mapping|.
5749 Warning: Setting this option can make pending mappings to be aborted
5750 when the mouse is moved.
5751 Currently only works in the GUI, may be made to work in a terminal
5752 later.
5753
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005755'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5756 vs:leftright,vd:lrsizing,m:no,
5757 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 {only available when compiled with the |+mouseshape|
5760 feature}
5761 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005762 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 like used for 'guicursor'. Each part consist of a mode/location-list
5764 and an argument-list:
5765 mode-list:shape,mode-list:shape,..
5766 The mode-list is a dash separated list of these modes/locations:
5767 In a normal window: ~
5768 n Normal mode
5769 v Visual mode
5770 ve Visual mode with 'selection' "exclusive" (same as 'v',
5771 if not specified)
5772 o Operator-pending mode
5773 i Insert mode
5774 r Replace mode
5775
5776 Others: ~
5777 c appending to the command-line
5778 ci inserting in the command-line
5779 cr replacing in the command-line
5780 m at the 'Hit ENTER' or 'More' prompts
5781 ml idem, but cursor in the last line
5782 e any mode, pointer below last window
5783 s any mode, pointer on a status line
5784 sd any mode, while dragging a status line
5785 vs any mode, pointer on a vertical separator line
5786 vd any mode, while dragging a vertical separator line
5787 a everywhere
5788
5789 The shape is one of the following:
5790 avail name looks like ~
5791 w x arrow Normal mouse pointer
5792 w x blank no pointer at all (use with care!)
5793 w x beam I-beam
5794 w x updown up-down sizing arrows
5795 w x leftright left-right sizing arrows
5796 w x busy The system's usual busy pointer
5797 w x no The system's usual 'no input' pointer
5798 x udsizing indicates up-down resizing
5799 x lrsizing indicates left-right resizing
5800 x crosshair like a big thin +
5801 x hand1 black hand
5802 x hand2 white hand
5803 x pencil what you write with
5804 x question big ?
5805 x rightup-arrow arrow pointing right-up
5806 w x up-arrow arrow pointing up
5807 x <number> any X11 pointer number (see X11/cursorfont.h)
5808
5809 The "avail" column contains a 'w' if the shape is available for Win32,
5810 x for X11.
5811 Any modes not specified or shapes not available use the normal mouse
5812 pointer.
5813
5814 Example: >
5815 :set mouseshape=s:udsizing,m:no
5816< will make the mouse turn to a sizing arrow over the status lines and
5817 indicate no input when the hit-enter prompt is displayed (since
5818 clicking the mouse has no effect in this state.)
5819
5820 *'mousetime'* *'mouset'*
5821'mousetime' 'mouset' number (default 500)
5822 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005823 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 time in msec between two mouse clicks for the second click to be
5825 recognized as a multi click.
5826
laburnumT3f7855a2023-12-05 18:37:03 +01005827 *'mzquantum'* *'mzq'*
5828'mzquantum' 'mzq' number (default 100)
5829 global
5830 {not available when compiled without the |+mzscheme|
5831 feature}
5832 The number of milliseconds between polls for MzScheme threads.
5833 Negative or zero value means no thread scheduling.
5834 NOTE: This option is set to the Vim default value when 'compatible'
5835 is reset.
5836
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005837 *'mzschemedll'*
5838'mzschemedll' string (default depends on the build)
5839 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005840 {only available when compiled with the |+mzscheme/dyn|
5841 feature}
5842 Specifies the name of the MzScheme shared library. The default is
5843 DYNAMIC_MZSCH_DLL which was specified at compile time.
5844 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005845 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005846 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005847 This option cannot be set from a |modeline| or in the |sandbox|, for
5848 security reasons.
5849
5850 *'mzschemegcdll'*
5851'mzschemegcdll' string (default depends on the build)
5852 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005853 {only available when compiled with the |+mzscheme/dyn|
5854 feature}
5855 Specifies the name of the MzScheme GC shared library. The default is
5856 DYNAMIC_MZGC_DLL which was specified at compile time.
5857 The value can be equal to 'mzschemedll' if it includes the GC code.
5858 Environment variables are expanded |:set_env|.
5859 This option cannot be set from a |modeline| or in the |sandbox|, for
5860 security reasons.
5861
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005863'nrformats' 'nf' string (default "bin,octal,hex",
5864 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 This defines what bases Vim will consider for numbers when using the
5867 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5868 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005869 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005871 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005872 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005874 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 considered to be hexadecimal. Example: Using CTRL-X on
5876 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005877 bin If included, numbers starting with "0b" or "0B" will be
5878 considered to be binary. Example: Using CTRL-X on
5879 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005880 unsigned If included, numbers are recognized as unsigned. Thus a
5881 leading dash or negative sign won't be considered as part of
5882 the number. Examples:
5883 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5884 (without "unsigned" it would become "9-2021").
5885 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5886 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005887 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5888 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 Numbers which simply begin with a digit in the range 1-9 are always
5890 considered decimal. This also happens for numbers that are not
5891 recognized as octal or hex.
5892
5893 *'number'* *'nu'* *'nonumber'* *'nonu'*
5894'number' 'nu' boolean (default off)
5895 local to window
5896 Print the line number in front of each line. When the 'n' option is
5897 excluded from 'cpoptions' a wrapped line will not use the column of
5898 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005899 The 'numberwidth' option can be used to set the room used for the line
5900 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 When a long, wrapped line doesn't start with the first character, '-'
5902 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005903 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5904 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005905 *number_relativenumber*
5906 The 'relativenumber' option changes the displayed number to be
5907 relative to the cursor. Together with 'number' there are these
5908 four combinations (cursor in line 3):
5909
Bram Moolenaar3848e002016-03-19 18:42:29 +01005910 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005911 'nornu' 'nornu' 'rnu' 'rnu'
5912
5913 |apple | 1 apple | 2 apple | 2 apple
5914 |pear | 2 pear | 1 pear | 1 pear
5915 |nobody | 3 nobody | 0 nobody |3 nobody
5916 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005918 *'numberwidth'* *'nuw'*
5919'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5920 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005921 {only available when compiled with the |+linebreak|
5922 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005923 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005924 when the 'number' or 'relativenumber' option is set or printing lines
5925 with a line number. Since one space is always between the number and
5926 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005927 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005928 fit the highest line number in the buffer respectively the number of
5929 rows in the window, depending on whether 'number' or 'relativenumber'
5930 is set. Thus with the Vim default of 4 there is room for a line number
5931 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005932 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005933 NOTE: This option is set to the Vi default value when 'compatible' is
5934 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005935
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005936 *'omnifunc'* *'ofu'*
5937'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005938 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005939 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005940 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005941 This option specifies a function to be used for Insert mode omni
5942 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005943 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005944 invoked and what it should return. The value can be the name of a
5945 function, a |lambda| or a |Funcref|. See |option-value-function| for
5946 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005947 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005948 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005949 This option cannot be set from a |modeline| or in the |sandbox|, for
5950 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005951
Bram Moolenaar02467872007-05-06 13:22:01 +00005952 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005953'opendevice' 'odev' boolean (default off)
5954 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005955 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005956 Enable reading and writing from devices. This may get Vim stuck on a
5957 device that can be opened but doesn't actually do the I/O. Therefore
5958 it is off by default.
5959 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5960 result in editing a device.
5961
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005962 *'operatorfunc'* *'opfunc'*
5963'operatorfunc' 'opfunc' string (default: empty)
5964 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005965 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005966 See |:map-operator| for more info and an example. The value can be
5967 the name of a function, a |lambda| or a |Funcref|. See
5968 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005969
5970 This option cannot be set from a |modeline| or in the |sandbox|, for
5971 security reasons.
5972
Bram Moolenaar251e1912011-06-19 05:09:16 +02005973 *'osfiletype'* *'oft'*
5974'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005976 This option was supported on RISC OS, which has been removed.
5977
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005978 *'packpath'* *'pp'*
5979'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005980 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11005981 This option cannot be set from a |modeline| or in the |sandbox|, for
5982 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005983
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005985'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 global
5987 Specifies the nroff macros that separate paragraphs. These are pairs
5988 of two letters (see |object-motions|).
5989
5990 *'paste'* *'nopaste'*
5991'paste' boolean (default off)
5992 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005993 Put Vim in Paste mode. This is useful if you want to cut or copy
5994 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 unexpected effects.
5996 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005997 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 knows about pasting and will mostly do the right thing without 'paste'
5999 being set. The same is true for a terminal where Vim handles the
6000 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006001 This option is reset when starting the GUI. Thus if you set it in
6002 your .vimrc it will work in a terminal, but not in the GUI. Setting
6003 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6004 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 When the 'paste' option is switched on (also when it was already on):
6006 - mapping in Insert mode and Command-line mode is disabled
6007 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006009 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006010 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 - 'revins' is reset
6012 - 'ruler' is reset
6013 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006014 - 'smarttab' is reset
6015 - 'softtabstop' is set to 0
6016 - 'textwidth' is set to 0
6017 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006018 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006021 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006022 - 'indentexpr'
6023 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006024 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 NOTE: When you start editing another file while the 'paste' option is
6026 on, settings from the modelines or autocommands may change the
6027 settings again, causing trouble when pasting text. You might want to
6028 set the 'paste' option again.
6029 When the 'paste' option is reset the mentioned options are restored to
6030 the value before the moment 'paste' was switched from off to on.
6031 Resetting 'paste' before ever setting it does not have any effect.
6032 Since mapping doesn't work while 'paste' is active, you need to use
6033 the 'pastetoggle' option to toggle the 'paste' option with some key.
6034
6035 *'pastetoggle'* *'pt'*
6036'pastetoggle' 'pt' string (default "")
6037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 When non-empty, specifies the key sequence that toggles the 'paste'
6039 option. This is like specifying a mapping: >
6040 :map {keys} :set invpaste<CR>
6041< Where {keys} is the value of 'pastetoggle'.
6042 The difference is that it will work even when 'paste' is set.
6043 'pastetoggle' works in Insert mode and Normal mode, but not in
6044 Command-line mode.
6045 Mappings are checked first, thus overrule 'pastetoggle'. However,
6046 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6047 this: >
6048 :map <F10> :set paste<CR>
6049 :map <F11> :set nopaste<CR>
6050 :imap <F10> <C-O>:set paste<CR>
6051 :imap <F11> <nop>
6052 :set pastetoggle=<F11>
6053< This will make <F10> start paste mode and <F11> stop paste mode.
6054 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6055 mode everything is inserted literally, except the 'pastetoggle' key
6056 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006057 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058
6059 *'pex'* *'patchexpr'*
6060'patchexpr' 'pex' string (default "")
6061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 {not available when compiled without the |+diff|
6063 feature}
6064 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006065 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006066 This option cannot be set from a |modeline| or in the |sandbox|, for
6067 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068
Bram Moolenaardbc28022014-07-26 13:40:44 +02006069 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070'patchmode' 'pm' string (default "")
6071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 When non-empty the oldest version of a file is kept. This can be used
6073 to keep the original version of a file if you are changing files in a
6074 source distribution. Only the first time that a file is written a
6075 copy of the original file will be kept. The name of the copy is the
6076 name of the original file with the string in the 'patchmode' option
6077 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006078 ".orig" or ".org". 'backupdir' must not be empty for this to work
6079 (Detail: The backup file is renamed to the patchmode file after the
6080 new file has been successfully written, that's why it must be possible
6081 to write a backup file). If there was no file to be backed up, an
6082 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 When the 'backupskip' pattern matches, a patchmode file is not made.
6084 Using 'patchmode' for compressed files appends the extension at the
6085 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6086 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006087 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006089 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 other systems: ".,,")
6092 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006094 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6095 provided that the file being searched for has a relative path (not
6096 starting with "/", "./" or "../"). The directories in the 'path'
6097 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 - Use commas to separate directory names: >
6099 :set path=.,/usr/local/include,/usr/include
6100< - Spaces can also be used to separate directory names (for backwards
6101 compatibility with version 3.0). To have a space in a directory
6102 name, precede it with an extra backslash, and escape the space: >
6103 :set path=.,/dir/with\\\ space
6104< - To include a comma in a directory name precede it with an extra
6105 backslash: >
6106 :set path=.,/dir/with\\,comma
6107< - To search relative to the directory of the current file, use: >
6108 :set path=.
6109< - To search in the current directory use an empty string between two
6110 commas: >
6111 :set path=,,
6112< - A directory name may end in a ':' or '/'.
6113 - Environment variables are expanded |:set_env|.
6114 - When using |netrw.vim| URLs can be used. For example, adding
6115 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006116 - Search upwards and downwards in a directory tree using "*", "**" and
6117 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 - Careful with '\' characters, type two to get one in the option: >
6119 :set path=.,c:\\include
6120< Or just use '/' instead: >
6121 :set path=.,c:/include
6122< Don't forget "." or files won't even be found in the same directory as
6123 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006124 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 it is something like 256 or 1024 characters.
6126 You can check if all the include files are found, using the value of
6127 'path', see |:checkpath|.
6128 The use of |:set+=| and |:set-=| is preferred when adding or removing
6129 directories from the list. This avoids problems when a future version
6130 uses another default. To remove the current directory use: >
6131 :set path-=
6132< To add the current directory use: >
6133 :set path+=
6134< To use an environment variable, you probably need to replace the
6135 separator. Here is an example to append $INCL, in which directory
6136 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006137 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138< Replace the ';' with a ':' or whatever separator is used. Note that
6139 this doesn't work when $INCL contains a comma or white space.
6140
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006141 *'perldll'*
6142'perldll' string (default depends on the build)
6143 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006144 {only available when compiled with the |+perl/dyn|
6145 feature}
6146 Specifies the name of the Perl shared library. The default is
6147 DYNAMIC_PERL_DLL, which was specified at compile time.
6148 Environment variables are expanded |:set_env|.
6149 This option cannot be set from a |modeline| or in the |sandbox|, for
6150 security reasons.
6151
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6153'preserveindent' 'pi' boolean (default off)
6154 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 When changing the indent of the current line, preserve as much of the
6156 indent structure as possible. Normally the indent is replaced by a
6157 series of tabs followed by spaces as required (unless |'expandtab'| is
6158 enabled, in which case only spaces are used). Enabling this option
6159 means the indent will preserve as many existing characters as possible
6160 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006161 'expandtab' does not apply to the preserved white space, a Tab remains
6162 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 NOTE: When using ">>" multiple times the resulting indent is a mix of
6164 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006165 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 Also see 'copyindent'.
6167 Use |:retab| to clean up white space.
6168
6169 *'previewheight'* *'pvh'*
6170'previewheight' 'pvh' number (default 12)
6171 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006172 {not available when compiled without the |+quickfix|
6173 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006175 commands. Used for |CTRL-W_}| when no count is given. Not used when
6176 'previewpopup' is set.
6177
6178 *'previewpopup'* *'pvp'*
6179'previewpopup' 'pvp' string (default empty)
6180 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006181 {not available when compiled without the |+textprop|
6182 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006183 When not empty a popup window is used for commands that would open a
6184 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006185 Not used for the insert completion info, add "popup" to
6186 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187
6188 *'previewwindow'* *'nopreviewwindow'*
6189 *'pvw'* *'nopvw'* *E590*
6190'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006191 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006192 {not available when compiled without the |+quickfix|
6193 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006194 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 set. It's normally not set directly, but by using one of the commands
6196 |:ptag|, |:pedit|, etc.
6197
6198 *'printdevice'* *'pdev'*
6199'printdevice' 'pdev' string (default empty)
6200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 {only available when compiled with the |+printer|
6202 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006203 The name of the printer to be used for |:hardcopy|.
6204 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006205 This option cannot be set from a |modeline| or in the |sandbox|, for
6206 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207
Bram Moolenaar8299df92004-07-10 09:47:34 +00006208 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006209'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 {only available when compiled with the |+printer|
6212 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006213 Sets the character encoding used when printing.
6214 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215
6216 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006217'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 {only available when compiled with the |+printer|
6220 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006221 Expression used to print the PostScript produced with |:hardcopy|.
6222 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
Bram Moolenaar8299df92004-07-10 09:47:34 +00006226 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227'printfont' 'pfn' string (default "courier")
6228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 {only available when compiled with the |+printer|
6230 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006231 The name of the font that will be used for |:hardcopy|.
6232 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233
6234 *'printheader'* *'pheader'*
6235'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 {only available when compiled with the |+printer|
6238 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006239 The format of the header produced in |:hardcopy| output.
6240 See |pheader-option|.
6241
6242 *'printmbcharset'* *'pmbcs'*
6243'printmbcharset' 'pmbcs' string (default "")
6244 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006245 {only available when compiled with the |+printer|
6246 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006247 The CJK character set to be used for CJK output from |:hardcopy|.
6248 See |pmbcs-option|.
6249
6250 *'printmbfont'* *'pmbfn'*
6251'printmbfont' 'pmbfn' string (default "")
6252 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006253 {only available when compiled with the |+printer|
6254 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006255 List of font names to be used for CJK output from |:hardcopy|.
6256 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257
6258 *'printoptions'* *'popt'*
6259'printoptions' 'popt' string (default "")
6260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006262 List of items that control the format of the output of |:hardcopy|.
6263 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006265 *'prompt'* *'noprompt'*
6266'prompt' boolean (default on)
6267 global
6268 When on a ":" prompt is used in Ex mode.
6269
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006270 *'pumheight'* *'ph'*
6271'pumheight' 'ph' number (default 0)
6272 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006273 Determines the maximum number of items to show in the popup menu for
6274 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006275 |ins-completion-menu|.
6276
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006277 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006278'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006279 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006280 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006281 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006282
Bram Moolenaard94464e2015-11-02 15:28:18 +01006283 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006284'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006285 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006286 {only available when compiled with the |+python/dyn|
6287 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006288 Specifies the name of the Python 2.x shared library. The default is
6289 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006290 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006291 This option cannot be set from a |modeline| or in the |sandbox|, for
6292 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006293
Bram Moolenaar94073162018-01-31 21:49:05 +01006294 *'pythonhome'*
6295'pythonhome' string (default "")
6296 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006297 {only available when compiled with the |+python/dyn|
6298 feature}
6299 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6300 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6301 which was specified at compile time, will be used for the Python 2.x
6302 home directory.
6303 Environment variables are expanded |:set_env|.
6304 This option cannot be set from a |modeline| or in the |sandbox|, for
6305 security reasons.
6306
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006307 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006308'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006309 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006310 {only available when compiled with the |+python3/dyn|
6311 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006312 Specifies the name of the Python 3 shared library. The default is
6313 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006314 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006315 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 security reasons.
6317
Bram Moolenaar94073162018-01-31 21:49:05 +01006318 *'pythonthreehome'*
6319'pythonthreehome' string (default "")
6320 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006321 {only available when compiled with the |+python3/dyn|
6322 feature}
6323 Specifies the name of the Python 3 home directory. When
6324 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6325 PYTHON3_HOME, which was specified at compile time, will be used for
6326 the Python 3 home directory.
6327 Environment variables are expanded |:set_env|.
6328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006331 *'pyxversion'* *'pyx'*
6332'pyxversion' 'pyx' number (default depends on the build)
6333 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006334 {only available when compiled with the |+python| or
6335 the |+python3| feature}
6336 Specifies the python version used for pyx* functions and commands
6337 |python_x|. The default value is as follows:
6338
6339 Compiled with Default ~
6340 |+python| and |+python3| 0
6341 only |+python| 2
6342 only |+python3| 3
6343
6344 Available values are 0, 2 and 3.
6345 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6346 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6347 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6348 to 2 if Python 2 is available.
6349 See also: |has-pythonx|
6350
6351 If Vim is compiled with only |+python| or |+python3| setting
6352 'pyxversion' has no effect. The pyx* functions and commands are
6353 always the same as the compiled version.
6354
6355 This option cannot be set from a |modeline| or in the |sandbox|, for
6356 security reasons.
6357
Bram Moolenaar858ba062020-05-31 23:11:59 +02006358 *'quickfixtextfunc'* *'qftf'*
6359'quickfixtextfunc' 'qftf' string (default "")
6360 global
6361 {only available when compiled with the |+quickfix|
6362 feature}
6363 This option specifies a function to be used to get the text to display
6364 in the quickfix and location list windows. This can be used to
6365 customize the information displayed in the quickfix or location window
6366 for each entry in the corresponding quickfix or location list. See
6367 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006368 function and an example. The value can be the name of a function, a
6369 |lambda| or a |Funcref|. See |option-value-function| for more
6370 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006371
6372 This option cannot be set from a |modeline| or in the |sandbox|, for
6373 security reasons.
6374
Bram Moolenaar677ee682005-01-27 14:41:15 +00006375 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006376'quoteescape' 'qe' string (default "\")
6377 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006378 The characters that are used to escape quotes in a string. Used for
6379 objects like a', a" and a` |a'|.
6380 When one of the characters in this option is found inside a string,
6381 the following character will be skipped. The default value makes the
6382 text "foo\"bar\\" considered to be one string.
6383
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6385'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006386 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 If on, writes fail unless you use a '!'. Protects you from
6388 accidentally overwriting a file. Default on when Vim is started
6389 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006390 When using ":w!" the 'readonly' option is reset for the current
6391 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006392 When using the ":view" command the 'readonly' option is set for the
6393 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006394 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006396 *'redrawtime'* *'rdt'*
6397'redrawtime' 'rdt' number (default 2000)
6398 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006399 {only available when compiled with the |+reltime|
6400 feature}
6401 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006402 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006403 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006404 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006405 matches will be highlighted.
6406 For syntax highlighting the time applies per window. When over the
6407 limit syntax highlighting is disabled until |CTRL-L| is used.
6408 This is used to avoid that Vim hangs when using a very complicated
6409 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006410
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006411 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006412'regexpengine' 're' number (default 0)
6413 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006414 This selects the default regexp engine. |two-engines|
6415 The possible values are:
6416 0 automatic selection
6417 1 old engine
6418 2 NFA engine
6419 Note that when using the NFA engine and the pattern contains something
6420 that is not supported the pattern will not match. This is only useful
6421 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006422 Using automatic selection enables Vim to switch the engine, if the
6423 default engine becomes too costly. E.g., when the NFA engine uses too
6424 many states. This should prevent Vim from hanging on a combination of
6425 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006426
Bram Moolenaar64486672010-05-16 15:46:46 +02006427 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6428'relativenumber' 'rnu' boolean (default off)
6429 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006430 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006431 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006432 precede some vertical motion commands (e.g. j k + -) with, without
6433 having to calculate it yourself. Especially useful in combination with
6434 other commands (e.g. y d c < > gq gw =).
6435 When the 'n' option is excluded from 'cpoptions' a wrapped
6436 line will not use the column of line numbers (this is the default when
6437 'compatible' isn't set).
6438 The 'numberwidth' option can be used to set the room used for the line
6439 number.
6440 When a long, wrapped line doesn't start with the first character, '-'
6441 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006442 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6443 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006444
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006445 The number in front of the cursor line also depends on the value of
6446 'number', see |number_relativenumber| for all combinations of the two
6447 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006448
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 *'remap'* *'noremap'*
6450'remap' boolean (default on)
6451 global
6452 Allows for mappings to work recursively. If you do not want this for
6453 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006454 NOTE: To avoid portability problems with Vim scripts, always keep
6455 this option at the default "on". Only switch it off when working with
6456 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006458 *'renderoptions'* *'rop'*
6459'renderoptions' 'rop' string (default: empty)
6460 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006461 {only available when compiled with GUI and DIRECTX on
6462 MS-Windows}
6463 Select a text renderer and set its options. The options depend on the
6464 renderer.
6465
6466 Syntax: >
6467 set rop=type:{renderer}(,{name}:{value})*
6468<
6469 Currently, only one optional renderer is available.
6470
6471 render behavior ~
6472 directx Vim will draw text using DirectX (DirectWrite). It makes
6473 drawn glyphs more beautiful than default GDI.
6474 It requires 'encoding' is "utf-8", and only works on
6475 MS-Windows Vista or newer version.
6476
6477 Options:
6478 name meaning type value ~
6479 gamma gamma float 1.0 - 2.2 (maybe)
6480 contrast enhancedContrast float (unknown)
6481 level clearTypeLevel float (unknown)
6482 geom pixelGeometry int 0 - 2 (see below)
6483 renmode renderingMode int 0 - 6 (see below)
6484 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006485 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006486
Bram Moolenaar92467d32017-12-05 13:22:16 +01006487 See this URL for detail (except for scrlines):
6488 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006489
6490 For geom: structure of a device pixel.
6491 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6492 1 - DWRITE_PIXEL_GEOMETRY_RGB
6493 2 - DWRITE_PIXEL_GEOMETRY_BGR
6494
6495 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006496 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006497
6498 For renmode: method of rendering glyphs.
6499 0 - DWRITE_RENDERING_MODE_DEFAULT
6500 1 - DWRITE_RENDERING_MODE_ALIASED
6501 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6502 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6503 4 - DWRITE_RENDERING_MODE_NATURAL
6504 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6505 6 - DWRITE_RENDERING_MODE_OUTLINE
6506
6507 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006508 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006509
6510 For taamode: antialiasing mode used for drawing text.
6511 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6512 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6513 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6514 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6515
6516 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006517 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6518
Bram Moolenaara338adc2018-01-31 20:51:47 +01006519 For scrlines:
6520 This was used for optimizing scrolling behavior, however this
6521 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006522
6523 Example: >
6524 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006525 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006526 set rop=type:directx
6527<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006528 If select a raster font (Courier, Terminal or FixedSys which
6529 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006530 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006531
6532 NOTE: It is known that some fonts and options combination
6533 causes trouble on drawing glyphs.
6534
Bram Moolenaar92467d32017-12-05 13:22:16 +01006535 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006536 special made fonts (True-Type fonts which includes only
6537 bitmap glyphs).
6538 - 'taamode:3' will not work with some vector fonts.
6539
6540 NOTE: With this option, you can display colored emoji
6541 (emoticon) in Windows 8.1 or later. To display colored emoji,
6542 there are some conditions which you should notice.
6543
6544 - If your font includes non-colored emoji already, it will
6545 be used.
6546 - If your font doesn't have emoji, the system chooses an
6547 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6548 will be used.
6549 - When this alternative font didn't have fixed width glyph,
6550 emoji might be rendered beyond the bounding box of drawing
6551 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006552
6553 Other render types are currently not supported.
6554
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 *'report'*
6556'report' number (default 2)
6557 global
6558 Threshold for reporting number of lines changed. When the number of
6559 changed lines is more than 'report' a message will be given for most
6560 ":" commands. If you want it always, set 'report' to 0.
6561 For the ":substitute" command the number of substitutions is used
6562 instead of the number of lines.
6563
6564 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6565'restorescreen' 'rs' boolean (default on)
6566 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006567 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 When set, the screen contents is restored when exiting Vim. This also
6569 happens when executing external commands.
6570
6571 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6572 options in your .vimrc. To disable restoring:
6573 set t_ti= t_te=
6574 To enable restoring (for an xterm):
6575 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6576 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6577
6578 *'revins'* *'ri'* *'norevins'* *'nori'*
6579'revins' 'ri' boolean (default off)
6580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 {only available when compiled with the |+rightleft|
6582 feature}
6583 Inserting characters in Insert mode will work backwards. See "typing
6584 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6585 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006586 NOTE: This option is reset when 'compatible' is set.
6587 This option is reset when 'paste' is set and restored when 'paste' is
6588 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589
6590 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6591'rightleft' 'rl' boolean (default off)
6592 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 {only available when compiled with the |+rightleft|
6594 feature}
6595 When on, display orientation becomes right-to-left, i.e., characters
6596 that are stored in the file appear from the right to the left.
6597 Using this option, it is possible to edit files for languages that
6598 are written from the right to the left such as Hebrew and Arabic.
6599 This option is per window, so it is possible to edit mixed files
6600 simultaneously, or to view the same file in both ways (this is
6601 useful whenever you have a mixed text file with both right-to-left
6602 and left-to-right strings so that both sets are displayed properly
6603 in different windows). Also see |rileft.txt|.
6604
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006605 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606'rightleftcmd' 'rlc' string (default "search")
6607 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 {only available when compiled with the |+rightleft|
6609 feature}
6610 Each word in this option enables the command line editing to work in
6611 right-to-left mode for a group of commands:
6612
6613 search "/" and "?" commands
6614
6615 This is useful for languages such as Hebrew, Arabic and Farsi.
6616 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6617
Bram Moolenaard94464e2015-11-02 15:28:18 +01006618 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006619'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006620 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006621 {only available when compiled with the |+ruby/dyn|
6622 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006623 Specifies the name of the Ruby shared library. The default is
6624 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006625 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006626 This option cannot be set from a |modeline| or in the |sandbox|, for
6627 security reasons.
6628
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006630'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006633 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 text in the file is shown on the far right:
6635 Top first line is visible
6636 Bot last line is visible
6637 All first and last line are visible
6638 45% relative position in the file
6639 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006640 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006641 ruler is shown there. Otherwise it is shown in the last line of the
6642 screen. If the statusline is given by 'statusline' (i.e. not empty),
6643 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006645 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 the text column (byte number) and the screen column are shown,
6647 separated with a dash.
6648 For an empty line "0-1" is shown.
6649 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006650 This option is reset when 'paste' is set and restored when 'paste' is
6651 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 If you don't want to see the ruler all the time but want to know where
6653 you are, use "g CTRL-G" |g_CTRL-G|.
6654 NOTE: This option is reset when 'compatible' is set.
6655
6656 *'rulerformat'* *'ruf'*
6657'rulerformat' 'ruf' string (default empty)
6658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 {not available when compiled without the |+statusline|
6660 feature}
6661 When this option is not empty, it determines the content of the ruler
6662 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006663 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006664 This option cannot be set in a modeline when 'modelineexpr' is off.
6665
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 The default ruler width is 17 characters. To make the ruler 15
6667 characters wide, put "%15(" at the start and "%)" at the end.
6668 Example: >
6669 :set rulerformat=%15(%c%V\ %p%%%)
6670<
6671 *'runtimepath'* *'rtp'* *vimfiles*
6672'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006673 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 $VIM/vimfiles,
6675 $VIMRUNTIME,
6676 $VIM/vimfiles/after,
6677 $HOME/.vim/after"
6678 Amiga: "home:vimfiles,
6679 $VIM/vimfiles,
6680 $VIMRUNTIME,
6681 $VIM/vimfiles/after,
6682 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006683 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 $VIM/vimfiles,
6685 $VIMRUNTIME,
6686 $VIM/vimfiles/after,
6687 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006688 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 $VIMRUNTIME,
6690 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006691 Haiku: "$BE_USER_SETTINGS/vim,
6692 $VIM/vimfiles,
6693 $VIMRUNTIME,
6694 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006695 $BE_USER_SETTINGS/vim/after"
6696 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 $VIM/vimfiles,
6698 $VIMRUNTIME,
6699 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006700 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 This is a list of directories which will be searched for runtime
6703 files:
6704 filetype.vim filetypes by file name |new-filetype|
6705 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006706 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 colors/ color scheme files |:colorscheme|
6708 compiler/ compiler files |:compiler|
6709 doc/ documentation |write-local-help|
6710 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006711 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 indent/ indent scripts |indent-expression|
6713 keymap/ key mapping files |mbyte-keymap|
6714 lang/ menu translations |:menutrans|
6715 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006716 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 plugin/ plugin scripts |write-plugin|
6718 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006719 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 syntax/ syntax files |mysyntaxfile|
6721 tutor/ files for vimtutor |tutor|
6722
6723 And any other file searched for with the |:runtime| command.
6724
6725 The defaults for most systems are setup to search five locations:
6726 1. In your home directory, for your personal preferences.
6727 2. In a system-wide Vim directory, for preferences from the system
6728 administrator.
6729 3. In $VIMRUNTIME, for files distributed with Vim.
6730 *after-directory*
6731 4. In the "after" directory in the system-wide Vim directory. This is
6732 for the system administrator to overrule or add to the distributed
6733 defaults (rarely needed)
6734 5. In the "after" directory in your home directory. This is for
6735 personal preferences to overrule or add to the distributed defaults
6736 or system-wide settings (rarely needed).
6737
Bram Moolenaard0796902016-09-16 20:02:31 +02006738 More entries are added when using |packages|. If it gets very long
6739 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6740 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006741
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6743 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006744 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 wildcards.
6746 See |:runtime|.
6747 Example: >
6748 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6749< This will use the directory "~/vimruntime" first (containing your
6750 personal Vim runtime files), then "/mygroup/vim" (shared between a
6751 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6752 files).
6753 You probably should always include $VIMRUNTIME somewhere, to use the
6754 distributed runtime files. You can put a directory before $VIMRUNTIME
6755 to find files which replace a distributed runtime files. You can put
6756 a directory after $VIMRUNTIME to find files which add to distributed
6757 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006758 When Vim is started with |--clean| the home directory entries are not
6759 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 This option cannot be set from a |modeline| or in the |sandbox|, for
6761 security reasons.
6762
6763 *'scroll'* *'scr'*
6764'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006765 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6767 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006768 changes. This may happen when enabling the |status-line| or
6769 'tabline' option after setting the 'scroll' option.
6770 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006772 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773
6774 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6775'scrollbind' 'scb' boolean (default off)
6776 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006777 See also |scroll-binding|. When this option is set, scrolling the
6778 current window also scrolls other scrollbind windows (windows that
6779 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 differences between two versions of a file, see 'diff'.
6781 See |'scrollopt'| for options that determine how this option should be
6782 interpreted.
6783 This option is mostly reset when splitting a window to edit another
6784 file. This means that ":split | edit file" results in two windows
6785 with scroll-binding, but ":split file" does not.
6786
Bram Moolenaarae20f342019-11-05 21:09:23 +01006787 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6788'scrollfocus' 'scf' boolean (default off)
6789 global
6790 {only for MS-Windows GUI}
6791 When using the scroll wheel and this option is set, the window under
6792 the mouse pointer is scrolled. With this option off the current
6793 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006794 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006795
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 *'scrolljump'* *'sj'*
6797'scrolljump' 'sj' number (default 1)
6798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 Minimal number of lines to scroll when the cursor gets off the
6800 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6801 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006802 When set to a negative number from -1 to -100 this is used as the
6803 percentage of the window height. Thus -50 scrolls half the window
6804 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 NOTE: This option is set to 1 when 'compatible' is set.
6806
6807 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006808'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006809 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 Minimal number of screen lines to keep above and below the cursor.
6811 This will make some context visible around where you are working. If
6812 you set it to a very large value (999) the cursor line will always be
6813 in the middle of the window (except at the start or end of the file or
6814 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006815 After using the local value, go back the global value with one of
6816 these two: >
6817 setlocal scrolloff<
6818 setlocal scrolloff=-1
6819< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 NOTE: This option is set to 0 when 'compatible' is set.
6821
6822 *'scrollopt'* *'sbo'*
6823'scrollopt' 'sbo' string (default "ver,jump")
6824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006826 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6827 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 The following words are available:
6829 ver Bind vertical scrolling for 'scrollbind' windows
6830 hor Bind horizontal scrolling for 'scrollbind' windows
6831 jump Applies to the offset between two windows for vertical
6832 scrolling. This offset is the difference in the first
6833 displayed line of the bound windows. When moving
6834 around in a window, another 'scrollbind' window may
6835 reach a position before the start or after the end of
6836 the buffer. The offset is not changed though, when
6837 moving back the 'scrollbind' window will try to scroll
6838 to the desired position when possible.
6839 When now making that window the current one, two
6840 things can be done with the relative offset:
6841 1. When "jump" is not included, the relative offset is
6842 adjusted for the scroll position in the new current
6843 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006844 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 2. When "jump" is included, the other windows are
6846 scrolled to keep the same relative offset. When
6847 going back to the other window, it still uses the
6848 same relative offset.
6849 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006850 When 'diff' mode is active there always is vertical scroll binding,
6851 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852
6853 *'sections'* *'sect'*
6854'sections' 'sect' string (default "SHNHH HUnhsh")
6855 global
6856 Specifies the nroff macros that separate sections. These are pairs of
6857 two letters (See |object-motions|). The default makes a section start
6858 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6859
6860 *'secure'* *'nosecure'* *E523*
6861'secure' boolean (default off)
6862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 When on, ":autocmd", shell and write commands are not allowed in
6864 ".vimrc" and ".exrc" in the current directory and map commands are
6865 displayed. Switch it off only if you know that you will not run into
6866 problems, or when the 'exrc' option is off. On Unix this option is
6867 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006868 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 'secure' at the end of your ~/.vimrc then.
6870 This option cannot be set from a |modeline| or in the |sandbox|, for
6871 security reasons.
6872
6873 *'selection'* *'sel'*
6874'selection' 'sel' string (default "inclusive")
6875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 This option defines the behavior of the selection. It is only used
6877 in Visual and Select mode.
6878 Possible values:
6879 value past line inclusive ~
6880 old no yes
6881 inclusive yes yes
6882 exclusive yes no
6883 "past line" means that the cursor is allowed to be positioned one
6884 character past the line.
6885 "inclusive" means that the last character of the selection is included
6886 in an operation. For example, when "x" is used to delete the
6887 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006888 When "old" is used and 'virtualedit' allows the cursor to move past
6889 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 Note that when "exclusive" is used and selecting from the end
6891 backwards, you cannot include the last character of a line, when
6892 starting in Normal mode and 'virtualedit' empty.
6893
6894 The 'selection' option is set by the |:behave| command.
6895
6896 *'selectmode'* *'slm'*
6897'selectmode' 'slm' string (default "")
6898 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006899 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 Select mode instead of Visual mode, when a selection is started.
6901 Possible values:
6902 mouse when using the mouse
6903 key when using shifted special keys
6904 cmd when using "v", "V" or CTRL-V
6905 See |Select-mode|.
6906 The 'selectmode' option is set by the |:behave| command.
6907
6908 *'sessionoptions'* *'ssop'*
6909'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006910 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006912 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 feature}
6914 Changes the effect of the |:mksession| command. It is a comma
6915 separated list of words. Each word enables saving and restoring
6916 something:
6917 word save and restore ~
6918 blank empty windows
6919 buffers hidden and unloaded buffers, not just those in windows
6920 curdir the current directory
6921 folds manually created folds, opened/closed folds and local
6922 fold options
6923 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006924 and contain at least one lowercase letter. Only
6925 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 help the help window
6927 localoptions options and mappings local to a window or buffer (not
6928 global values for local options)
6929 options all options and mappings (also global values for local
6930 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006931 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 resize size of the Vim window: 'lines' and 'columns'
6933 sesdir the directory in which the session file is located
6934 will become the current directory (useful with
6935 projects accessed over a network from different
6936 systems)
6937 slash backslashes in file names replaced with forward
6938 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006939 tabpages all tab pages; without this only the current tab page
6940 is restored, so that you can make a session for each
6941 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006942 terminal include terminal windows where the command can be
6943 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 unix with Unix end-of-line format (single <NL>), even when
6945 on Windows or DOS
6946 winpos position of the whole Vim window
6947 winsize window sizes
6948
6949 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006950 When neither "curdir" nor "sesdir" is included, file names are stored
6951 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006952 If you leave out "options" many things won't work well after restoring
6953 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 "slash" and "unix" are useful on Windows when sharing session files
6955 with Unix. The Unix version of Vim cannot source dos format scripts,
6956 but the Windows version of Vim can source unix format scripts.
6957
6958 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006959'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 global
6961 Name of the shell to use for ! and :! commands. When changing the
6962 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6963 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006964 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 See |option-backslash| about including spaces and backslashes.
6966 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006967
Bram Moolenaara2baa732022-02-04 16:09:54 +00006968 In |restricted-mode| shell commands will not be possible. This mode
6969 is used if the value of $SHELL ends in "false" or "nologin".
6970
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006971 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006972 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6974< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006975 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006977 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006979 Example with escaped space (Vim will do this when initializing the
6980 option from $SHELL): >
6981 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006982< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006983 backslashes are consumed by `:set`.
6984
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 Under MS-Windows, when the executable ends in ".com" it must be
6986 included. Thus setting the shell to "command.com" or "4dos.com"
6987 works, but "command" and "4dos" do not work for all commands (e.g.,
6988 filtering).
6989 For unknown reasons, when using "4dos.com" the current directory is
6990 changed to "C:\". To avoid this set 'shell' like this: >
6991 :set shell=command.com\ /c\ 4dos
6992< This option cannot be set from a |modeline| or in the |sandbox|, for
6993 security reasons.
6994
6995 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006996'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006997 Win32, when 'shell' contains "powershell":
6998 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006999 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007002 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7003 For MS-Windows, the default is set according to the value of 'shell',
7004 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007005 On Unix it can have more than one flag. Each white space separated
7006 part is passed as an argument to the shell command.
7007 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007008 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 This option cannot be set from a |modeline| or in the |sandbox|, for
7010 security reasons.
7011
7012 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007013'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7014 "2>&1| tee", or
7015 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 {not available when compiled without the |+quickfix|
7018 feature}
7019 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007020 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 including spaces and backslashes.
7022 The name of the temporary file can be represented by "%s" if necessary
7023 (the file name is appended automatically if no %s appears in the value
7024 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007025 For the Amiga the default is ">". For MS-Windows using powershell the
7026 default is "2>&1 | Out-File -Encoding default", otherwise the default
7027 is ">%s 2>&1". The output is directly saved in a file and not echoed
7028 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007029 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 in a file and echoed to the screen. If the 'shell' option is "csh" or
7031 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007032 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007033 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7034 means that stderr is also included. Before using the 'shell' option a
7035 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007036 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7037 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 The initialization of this option is done after reading the ".vimrc"
7039 and the other initializations, so that when the 'shell' option is set
7040 there, the 'shellpipe' option changes automatically, unless it was
7041 explicitly set before.
7042 When 'shellpipe' is set to an empty string, no redirection of the
7043 ":make" output will be done. This is useful if you use a 'makeprg'
7044 that writes to 'makeef' by itself. If you want no piping, but do
7045 want to include the 'makeef', set 'shellpipe' to a single space.
7046 Don't forget to precede the space with a backslash: ":set sp=\ ".
7047 In the future pipes may be used for filtering and this option will
7048 become obsolete (at least for Unix).
7049 This option cannot be set from a |modeline| or in the |sandbox|, for
7050 security reasons.
7051
7052 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007053'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 Quoting character(s), put around the command passed to the shell, for
7056 the "!" and ":!" commands. The redirection is kept outside of the
7057 quoting. See 'shellxquote' to include the redirection. It's
7058 probably not useful to set both options.
7059 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007060 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007061 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 This option cannot be set from a |modeline| or in the |sandbox|, for
7063 security reasons.
7064
7065 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007066'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7067 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 String to be used to put the output of a filter command in a temporary
7070 file. See also |:!|. See |option-backslash| about including spaces
7071 and backslashes.
7072 The name of the temporary file can be represented by "%s" if necessary
7073 (the file name is appended automatically if no %s appears in the value
7074 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007075 The default is ">". For Unix, if the 'shell' option is "csh" or
7076 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007077 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007078 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7079 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007080 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7081 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007082 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7083 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 The initialization of this option is done after reading the ".vimrc"
7085 and the other initializations, so that when the 'shell' option is set
7086 there, the 'shellredir' option changes automatically unless it was
7087 explicitly set before.
7088 In the future pipes may be used for filtering and this option will
7089 become obsolete (at least for Unix).
7090 This option cannot be set from a |modeline| or in the |sandbox|, for
7091 security reasons.
7092
7093 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7094'shellslash' 'ssl' boolean (default off)
7095 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007096 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007098 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007099 powershell.exe. Backward slashes can still be typed, but they are
7100 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 Note that setting or resetting this option has no effect for some
7102 existing file names, thus this option needs to be set before opening
7103 any file for best results. This might change in the future.
7104 'shellslash' only works when a backslash can be used as a path
7105 separator. To test if this is so use: >
7106 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007107< Also see 'completeslash'.
7108
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007109 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7110'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7111 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007112 When on, use temp files for shell commands. When off use a pipe.
7113 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007114 Currently a pipe is only supported on Unix and MS-Windows 2K and
7115 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007116 :if has("filterpipe")
7117< The advantage of using a pipe is that nobody can read the temp file
7118 and the 'shell' command does not need to support redirection.
7119 The advantage of using a temp file is that the file type and encoding
7120 can be detected.
7121 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7122 |FilterWritePost| autocommands event are not triggered when
7123 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007124 The `system()` function does not respect this option and always uses
7125 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007126 NOTE: This option is set to the Vim default value when 'compatible'
7127 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007128
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 *'shelltype'* *'st'*
7130'shelltype' 'st' number (default 0)
7131 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007132 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 On the Amiga this option influences the way how the commands work
7134 which use a shell.
7135 0 and 1: always use the shell
7136 2 and 3: use the shell only to filter lines
7137 4 and 5: use shell only for ':sh' command
7138 When not using the shell, the command is executed directly.
7139
7140 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7141 1 and 3: use "shell cmd" to start external commands
7142
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007143 *'shellxescape'* *'sxe'*
7144'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007145 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007146 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007147 When 'shellxquote' is set to "(" then the characters listed in this
7148 option will be escaped with a '^' character. This makes it possible
7149 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007150 This option cannot be set from a |modeline| or in the |sandbox|, for
7151 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007152
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 *'shellxquote'* *'sxq'*
7154'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007155 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007156 for Win32, when 'shell' is
7157 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007158 for Win32, when 'shell' contains "sh"
7159 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 for Unix, when using system(): "\"")
7161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 Quoting character(s), put around the command passed to the shell, for
7163 the "!" and ":!" commands. Includes the redirection. See
7164 'shellquote' to exclude the redirection. It's probably not useful
7165 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007166 When the value is '(' then ')' is appended. When the value is '"('
7167 then ')"' is appended.
7168 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007169 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007170 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7171 pwsh.exe which automatically strips off the first and last quote on a
7172 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7173 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007174 'shell', to reduce the need to set this option by the user. See
7175 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 This option cannot be set from a |modeline| or in the |sandbox|, for
7177 security reasons.
7178
7179 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7180'shiftround' 'sr' boolean (default off)
7181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 Round indent to multiple of 'shiftwidth'. Applies to > and <
7183 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7184 a multiple of 'shiftwidth' (this is Vi compatible).
7185 NOTE: This option is reset when 'compatible' is set.
7186
7187 *'shiftwidth'* *'sw'*
7188'shiftwidth' 'sw' number (default 8)
7189 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007190 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007192 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007193 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194
7195 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007196'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7197 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007198 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 This option helps to avoid all the |hit-enter| prompts caused by file
7200 messages, for example with CTRL-G, and to avoid some other messages.
7201 It is a list of flags:
7202 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007203 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7204 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7205 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7206 m use "[+]" instead of "[Modified]" *shm-m*
7207 n use "[New]" instead of "[New File]" *shm-n*
7208 r use "[RO]" instead of "[readonly]" *shm-r*
7209 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007211 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7212 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007213 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007214 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007216 o overwrite message for writing a file with subsequent *shm-o*
7217 message for reading a file (useful for ":wn" or when
7218 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007219 O message for reading a file overwrites any previous *shm-O*
7220 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007221 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7222 "search hit TOP, continuing at BOTTOM" messages; when using
7223 the search count do not show "W" after the count message (see
7224 S below)
7225 t truncate file message at the start if it is too long *shm-t*
7226 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007227 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007228 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007229 long to fit on the command line; "..." will appear in the
7230 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007231 W don't give "written" or "[w]" when writing a file *shm-W*
7232 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007233 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007234 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007235 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007236 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007237 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7238 match", "Pattern not found", "Back at original", etc.
7239 C don't give messages while scanning for ins-completion *shm-C*
7240 items, for instance "scanning tags"
7241 q use "recording" instead of "recording @a" *shm-q*
7242 F don't give the file info when editing a file, like *shm-F*
7243 `:silent` was used for the command; note that this also
7244 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007245 S do not show search count message when searching, e.g. *shm-S*
7246 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247
7248 This gives you the opportunity to avoid that a change between buffers
7249 requires you to hit <Enter>, but still gives as useful a message as
7250 possible for the space available. To get the whole message that you
7251 would have got with 'shm' empty, use ":file!"
7252 Useful values:
7253 shm= No abbreviation of message.
7254 shm=a Abbreviation, but no loss of information.
7255 shm=at Abbreviation, and truncate message when necessary.
7256
7257 NOTE: This option is set to the Vi default value when 'compatible' is
7258 set and to the Vim default value when 'compatible' is reset.
7259
7260 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7261'shortname' 'sn' boolean (default off)
7262 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 Filenames are assumed to be 8 characters plus one extension of 3
7264 characters. Multiple dots in file names are not allowed. When this
7265 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007266 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007268 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269
7270 *'showbreak'* *'sbr'* *E595*
7271'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007272 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007273 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 feature}
7275 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007276 values are "> " or "+++ ": >
7277 :set showbreak=>\
7278< Note the backslash to escape the trailing space. It's easier like
7279 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007280 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007281< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 comma (in a future version the comma might be used to separate the
7283 part that is shown at the end and at the start of a line).
7284 The characters are highlighted according to the '@' flag in
7285 'highlight'.
7286 Note that tabs after the showbreak will be displayed differently.
7287 If you want the 'showbreak' to appear in between line numbers, add the
7288 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007289 A window-local value overrules a global value. If the global value is
7290 set and you want no value in the current window use NONE: >
7291 :setlocal showbreak=NONE
7292<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007294'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7295 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007297 Show (partial) command in the last line of the screen. Set this
7298 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 In Visual mode the size of the selected area is shown:
7300 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007301 If the number of bytes is different it is also displayed: "2-6"
7302 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007304 - When selecting a block, the size in screen characters:
7305 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007306 This information can be displayed in an alternative location using the
7307 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 NOTE: This option is set to the Vi default value when 'compatible' is
7309 set and to the Vim default value when 'compatible' is reset.
7310
Luuk van Baalba936f62022-12-15 13:15:39 +00007311 *'showcmdloc'* *'sloc'*
7312'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007313 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007314 This option can be used to display the (partially) entered command in
7315 another location. Possible values are:
7316 last Last line of the screen (default).
7317 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007318 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007319 Setting this option to "statusline" or "tabline" means that these will
7320 be redrawn whenever the command changes, which can be on every key
7321 pressed.
7322 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7323 place the text. Without a custom 'statusline' or 'tabline' it will be
7324 displayed in a convenient location.
7325
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7327'showfulltag' 'sft' boolean (default off)
7328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 When completing a word in insert mode (see |ins-completion|) from the
7330 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007331 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 matched a C function, you can see a template for what arguments are
7333 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007334 Note that this doesn't work well together with having "longest" in
7335 'completeopt', because the completion from the search pattern may not
7336 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337
7338 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7339'showmatch' 'sm' boolean (default off)
7340 global
7341 When a bracket is inserted, briefly jump to the matching one. The
7342 jump is only done if the match can be seen on the screen. The time to
7343 show the match can be set with 'matchtime'.
7344 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007345 seen or not).
7346 This option is reset when 'paste' is set and restored when 'paste' is
7347 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 When the 'm' flag is not included in 'cpoptions', typing a character
7349 will immediately move the cursor back to where it belongs.
7350 See the "sm" field in 'guicursor' for setting the cursor shape and
7351 blinking when showing the match.
7352 The 'matchpairs' option can be used to specify the characters to show
7353 matches for. 'rightleft' and 'revins' are used to look for opposite
7354 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007355 Also see the matchparen plugin for highlighting the match when moving
7356 around |pi_paren.txt|.
7357 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358
7359 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7360'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7361 global
7362 If in Insert, Replace or Visual mode put a message on the last line.
7363 Use the 'M' flag in 'highlight' to set the type of highlighting for
7364 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007365 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 doesn't mean XIM is really active, especially when 'imactivatekey' is
7367 not set.
7368 NOTE: This option is set to the Vi default value when 'compatible' is
7369 set and to the Vim default value when 'compatible' is reset.
7370
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007371 *'showtabline'* *'stal'*
7372'showtabline' 'stal' number (default 1)
7373 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007374 The value of this option specifies when the line with tab page labels
7375 will be displayed:
7376 0: never
7377 1: only if there are at least two tab pages
7378 2: always
7379 This is both for the GUI and non-GUI implementation of the tab pages
7380 line.
7381 See |tab-page| for more information about tab pages.
7382
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 *'sidescroll'* *'ss'*
7384'sidescroll' 'ss' number (default 0)
7385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 The minimal number of columns to scroll horizontally. Used only when
7387 the 'wrap' option is off and the cursor is moved off of the screen.
7388 When it is zero the cursor will be put in the middle of the screen.
7389 When using a slow terminal set it to a large number or 0. When using
7390 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7391 commands.
7392
7393 *'sidescrolloff'* *'siso'*
7394'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007395 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007397 right of the cursor if 'nowrap' is set. Setting this option to a
7398 value greater than 0 while having |'sidescroll'| also at a non-zero
7399 value makes some context visible in the line you are scrolling in
7400 horizontally (except at beginning of the line). Setting this option
7401 to a large value (like 999) has the effect of keeping the cursor
7402 horizontally centered in the window, as long as one does not come too
7403 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007404 After using the local value, go back the global value with one of
7405 these two: >
7406 setlocal sidescrolloff<
7407 setlocal sidescrolloff=-1
7408< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409
7410 Example: Try this together with 'sidescroll' and 'listchars' as
7411 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007412 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413
7414 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7415 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007416<
7417 *'signcolumn'* *'scl'*
7418'signcolumn' 'scl' string (default "auto")
7419 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007420 {not available when compiled without the |+signs|
7421 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007422 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007423 "auto" only when there is a sign to display
7424 "no" never
7425 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007426 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007427 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7430'smartcase' 'scs' boolean (default off)
7431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 Override the 'ignorecase' option if the search pattern contains upper
7433 case characters. Only used when the search pattern is typed and
7434 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007435 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7437 recalling the search pattern from history and hitting <Enter>.
7438 NOTE: This option is reset when 'compatible' is set.
7439
7440 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7441'smartindent' 'si' boolean (default off)
7442 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 Do smart autoindenting when starting a new line. Works for C-like
7444 programs, but can also be used for other languages. 'cindent' does
7445 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007446 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007447 setting 'si' has no effect. 'indentexpr' is a more advanced
7448 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 Normally 'autoindent' should also be on when using 'smartindent'.
7450 An indent is automatically inserted:
7451 - After a line ending in '{'.
7452 - After a line starting with a keyword from 'cinwords'.
7453 - Before a line starting with '}' (only with the "O" command).
7454 When typing '}' as the first character in a new line, that line is
7455 given the same indent as the matching '{'.
7456 When typing '#' as the first character in a new line, the indent for
7457 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007458 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7460 When using the ">>" command, lines starting with '#' are not shifted
7461 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007462 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007463 This option is reset when 'paste' is set and restored when 'paste' is
7464 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465
7466 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7467'smarttab' 'sta' boolean (default off)
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007470 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7471 <BS> will delete a 'shiftwidth' worth of space at the start of the
7472 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007473 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007474 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7475 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007476 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007478 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007479 This option is reset when 'paste' is set and restored when 'paste' is
7480 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 NOTE: This option is reset when 'compatible' is set.
7482
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007483 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7484'smoothscroll' 'sms' boolean (default off)
7485 local to window
7486 Scrolling works with screen lines. When 'wrap' is set and the first
7487 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007488 above the window. "<<<" is displayed at the start of the first line,
7489 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007490 You may also want to add "lastline" to the 'display' option to show as
7491 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007492 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7493 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007494
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 *'softtabstop'* *'sts'*
7496'softtabstop' 'sts' number (default 0)
7497 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 Number of spaces that a <Tab> counts for while performing editing
7499 operations, like inserting a <Tab> or using <BS>. It "feels" like
7500 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7501 used. This is useful to keep the 'ts' setting at its standard value
7502 of 8, while being able to edit like it is set to 'sts'. However,
7503 commands like "x" still work on the actual characters.
7504 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007505 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007506 'softtabstop' is set to 0 when the 'paste' option is set and restored
7507 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7509 spaces is minimized by using <Tab>s.
7510 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7511 set.
7512 NOTE: This option is set to 0 when 'compatible' is set.
7513
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007514 If Vim is compiled with the |+vartabs| feature then the value of
7515 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7516 anything other than an empty string.
7517
Bram Moolenaar217ad922005-03-20 22:37:15 +00007518 *'spell'* *'nospell'*
7519'spell' boolean (default off)
7520 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007521 {not available when compiled without the |+syntax|
7522 feature}
7523 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007524 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007525
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007526 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007527'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007528 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007529 {not available when compiled without the |+syntax|
7530 feature}
7531 Pattern to locate the end of a sentence. The following word will be
7532 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007533 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007534 When this check is not wanted make this option empty.
7535 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007536 Be careful with special characters, see |option-backslash| about
7537 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007538 To set this option automatically depending on the language, see
7539 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007540
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007541 *'spellfile'* *'spf'*
7542'spellfile' 'spf' string (default empty)
7543 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007544 {not available when compiled without the |+syntax|
7545 feature}
7546 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007547 commands. It must end in ".{encoding}.add". You need to include the
7548 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007549 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007550 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007551 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007552 |zg| and |zw| commands can be used to access each. This allows using
7553 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007554 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007555 you: Using the first directory in 'runtimepath' that is writable. If
7556 there is no "spell" directory yet it will be created. For the file
7557 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007558 ignoring the region.
7559 The resulting ".spl" file will be used for spell checking, it does not
7560 have to appear in 'spelllang'.
7561 Normally one file is used for all regions, but you can add the region
7562 name if you want to. However, it will then only be used when
7563 'spellfile' is set to it, for entries in 'spelllang' only files
7564 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007565 This option cannot be set from a |modeline| or in the |sandbox|, for
7566 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007567
Bram Moolenaar217ad922005-03-20 22:37:15 +00007568 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007569'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007570 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007571 {not available when compiled without the |+syntax|
7572 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007573 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007574 on spellchecking will be done for these languages. Example: >
7575 set spelllang=en_us,nl,medical
7576< This means US English, Dutch and medical words are recognized. Words
7577 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007578 The word list name must consist of alphanumeric characters, a dash or
7579 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007580 recommended to separate the two letter language name from a
7581 specification. Thus "en-rare" is used for rare English words.
7582 A region name must come last and have the form "_xx", where "xx" is
7583 the two-letter, lower case region name. You can use more than one
7584 region by listing them: "en_us,en_ca" supports both US and Canadian
7585 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007586 Britain. (Note: currently en_au and en_nz dictionaries are older than
7587 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007588 If the name "cjk" is included East Asian characters are excluded from
7589 spell checking. This is useful when editing text that also has Asian
7590 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007591 Note that the "medical" dictionary does not exist, it is just an
7592 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007593 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007594 As a special case the name of a .spl file can be given as-is. The
7595 first "_xx" in the name is removed and used as the region name
7596 (_xx is an underscore, two letters and followed by a non-letter).
7597 This is mainly for testing purposes. You must make sure the correct
7598 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007599 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007600 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7601 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007602 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007603
Bram Moolenaar98692072006-02-04 00:57:42 +00007604 If the |spellfile.vim| plugin is active and you use a language name
7605 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7606 will ask you if you want to download the file.
7607
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007608 After this option has been set successfully, Vim will source the files
7609 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007610 up to the first character that is not an ASCII letter or number and
7611 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007612
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007613 *'spelloptions'* *'spo'*
7614'spelloptions' 'spo' string (default "")
7615 local to buffer
7616 {not available when compiled without the |+syntax|
7617 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007618 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007619 camel When a word is CamelCased, assume "Cased" is a
7620 separate word: every upper-case character in a word
7621 that comes after a lower case character indicates the
7622 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007623
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007624 *'spellsuggest'* *'sps'*
7625'spellsuggest' 'sps' string (default "best")
7626 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007627 {not available when compiled without the |+syntax|
7628 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007629 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007630 the |spellsuggest()| function. This is a comma-separated list of
7631 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007632
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007633 best Internal method that works best for English. Finds
7634 changes like "fast" and uses a bit of sound-a-like
7635 scoring to improve the ordering.
7636
7637 double Internal method that uses two methods and mixes the
7638 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007639 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007640 word. That only works when the language specifies
7641 sound folding. Can be slow and doesn't always give
7642 better results.
7643
7644 fast Internal method that only checks for simple changes:
7645 character inserts/deletes/swaps. Works well for
7646 simple typing mistakes.
7647
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007648 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007649 Not used for |spellsuggest()|. The number of
7650 suggestions is never more than the value of 'lines'
7651 minus two.
7652
Bram Moolenaar585ee072022-01-29 11:22:17 +00007653 timeout:{millisec} Limit the time searching for suggestions to
7654 {millisec} milli seconds. Applies to the following
7655 methods. When omitted the limit is 5000. When
7656 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007657 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007658
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007659 file:{filename} Read file {filename}, which must have two columns,
7660 separated by a slash. The first column contains the
7661 bad word, the second column the suggested good word.
7662 Example:
7663 theribal/terrible ~
7664 Use this for common mistakes that do not appear at the
7665 top of the suggestion list with the internal methods.
7666 Lines without a slash are ignored, use this for
7667 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007668 The word in the second column must be correct,
7669 otherwise it will not be used. Add the word to an
7670 ".add" file if it is currently flagged as a spelling
7671 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007672 The file is used for all languages.
7673
7674 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007675 trouble with spaces. Best is to call a function
7676 without arguments, see |expr-option-function|.
7677 |v:val| holds the badly spelled word. The expression
7678 must evaluate to a List of Lists, each with a
7679 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007680 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007681 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007682 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007683 internal methods use. A lower score is better.
7684 This may invoke |spellsuggest()| if you temporarily
7685 set 'spellsuggest' to exclude the "expr:" part.
7686 Errors are silently ignored, unless you set the
7687 'verbose' option to a non-zero value.
7688
7689 Only one of "best", "double" or "fast" may be used. The others may
7690 appear several times in any order. Example: >
7691 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7692<
7693 This option cannot be set from a |modeline| or in the |sandbox|, for
7694 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007695
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7697'splitbelow' 'sb' boolean (default off)
7698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 When on, splitting a window will put the new window below the current
7700 one. |:split|
7701
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007702 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007703'splitkeep' 'spk' string (default "cursor")
7704 global
7705 The value of this option determines the scroll behavior when opening,
7706 closing or resizing horizontal splits.
7707
7708 Possible values are:
7709 cursor Keep the same relative cursor position.
7710 screen Keep the text on the same screen line.
7711 topline Keep the topline the same.
7712
7713 For the "screen" and "topline" values, the cursor position will be
7714 changed when necessary. In this case, the jumplist will be populated
7715 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007716 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007717
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7719'splitright' 'spr' boolean (default off)
7720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 When on, splitting a window will put the new window right of the
7722 current one. |:vsplit|
7723
7724 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7725'startofline' 'sol' boolean (default on)
7726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007728 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007729 (if possible). This applies to the commands:
7730 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7731 - "d", "<<" and ">>" with a linewise operator
7732 - "%" with a count
7733 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7734 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 In case of buffer changing commands the cursor is placed at the column
7736 where it was the last time the buffer was edited.
7737 NOTE: This option is set when 'compatible' is set.
7738
Bram Moolenaar00654022011-02-25 14:42:19 +01007739 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007741 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 {not available when compiled without the |+statusline|
7743 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007744 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 Also see |status-line|.
7746
7747 The option consists of printf style '%' items interspersed with
7748 normal text. Each status line item is of the form:
7749 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007750 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007751 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752
Bram Moolenaar238a5642006-02-21 22:12:05 +00007753 When the option starts with "%!" then it is used as an expression,
7754 evaluated and the result is used as the option value. Example: >
7755 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007756< The *g:statusline_winid* variable will be set to the |window-ID| of the
7757 window that the status line belongs to.
7758 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007759 Note that the "%!" expression is evaluated in the context of the
7760 current window and buffer, while %{} items are evaluated in the
7761 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007762
7763 When there is error while evaluating the option then it will be made
7764 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007765 When the result contains unprintable characters the result is
7766 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007767
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 Note that the only effect of 'ruler' when this option is set (and
7769 'laststatus' is 2) is controlling the output of |CTRL-G|.
7770
7771 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007772 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007774 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 minwid Minimum width of the item, padding as set by '-' & '0'.
7776 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007777 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 on the left for text items. Numeric items will be
7779 shifted down to maxwid-2 digits followed by '>'number
7780 where number is the amount of missing digits, much like
7781 an exponential notation.
7782 item A one letter code as described below.
7783
7784 Following is a description of the possible statusline items. The
7785 second character in "item" is the type:
7786 N for number
7787 S for string
7788 F for flags as described below
7789 - not applicable
7790
7791 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007792 f S Path to the file in the buffer, as typed or relative to current
7793 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 F S Full path to the file in the buffer.
7795 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007796 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007798 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007800 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007802 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007804 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007806 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7808 being used: "<keymap>"
7809 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007810 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 B N As above, in hexadecimal.
7812 o N Byte number in file of byte under cursor, first byte is 1.
7813 Mnemonic: Offset from start of file (with one added)
7814 {not available when compiled without |+byte_offset| feature}
7815 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007816 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 l N Line number.
7818 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007819 c N Column number (byte index).
7820 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007821 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 p N Percentage through file in lines as in |CTRL-G|.
7823 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007824 percentage described for 'ruler'. Always 3 in length, unless
7825 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007826 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007827 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007829 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007830 Note that there is no '%' before the closing '}'. The
7831 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007832 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007833 {% - This is almost same as { except the result of the expression is
7834 re-evaluated as a statusline format string. Thus if the
7835 return value of expr contains % items they will get expanded.
7836 The expression can contain the } character, the end of
7837 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007838 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007839 func! Stl_filename() abort
7840 return "%t"
7841 endfunc
7842< `stl=%{Stl_filename()}` results in `"%t"`
7843 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007844 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 ( - Start of item group. Can be used for setting the width and
7846 alignment of a section. Must be followed by %) somewhere.
7847 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007848 T N For 'tabline': start of tab page N label. Use %T after the last
7849 label. This information is used for mouse clicks.
7850 X N For 'tabline': start of close tab N label. Use %X after the
7851 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7852 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 < - Where to truncate line if too long. Default is at the start.
7854 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007855 = - Separation point between alignment sections. Each section will
7856 be separated by an equal number of spaces. With one %= what
7857 comes after it will be right-aligned. With two %= there is a
7858 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007860 # - Set highlight group. The name must follow and then a # again.
7861 Thus use %#HLname# for highlight group HLname. The same
7862 highlighting is used, also for the statusline of non-current
7863 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007865 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007866 The difference between User{N} and StatusLine will be applied to
7867 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 The number N must be between 1 and 9. See |hl-User1..9|
7869
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007870 When displaying a flag, Vim removes the leading comma, if any, when
7871 that flag comes right after plaintext. This will make a nice display
7872 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873
Bram Moolenaar582fd852005-03-28 20:58:01 +00007874 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 not set) and a minwid is not set for the group, the whole group will
7876 become empty. This will make a group like the following disappear
7877 completely from the statusline when none of the flags are set. >
7878 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007879< Beware that an expression is evaluated each and every time the status
7880 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007881 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007882 While evaluating %{} the current buffer and current window will be set
7883 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007884 currently being drawn. The expression will evaluate in this context.
7885 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7886 real current buffer and "g:actual_curwin" to the |window-ID| of the
7887 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007888
Bram Moolenaar30b65812012-07-12 22:01:11 +02007889 The 'statusline' option will be evaluated in the |sandbox| if set from
7890 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007891 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007892
7893 It is not allowed to change text or jump to another window while
7894 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895
7896 If the statusline is not updated when you want it (e.g., after setting
7897 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007898 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007900 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 Otherwise the result is taken as flag text and applied to the rules
7902 described above.
7903
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007904 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007906 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907
7908 Examples:
7909 Emulate standard status line with 'ruler' set >
7910 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7911< Similar, but add ASCII value of char under the cursor (like "ga") >
7912 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7913< Display byte count and byte value, modified flag in red. >
7914 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7915 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7916< Display a ,GZ flag if a compressed file is loaded >
7917 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7918< In the |:autocmd|'s: >
7919 :let b:gzflag = 1
7920< And: >
7921 :unlet b:gzflag
7922< And define this function: >
7923 :function VarExists(var, val)
7924 : if exists(a:var) | return a:val | else | return '' | endif
7925 :endfunction
7926<
7927 *'suffixes'* *'su'*
7928'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 Files with these suffixes get a lower priority when multiple files
7931 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007932 suffixes. Spaces after the comma are ignored. A dot is also seen as
7933 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 separator, precede it with a backslash (see |option-backslash| about
7935 including spaces and backslashes).
7936 See 'wildignore' for completely ignoring files.
7937 The use of |:set+=| and |:set-=| is preferred when adding or removing
7938 suffixes from the list. This avoids problems when a future version
7939 uses another default.
7940
7941 *'suffixesadd'* *'sua'*
7942'suffixesadd' 'sua' string (default "")
7943 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007944 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 file for the "gf", "[I", etc. commands. Example: >
7946 :set suffixesadd=.java
7947<
7948 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7949'swapfile' 'swf' boolean (default on)
7950 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007951 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 swapfile is not wanted for a specific buffer. For example, with
7953 confidential information that even root must not be able to access.
7954 Careful: All text will be in memory:
7955 - Don't use this for big files.
7956 - Recovery will be impossible!
7957 A swapfile will only be present when |'updatecount'| is non-zero and
7958 'swapfile' is set.
7959 When 'swapfile' is reset, the swap file for the current buffer is
7960 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7961 non-zero, a swap file is immediately created.
7962 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007963 If you want to open a new buffer without creating a swap file for it,
7964 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007965 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966
7967 This option is used together with 'bufhidden' and 'buftype' to
7968 specify special kinds of buffers. See |special-buffers|.
7969
7970 *'swapsync'* *'sws'*
7971'swapsync' 'sws' string (default "fsync")
7972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007974 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 When this option is empty parts of the swap file may be in memory and
7976 not written to disk. When the system crashes you may lose more work.
7977 On Unix the system does a sync now and then without Vim asking for it,
7978 so the disadvantage of setting this option off is small. On some
7979 systems the swap file will not be written at all. For a unix system
7980 setting it to "sync" will use the sync() call instead of the default
7981 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007982 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983
7984 *'switchbuf'* *'swb'*
7985'switchbuf' 'swb' string (default "")
7986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007988 This option is checked, when
7989 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09007990 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007991 - jumping to a tag using the |:stag| command.
7992 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
7993 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
7994 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007995 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007996 useopen If included, jump to the first open window in the
7997 current tab page that contains the specified buffer
7998 (if there is one). Otherwise: Do not examine other
7999 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008000 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008001 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008003 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008004 Otherwise: do not split, use current window (when used
8005 in the quickfix window: the previously used window or
8006 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008007 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008008 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008009 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008010 uselast If included, jump to the previously used window when
8011 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008013 *'synmaxcol'* *'smc'*
8014'synmaxcol' 'smc' number (default 3000)
8015 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008016 {not available when compiled without the |+syntax|
8017 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008018 Maximum column in which to search for syntax items. In long lines the
8019 text after this column is not highlighted and following lines may not
8020 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008021 This helps to avoid very slow redrawing for an XML file that is one
8022 long line.
8023 Set to zero to remove the limit.
8024
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 *'syntax'* *'syn'*
8026'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008027 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 {not available when compiled without the |+syntax|
8029 feature}
8030 When this option is set, the syntax with this name is loaded, unless
8031 syntax highlighting has been switched off with ":syntax off".
8032 Otherwise this option does not always reflect the current syntax (the
8033 b:current_syntax variable does).
8034 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008035 not automatically recognized. Example, in an IDL file:
8036 /* vim: set syntax=idl : */ ~
8037 When a dot appears in the value then this separates two filetype
8038 names. Example:
8039 /* vim: set syntax=c.doxygen : */ ~
8040 This will use the "c" syntax first, then the "doxygen" syntax.
8041 Note that the second one must be prepared to be loaded as an addition,
8042 otherwise it will be skipped. More than one dot may appear.
8043 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 :set syntax=OFF
8045< To switch syntax highlighting on according to the current value of the
8046 'filetype' option: >
8047 :set syntax=ON
8048< What actually happens when setting the 'syntax' option is that the
8049 Syntax autocommand event is triggered with the value as argument.
8050 This option is not copied to another buffer, independent of the 's' or
8051 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008052 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008054 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008055'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008056 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008057 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008058 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008059 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008060
8061 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008062 option and only when there is no GUI tab line. When 'e' is in
8063 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008064 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008065
8066 The value is evaluated like with 'statusline'. You can use
8067 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008068 the text to be displayed. Use "%1T" for the first label, "%2T" for
8069 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008070
Bram Moolenaare12bab32019-01-08 22:02:56 +01008071 When changing something that is used in 'tabline' that does not
8072 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008073 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008074
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008075 Keep in mind that only one of the tab pages is the current one, others
8076 are invisible and you can't jump to their windows.
8077
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008078 *'tabpagemax'* *'tpm'*
8079'tabpagemax' 'tpm' number (default 10)
8080 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008081 Maximum number of tab pages to be opened by the |-p| command line
8082 argument or the ":tab all" command. |tabpage|
8083
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008084 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085'tabstop' 'ts' number (default 8)
8086 local to buffer
8087 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008088 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089
8090 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008091 appear wrong in many places, e.g., when printing it.
8092 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093
8094 There are four main ways to use tabs in Vim:
8095 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8096 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008097 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008099 This is the recommended way, the file will look the same with other
8100 tools and when listing it in a terminal.
8101 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8102 'expandtab'. This way you will always insert spaces. The
8103 formatting will never be messed up when 'tabstop' is changed (leave
8104 it at 8 just in case). The file will be a bit larger.
8105 You do need to check if no Tabs exist in the file. You can get rid
8106 of them by first setting 'expandtab' and using `%retab!`, making
8107 sure the value of 'tabstop' is set correctly.
8108 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 'expandtab'. This way you will always insert spaces. The
8110 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008111 You do need to check if no Tabs exist in the file, just like in the
8112 item just above.
8113 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008114 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008115 works when using Vim to edit the file, other tools assume a tabstop
8116 is worth 8 spaces.
8117 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 'noexpandtab'. This should then work (for initial indents only)
8119 for any tabstop setting that people use. It might be nice to have
8120 tabs after the first non-blank inserted as spaces if you do this
8121 though. Otherwise aligned comments will be wrong when 'tabstop' is
8122 changed.
8123
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008124 If Vim is compiled with the |+vartabs| feature then the value of
8125 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8126 than an empty string.
8127
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8129'tagbsearch' 'tbs' boolean (default on)
8130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008132 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 searching makes searching for a tag a LOT faster, but a linear search
8134 will find more tags if the tags file wasn't properly sorted.
8135 Vim normally assumes that your tags files are sorted, or indicate that
8136 they are not sorted. Only when this is not the case does the
8137 'tagbsearch' option need to be switched off.
8138
8139 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008140 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 certain files, or retry all files with a linear search. When
8142 'tagbsearch' is off, only a linear search is done.
8143
8144 Linear searching is done anyway, for one file, when Vim finds a line
8145 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008146 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147< [The whitespace before and after the '0' must be a single <Tab>]
8148
8149 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008150 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 instead of a normal tag name, a retry is done with a linear search.
8152 Tags in unsorted tags files, and matches with different case will only
8153 be found in the retry.
8154
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008155 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008156 linear search can be avoided when case is ignored. Use a value of '2'
8157 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8158 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008159 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8160 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8161 used for this as well. Note that case must be folded to uppercase for
8162 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008163
8164 By default, tag searches are case-sensitive. Case is ignored when
8165 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8166 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008167 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8168 'tagcase' is "smart", and the pattern contains only lowercase
8169 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170
8171 When 'tagbsearch' is off, tags searching is slower when a full match
8172 exists, but faster when no full match exists. Tags in unsorted tags
8173 files may only be found with 'tagbsearch' off.
8174 When the tags file is not sorted, or sorted in a wrong way (not on
8175 ASCII byte value), 'tagbsearch' should be off, or the line given above
8176 must be included in the tags file.
8177 This option doesn't affect commands that find all matching tags (e.g.,
8178 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008180 *'tagcase'* *'tc'*
8181'tagcase' 'tc' string (default "followic")
8182 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008183 This option specifies how case is handled when searching the tags
8184 file:
8185 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008186 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008187 ignore Ignore case
8188 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008189 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008190 NOTE: This option is set to the Vi default value when 'compatible' is
8191 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008192
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008193 *'tagfunc'* *'tfu'*
8194'tagfunc' 'tfu' string (default: empty)
8195 local to buffer
8196 {not available when compiled without the |+eval|
8197 feature}
8198 This option specifies a function to be used to perform tag searches.
8199 The function gets the tag pattern and should return a List of matching
8200 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008201 function and an example. The value can be the name of a function, a
8202 |lambda| or a |Funcref|. See |option-value-function| for more
8203 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008204 This option cannot be set from a |modeline| or in the |sandbox|, for
8205 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008206
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 *'taglength'* *'tl'*
8208'taglength' 'tl' number (default 0)
8209 global
8210 If non-zero, tags are significant up to this number of characters.
8211
8212 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8213'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8214 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008215 If on and using a tags file in another directory, file names in that
8216 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 NOTE: This option is set to the Vi default value when 'compatible' is
8218 set and to the Vim default value when 'compatible' is reset.
8219
8220 *'tags'* *'tag'* *E433*
8221'tags' 'tag' string (default "./tags,tags", when compiled with
8222 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8223 global or local to buffer |global-local|
8224 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008225 include a space or comma in a file name, precede it with backslashes
8226 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 When a file name starts with "./", the '.' is replaced with the path
8228 of the current file. But only when the 'd' flag is not included in
8229 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8230 |tags-option|.
8231 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008232 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8233 find all files named "tags" below "/lib". The filename itself cannot
8234 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008235 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008236 The |tagfiles()| function can be used to get a list of the file names
8237 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8239 files are also supported. They are automatically recognized. The
8240 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8241 differences are ignored (MS-Windows). |emacs-tags|
8242 The use of |:set+=| and |:set-=| is preferred when adding or removing
8243 file names from the list. This avoids problems when a future version
8244 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245
8246 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8247'tagstack' 'tgst' boolean (default on)
8248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 When on, the |tagstack| is used normally. When off, a ":tag" or
8250 ":tselect" command with an argument will not push the tag onto the
8251 tagstack. A following ":tag" without an argument, a ":pop" command or
8252 any other command that uses the tagstack will use the unmodified
8253 tagstack, but does change the pointer to the active entry.
8254 Resetting this option is useful when using a ":tag" command in a
8255 mapping which should not change the tagstack.
8256
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008257 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008258'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008259 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008260 {only available when compiled with the |+tcl/dyn|
8261 feature}
8262 Specifies the name of the Tcl shared library. The default is
8263 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008264 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008265 This option cannot be set from a |modeline| or in the |sandbox|, for
8266 security reasons.
8267
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 *'term'* *E529* *E530* *E531*
8269'term' string (default is $TERM, if that fails:
8270 in the GUI: "builtin_gui"
8271 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008272 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 on Unix: "ansi"
8275 on VMS: "ansi"
8276 on Win 32: "win32")
8277 global
8278 Name of the terminal. Used for choosing the terminal control
8279 characters. Environment variables are expanded |:set_env|.
8280 For example: >
8281 :set term=$TERM
8282< See |termcap|.
8283
8284 *'termbidi'* *'tbidi'*
8285 *'notermbidi'* *'notbidi'*
8286'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 {only available when compiled with the |+arabic|
8289 feature}
8290 The terminal is in charge of Bi-directionality of text (as specified
8291 by Unicode). The terminal is also expected to do the required shaping
8292 that some languages (such as Arabic) require.
8293 Setting this option implies that 'rightleft' will not be set when
8294 'arabic' is set and the value of 'arabicshape' will be ignored.
8295 Note that setting 'termbidi' has the immediate effect that
8296 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8297 This option is reset when the GUI is started.
8298 For further details see |arabic.txt|.
8299
8300 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008301'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 Encoding used for the terminal. This specifies what character
8304 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008305 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008306 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008307 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008308 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8310 Any attempts to set a different value will be rejected, and an error
8311 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008312 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 because the Win32 system always passes Unicode characters.
8314 When empty, the same encoding is used as for the 'encoding' option.
8315 This is the normal value.
8316 Not all combinations for 'termencoding' and 'encoding' are valid. See
8317 |encoding-table|.
8318 The value for this option must be supported by internal conversions or
8319 iconv(). When this is not possible no conversion will be done and you
8320 will probably experience problems with non-ASCII characters.
8321 Example: You are working with the locale set to euc-jp (Japanese) and
8322 want to edit a UTF-8 file: >
8323 :let &termencoding = &encoding
8324 :set encoding=utf-8
8325< You need to do this when your system has no locale support for UTF-8.
8326
Bram Moolenaar938ae282023-02-20 20:44:55 +00008327 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008328'termguicolors' 'tgc' boolean (default off)
8329 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008330 {not available when compiled without the
8331 |+termguicolors| feature}
8332 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008333 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008334
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008335 Requires a ISO-8613-3 compatible terminal. If setting this option
8336 does not work (produces a colorless UI) reading |xterm-true-color|
8337 might help.
8338
8339 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8340 is required. Use this check to find out: >
8341 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008342< This requires Vim to be built with the |+vtp| feature.
8343
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008344 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008345
8346 When using Vim with Windows Terminal, the background of Windows
8347 Terminal is normally filled with the Vim background color. Setting
8348 'termguicolors' and the guibg of the Normal highlight group to NONE
8349 will make the background transparent: >
8350 :hi Normal guibg=NONE
8351<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008352 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008353
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008354 *'termwinkey'* *'twk'*
8355'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008356 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008357 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008358 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008359 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008360 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008361< The string must be one key stroke but can be multiple bytes.
8362 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008363 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008364 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008365
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008366 *'termwinscroll'* *'twsl'*
8367'termwinscroll' 'twsl' number (default 10000)
8368 local to buffer
8369 {not available when compiled without the
8370 |+terminal| feature}
8371 Number of scrollback lines to keep. When going over this limit the
8372 first 10% of the scrollback lines are deleted. This is just to reduce
8373 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008374 Also used as a limit for text sent to the terminal in one write,
8375 multiplied by the number of columns times 3 (average number of bytes
8376 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008377
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008378 *'termwinsize'* *'tws'*
8379'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008380 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008381 Size used when opening the |terminal| window. Format:
8382 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008383 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008384 - When set with a "x" (e.g., "24x80") the terminal size is not
8385 adjusted to the window size. If the window is smaller only the
8386 top-left part is displayed.
8387 - When set with a "*" (e.g., "10*50") the terminal size follows the
8388 window size, but will not be smaller than the specified rows and/or
8389 columns.
8390 - When rows is zero then use the height of the window.
8391 - When columns is zero then use the width of the window.
8392 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008393 - Can be overruled in the |term_start()| options with "term_rows" and
8394 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008395
8396 Examples:
8397 "30x0" uses 30 rows and the current window width.
8398 "20*0" uses at least 20 rows and the current window width.
8399 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008400 Note that the command running in the terminal window may still change
8401 the size of the terminal. In that case the Vim window will be
8402 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008403
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008404 *'termwintype'* *'twt'*
8405'termwintype' 'twt' string (default "")
8406 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008407 {only available when compiled with the |terminal|
8408 feature on MS-Windows}
8409 Specify the virtual console (pty) used when opening the terminal
8410 window.
8411
8412 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008413 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008414 "winpty" use winpty, fail if not supported
8415 "conpty" use |ConPTY|, fail if not supported
8416
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008417 |ConPTY| support depends on the platform. Windows 10 October 2018
8418 Update is the first version that supports ConPTY, however it is still
8419 considered unstable. ConPTY might become stable in the next release
8420 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008421 supported then you cannot open a terminal window.
8422
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 *'terse'* *'noterse'*
8424'terse' boolean (default off)
8425 global
8426 When set: Add 's' flag to 'shortmess' option (this makes the message
8427 for a search that hits the start or end of the file not being
8428 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8429 shortens a lot of messages}
8430
8431 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8432'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 This option is obsolete. Use 'fileformats'.
8435 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8436 set to the default value for the current system. When 'textauto' is
8437 reset, 'fileformats' is made empty.
8438 NOTE: This option is set to the Vi default value when 'compatible' is
8439 set and to the Vim default value when 'compatible' is reset.
8440
8441 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008442'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 others: default off)
8444 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 This option is obsolete. Use 'fileformat'.
8446 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8447 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8448 "unix".
8449
8450 *'textwidth'* *'tw'*
8451'textwidth' 'tw' number (default 0)
8452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 Maximum width of text that is being inserted. A longer line will be
8454 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008455 this.
8456 'textwidth' is set to 0 when the 'paste' option is set and restored
8457 when 'paste' is reset.
8458 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008460 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 NOTE: This option is set to 0 when 'compatible' is set.
8462
8463 *'thesaurus'* *'tsr'*
8464'thesaurus' 'tsr' string (default "")
8465 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008467 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8468 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008469
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008470 This option is not used if 'thesaurusfunc' is set, either for the
8471 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008472
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008473 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008475 name. See |option-backslash| about using backslashes. The use of
8476 |:set+=| and |:set-=| is preferred when adding or removing directories
8477 from the list. This avoids problems when a future version uses
8478 another default. Backticks cannot be used in this option for security
8479 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008481 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008482'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008483 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008484 {not available when compiled without the |+eval|
8485 feature}
8486 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008487 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008488 The value can be the name of a function, a |lambda| or a |Funcref|.
8489 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008490
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008491 This option cannot be set from a |modeline| or in the |sandbox|, for
8492 security reasons.
8493
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8495'tildeop' 'top' boolean (default off)
8496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 When on: The tilde command "~" behaves like an operator.
8498 NOTE: This option is reset when 'compatible' is set.
8499
8500 *'timeout'* *'to'* *'notimeout'* *'noto'*
8501'timeout' 'to' boolean (default on)
8502 global
laburnumT3f7855a2023-12-05 18:37:03 +01008503
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008505'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 These two options together determine the behavior when part of a
8508 mapped key sequence or keyboard code has been received:
8509
8510 'timeout' 'ttimeout' action ~
8511 off off do not time out
8512 on on or off time out on :mappings and key codes
8513 off on time out on key codes
8514
8515 If both options are off, Vim will wait until either the complete
8516 mapping or key sequence has been received, or it is clear that there
8517 is no mapping or key sequence for the received characters. For
8518 example: if you have mapped "vl" and Vim has received 'v', the next
8519 character is needed to see if the 'v' is followed by an 'l'.
8520 When one of the options is on, Vim will wait for about 1 second for
8521 the next character to arrive. After that the already received
8522 characters are interpreted as single characters. The waiting time can
8523 be changed with the 'timeoutlen' option.
8524 On slow terminals or very busy systems timing out may cause
8525 malfunctioning cursor keys. If both options are off, Vim waits
8526 forever after an entered <Esc> if there are key codes that start
8527 with <Esc>. You will have to type <Esc> twice. If you do not have
8528 problems with key codes, but would like to have :mapped key
8529 sequences not timing out in 1 second, set the 'ttimeout' option and
8530 reset the 'timeout' option.
8531
8532 NOTE: 'ttimeout' is reset when 'compatible' is set.
8533
8534 *'timeoutlen'* *'tm'*
8535'timeoutlen' 'tm' number (default 1000)
8536 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008537
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008539'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 The time in milliseconds that is waited for a key code or mapped key
8542 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8543 when part of a command has been typed.
8544 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8545 different timeout value for key codes is desired set 'ttimeoutlen' to
8546 a non-negative number.
8547
8548 ttimeoutlen mapping delay key code delay ~
8549 < 0 'timeoutlen' 'timeoutlen'
8550 >= 0 'timeoutlen' 'ttimeoutlen'
8551
8552 The timeout only happens when the 'timeout' and 'ttimeout' options
8553 tell so. A useful setting would be >
8554 :set timeout timeoutlen=3000 ttimeoutlen=100
8555< (time out on mapping after three seconds, time out on key codes after
8556 a tenth of a second).
8557
8558 *'title'* *'notitle'*
8559'title' boolean (default off, on when title can be restored)
8560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 When on, the title of the window will be set to the value of
8562 'titlestring' (if it is not empty), or to:
8563 filename [+=-] (path) - VIM
8564 Where:
8565 filename the name of the file being edited
8566 - indicates the file cannot be modified, 'ma' off
8567 + indicates the file was modified
8568 = indicates the file is read-only
8569 =+ indicates the file is read-only and modified
8570 (path) is the path of the file being edited
8571 - VIM the server name |v:servername| or "VIM"
8572 Only works if the terminal supports setting window titles
8573 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008574 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8576 *X11*
8577 When Vim was compiled with HAVE_X11 defined, the original title will
8578 be restored if possible. The output of ":version" will include "+X11"
8579 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8580 works for the icon name |'icon'|.
8581 But: When Vim was started with the |-X| argument, restoring the title
8582 will not work (except in the GUI).
8583 If the title cannot be restored, it is set to the value of 'titleold'.
8584 You might want to restore the title outside of Vim then.
8585 When using an xterm from a remote machine you can use this command:
8586 rsh machine_name xterm -display $DISPLAY &
8587 then the WINDOWID environment variable should be inherited and the
8588 title of the window should change back to what it should be after
8589 exiting Vim.
8590
8591 *'titlelen'*
8592'titlelen' number (default 85)
8593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008595 title. When the title is longer, only the end of the path name is
8596 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 Using a percentage makes this adapt to the width of the window. But
8598 it won't work perfectly, because the actual number of characters
8599 available also depends on the font used and other things in the title
8600 bar. When 'titlelen' is zero the full path is used. Otherwise,
8601 values from 1 to 30000 percent can be used.
8602 'titlelen' is also used for the 'titlestring' option.
8603
8604 *'titleold'*
8605'titleold' string (default "Thanks for flying Vim")
8606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 This option will be used for the window title when exiting Vim if the
8608 original title cannot be restored. Only happens if 'title' is on or
8609 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008610 This option cannot be set from a |modeline| or in the |sandbox|, for
8611 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 *'titlestring'*
8613'titlestring' string (default "")
8614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 When this option is not empty, it will be used for the title of the
8616 window. This happens only when the 'title' option is on.
8617 Only works if the terminal supports setting window titles (currently
8618 Amiga console, Win32 console, all GUI versions and terminals with a
8619 non-empty 't_ts' option).
8620 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008621 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008622
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 When this option contains printf-style '%' items, they will be
8624 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008625 This option cannot be set in a modeline when 'modelineexpr' is off.
8626
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008628 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8630< The value of 'titlelen' is used to align items in the middle or right
8631 of the available space.
8632 Some people prefer to have the file name first: >
8633 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8634< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008635 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 separating space only when needed.
8637 NOTE: Use of special characters in 'titlestring' may cause the display
8638 to be garbled (e.g., when it contains a CR or NL character).
8639 {not available when compiled without the |+statusline| feature}
8640
8641 *'toolbar'* *'tb'*
8642'toolbar' 'tb' string (default "icons,tooltips")
8643 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008644 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008645 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 possible values are:
8647 icons Toolbar buttons are shown with icons.
8648 text Toolbar buttons shown with text.
8649 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008650 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 tooltips Tooltips are active for toolbar buttons.
8652 Tooltips refer to the popup help text which appears after the mouse
8653 cursor is placed over a toolbar button for a brief moment.
8654
8655 If you want the toolbar to be shown with icons as well as text, do the
8656 following: >
8657 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008658< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 will show icons if both are requested.
8660
8661 If none of the strings specified in 'toolbar' are valid or if
8662 'toolbar' is empty, this option is ignored. If you want to disable
8663 the toolbar, you need to set the 'guioptions' option. For example: >
8664 :set guioptions-=T
8665< Also see |gui-toolbar|.
8666
8667 *'toolbariconsize'* *'tbis'*
8668'toolbariconsize' 'tbis' string (default "small")
8669 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008670 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008672 tiny Use tiny icons.
8673 small Use small icons (default).
8674 medium Use medium-sized icons.
8675 large Use large icons.
8676 huge Use even larger icons.
8677 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008679 the current theme. Common dimensions are giant=48x48, huge=32x32,
8680 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681
8682 If 'toolbariconsize' is empty, the global default size as determined
8683 by user preferences or the current theme is used.
8684
8685 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8686'ttybuiltin' 'tbi' boolean (default on)
8687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 When on, the builtin termcaps are searched before the external ones.
8689 When off the builtin termcaps are searched after the external ones.
8690 When this option is changed, you should set the 'term' option next for
8691 the change to take effect, for example: >
8692 :set notbi term=$TERM
8693< See also |termcap|.
8694 Rationale: The default for this option is "on", because the builtin
8695 termcap entries are generally better (many systems contain faulty
8696 xterm entries...).
8697
8698 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008699'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 Indicates a fast terminal connection. More characters will be sent to
8702 the screen for redrawing, instead of using insert/delete line
8703 commands. Improves smoothness of redrawing when there are multiple
8704 windows and the terminal does not support a scrolling region.
8705 Also enables the extra writing of characters at the end of each screen
8706 line for lines that wrap. This helps when using copy/paste with the
8707 mouse in an xterm and other terminals.
8708
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008709 The default used to be set only for some terminal names, but these
8710 days nearly all terminals are fast, therefore the default is now "on".
8711 If you have a slow connection you may want to set this option off,
8712 e.g. depending on the host name: >
8713 if hostname() =~ 'faraway'
8714 set nottyfast
8715 endif
8716<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 *'ttymouse'* *'ttym'*
8718'ttymouse' 'ttym' string (default depends on 'term')
8719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 {only in Unix and VMS, doesn't work in the GUI; not
8721 available when compiled without |+mouse|}
8722 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008723 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 *xterm-mouse*
8725 xterm xterm-like mouse handling. The mouse generates
8726 "<Esc>[Mscr", where "scr" is three bytes:
8727 "s" = button state
8728 "c" = column plus 33
8729 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008730 This only works up to 223 columns! See "dec",
8731 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 xterm2 Works like "xterm", but with the xterm reporting the
8733 mouse position while the mouse is dragged. This works
8734 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008735 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 work. See below for how Vim detects this
8737 automatically.
8738 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008739 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008741 for the row and column. No other mouse events are
8742 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 *dec-mouse*
8744 dec DEC terminal mouse handling. The mouse generates a
8745 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008746 This is also available for an Xterm, if it was
8747 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 *jsbterm-mouse*
8749 jsbterm JSB term mouse handling.
8750 *pterm-mouse*
8751 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008752 *urxvt-mouse*
8753 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008754 The mouse works only if the terminal supports this
8755 encoding style, but it does not have 223 columns limit
8756 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008757 *sgr-mouse*
8758 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008759 mouse reporting. The mouse works even in columns
8760 beyond 223. This option is backward compatible with
8761 "xterm2" because it can also decode "xterm2" style
8762 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763
8764 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008765 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8766 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8768 recognized, if enabled at compile time. DEC terminal mouse codes
8769 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008770 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8771 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008773 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8774 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8775 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008776 If the terminfo/termcap entry "XM" exists and the first number is
8777 "1006" then 'ttymouse' will be set to "sgr". This works for many
8778 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008779 Additionally, if vim is compiled with the |+termresponse| feature and
8780 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008781 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008783 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8784 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8785 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008786 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8787 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 :set t_RV=
8789<
8790 *'ttyscroll'* *'tsl'*
8791'ttyscroll' 'tsl' number (default 999)
8792 global
8793 Maximum number of lines to scroll the screen. If there are more lines
8794 to scroll the window is redrawn. For terminals where scrolling is
8795 very slow and redrawing is not slow this can be set to a small number,
8796 e.g., 3, to speed up displaying.
8797
8798 *'ttytype'* *'tty'*
8799'ttytype' 'tty' string (default from $TERM)
8800 global
8801 Alias for 'term', see above.
8802
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008803 *'undodir'* *'udir'*
8804'undodir' 'udir' string (default ".")
8805 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008806 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008807 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008808 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008809 "." means using the directory of the file. The undo file name for
8810 "file.txt" is ".file.txt.un~".
8811 For other directories the file name is the full path of the edited
8812 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008813 When writing: The first directory that exists is used. "." always
8814 works, no directories after "." will be used for writing.
8815 When reading all entries are tried to find an undo file. The first
8816 undo file that exists is used. When it cannot be read an error is
8817 given, no further entry is used.
8818 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008819 This option cannot be set from a |modeline| or in the |sandbox|, for
8820 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008821
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008822 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008823'undofile' 'udf' boolean (default off)
8824 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008825 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008826 When on, Vim automatically saves undo history to an undo file when
8827 writing a buffer to a file, and restores undo history from the same
8828 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008829 The directory where the undo file is stored is specified by 'undodir'.
8830 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008831 The undo file is not read when 'undoreload' causes the buffer from
8832 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008833 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008834 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008835
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008837'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008838 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008840 is kept in memory, higher numbers will cause more memory to be used.
8841 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8843 itself: >
8844 set ul=0
8845< But you can also get Vi compatibility by including the 'u' flag in
8846 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008847 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008848 Set to -1 for no undo at all. You might want to do this only for the
8849 current buffer: >
8850 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008852
8853 The local value is set to -123456 when the global value is to be used.
8854
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008855 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008857 *'undoreload'* *'ur'*
8858'undoreload' 'ur' number (default 10000)
8859 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008860 Save the whole buffer for undo when reloading it. This applies to the
8861 ":e!" command and reloading for when the buffer changed outside of
8862 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008863 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008864 of lines is smaller than the value of this option.
8865 Set this option to zero to disable undo for a reload.
8866
8867 When saving undo for a reload, any undo file is not read.
8868
8869 Note that this causes the whole buffer to be stored in memory. Set
8870 this option to a lower value if you run out of memory.
8871
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 *'updatecount'* *'uc'*
8873'updatecount' 'uc' number (default: 200)
8874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 After typing this many characters the swap file will be written to
8876 disk. When zero, no swap file will be created at all (see chapter on
8877 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8878 Vim with the "-n" option, see |startup|. When editing in readonly
8879 mode this option will be initialized to 10000.
8880 The swapfile can be disabled per buffer with |'swapfile'|.
8881 When 'updatecount' is set from zero to non-zero, swap files are
8882 created for all buffers that have 'swapfile' set. When 'updatecount'
8883 is set to zero, existing swap files are not deleted.
8884 Also see |'swapsync'|.
8885 This option has no meaning in buffers where |'buftype'| is "nofile"
8886 or "nowrite".
8887
8888 *'updatetime'* *'ut'*
8889'updatetime' 'ut' number (default 4000)
8890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 If this many milliseconds nothing is typed the swap file will be
8892 written to disk (see |crash-recovery|). Also used for the
8893 |CursorHold| autocommand event.
8894
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008895 *'varsofttabstop'* *'vsts'*
8896'varsofttabstop' 'vsts' string (default "")
8897 local to buffer
8898 {only available when compiled with the |+vartabs|
8899 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008900 A list of the number of spaces that a <Tab> counts for while editing,
8901 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8902 width <Tab>s are being inserted, while in fact a mixture of spaces
8903 and <Tab>s is used. Tab widths are separated with commas, with the
8904 final value applying to all subsequent tabs.
8905
8906 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008907 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008908 to use the following: >
8909 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008910< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8911 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008912
8913 Note that the value of |'softtabstop'| will be ignored while
8914 'varsofttabstop' is set.
8915
8916 *'vartabstop'* *'vts'*
8917'vartabstop' 'vts' string (default "")
8918 local to buffer
8919 {only available when compiled with the |+vartabs|
8920 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008921 A list of the number of spaces that a <Tab> in the file counts for,
8922 separated by commas. Each value corresponds to one tab, with the
8923 final value applying to all subsequent tabs. For example: >
8924 :set vartabstop=4,20,10,8
8925< This will make the first tab 4 spaces wide, the second 20 spaces,
8926 the third 10 spaces, and all following tabs 8 spaces.
8927
8928 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8929 is set.
8930
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 *'verbose'* *'vbs'*
8932'verbose' 'vbs' number (default 0)
8933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 When bigger than zero, Vim will give messages about what it is doing.
8935 Currently, these messages are given:
8936 >= 1 When the viminfo file is read or written.
8937 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008938 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008939 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 >= 8 Files for which a group of autocommands is executed.
8941 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008942 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943 >= 12 Every executed function.
8944 >= 13 When an exception is thrown, caught, finished, or discarded.
8945 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008946 >= 15 Every executed Ex command from a script (truncated at 200
8947 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008948 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949
8950 This option can also be set with the "-V" argument. See |-V|.
8951 This option is also set by the |:verbose| command.
8952
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008953 When the 'verbosefile' option is set then the verbose messages are not
8954 displayed.
8955
8956 *'verbosefile'* *'vfile'*
8957'verbosefile' 'vfile' string (default empty)
8958 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008959 When not empty all messages are written in a file with this name.
8960 When the file exists messages are appended.
8961 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008962 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008963 Setting 'verbosefile' to a new value is like making it empty first.
8964 The difference with |:redir| is that verbose messages are not
8965 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11008966 This option cannot be set from a |modeline| or in the |sandbox|, for
8967 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008968
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09008970'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008971 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008972 for Unix: "$HOME/.vim/view",
h_east59858792023-10-25 22:47:05 +09008973 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008974 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008976 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 feature}
8978 Name of the directory where to store files for |:mkview|.
8979 This option cannot be set from a |modeline| or in the |sandbox|, for
8980 security reasons.
8981
8982 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008983'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008985 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008987 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008988 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989 word save and restore ~
8990 cursor cursor position in file and in window
8991 folds manually created folds, opened/closed folds and local
8992 fold options
8993 options options and mappings local to a window or buffer (not
8994 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008995 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 slash backslashes in file names replaced with forward
8997 slashes
8998 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008999 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009000 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009002 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009004 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005
9006 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009007'viminfo' 'vi' string (Vi default: "", Vim default for
9008 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009009 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9010 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009012 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 feature}
9014 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009015 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9016 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009017 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009018 consisting of a single character identifying the particular parameter,
9019 followed by a number or string which specifies the value of that
9020 parameter. If a particular character is left out, then the default
9021 value is used for that parameter. The following is a list of the
9022 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009024 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 ! When included, save and restore global variables that start
9026 with an uppercase letter, and don't contain a lowercase
9027 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009028 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009029 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009030 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 " Maximum number of lines saved for each register. Old name of
9032 the '<' item, with the disadvantage that you need to put a
9033 backslash before the ", otherwise it will be recognized as the
9034 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009035 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 % When included, save and restore the buffer list. If Vim is
9037 started with a file name argument, the buffer list is not
9038 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009039 buffer list is restored from the viminfo file. Quickfix
9040 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9041 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009042 When followed by a number, the number specifies the maximum
9043 number of buffers that are stored. Without a number all
9044 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009045 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 ' Maximum number of previously edited files for which the marks
9047 are remembered. This parameter must always be included when
9048 'viminfo' is non-empty.
9049 Including this item also means that the |jumplist| and the
9050 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009051 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009053 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 patterns are also saved. When not included, the value of
9055 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009056 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009058 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009059 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 < Maximum number of lines saved for each register. If zero then
9061 registers are not saved. When not included, all lines are
9062 saved. '"' is the old name for this item.
9063 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009064 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009066 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009067 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 c When included, convert the text in the viminfo file from the
9069 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009070 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009071 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 f Whether file marks need to be stored. If zero, file marks ('0
9073 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009074 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009076 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 h Disable the effect of 'hlsearch' when loading the viminfo
9078 file. When not included, it depends on whether ":nohlsearch"
9079 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009080 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009082 the 'n'. Must be at the end of the option! If the
9083 'viminfofile' option is set, that file name overrides the one
9084 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009085 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009086 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 r Removable media. The argument is a string (up to the next
9088 ','). This parameter can be given several times. Each
9089 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009090 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9092 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9093 ignored. Maximum length of each 'r' argument is 50
9094 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009095 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 s Maximum size of an item in Kbyte. If zero then registers are
9097 not saved. Currently only applies to registers. The default
9098 "s10" will exclude registers with more than 10 Kbyte of text.
9099 Also see the '<' item above: line count limit.
9100
9101 Example: >
9102 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9103<
9104 '50 Marks will be remembered for the last 50 files you
9105 edited.
9106 <1000 Contents of registers (up to 1000 lines each) will be
9107 remembered.
9108 s100 Registers with more than 100 Kbyte text are skipped.
9109 :0 Command-line history will not be saved.
9110 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9111 no / Since '/' is not specified, the default will be used,
9112 that is, save all of the search history, and also the
9113 previous search and substitute patterns.
9114 no % The buffer list will not be saved nor read back.
9115 no h 'hlsearch' highlighting will be restored.
9116
9117 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9118 load the contents of the file, this is not done automatically.
9119
9120 This option cannot be set from a |modeline| or in the |sandbox|, for
9121 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009122 NOTE: This option is set to the Vim default value when 'compatible'
9123 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009125 *'viminfofile'* *'vif'*
9126'viminfofile' 'vif' string (default: "")
9127 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009128 {not available when compiled without the |+viminfo|
9129 feature}
9130 When non-empty, overrides the file name used for viminfo.
9131 When equal to "NONE" no viminfo file will be read or written.
9132 This option can be set with the |-i| command line flag. The |--clean|
9133 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009134 This option cannot be set from a |modeline| or in the |sandbox|, for
9135 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009136
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 *'virtualedit'* *'ve'*
9138'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009139 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009140 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 block Allow virtual editing in Visual block mode.
9142 insert Allow virtual editing in Insert mode.
9143 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009144 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009145 none When used as the local value, do not allow virtual
9146 editing even when the global value is set. When used
9147 as the global value, "none" is the same as "".
9148 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009149
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009151 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 of the line. Useful for selecting a rectangle in Visual mode and
9153 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009154 "onemore" is not the same, it will only allow moving the cursor just
9155 after the last character of the line. This makes some commands more
9156 consistent. Previously the cursor was always past the end of the line
9157 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009158 break some plugins or Vim scripts. For example because |l| can move
9159 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009160 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009161 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009162 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009163 It doesn't make sense to combine "all" with "onemore", but you will
9164 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009165 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009166 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167
9168 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9169'visualbell' 'vb' boolean (default off)
9170 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009171 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009173 use: >
9174 :set vb t_vb=
9175< If you want a short flash, you can use this on many terminals: >
9176 :set vb t_vb=[?5h$<100>[?5l
9177< Here $<100> specifies the time, you can use a smaller or bigger value
9178 to get a shorter or longer flash.
9179
9180 Note: Vim will limit the bell to once per half a second. This avoids
9181 having to wait for the flashing to finish when there are lots of
9182 bells, e.g. on key repeat. This also happens without 'visualbell'
9183 set.
9184
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9186 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9187 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009188
9189 Note: When the GUI starts, 't_vb' is reset to its default value. You
9190 might want to set it again in your |gvimrc|.
9191
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 Does not work on the Amiga, you always get a screen flash.
9193 Also see 'errorbells'.
9194
9195 *'warn'* *'nowarn'*
9196'warn' boolean (default on)
9197 global
9198 Give a warning message when a shell command is used while the buffer
9199 has been changed.
9200
9201 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9202'weirdinvert' 'wiv' boolean (default off)
9203 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009204 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 It is provided for backwards compatibility with version 4.x.
9206 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9207 vice versa. Has no effect when the GUI is running.
9208
9209 *'whichwrap'* *'ww'*
9210'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 Allow specified keys that move the cursor left/right to move to the
9213 previous/next line when the cursor is on the first/last character in
9214 the line. Concatenate characters to allow this for these keys:
9215 char key mode ~
9216 b <BS> Normal and Visual
9217 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009218 h "h" Normal and Visual (not recommended)
9219 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 < <Left> Normal and Visual
9221 > <Right> Normal and Visual
9222 ~ "~" Normal
9223 [ <Left> Insert and Replace
9224 ] <Right> Insert and Replace
9225 For example: >
9226 :set ww=<,>,[,]
9227< allows wrap only when cursor keys are used.
9228 When the movement keys are used in combination with a delete or change
9229 operator, the <EOL> also counts for a character. This makes "3h"
9230 different from "3dh" when the cursor crosses the end of a line. This
9231 is also true for "x" and "X", because they do the same as "dl" and
9232 "dh". If you use this, you may also want to use the mapping
9233 ":map <BS> X" to make backspace delete the character in front of the
9234 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009235 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009236 line (not an empty line) then it will not move to the next line. This
9237 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 NOTE: This option is set to the Vi default value when 'compatible' is
9239 set and to the Vim default value when 'compatible' is reset.
9240
9241 *'wildchar'* *'wc'*
9242'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009244 Character you have to type to start wildcard expansion in the
9245 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009246 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247 The character is not recognized when used inside a macro. See
9248 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009249 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009250 <Esc> can be used, but hitting it twice in a row will still exit
9251 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009252 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009253 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254< NOTE: This option is set to the Vi default value when 'compatible' is
9255 set and to the Vim default value when 'compatible' is reset.
9256
9257 *'wildcharm'* *'wcm'*
9258'wildcharm' 'wcm' number (default: none (0))
9259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009260 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009261 recognized when used inside a macro. You can find "spare" command-line
9262 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263 you'll never actually type 'wildcharm', just use it in mappings that
9264 automatically invoke completion mode, e.g.: >
9265 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009266 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009267< Then after typing :ss you can use CTRL-P & CTRL-N.
9268
9269 *'wildignore'* *'wig'*
9270'wildignore' 'wig' string (default "")
9271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009272 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009273 patterns is ignored when expanding |wildcards|, completing file or
9274 directory names, and influences the result of |expand()|, |glob()| and
9275 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9277 Also see 'suffixes'.
9278 Example: >
9279 :set wildignore=*.o,*.obj
9280< The use of |:set+=| and |:set-=| is preferred when adding or removing
9281 a pattern from the list. This avoids problems when a future version
9282 uses another default.
9283
h_east596a9f22023-11-21 21:24:23 +09009284 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009285'wildignorecase' 'wic' boolean (default off)
9286 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009287 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009288 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009289 Does not apply when the shell is used to expand wildcards, which
9290 happens when there are special characters.
9291
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009293'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 When 'wildmenu' is on, command-line completion operates in an enhanced
9296 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009297 the possible matches are shown.
9298 When 'wildoptions' contains "pum", then the completion matches are
9299 shown in a popup menu. Otherwise they are displayed just above the
9300 command line, with the first match highlighted (overwriting the status
9301 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009302 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009303 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9304 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9305 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009306 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307 If there are more matches than can fit in the line, a ">" is shown on
9308 the right and/or a "<" is shown on the left. The status line scrolls
9309 as needed.
9310 The "wildmenu" mode is abandoned when a key is hit that is not used
9311 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009312 While the "wildmenu" is active, the following keys have special
9313 meanings:
9314 CTRL-P - go to the previous entry
9315 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 <CR> - in menu completion, when the cursor is just after a
9317 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009318 CTRL-E - end completion, go back to what was there before
9319 selecting a match.
9320 CTRL-Y - accept the currently selected match and stop
9321 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009322
9323 When not using the popup menu for command line completion, the
9324 following keys have special meanings:
9325 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 <Up> - in filename/menu name completion: move up into
9327 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009328 <Down> - in filename/menu name completion: move into a
9329 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009331 When using the popup menu for command line completion, the following
9332 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009333 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009334 <PageUp> - select a match several entries back
9335 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009336 <Left> - in filename/menu name completion: move up into
9337 parent directory or parent menu.
9338 <Right> - in filename/menu name completion: move into a
9339 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009340
Bram Moolenaar071d4272004-06-13 20:20:40 +00009341 This makes the menus accessible from the console |console-menus|.
9342
9343 If you prefer the <Left> and <Right> keys to move the cursor instead
9344 of selecting a different match, use this: >
9345 :cnoremap <Left> <Space><BS><Left>
9346 :cnoremap <Right> <Space><BS><Right>
9347<
9348 The "WildMenu" highlighting is used for displaying the current match
9349 |hl-WildMenu|.
9350
9351 *'wildmode'* *'wim'*
9352'wildmode' 'wim' string (Vim default: "full")
9353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009355 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009356 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009357 first part specifies the behavior for the first use of 'wildchar',
9358 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009359
9360 Each part consists of a colon separated list consisting of the
9361 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009362 "" Complete only the first match.
9363 "full" Complete the next full match. After the last match,
9364 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009365 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366 "longest" Complete till longest common string. If this doesn't
9367 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009368 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009369 "lastused" When completing buffer names and more than one buffer
9370 matches, sort buffers by time last used (other than
9371 the current buffer).
9372 When there is only a single match, it is fully completed in all cases.
9373
9374 Examples of useful colon-separated values:
9375 "longest:full" Like "longest", but also start 'wildmenu' if it is
9376 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009377 "list:full" When more than one match, list all matches and
9378 complete first match.
9379 "list:longest" When more than one match, list all matches and
9380 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009381 "list:lastused" When more than one buffer matches, list all matches
9382 and sort buffers by time last used (other than the
9383 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009384
9385 Examples: >
9386 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009387< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009388 :set wildmode=longest,full
9389< Complete longest common string, then each full match >
9390 :set wildmode=list:full
9391< List all matches and complete each full match >
9392 :set wildmode=list,full
9393< List all matches without completing, then each full match >
9394 :set wildmode=longest,list
9395< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009396 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009397
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009398 *'wildoptions'* *'wop'*
9399'wildoptions' 'wop' string (default "")
9400 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009401 A list of words that change how |cmdline-completion| is done.
9402 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009403 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009404 this value is specified, wildcard expansion will not
9405 be used for completion. The matches will be sorted by
9406 the "best match" rather than alphabetically sorted.
9407 This will find more matches than the wildcard
9408 expansion. Currently fuzzy matching based completion
9409 is not supported for file and directory names and
9410 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009411 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009412 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009413 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009414 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009415 is displayed per line. Often used tag kinds are:
9416 d #define
9417 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009418
Bram Moolenaar071d4272004-06-13 20:20:40 +00009419 *'winaltkeys'* *'wak'*
9420'winaltkeys' 'wak' string (default "menu")
9421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009422 {only used in Win32, Motif, GTK and Photon GUI}
9423 Some GUI versions allow the access to menu entries by using the ALT
9424 key in combination with a character that appears underlined in the
9425 menu. This conflicts with the use of the ALT key for mappings and
9426 entering special characters. This option tells what to do:
9427 no Don't use ALT keys for menus. ALT key combinations can be
9428 mapped, but there is no automatic handling. This can then be
9429 done with the |:simalt| command.
9430 yes ALT key handling is done by the windowing system. ALT key
9431 combinations cannot be mapped.
9432 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009433 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009434 keys can be mapped.
9435 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9436 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009437 This option is not used for <F10>; on Win32 and with GTK <F10> will
9438 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009440 *'wincolor'* *'wcr'*
9441'wincolor' 'wcr' string (default empty)
9442 local to window
9443 Highlight group name to use for this window instead of the Normal
9444 color |hl-Normal|.
9445
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009446 *'window'* *'wi'*
9447'window' 'wi' number (default screen height - 1)
9448 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009449 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9450 window and the value is smaller than 'lines' minus one. The screen
9451 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009452 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9453 in a much smarter way, taking care of wrapping lines.
9454 When resizing the Vim window, the value is smaller than 1 or more than
9455 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009456 Note: Do not confuse this with the height of the Vim window, use
9457 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009458
laburnumT3f7855a2023-12-05 18:37:03 +01009459 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9460'winfixheight' 'wfh' boolean (default off)
9461 local to window |local-noglobal|
9462 Keep the window height when windows are opened or closed and
9463 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9464 |preview-window| and |quickfix-window|.
9465 The height may be changed anyway when running out of room.
9466
9467 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9468'winfixwidth' 'wfw' boolean (default off)
9469 local to window |local-noglobal|
9470 Keep the window width when windows are opened or closed and
9471 'equalalways' is set. Also for |CTRL-W_=|.
9472 The width may be changed anyway when running out of room.
9473
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 *'winheight'* *'wh'* *E591*
9475'winheight' 'wh' number (default 1)
9476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009478 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009479 focus goes to a window that is smaller, its size is increased, at the
9480 cost of the height of other windows.
9481 Set 'winheight' to a small number for normal editing.
9482 Set it to 999 to make the current window fill most of the screen.
9483 Other windows will be only 'winminheight' high. This has the drawback
9484 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9485 to create only two windows, set the option after startup is done,
9486 using the |VimEnter| event: >
9487 au VimEnter * set winheight=999
9488< Minimum value is 1.
9489 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009490 height of the current window.
9491 'winheight' applies to the current window. Use 'winminheight' to set
9492 the minimal height for other windows.
9493
Bram Moolenaar071d4272004-06-13 20:20:40 +00009494 *'winminheight'* *'wmh'*
9495'winminheight' 'wmh' number (default 1)
9496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009497 The minimal height of a window, when it's not the current window.
9498 This is a hard minimum, windows will never become smaller.
9499 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9500 status bar) if necessary. They will return to at least one line when
9501 they become active (since the cursor has to have somewhere to go.)
9502 Use 'winheight' to set the minimal height of the current window.
9503 This option is only checked when making a window smaller. Don't use a
9504 large number, it will cause errors when opening more than a few
9505 windows. A value of 0 to 3 is reasonable.
9506
9507 *'winminwidth'* *'wmw'*
9508'winminwidth' 'wmw' number (default 1)
9509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009510 The minimal width of a window, when it's not the current window.
9511 This is a hard minimum, windows will never become smaller.
9512 When set to zero, windows may be "squashed" to zero columns (i.e. just
9513 a vertical separator) if necessary. They will return to at least one
9514 line when they become active (since the cursor has to have somewhere
9515 to go.)
9516 Use 'winwidth' to set the minimal width of the current window.
9517 This option is only checked when making a window smaller. Don't use a
9518 large number, it will cause errors when opening more than a few
9519 windows. A value of 0 to 12 is reasonable.
9520
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009521 *'winptydll'*
9522'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9523 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009524 {only available when compiled with the |terminal|
9525 feature on MS-Windows}
9526 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009527 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009528 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009529 a fallback.
9530 Environment variables are expanded |:set_env|.
9531 This option cannot be set from a |modeline| or in the |sandbox|, for
9532 security reasons.
9533
Bram Moolenaar071d4272004-06-13 20:20:40 +00009534 *'winwidth'* *'wiw'* *E592*
9535'winwidth' 'wiw' number (default 20)
9536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009537 Minimal number of columns for the current window. This is not a hard
9538 minimum, Vim will use fewer columns if there is not enough room. If
9539 the current window is smaller, its size is increased, at the cost of
9540 the width of other windows. Set it to 999 to make the current window
9541 always fill the screen. Set it to a small number for normal editing.
9542 The width is not adjusted after one of the commands to change the
9543 width of the current window.
9544 'winwidth' applies to the current window. Use 'winminwidth' to set
9545 the minimal width for other windows.
9546
9547 *'wrap'* *'nowrap'*
9548'wrap' boolean (default on)
9549 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009550 This option changes how text is displayed. It doesn't change the text
9551 in the buffer, see 'textwidth' for that.
9552 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009553 displaying continues on the next line. When off lines will not wrap
9554 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 moved to a part that is not shown, the screen will scroll
9556 horizontally.
9557 The line will be broken in the middle of a word if necessary. See
9558 'linebreak' to get the break at a word boundary.
9559 To make scrolling horizontally a bit more useful, try this: >
9560 :set sidescroll=5
9561 :set listchars+=precedes:<,extends:>
9562< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009563 This option can't be set from a |modeline| when the 'diff' option is
9564 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565
9566 *'wrapmargin'* *'wm'*
9567'wrapmargin' 'wm' number (default 0)
9568 local to buffer
9569 Number of characters from the right window border where wrapping
9570 starts. When typing text beyond this limit, an <EOL> will be inserted
9571 and inserting continues on the next line.
9572 Options that add a margin, such as 'number' and 'foldcolumn', cause
9573 the text width to be further reduced. This is Vi compatible.
9574 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009575 This option is set to 0 when 'paste' is set and restored when 'paste'
9576 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009577 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578
9579 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9580'wrapscan' 'ws' boolean (default on) *E384* *E385*
9581 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009582 Searches wrap around the end of the file. Also applies to |]s| and
9583 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009584
9585 *'write'* *'nowrite'*
9586'write' boolean (default on)
9587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 Allows writing files. When not set, writing a file is not allowed.
9589 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009590 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591 argument. Filtering text is still possible, even though this requires
9592 writing a temporary file.
9593
9594 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9595'writeany' 'wa' boolean (default off)
9596 global
9597 Allows writing to any file with no need for "!" override.
9598
9599 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9600'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9601 otherwise)
9602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009603 Make a backup before overwriting a file. The backup is removed after
9604 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009605 also on.
9606 WARNING: Switching this option off means that when Vim fails to write
9607 your buffer correctly and then, for whatever reason, Vim exits, you
9608 lose both the original file and what you were writing. Only reset
9609 this option if your file system is almost full and it makes the write
9610 fail (and make sure not to exit Vim until the write was successful).
9611 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009612 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009613 Depending on 'backupcopy' the backup is a new file or the original
9614 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 NOTE: This option is set to the default value when 'compatible' is
9616 set.
9617
9618 *'writedelay'* *'wd'*
9619'writedelay' 'wd' number (default 0)
9620 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009621 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009622 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009623 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009624
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009625 *'xtermcodes'* *'noxtermcodes'*
9626'xtermcodes' boolean (default on)
9627 global
9628 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009629 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009630 key codes and number of colors from the terminal. This takes care of
9631 various configuration options of the terminal that cannot be obtained
9632 from the termlib/terminfo entry, see |xterm-codes|.
9633 A side effect may be that t_Co changes and Vim will redraw the
9634 display.
9635
9636
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009637 vim:tw=78:ts=8:noet:ft=help:norl: