blob: 52714da2dbeda5b18baa7a84eec7dc3e62c007f7 [file] [log] [blame]
Doug Kearnsddbb6fe2024-07-24 20:21:22 +02001*options.txt* For Vim version 9.1. Last change: 2024 Jul 24
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,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
215 :set tags=tags\\,file results in "tags,file"
216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
399 Command global value local value ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display
404 :setlocal option? - display
405:setglobal option? display -
406
407
408Global options with a local value *global-local*
409
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000410Options are global when you mostly use one value for all buffers and windows.
411For some global options it's useful to sometimes have a different local value.
412You can set the local value with ":setlocal". That buffer or window will then
413use the local value, while other buffers and windows continue using the global
414value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415
416For example, you have two windows, both on C source code. They use the global
417'makeprg' option. If you do this in one of the two windows: >
418 :set makeprg=gmake
419then the other window will switch to the same value. There is no need to set
420the 'makeprg' option in the other C source window too.
421However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000422another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000423files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424 :setlocal makeprg=perlmake
425You can switch back to using the global value by making the local value empty: >
426 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100427This only works for a string option. For a number or boolean option you need
428to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100430Note that for non-boolean and non-number options using "<" copies the global
431value to the local value, it doesn't switch back to using the global value
432(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000433 :set path<
434This will make the local value of 'path' empty, so that the global value is
435used. Thus it does the same as: >
436 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000437Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438":setlocal" on a global option might work differently then.
439
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000440 *option-value-function*
441Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000442'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000443a function name or a function reference or a lambda function. When using a
444lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000445>
446 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000447 set opfunc=function('MyOpFunc')
448 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000449 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000450
451Set to a script-local function: >
452 set opfunc=s:MyLocalFunc
453 set opfunc=<SID>MyLocalFunc
454In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
455the script: >
456 set opfunc=MyLocalFunc
457
458Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000459 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000460 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000461
462Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000463 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000464
465Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000466 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000467 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000468
469In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300470closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000471context of where it was defined.
472
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474Setting the filetype
475
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200476:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 Set the 'filetype' option to {filetype}, but only if
478 not done yet in a sequence of (nested) autocommands.
479 This is short for: >
480 :if !did_filetype()
481 : setlocal filetype={filetype}
482 :endif
483< This command is used in a filetype.vim file to avoid
484 setting the 'filetype' option twice, causing different
485 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200486
487 When the optional FALLBACK argument is present, a
488 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100489 'filetype'. This is to be used for filetype
490 detections that are just a guess. |did_filetype()|
491 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200492
Bram Moolenaard58e9292011-02-09 17:07:58 +0100493 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
495:opt[ions] Open a window for viewing and setting all options.
496 Options are grouped by function.
497 Offers short help for each option. Hit <CR> on the
498 short help to open a help window with more help for
499 the option.
500 Modify the value of the option and hit <CR> on the
501 "set" line to set the new value. For window and
502 buffer specific options, the last accessed window is
503 used to set the option value in, unless this is a help
504 window, in which case the window below help window is
505 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100506 {not available when compiled without the |+eval|
507 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
509 *$HOME*
510Using "~" is like using "$HOME", but it is only recognized at the start of an
511option and after a space or comma.
512
513On Unix systems "~user" can be used too. It is replaced by the home directory
514of user "user". Example: >
515 :set path=~mool/include,/usr/include,.
516
517On Unix systems the form "${HOME}" can be used too. The name between {} can
518contain non-id characters then. Note that if you want to use this for the
519"gf" command, you need to add the '{' and '}' characters to 'isfname'.
520
521NOTE: expanding environment variables and "~/" is only done with the ":set"
522command, not when assigning a value to an option with ":let".
523
Bram Moolenaarc572da52017-08-27 16:52:01 +0200524 *$HOME-windows*
525On MS-Windows, if $HOME is not defined as an environment variable, then
526at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200527If $HOMEDRIVE is not set then $USERPROFILE is used.
528
529This expanded value is not exported to the environment, this matters when
530running an external command: >
531 :echo system('set | findstr ^HOME=')
532and >
533 :echo luaeval('os.getenv("HOME")')
534should echo nothing (an empty string) despite exists('$HOME') being true.
535When setting $HOME to a non-empty string it will be exported to the
536subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200537
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539Note the maximum length of an expanded option is limited. How much depends on
540the system, mostly it is something like 256 or 1024 characters.
541
542 *:fix* *:fixdel*
543:fix[del] Set the value of 't_kD':
544 't_kb' is 't_kD' becomes ~
545 CTRL-? CTRL-H
546 not CTRL-? CTRL-?
547
Bram Moolenaar82be4842021-01-11 19:40:15 +0100548 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
550 If your delete key terminal code is wrong, but the
551 code for backspace is alright, you can put this in
552 your .vimrc: >
553 :fixdel
554< This works no matter what the actual code for
555 backspace is.
556
557 If the backspace key terminal code is wrong you can
558 use this: >
559 :if &term == "termname"
560 : set t_kb=^V<BS>
561 : fixdel
562 :endif
563< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000564 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 with your terminal name.
566
567 If your <Delete> key sends a strange key sequence (not
568 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
569 :if &term == "termname"
570 : set t_kD=^V<Delete>
571 :endif
572< Where "^V" is CTRL-V and "<Delete>" is the delete key
573 (don't type eight characters!). Replace "termname"
574 with your terminal name.
575
576 *Linux-backspace*
577 Note about Linux: By default the backspace key
578 produces CTRL-?, which is wrong. You can fix it by
579 putting this line in your rc.local: >
580 echo "keycode 14 = BackSpace" | loadkeys
581<
582 *NetBSD-backspace*
583 Note about NetBSD: If your backspace doesn't produce
584 the right code, try this: >
585 xmodmap -e "keycode 22 = BackSpace"
586< If this works, add this in your .Xmodmap file: >
587 keysym 22 = BackSpace
588< You need to restart for this to take effect.
589
590==============================================================================
5912. Automatically setting options *auto-setting*
592
593Besides changing options with the ":set" command, there are three alternatives
594to set options automatically for one or more files:
595
5961. When starting Vim initializations are read from various places. See
597 |initialization|. Most of them are performed for all editing sessions,
598 and some of them depend on the directory where Vim is started.
599 You can create an initialization file with |:mkvimrc|, |:mkview| and
600 |:mksession|.
6012. If you start editing a new file, the automatic commands are executed.
602 This can be used to set options for files matching a particular pattern and
603 many other things. See |autocommand|.
6043. If you start editing a new file, and the 'modeline' option is on, a
605 number of lines at the beginning and end of the file are checked for
606 modelines. This is explained here.
607
608 *modeline* *vim:* *vi:* *ex:* *E520*
609There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100610 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612[text{white}] empty or any text followed by at least one blank
613 character (<Space> or <Tab>); "ex:" always requires at
614 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200615{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200616[white] optional white space
617{options} a list of option settings, separated with white space
618 or ':', where each part between ':' is the argument
619 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620
Bram Moolenaar14b69452013-06-29 23:05:20 +0200621Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000622 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624
625The second form (this is compatible with some versions of Vi):
626
Bram Moolenaarade0d392020-01-21 22:33:58 +0100627 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629[text{white}] empty or any text followed by at least one blank
630 character (<Space> or <Tab>); "ex:" always requires at
631 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200632{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
633[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200634se[t] the string "set " or "se " (note the space); When
635 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200636{options} a list of options, separated with white space, which
637 is the argument for a ":set" command
638: a colon
639[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
Bram Moolenaar14b69452013-06-29 23:05:20 +0200641Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000642 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200645The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
646chance that a normal word like "lex:" is caught. There is one exception:
647"vi:" and "vim:" can also be at the start of the line (for compatibility with
648version 3.0). Using "ex:" at the start of the line will be ignored (this
649could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
Hu Jialun9dcd3492021-08-28 20:42:50 +0200651If the modeline is disabled within a modeline, subsequent modelines will be
652ignored. This is to allow turning off modeline on a per-file basis. This is
653useful when a line looks like a modeline but isn't. For example, it would be
654good to start a YAML file containing strings like "vim:" with
655 # vim: nomodeline ~
656so as to avoid modeline misdetection. Following options on the same line
657after modeline deactivation, if any, are still evaluated (but you would
658normally not have any).
659
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 *modeline-local*
661The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000662buffer and window that contain the file. Although it's possible to set global
663options from a modeline, this is unusual. If you have two windows open and
664the files in it set the same global option to a different value, the result
665depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000667When editing a file that was already loaded, only the window-local options
668from the modeline are used. Thus if you manually changed a buffer-local
669option after opening the file, it won't be changed if you edit the same buffer
670in another window. But window-local options will be set.
671
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 *modeline-version*
673If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200674number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 vim{vers}: version {vers} or later
676 vim<{vers}: version before {vers}
677 vim={vers}: version {vers}
678 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100679{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
680For example, to use a modeline only for Vim 7.0:
681 /* vim700: set foldmethod=marker */ ~
682To use a modeline for Vim after version 7.2:
683 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684There can be no blanks between "vim" and the ":".
685
686
687The number of lines that are checked can be set with the 'modelines' option.
688If 'modeline' is off or 'modelines' is 0 no lines are checked.
689
690Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000691like:
692 /* vi:ts=4: */ ~
693will give an error message for the trailing "*/". This line is OK:
694 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696If an error is detected the rest of the line is skipped.
697
698If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000699backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100700 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
701This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
702before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200703 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000705might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200706can be set. For some options a flag is set, so that when the value is used
707the |sandbox| is effective. Some options can only be set from the modeline
708when 'modelineexpr' is set (the default is off).
709
710Still, there is always a small risk that a modeline causes trouble. E.g.,
711when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
712So disable modelines before editing untrusted text. The mail ftplugin does
713this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714
715Hint: If you would like to do something else than setting an option, you could
716define an autocommand that checks the file for a specific string. For
717example: >
718 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
719And define a function SetVar() that does something with the line containing
720"VAR".
721
722==============================================================================
7233. Options summary *option-summary*
724
725In the list below all the options are mentioned with their full name and with
726an abbreviation if there is one. Both forms may be used.
727
728In this document when a boolean option is "set" that means that ":set option"
729is entered. When an option is "reset", ":set nooption" is used.
730
731For some options there are two default values: The "Vim default", which is
732used when 'compatible' is not set, and the "Vi default", which is used when
733'compatible' is set.
734
735Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000736are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737different value in each window. For example the 'list' option can be set in
738one window and reset in another for the same text, giving both types of view
739at the same time. There are a few options that are specific to a certain
740file. These can have a different value for each file or buffer. For example
741the 'textwidth' option can be 78 for a normal text file and 0 for a C
742program.
743
744 global one option for all buffers and windows
745 local to window each window has its own copy of this option
746 local to buffer each buffer has its own copy of this option
747
748When creating a new window the option values from the currently active window
749are used as a default value for the window-specific options. For the
750buffer-specific options this depends on the 's' and 'S' flags in the
751'cpoptions' option. If 's' is included (which is the default) the values for
752buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000753first entered. If 'S' is present the options are copied each time the buffer
754is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755present, the options are copied from the currently active buffer when the
756buffer is created.
757
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000758Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Not all options are supported in all versions. This depends on the supported
761features and sometimes on the system. A remark about this is in curly braces
762below. When an option is not supported it may still be set without getting an
763error, this is called a hidden option. You can't get the value of a hidden
764option though, it is not stored.
765
766To test if option "foo" can be used with ":set" use something like this: >
767 if exists('&foo')
768This also returns true for a hidden option. To test if option "foo" is really
769supported use something like this: >
770 if exists('+foo')
771<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 *E355*
773A jump table for the options with a short description can be found at |Q_op|.
774
775 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100776'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 {only available when compiled with the |+rightleft|
779 feature}
780 The ASCII code for the first letter of the Hebrew alphabet. The
781 routine that maps the keyboard in Hebrew mode, both in Insert mode
782 (when hkmap is set) and on the command-line (when hitting CTRL-_)
783 outputs the Hebrew characters in the range [aleph..aleph+26].
784 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
785 See |rileft.txt|.
786
787 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
788'allowrevins' 'ari' boolean (default off)
789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 {only available when compiled with the |+rightleft|
791 feature}
792 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
793 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
794 into reverse Insert mode, and don't know how to get out. See
795 'revins'.
796 NOTE: This option is reset when 'compatible' is set.
797
798 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
799'altkeymap' 'akm' boolean (default off)
800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {only available when compiled with the |+farsi|
802 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100803 This option was for using Farsi, which has been removed. See
804 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806 *'ambiwidth'* *'ambw'*
807'ambiwidth' 'ambw' string (default: "single")
808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
810 Tells Vim what to do with characters with East Asian Width Class
811 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
812 letters, Cyrillic letters).
813
814 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000815 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 expected by most users.
817 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200818 *E834* *E835*
819 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100820 contains a character that would be double width. These errors may
821 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200822
823 The values are overruled for characters specified with
824 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 There are a number of CJK fonts for which the width of glyphs for
827 those characters are solely based on how many octets they take in
828 legacy/traditional CJK encodings. In those encodings, Euro,
829 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000830 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 Vim is running inside a terminal (emulators) that uses a CJK font
834 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
835 this option should be set to "double" to match the width perceived
836 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100837 to be set to "double" under CJK MS-Windows when the system locale is
838 set to one of CJK locales. See Unicode Standard Annex #11
839 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100841 Vim may set this option automatically at startup time when Vim is
842 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200843 escape sequence to request cursor position report. The response can
844 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100845
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
847'antialias' 'anti' boolean (default: off)
848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200850 on macOS}
851 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
853 which can be easier to read at certain sizes on certain displays.
854 Setting this option can sometimes cause problems if 'guifont' is set
855 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100856 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
859'arabic' 'arab' boolean (default off)
860 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 {only available when compiled with the |+arabic|
862 feature}
863 This option can be set to start editing Arabic text.
864 Setting this option will:
865 - Set the 'rightleft' option, unless 'termbidi' is set.
866 - Set the 'arabicshape' option, unless 'termbidi' is set.
867 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
868 between typing English and Arabic key mapping.
869 - Set the 'delcombine' option
870 Note that 'encoding' must be "utf-8" for working with Arabic text.
871
872 Resetting this option will:
873 - Reset the 'rightleft' option.
874 - Disable the use of 'keymap' (without changing its value).
875 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200876 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100877 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 Also see |arabic.txt|.
879
880 *'arabicshape'* *'arshape'*
881 *'noarabicshape'* *'noarshape'*
882'arabicshape' 'arshape' boolean (default on)
883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 {only available when compiled with the |+arabic|
885 feature}
886 When on and 'termbidi' is off, the required visual character
887 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200888 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 one which encompasses:
890 a) the changing/morphing of characters based on their location
891 within a word (initial, medial, final and stand-alone).
892 b) the enabling of the ability to compose characters
893 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100894 When disabled the display shows each character's true stand-alone
895 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Arabic is a complex language which requires other settings, for
897 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100898 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
laburnumT3f7855a2023-12-05 18:37:03 +0100900 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
901'autochdir' 'acd' boolean (default off)
902 global
903 {only available when compiled with it, use
904 exists("+autochdir") to check}
905 When on, Vim will change the current working directory whenever you
906 open a file, switch buffers, delete a buffer or open/close a window.
907 It will change to the directory containing the file which was opened
908 or selected. When a buffer has no name it also has no directory, thus
909 the current directory won't change when navigating to it.
910 Note: When this option is on some plugins may not work.
911
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
913'autoindent' 'ai' boolean (default off)
914 local to buffer
915 Copy indent from current line when starting a new line (typing <CR>
916 in Insert mode or when using the "o" or "O" command). If you do not
917 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000918 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
919 to another line has the same effect, unless the 'I' flag is included
920 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000921 When autoindent is on, formatting (with the "gq" command or when you
922 reach 'textwidth' in Insert mode) uses the indentation of the first
923 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 When 'smartindent' or 'cindent' is on the indent is changed in
925 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200926 The 'autoindent' option is reset when the 'paste' option is set and
927 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928
929 *'autoread'* *'ar'* *'noautoread'* *'noar'*
930'autoread' 'ar' boolean (default off)
931 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 When a file has been detected to have been changed outside of Vim and
933 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200934 When the file has been deleted this is not done, so you have the text
935 from before it was deleted. When it appears again then it is read.
936 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 If this option has a local value, use this command to switch back to
938 using the global value: >
939 :set autoread<
940<
laburnumT3f7855a2023-12-05 18:37:03 +0100941
942 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
943'autoshelldir' 'asd' boolean (default off)
944 global
945 When on, Vim will change the current working directory whenever you
946 change the directory of the shell running in a terminal window. You
947 need proper setting-up, so whenever the shell's pwd changes an OSC 7
948 escape sequence will be emitted. For example, on Linux, you can
949 source /etc/profile.d/vte.sh in your shell profile if you use bash or
950 zsh. For bash this should work (put it in a bash init file): >
951 if [[ -n "$VIM_TERMINAL" ]]; then
952 PROMPT_COMMAND='_vim_sync_PWD'
953 function _vim_sync_PWD() {
954 printf '\033]7;file://%s\033\\' "$PWD"
955 }
956 fi
957<
958 Or, in a zsh init file: >
959 if [[ -n "$VIM_TERMINAL" ]]; then
960 autoload -Uz add-zsh-hook
961 add-zsh-hook -Uz chpwd _vim_sync_PWD
962 function _vim_sync_PWD() {
963 printf '\033]7;file://%s\033\\' "$PWD"
964 }
965 fi
966<
967 In a fish init file: >
968 if test -n "$VIM_TERMINAL"
969 function _vim_sync_PWD --on-variable=PWD
970 printf '\033]7;file://%s\033\\' "$PWD"
971 end
972 end
973<
974 You can find an alternative method at |terminal-autoshelldir|.
975 When the parsing of the OSC sequence fails you get *E1179* .
976
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
978'autowrite' 'aw' boolean (default off)
979 global
980 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000981 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000982 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
983 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000984 to another file.
985 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000986 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 Note that for some commands the 'autowrite' option is not used, see
988 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200989 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200990 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100991 USE WITH CARE: If you make temporary changes to a buffer that you
992 don't want to be saved this option may cause it to be saved anyway.
993 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994
995 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
996'autowriteall' 'awa' boolean (default off)
997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
999 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1000 Setting this option also implies that Vim behaves like 'autowrite' has
1001 been set.
1002
1003 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001004'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 When set to "dark", Vim will try to use colors that look good on a
1007 dark background. When set to "light", Vim will try to use colors that
1008 look good on a light background. Any other value is illegal.
1009 Vim tries to set the default value according to the terminal used.
1010 This will not always be correct.
1011 Setting this option does not change the background color, it tells Vim
1012 what the background color looks like. For changing the background
1013 color, see |:hi-normal|.
1014
Gregory Anders83ad2722024-01-03 19:48:51 +01001015 When 'background' is changed Vim will adjust the default color groups
1016 for the new value. But the colors used for syntax highlighting will
1017 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001018 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001019 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 the color scheme adjusts to the value of 'background' this will work.
1021 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001022 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 When setting 'background' to the default value with: >
1025 :set background&
1026< Vim will guess the value. In the GUI this should work correctly,
1027 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001028 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001029 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001031 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001032 color from the terminal. If the returned RGB value is dark/light and
1033 'background' is not dark/light, 'background' will be set and the
1034 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001035 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001036 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001037
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 When starting the GUI, the default value for 'background' will be
1039 "light". When the value is not set in the .gvimrc, and Vim detects
1040 that the background is actually quite dark, 'background' is set to
1041 "dark". But this happens only AFTER the .gvimrc file has been read
1042 (because the window needs to be opened to find the actual background
1043 color). To get around this, force the GUI window to be opened by
1044 putting a ":gui" command in the .gvimrc file, before where the value
1045 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001046
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001047 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048 For other systems "dark" is used when 'term' is "linux",
1049 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1050 background. Otherwise the default is "light".
1051
Bram Moolenaarc572da52017-08-27 16:52:01 +02001052 The |:terminal| command and the |term_start()| function use the
1053 'background' value to decide whether the terminal window will start
1054 with a white or black background.
1055
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 Normally this option would be set in the .vimrc file. Possibly
1057 depending on the terminal name. Example: >
1058 :if &term == "pcterm"
1059 : set background=dark
1060 :endif
1061< When this option is set, the default settings for the highlight groups
1062 will change. To use other settings, place ":highlight" commands AFTER
1063 the setting of the 'background' option.
1064 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1065 to select the colors for syntax highlighting. After changing this
1066 option, you must load syntax.vim again to see the result. This can be
1067 done with ":syntax on".
1068
1069 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001070'backspace' 'bs' string (default "", set to "indent,eol,start"
1071 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1074 mode. This is a list of items, separated by commas. Each item allows
1075 a way to backspace over something:
1076 value effect ~
1077 indent allow backspacing over autoindent
1078 eol allow backspacing over line breaks (join lines)
1079 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1080 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001081 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1082 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083
Bram Moolenaar46eea442022-03-30 10:51:39 +01001084 When the value is empty, Vi compatible backspacing is used, none of
1085 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086
1087 For backwards compatibility with version 5.4 and earlier:
1088 value effect ~
1089 0 same as ":set backspace=" (Vi compatible)
1090 1 same as ":set backspace=indent,eol"
1091 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001092 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093
1094 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1095 NOTE: This option is set to "" when 'compatible' is set.
1096
1097 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1098'backup' 'bk' boolean (default off)
1099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 Make a backup before overwriting a file. Leave it around after the
1101 file has been successfully written. If you do not want to keep the
1102 backup file, but you do want a backup while the file is being
1103 written, reset this option and set the 'writebackup' option (this is
1104 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001105 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 |backup-table| for more explanations.
1107 When the 'backupskip' pattern matches, a backup is not made anyway.
1108 When 'patchmode' is set, the backup may be renamed to become the
1109 oldest version of a file.
1110 NOTE: This option is reset when 'compatible' is set.
1111
1112 *'backupcopy'* *'bkc'*
1113'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001114 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001116 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
1118 The main values are:
1119 "yes" make a copy of the file and overwrite the original one
1120 "no" rename the file and write a new one
1121 "auto" one of the previous, what works best
1122
1123 Extra values that can be combined with the ones above are:
1124 "breaksymlink" always break symlinks when writing
1125 "breakhardlink" always break hardlinks when writing
1126
1127 Making a copy and overwriting the original file:
1128 - Takes extra time to copy the file.
1129 + When the file has special attributes, is a (hard/symbolic) link or
1130 has a resource fork, all this is preserved.
1131 - When the file is a link the backup will have the name of the link,
1132 not of the real file.
1133
1134 Renaming the file and writing a new one:
1135 + It's fast.
1136 - Sometimes not all attributes of the file can be copied to the new
1137 file.
1138 - When the file is a link the new file will not be a link.
1139
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001140 The "auto" value is the middle way: When Vim sees that renaming the
1141 file is possible without side effects (the attributes can be passed on
1142 and the file is not a link) that is used. When problems are expected,
1143 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144
1145 The "breaksymlink" and "breakhardlink" values can be used in
1146 combination with any of "yes", "no" and "auto". When included, they
1147 force Vim to always break either symbolic or hard links by doing
1148 exactly what the "no" option does, renaming the original file to
1149 become the backup and writing a new file in its place. This can be
1150 useful for example in source trees where all the files are symbolic or
1151 hard links and any changes should stay in the local source tree, not
1152 be propagated back to the original source.
1153 *crontab*
1154 One situation where "no" and "auto" will cause problems: A program
1155 that opens a file, invokes Vim to edit that file, and then tests if
1156 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001157 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 example.
1159
1160 When a copy is made, the original file is truncated and then filled
1161 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001162 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001163 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 group of the backup is set to the group of the original file. If this
1165 fails, the protection bits for the group are made the same as for
1166 others.
1167
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001168 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 the same attributes of the original file, and the newly written file
1170 is owned by the current user. When the file was a (hard/symbolic)
1171 link, the new file will not! That's why the "auto" value doesn't
1172 rename when the file is a link. The owner and group of the newly
1173 written file will be set to the same ones as the original file, but
1174 the system may refuse to do this. In that case the "auto" value will
1175 again not rename the file.
1176
Bram Moolenaar036986f2017-03-16 17:41:02 +01001177 NOTE: This option is set to the Vi default value when 'compatible' is
1178 set and to the Vim default value when 'compatible' is reset.
1179
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 *'backupdir'* *'bdir'*
1181'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001182 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 for Unix: ".,~/tmp,~/")
1184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 List of directories for the backup file, separated with commas.
1186 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001187 where this is possible. The directory must exist, Vim will not
1188 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001189 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 impossible!). Writing may fail because of this.
1191 - A directory "." means to put the backup file in the same directory
1192 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001193 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1194 the backup file relative to where the edited file is. The leading
1195 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 ("." inside a directory name has no special meaning).
1197 - Spaces after the comma are ignored, other spaces are considered part
1198 of the directory name. To have a space at the start of a directory
1199 name, precede it with a backslash.
1200 - To include a comma in a directory name precede it with a backslash.
1201 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001202 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001203 the backup file name will be built from the complete path to the
1204 file with all path separators changed to percent '%' signs. This
1205 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001206 On Win32, it is also possible to end with "\\". However, When a
1207 separating comma is following, you must use "//", since "\\" will
1208 include the comma in the file name. Therefore it is recommended to
1209 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 - Environment variables are expanded |:set_env|.
1211 - Careful with '\' characters, type one before a space, type two to
1212 get one in the option (see |option-backslash|), for example: >
1213 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1214< - For backwards compatibility with Vim version 3.0 a '>' at the start
1215 of the option is removed.
1216 See also 'backup' and 'writebackup' options.
1217 If you want to hide your backup files on Unix, consider this value: >
1218 :set backupdir=./.backup,~/.backup,.,/tmp
1219< You must create a ".backup" directory in each directory and in your
1220 home directory for this to work properly.
1221 The use of |:set+=| and |:set-=| is preferred when adding or removing
1222 directories from the list. This avoids problems when a future version
1223 uses another default.
1224 This option cannot be set from a |modeline| or in the |sandbox|, for
1225 security reasons.
1226
1227 *'backupext'* *'bex'* *E589*
1228'backupext' 'bex' string (default "~", for VMS: "_")
1229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 String which is appended to a file name to make the name of the
1231 backup file. The default is quite unusual, because this avoids
1232 accidentally overwriting existing files with a backup file. You might
1233 prefer using ".bak", but make sure that you don't have files with
1234 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001235 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001237 If you like to keep a lot of backups, you could use a BufWritePre
1238 autocommand to change 'backupext' just before writing the file to
1239 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001240 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001241< Use 'backupdir' to put the backup in a different directory.
1242
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001244'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1245 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1246 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 A list of file patterns. When one of the patterns matches with the
1249 name of the file which is written, no backup file is created. Both
1250 the specified file name and the full path name of the file are used.
1251 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1252 Watch out for special characters, see |option-backslash|.
1253 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001254 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001255
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001256 WARNING: Not having a backup file means that when Vim fails to write
1257 your buffer correctly and then, for whatever reason, Vim exits, you
1258 lose both the original file and what you were writing. Only disable
1259 backups if you don't care about losing the file.
1260
Bram Moolenaar02467872007-05-06 13:22:01 +00001261 Note that environment variables are not expanded. If you want to use
1262 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001263 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001264
1265< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001266 backup would be made by renaming the original file crontab won't see
1267 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
1269 *'balloondelay'* *'bdlay'*
1270'balloondelay' 'bdlay' number (default: 600)
1271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 {only available when compiled with the |+balloon_eval|
1273 feature}
1274 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1275
1276 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1277'ballooneval' 'beval' boolean (default off)
1278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001280 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001281 Switch on the |balloon-eval| functionality for the GUI.
1282
1283 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1284 *'nobevalterm'*
1285'balloonevalterm' 'bevalterm' boolean (default off)
1286 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001287 {only available when compiled with the
1288 |+balloon_eval_term| feature}
1289 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001291 *'balloonexpr'* *'bexpr'*
1292'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001293 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 {only available when compiled with the |+balloon_eval|
1295 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001296 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001297 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1298 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001299
1300 v:beval_bufnr number of the buffer in which balloon is going to show
1301 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001302 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001303 v:beval_lnum line number
1304 v:beval_col column number (byte index)
1305 v:beval_text word under or after the mouse pointer
1306
Bram Moolenaar54775062019-07-31 21:07:14 +02001307 Instead of showing a balloon, which is limited to plain text, consider
1308 using a popup window, see |popup_beval_example|. A popup window can
1309 use highlighting and show a border.
1310
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001311 The evaluation of the expression must not have side effects!
1312 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001313 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001314 return 'Cursor is at line ' .. v:beval_lnum ..
1315 \ ', column ' .. v:beval_col ..
1316 \ ' of file ' .. bufname(v:beval_bufnr) ..
1317 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001318 endfunction
1319 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001320 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001322 Also see |balloon_show()|, it can be used if the content of the balloon
1323 is to be fetched asynchronously. In that case evaluating
1324 'balloonexpr' should result in an empty string. If you get a balloon
1325 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001326
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001327 NOTE: The balloon is displayed only if the cursor is on a text
1328 character. If the result of evaluating 'balloonexpr' is not empty,
1329 Vim does not try to send a message to an external debugger (Netbeans
1330 or Sun Workshop).
1331
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001332 If the expression starts with s: or |<SID>|, then it is replaced with
1333 the script ID (|local-function|). Example: >
1334 set bexpr=s:MyBalloonExpr()
1335 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001336< Otherwise, the expression is evaluated in the context of the script
1337 where the option was set, thus script-local items are available.
1338
Bram Moolenaar30b65812012-07-12 22:01:11 +02001339 The expression will be evaluated in the |sandbox| when set from a
1340 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001341 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001342
1343 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001344 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001346 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001347 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001348< When they are supported "\n" characters will start a new line. If the
1349 expression evaluates to a |List| this is equal to using each List item
1350 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001351 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001352
Bram Moolenaar165bc692015-07-21 17:53:25 +02001353 *'belloff'* *'bo'*
1354'belloff' 'bo' string (default "")
1355 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 Specifies for which events the bell will not be rung. It is a comma
1357 separated list of items. For each item that is present, the bell
1358 will be silenced. This is most useful to specify specific events in
1359 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001360 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001361
1362 item meaning when present ~
1363 all All events.
1364 backspace When hitting <BS> or <Del> and deleting results in an
1365 error.
1366 cursor Fail to move around using the cursor keys or
1367 <PageUp>/<PageDown> in |Insert-mode|.
1368 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1369 |i_CTRL-X_CTRL-T|.
1370 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1371 |i_CTRL-E|.
1372 ctrlg Unknown Char after <C-G> in Insert mode.
1373 error Other Error occurred (e.g. try to join last line)
1374 (mostly used in |Normal-mode| or |Cmdline-mode|).
1375 esc hitting <Esc> in |Normal-mode|.
1376 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001377 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001378 insertmode Pressing <Esc> in 'insertmode'.
1379 lang Calling the beep module for Lua/Mzscheme/TCL.
1380 mess No output available for |g<|.
1381 showmatch Error occurred for 'showmatch' function.
1382 operator Empty region error |cpo-E|.
1383 register Unknown register after <C-R> in |Insert-mode|.
1384 shell Bell from shell output |:!|.
1385 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001386 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001387 wildmode More matches in |cmdline-completion| available
1388 (depends on the 'wildmode' setting).
1389
Bram Moolenaar036986f2017-03-16 17:41:02 +01001390 This is most useful to fine tune when in Insert mode the bell should
1391 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001392 indicate that an error occurred. It can be silenced by adding the
1393 "error" keyword.
1394
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1396'binary' 'bin' boolean (default off)
1397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 This option should be set before editing a binary file. You can also
1399 use the |-b| Vim argument. When this option is switched on a few
1400 options will be changed (also when it already was on):
1401 'textwidth' will be set to 0
1402 'wrapmargin' will be set to 0
1403 'modeline' will be off
1404 'expandtab' will be off
1405 Also, 'fileformat' and 'fileformats' options will not be used, the
1406 file is read and written like 'fileformat' was "unix" (a single <NL>
1407 separates lines).
1408 The 'fileencoding' and 'fileencodings' options will not be used, the
1409 file is read without conversion.
1410 NOTE: When you start editing a(nother) file while the 'bin' option is
1411 on, settings from autocommands may change the settings again (e.g.,
1412 'textwidth'), causing trouble when editing. You might want to set
1413 'bin' again when the file has been loaded.
1414 The previous values of these options are remembered and restored when
1415 'bin' is switched from on to off. Each buffer has its own set of
1416 saved option values.
1417 To edit a file with 'binary' set you can use the |++bin| argument.
1418 This avoids you have to do ":set bin", which would have effect for all
1419 files you edit.
1420 When writing a file the <EOL> for the last line is only written if
1421 there was one in the original file (normally Vim appends an <EOL> to
1422 the last line if there is none; this would make the file longer). See
1423 the 'endofline' option.
1424
1425 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1426'bioskey' 'biosk' boolean (default on)
1427 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001428 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001429 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430
1431 *'bomb'* *'nobomb'*
1432'bomb' boolean (default off)
1433 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 When writing a file and the following conditions are met, a BOM (Byte
1435 Order Mark) is prepended to the file:
1436 - this option is on
1437 - the 'binary' option is off
1438 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1439 endian variants.
1440 Some applications use the BOM to recognize the encoding of the file.
1441 Often used for UCS-2 files on MS-Windows. For other applications it
1442 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001443 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1445 check for the presence of the BOM is done and 'bomb' set accordingly.
1446 Unless 'binary' is set, it is removed from the first line, so that you
1447 don't see it when editing. When you don't change the options, the BOM
1448 will be restored when writing the file.
1449
1450 *'breakat'* *'brk'*
1451'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1452 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001453 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454 feature}
1455 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001456 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1457 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001459 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001460'breakindent' 'bri' boolean (default off)
1461 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001462 {not available when compiled without the |+linebreak|
1463 feature}
1464 Every wrapped line will continue visually indented (same amount of
1465 space as the beginning of that line), thus preserving horizontal blocks
1466 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001467 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001468
1469 *'breakindentopt'* *'briopt'*
1470'breakindentopt' 'briopt' string (default empty)
1471 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001472 {not available when compiled without the |+linebreak|
1473 feature}
1474 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001475 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001476 min:{n} Minimum text width that will be kept after
1477 applying 'breakindent', even if the resulting
1478 text should normally be narrower. This prevents
1479 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001480 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001481 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001482 shift:{n} After applying 'breakindent', the wrapped line's
1483 beginning will be shifted by the given number of
1484 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001485 indentation (negative) or emphasizing the line
1486 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001487 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001488 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001489 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001491 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001492 numbered or bulleted list (using the
1493 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:-1 Uses the length of a match with 'formatlistpat'
1495 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001496 (default: 0)
1497 column:{n} Indent at column {n}. Will overrule the other
1498 sub-options. Note: an additional indent may be
1499 added for the 'showbreak' setting.
1500 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001501
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001503'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001505 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001507 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001508 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 buffer Use the directory of the related buffer.
1510 current Use the current directory.
1511 {path} Use the specified directory
1512
1513 *'bufhidden'* *'bh'*
1514'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001515 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 This option specifies what happens when a buffer is no longer
1517 displayed in a window:
1518 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001519 hide hide the buffer (don't unload it), even if 'hidden' is
1520 not set
1521 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001522 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001523 delete delete the buffer from the buffer list, even if
1524 'hidden' is set; the |:hide| command will also delete
1525 the buffer, making it behave like |:bdelete|
1526 wipe wipe the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also wipe
1528 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001530 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001531 are lost without a warning. Also, these values may break autocommands
1532 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 This option is used together with 'buftype' and 'swapfile' to specify
1534 special kinds of buffers. See |special-buffers|.
1535
1536 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1537'buflisted' 'bl' boolean (default: on)
1538 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 When this option is set, the buffer shows up in the buffer list. If
1540 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1541 This option is reset by Vim for buffers that are only used to remember
1542 a file name or marks. Vim sets it when starting to edit a buffer.
1543 But not when moving to a buffer with ":buffer".
1544
1545 *'buftype'* *'bt'* *E382*
1546'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001547 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 The value of this option specifies the type of a buffer:
1549 <empty> normal buffer
1550 nofile buffer which is not related to a file and will not be
1551 written
1552 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001553 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001554 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001556 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 help help buffer (you are not supposed to set this
1558 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001559 terminal buffer for a |terminal| (you are not supposed to set
1560 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001561 prompt buffer where only the last line can be edited, meant
1562 to be used by a plugin, see |prompt-buffer|
1563 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001564 popup buffer used in a popup window, see |popup|.
1565 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566
1567 This option is used together with 'bufhidden' and 'swapfile' to
1568 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001569 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570
1571 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001572 One such effect is that Vim will not check the timestamp of the file,
1573 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574
Bram Moolenaar280f1262006-01-30 00:14:18 +00001575 A "quickfix" buffer is only used for the error list and the location
1576 list. This value is set by the |:cwindow| and |:lwindow| commands and
1577 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578
1579 "nofile" and "nowrite" buffers are similar:
1580 both: The buffer is not to be written to disk, ":w" doesn't
1581 work (":w filename" does work though).
1582 both: The buffer is never considered to be |'modified'|.
1583 There is no warning when the changes will be lost, for
1584 example when you quit Vim.
1585 both: A swap file is only created when using too much memory
1586 (when 'swapfile' has been reset there is never a swap
1587 file).
1588 nofile only: The buffer name is fixed, it is not handled like a
1589 file name. It is not modified in response to a |:cd|
1590 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001591 both: When using ":e bufname" and already editing "bufname"
1592 the buffer is made empty and autocommands are
1593 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001594 *E676*
1595 "acwrite" implies that the buffer name is not related to a file, like
1596 "nofile", but it will be written. Thus, in contrast to "nofile" and
1597 "nowrite", ":w" does work and a modified buffer can't be abandoned
1598 without saving. For writing there must be matching |BufWriteCmd|,
1599 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600
1601 *'casemap'* *'cmp'*
1602'casemap' 'cmp' string (default: "internal,keepascii")
1603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 Specifies details about changing the case of letters. It may contain
1605 these words, separated by a comma:
1606 internal Use internal case mapping functions, the current
1607 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001608 matters when 'encoding' is a Unicode encoding,
1609 "latin1" or "iso-8859-15". When "internal" is
1610 omitted, the towupper() and towlower() system library
1611 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1613 case mapping, the current locale is not effective.
1614 This probably only matters for Turkish.
1615
Bram Moolenaar938ae282023-02-20 20:44:55 +00001616 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001617'cdhome' 'cdh' boolean (default: off)
1618 global
1619 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1620 current working directory to the |$HOME| directory like in Unix.
1621 When off, those commands just print the current directory name.
1622 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001623 This option cannot be set from a |modeline| or in the |sandbox|, for
1624 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001625 NOTE: This option is reset when 'compatible' is set.
1626
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 *'cdpath'* *'cd'* *E344* *E346*
1628'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001631 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1632 searched for has a relative path, not an absolute part starting with
1633 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 The 'cdpath' option's value has the same form and semantics as
1635 |'path'|. Also see |file-searching|.
1636 The default value is taken from $CDPATH, with a "," prepended to look
1637 in the current directory first.
1638 If the default value taken from $CDPATH is not what you want, include
1639 a modified version of the following command in your vimrc file to
1640 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001641 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642< This option cannot be set from a |modeline| or in the |sandbox|, for
1643 security reasons.
1644 (parts of 'cdpath' can be passed to the shell to expand file names).
1645
1646 *'cedit'*
1647'cedit' string (Vi default: "", Vim default: CTRL-F)
1648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 The key used in Command-line Mode to open the command-line window.
1650 The default is CTRL-F when 'compatible' is off.
1651 Only non-printable keys are allowed.
1652 The key can be specified as a single character, but it is difficult to
1653 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001654 :exe "set cedit=\<C-Y>"
1655 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656< |Nvi| also has this option, but it only uses the first character.
1657 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001658 NOTE: This option is set to the Vim default value when 'compatible'
1659 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1662'charconvert' 'ccv' string (default "")
1663 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001664 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 An expression that is used for character encoding conversion. It is
1666 evaluated when a file that is to be read or has been written has a
1667 different encoding from what is desired.
1668 'charconvert' is not used when the internal iconv() function is
1669 supported and is able to do the conversion. Using iconv() is
1670 preferred, because it is much faster.
1671 'charconvert' is not used when reading stdin |--|, because there is no
1672 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001673 The expression must return zero, false or an empty string for success,
1674 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 The possible encoding names encountered are in 'encoding'.
1676 Additionally, names given in 'fileencodings' and 'fileencoding' are
1677 used.
1678 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1679 is done internally by Vim, 'charconvert' is not used for this.
1680 'charconvert' is also used to convert the viminfo file, if the 'c'
1681 flag is present in 'viminfo'. Also used for Unicode conversion.
1682 Example: >
1683 set charconvert=CharConvert()
1684 fun CharConvert()
1685 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001686 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1687 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 return v:shell_error
1689 endfun
1690< The related Vim variables are:
1691 v:charconvert_from name of the current encoding
1692 v:charconvert_to name of the desired encoding
1693 v:fname_in name of the input file
1694 v:fname_out name of the output file
1695 Note that v:fname_in and v:fname_out will never be the same.
1696 Note that v:charconvert_from and v:charconvert_to may be different
1697 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001698
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001699 The advantage of using a function call without arguments is that it is
1700 faster, see |expr-option-function|.
1701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 Encryption is not done by Vim when using 'charconvert'. If you want
1703 to encrypt the file after conversion, 'charconvert' should take care
1704 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001705
1706 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1707 replaced with the script ID (|local-function|). Example: >
1708 set charconvert=s:MyConvert()
1709 set charconvert=<SID>SomeConvert()
1710< Otherwise the expression is evaluated in the context of the script
1711 where the option was set, thus script-local items are available.
1712
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 This option cannot be set from a |modeline| or in the |sandbox|, for
1714 security reasons.
1715
1716 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1717'cindent' 'cin' boolean (default off)
1718 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001719 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 that trigger reindenting in insert mode and 'cinoptions' to set your
1721 preferred indent style.
1722 If 'indentexpr' is not empty, it overrules 'cindent'.
1723 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1724 the "=" operator indents using this algorithm rather than calling an
1725 external program.
1726 See |C-indenting|.
1727 When you don't like the way 'cindent' works, try the 'smartindent'
1728 option or 'indentexpr'.
1729 This option is not used when 'paste' is set.
1730 NOTE: This option is reset when 'compatible' is set.
1731
1732 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001733'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 A list of keys that, when typed in Insert mode, cause reindenting of
1736 the current line. Only used if 'cindent' is on and 'indentexpr' is
1737 empty.
1738 For the format of this option see |cinkeys-format|.
1739 See |C-indenting|.
1740
1741 *'cinoptions'* *'cino'*
1742'cinoptions' 'cino' string (default "")
1743 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1745 program. See |cinoptions-values| for the values of this option, and
1746 |C-indenting| for info on C indenting in general.
1747
laburnumT3f7855a2023-12-05 18:37:03 +01001748 *'cinscopedecls'* *'cinsd'*
1749'cinscopedecls' 'cinsd' string (default "public,protected,private")
1750 local to buffer
1751 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1752 Useful e.g. for working with the Qt framework that defines additional
1753 scope declarations "signals", "public slots" and "private slots": >
1754 set cinscopedecls+=signals,public\ slots,private\ slots
1755<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 *'cinwords'* *'cinw'*
1757'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1758 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 These keywords start an extra indent in the next line when
1760 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1761 an appropriate place (inside {}).
1762 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1763 matter, include the keyword both the uppercase and lowercase:
1764 "if,If,IF".
1765
laburnumT3f7855a2023-12-05 18:37:03 +01001766 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1768 for X-windows, "" otherwise)
1769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 {only in GUI versions or when the |+xterm_clipboard|
1771 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001772 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001773 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001774 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001775 prepend, e.g.: >
1776 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001777< When using the GUI see |'go-A'|.
1778 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001780 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 unnamed When included, Vim will use the clipboard register '*'
1782 for all yank, delete, change and put operations which
1783 would normally go to the unnamed register. When a
1784 register is explicitly specified, it will always be
1785 used regardless of whether "unnamed" is in 'clipboard'
1786 or not. The clipboard register can always be
1787 explicitly accessed using the "* notation. Also see
1788 |gui-clipboard|.
1789
Bram Moolenaar30b65812012-07-12 22:01:11 +02001790 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001791 unnamedplus A variant of the "unnamed" flag which uses the
1792 clipboard register '+' (|quoteplus|) instead of
1793 register '*' for all yank, delete, change and put
1794 operations which would normally go to the unnamed
1795 register. When "unnamed" is also included to the
1796 option, yank operations (but not delete, change or
1797 put) will additionally copy the text into register
1798 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001799 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001800 Availability can be checked with: >
1801 if has('unnamedplus')
1802<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001803 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 autoselect Works like the 'a' flag in 'guioptions': If present,
1805 then whenever Visual mode is started, or the Visual
1806 area extended, Vim tries to become the owner of the
1807 windowing system's global selection or put the
1808 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001809 register "*. See |'go-a'| and |quotestar| for details.
1810 When the GUI is active, the 'a' flag in 'guioptions'
1811 is used, when the GUI is not active, this "autoselect"
1812 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 Also applies to the modeless selection.
1814
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001815 *clipboard-autoselectplus*
1816 autoselectplus Like "autoselect" but using the + register instead of
1817 the * register. Compare to the 'P' flag in
1818 'guioptions'.
1819
1820 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 autoselectml Like "autoselect", but for the modeless selection
1822 only. Compare to the 'A' flag in 'guioptions'.
1823
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001824 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001825 html When the clipboard contains HTML, use this when
1826 pasting. When putting text on the clipboard, mark it
1827 as HTML. This works to copy rendered HTML from
1828 Firefox, paste it as raw HTML in Vim, select the HTML
1829 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001830 You probably want to add this only temporarily,
1831 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001832 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001833
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001834 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 exclude:{pattern}
1836 Defines a pattern that is matched against the name of
1837 the terminal 'term'. If there is a match, no
1838 connection will be made to the X server. This is
1839 useful in this situation:
1840 - Running Vim in a console.
1841 - $DISPLAY is set to start applications on another
1842 display.
1843 - You do not want to connect to the X server in the
1844 console, but do want this in a terminal emulator.
1845 To never connect to the X server use: >
1846 exclude:.*
1847< This has the same effect as using the |-X| argument.
1848 Note that when there is no connection to the X server
1849 the window title won't be restored and the clipboard
1850 cannot be accessed.
1851 The value of 'magic' is ignored, {pattern} is
1852 interpreted as if 'magic' was on.
1853 The rest of the option value will be used for
1854 {pattern}, this must be the last entry.
1855
1856 *'cmdheight'* *'ch'*
1857'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001858 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001859 Number of screen lines to use for the command-line. A larger value
1860 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001861 The value of this option is stored with the tab page, so that each tab
1862 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863
1864 *'cmdwinheight'* *'cwh'*
1865'cmdwinheight' 'cwh' number (default 7)
1866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 Number of screen lines to use for the command-line window. |cmdwin|
1868
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001869 *'colorcolumn'* *'cc'*
1870'colorcolumn' 'cc' string (default "")
1871 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001872 {not available when compiled without the |+syntax|
1873 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001874 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001875 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1876 text. Will make screen redrawing slower.
1877 The screen column can be an absolute number, or a number preceded with
1878 '+' or '-', which is added to or subtracted from 'textwidth'. >
1879
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001880 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001881 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1882 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1883<
1884 When 'textwidth' is zero then the items with '-' and '+' are not used.
1885 A maximum of 256 columns are highlighted.
1886
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887 *'columns'* *'co'* *E594*
1888'columns' 'co' number (default 80 or terminal width)
1889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001891 initialization and does not have to be set by hand. Also see
1892 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 When Vim is running in the GUI or in a resizable window, setting this
1894 option will cause the window size to be changed. When you only want
1895 to use the size for the GUI, put the command in your |gvimrc| file.
1896 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001897 number of columns of the display, the display may be messed up. For
1898 the GUI it is always possible and Vim limits the number of columns to
1899 what fits on the screen. You can use this command to get the widest
1900 window possible: >
1901 :set columns=9999
1902< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903
1904 *'comments'* *'com'* *E524* *E525*
1905'comments' 'com' string (default
1906 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1907 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001908 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 |format-comments|. See |option-backslash| about using backslashes to
1910 insert a space.
1911
1912 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001913'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 {not available when compiled without the |+folding|
1916 feature}
1917 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001918 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001919 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001920 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921
1922 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001923'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001924 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 This option has the effect of making Vim either more Vi-compatible, or
1927 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001928
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001930 other options are also changed as a side effect.
1931 NOTE: Setting or resetting this option can have a lot of unexpected
1932 effects: Mappings are interpreted in another way, undo behaves
1933 differently, etc. If you set this option in your vimrc file, you
1934 should probably put it at the very start.
1935
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 By default this option is on and the Vi defaults are used for the
1937 options. This default was chosen for those people who want to use Vim
1938 just like Vi, and don't even (want to) know about the 'compatible'
1939 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001940 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001941 this option is switched off, and all options that have not been
1942 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001943 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001944 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001945 happen for the system-wide vimrc or gvimrc file, nor for a file given
1946 with the |-u| argument). Also see |compatible-default| and
1947 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 You can also set this option with the "-C" argument, and reset it with
1949 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001950 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951
Bram Moolenaar214641f2017-03-05 17:04:09 +01001952 When this option is set, numerous other options are set to make Vim as
1953 Vi-compatible as possible. When this option is unset, various options
1954 are set to make Vim more useful. The table below lists all the
1955 options affected.
1956 The {?} column indicates when the options are affected:
1957 + Means that the option is set to the value given in {set value} when
1958 'compatible' is set.
1959 & Means that the option is set to the value given in {set value} when
1960 'compatible' is set AND is set to its Vim default value when
1961 'compatible' is unset.
1962 - Means the option is NOT changed when setting 'compatible' but IS
1963 set to its Vim default when 'compatible' is unset.
1964 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965
Bram Moolenaar036986f2017-03-16 17:41:02 +01001966 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001967
1968 'allowrevins' + off no CTRL-_ command
1969 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001970 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971 'arabicshape' + on correct character shapes
1972 'backspace' + "" normal backspace
1973 'backup' + off no backup file
1974 'backupcopy' & Unix: "yes" backup file is a copy
1975 else: "auto" copy or rename backup file
1976 'balloonexpr' + "" text to show in evaluation balloon
1977 'breakindent' + off don't indent when wrapping lines
1978 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001979 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001980 'cindent' + off no C code indentation
1981 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1982 'copyindent' + off don't copy indent structure
1983 'cpoptions' & (all flags) Vi-compatible flags
1984 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001985 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001986 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001987 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001988 'cscopeverbose' + off see |cscopeverbose|
1989 'delcombine' + off unicode: delete whole char combination
1990 'digraph' + off no digraphs
1991 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001992 this also disables |modifyOtherKeys|
1993 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001994 'expandtab' + off tabs not expanded to spaces
1995 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001996 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001997 'formatexpr' + "" use 'formatprg' for auto-formatting
1998 'formatoptions' & "vt" Vi compatible formatting
1999 'gdefault' + off no default 'g' flag for ":s"
2000 'history' & 0 no commandline history
2001 'hkmap' + off no Hebrew keyboard mapping
2002 'hkmapp' + off no phonetic Hebrew keyboard mapping
2003 'hlsearch' + off no highlighting of search matches
2004 'incsearch' + off no incremental searching
2005 'indentexpr' + "" no indenting by expression
2006 'insertmode' + off do not start in Insert mode
2007 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002009 'joinspaces' + on insert 2 spaces after period
2010 'modeline' & off no modelines
2011 'more' & off no pauses in listings
2012 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2013 'numberwidth' & 8 min number of columns for line number
2014 'preserveindent'+ off don't preserve current indent structure
2015 when changing it
2016 'revins' + off no reverse insert
2017 'ruler' + off no ruler
2018 'scrolljump' + 1 no jump scroll
2019 'scrolloff' + 0 no scroll offset
2020 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2021 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002022 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002023 'showcmd' & off command characters not shown
2024 'showmode' & off current mode not shown
2025 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2026 'smartcase' + off no automatic ignore case switch
2027 'smartindent' + off no smart indentation
2028 'smarttab' + off no smart tab size
2029 'softtabstop' + 0 tabs are always 'tabstop' positions
2030 'startofline' + on goto startofline with some commands
2031 'tagcase' & "followic" 'ignorecase' when searching tags file
2032 'tagrelative' & off tag file names are not relative
2033 'termguicolors' + off don't use highlight-(guifg|guibg)
2034 'textauto' & off no automatic textmode detection
2035 'textwidth' + 0 no automatic line wrap
2036 'tildeop' + off tilde is not an operator
2037 'ttimeout' + off no terminal timeout
2038 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002039 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002040 'virtualedit' + "" cursor can only be placed on characters
2041 'whichwrap' & "" left-right movements don't wrap
2042 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045
2046 *'complete'* *'cpt'* *E535*
2047'complete' 'cpt' string (default: ".,w,b,u,t,i")
2048 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 This option specifies how keyword completion |ins-completion| works
2050 when CTRL-P or CTRL-N are used. It is also used for whole-line
2051 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002052 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002053 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 w scan buffers from other windows
2055 b scan other loaded buffers that are in the buffer list
2056 u scan the unloaded buffers that are in the buffer list
2057 U scan the buffers that are not in the buffer list
2058 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002059 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 k{dict} scan the file {dict}. Several "k" flags can be given,
2061 patterns are valid too. For example: >
2062 :set cpt=k/usr/dict/*,k~/spanish
2063< s scan the files given with the 'thesaurus' option
2064 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2065 are valid too.
2066 i scan current and included files
2067 d scan current and included files for defined name or macro
2068 |i_CTRL-X_CTRL-D|
2069 ] tag completion
2070 t same as "]"
2071
2072 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2073 not executed, this may lead to unexpected completions from some files
2074 (gzipped files for example). Unloaded buffers are not scanned for
2075 whole-line completion.
2076
2077 The default is ".,w,b,u,t,i", which means to scan:
2078 1. the current buffer
2079 2. buffers in other windows
2080 3. other loaded buffers
2081 4. unloaded buffers
2082 5. tags
2083 6. included files
2084
2085 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002086 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2087 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002089 *'completefunc'* *'cfu'*
2090'completefunc' 'cfu' string (default: empty)
2091 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002092 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002093 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002094 This option specifies a function to be used for Insert mode completion
2095 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002096 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002097 invoked and what it should return. The value can be the name of a
2098 function, a |lambda| or a |Funcref|. See |option-value-function| for
2099 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002100 This option cannot be set from a |modeline| or in the |sandbox|, for
2101 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002102
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002103 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002104'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002105 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002106 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002107 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002108
2109 menu Use a popup menu to show the possible completions. The
2110 menu is only shown when there is more than one match and
2111 sufficient colors are available. |ins-completion-menu|
2112
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002113 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002114 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002115 match, e.g., what file it comes from.
2116
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002117 longest Only insert the longest common text of the matches. If
2118 the menu is displayed you can use CTRL-L to add more
2119 characters. Whether case is ignored depends on the kind
2120 of completion. For buffer text the 'ignorecase' option is
2121 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002122
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002123 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002124 completion in the preview window. Only works in
2125 combination with "menu" or "menuone".
2126
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002127 popup Show extra information about the currently selected
2128 completion in a popup window. Only works in combination
2129 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002130 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002131 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002132
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002133 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002134 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002135 |CompleteChanged| autocommand to fetch the info and call
2136 |popup_show()| once the popup has been filled.
2137 See the example at |complete-popuphidden|.
2138 {only works when compiled with the |+textprop| feature}
2139
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002140 noinsert Do not insert any text for a match until the user selects
2141 a match from the menu. Only works in combination with
2142 "menu" or "menuone". No effect if "longest" is present.
2143
2144 noselect Do not select a match in the menu, force the user to
2145 select one from the menu. Only works in combination with
2146 "menu" or "menuone".
2147
glepnira218cc62024-06-03 19:32:39 +02002148 fuzzy Enable |fuzzy-matching| for completion candidates. This
2149 allows for more flexible and intuitive matching, where
2150 characters can be skipped and matches can be found even
Christian Brabandt2a2c4ff2024-06-04 20:27:18 +02002151 if the exact sequence is not typed. Only makes a
2152 difference how completion candidates are reduced from the
2153 list of alternatives, but not how the candidates are
2154 collected (using different completion types).
glepnira218cc62024-06-03 19:32:39 +02002155
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002156 *'completepopup'* *'cpp'*
2157'completepopup' 'cpp' string (default empty)
2158 global
2159 {not available when compiled without the |+textprop|
2160 or |+quickfix| feature}
2161 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002162 properties of the info popup when it is created. If an info popup
2163 window already exists it is closed, so that the option value is
2164 applied when it is created again.
2165 You can also use |popup_findinfo()| and then set properties for an
2166 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002167
laburnumT3f7855a2023-12-05 18:37:03 +01002168 *'completeslash'* *'csl'*
2169'completeslash' 'csl' string (default: "")
2170 local to buffer
2171 {only for MS-Windows}
2172 When this option is set it overrules 'shellslash' for completion:
2173 - When this option is set to "slash", a forward slash is used for path
2174 completion in insert mode. This is useful when editing HTML tag, or
2175 Makefile with 'noshellslash' on MS-Windows.
2176 - When this option is set to "backslash", backslash is used. This is
2177 useful when editing a batch file with 'shellslash' set on MS-Windows.
2178 - When this option is empty, same character is used as for
2179 'shellslash'.
2180 For Insert mode completion the buffer-local value is used. For
2181 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002182
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002183 *'concealcursor'* *'cocu'*
2184'concealcursor' 'cocu' string (default: "")
2185 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002186 {not available when compiled without the |+conceal|
2187 feature}
2188 Sets the modes in which text in the cursor line can also be concealed.
2189 When the current mode is listed then concealing happens just like in
2190 other lines.
2191 n Normal mode
2192 v Visual mode
2193 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002194 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002195
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002196 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002197 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002198 are moving around text is concealed, but when starting to insert text
2199 or selecting a Visual area the concealed text is displayed, so that
2200 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002201 Keep in mind that the cursor position is not always where it's
2202 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002203
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002204 *'conceallevel'* *'cole'*
2205'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002206 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002207 {not available when compiled without the |+conceal|
2208 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002209 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2210 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002211
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002212 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002213 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002214 1 Each block of concealed text is replaced with one
2215 character. If the syntax item does not have a custom
2216 replacement character defined (see |:syn-cchar|) the
2217 character defined in 'listchars' is used (default is a
2218 space).
2219 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002220 2 Concealed text is completely hidden unless it has a
2221 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002222 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002223 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002224
Bram Moolenaara7781e02010-07-19 20:13:22 +02002225 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002226 edit and copy the text. This can be changed with the 'concealcursor'
2227 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002228
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2230'confirm' 'cf' boolean (default off)
2231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 When 'confirm' is on, certain operations that would normally
2233 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2234 instead raise a |dialog| asking if you wish to save the current
2235 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2236 If 'confirm' is off you can still activate confirmation for one
2237 command only (this is most useful in mappings) with the |:confirm|
2238 command.
2239 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2240
2241 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2242'conskey' 'consk' boolean (default off)
2243 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002244 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245
2246 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2247'copyindent' 'ci' boolean (default off)
2248 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 Copy the structure of the existing lines indent when autoindenting a
2250 new line. Normally the new indent is reconstructed by a series of
2251 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2252 in which case only spaces are used). Enabling this option makes the
2253 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002254 existing line. 'expandtab' has no effect on these characters, a Tab
2255 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002257 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 Also see 'preserveindent'.
2259
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002260 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002261'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2262 Vi default: all flags, except "#{|&/\."
2263 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002266 this indicates Vi-compatible behavior. This is used for things where
2267 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 'cpoptions' stands for "compatible-options".
2269 Commas can be added for readability.
2270 To avoid problems with flags that are added in the future, use the
2271 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002272
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 NOTE: This option is set to the Vi default value when 'compatible' is
2274 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002275
2276 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2277 is saved, 'cpoptions' is set to the Vim default, and the saved value
2278 is restored at the end of the script. Changes to the value of
2279 'cpoptions' will be applied to the saved value, but keep in mind that
2280 removing a flag that is not present when 'cpoptions' is changed has no
2281 effect. In the |.vimrc| file the value is not restored, thus using
2282 `vim9script` in the |.vimrc| file results in using the Vim default.
2283
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002284 NOTE: This option is set to the POSIX default value at startup when
2285 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002286 variable exists |posix|. This means Vim tries to behave like the
2287 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288
2289 contains behavior ~
2290 *cpo-a*
2291 a When included, a ":read" command with a file name
2292 argument will set the alternate file name for the
2293 current window.
2294 *cpo-A*
2295 A When included, a ":write" command with a file name
2296 argument will set the alternate file name for the
2297 current window.
2298 *cpo-b*
2299 b "\|" in a ":map" command is recognized as the end of
2300 the map command. The '\' is included in the mapping,
2301 the text after the '|' is interpreted as the next
2302 command. Use a CTRL-V instead of a backslash to
2303 include the '|' in the mapping. Applies to all
2304 mapping, abbreviation, menu and autocmd commands.
2305 See also |map_bar|.
2306 *cpo-B*
2307 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002308 abbreviations, user commands and the "to" part of the
2309 menu commands. Remove this flag to be able to use a
2310 backslash like a CTRL-V. For example, the command
2311 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 'B' included: "\^[" (^[ is a real <Esc>)
2313 'B' excluded: "<Esc>" (5 characters)
2314 ('<' excluded in both cases)
2315 *cpo-c*
2316 c Searching continues at the end of any match at the
2317 cursor position, but not further than the start of the
2318 next line. When not present searching continues
2319 one character from the cursor position. With 'c'
2320 "abababababab" only gets three matches when repeating
2321 "/abab", without 'c' there are five matches.
2322 *cpo-C*
2323 C Do not concatenate sourced lines that start with a
2324 backslash. See |line-continuation|.
2325 *cpo-d*
2326 d Using "./" in the 'tags' option doesn't mean to use
2327 the tags file relative to the current file, but the
2328 tags file in the current directory.
2329 *cpo-D*
2330 D Can't use CTRL-K to enter a digraph after Normal mode
2331 commands with a character argument, like |r|, |f| and
2332 |t|.
2333 *cpo-e*
2334 e When executing a register with ":@r", always add a
2335 <CR> to the last line, also when the register is not
2336 linewise. If this flag is not present, the register
2337 is not linewise and the last line does not end in a
2338 <CR>, then the last line is put on the command-line
2339 and can be edited before hitting <CR>.
2340 *cpo-E*
2341 E It is an error when using "y", "d", "c", "g~", "gu" or
2342 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002343 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 This makes "y0" fail in the first column.
2345 *cpo-f*
2346 f When included, a ":read" command with a file name
2347 argument will set the file name for the current buffer,
2348 if the current buffer doesn't have a file name yet.
2349 *cpo-F*
2350 F When included, a ":write" command with a file name
2351 argument will set the file name for the current
2352 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002353 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 *cpo-g*
2355 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002356 *cpo-H*
2357 H When using "I" on a line with only blanks, insert
2358 before the last blank. Without this flag insert after
2359 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 *cpo-i*
2361 i When included, interrupting the reading of a file will
2362 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002363 *cpo-I*
2364 I When moving the cursor up or down just after inserting
2365 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 *cpo-j*
2367 j When joining lines, only add two spaces after a '.',
2368 not after '!' or '?'. Also see 'joinspaces'.
2369 *cpo-J*
2370 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002371 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 white space.
2373 *cpo-k*
2374 k Disable the recognition of raw key codes in
2375 mappings, abbreviations, and the "to" part of menu
2376 commands. For example, if <Key> sends ^[OA (where ^[
2377 is <Esc>), the command ":map X ^[OA" results in X
2378 being mapped to:
2379 'k' included: "^[OA" (3 characters)
2380 'k' excluded: "<Key>" (one key code)
2381 Also see the '<' flag below.
2382 *cpo-K*
2383 K Don't wait for a key code to complete when it is
2384 halfway a mapping. This breaks mapping <F1><F1> when
2385 only part of the second <F1> has been read. It
2386 enables cancelling the mapping by typing <F1><Esc>.
2387 *cpo-l*
2388 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002389 literally, only "\]", "\^", "\-" and "\\" are special.
2390 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2392 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002393 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 *cpo-L*
2395 L When the 'list' option is set, 'wrapmargin',
2396 'textwidth', 'softtabstop' and Virtual Replace mode
2397 (see |gR|) count a <Tab> as two characters, instead of
2398 the normal behavior of a <Tab>.
2399 *cpo-m*
2400 m When included, a showmatch will always wait half a
2401 second. When not included, a showmatch will wait half
2402 a second or until a character is typed. |'showmatch'|
2403 *cpo-M*
2404 M When excluded, "%" matching will take backslashes into
2405 account. Thus in "( \( )" and "\( ( \)" the outer
2406 parenthesis match. When included "%" ignores
2407 backslashes, which is Vi compatible.
2408 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002409 n When included, the column used for 'number' and
2410 'relativenumber' will also be used for text of wrapped
2411 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 *cpo-o*
2413 o Line offset to search command is not remembered for
2414 next search.
2415 *cpo-O*
2416 O Don't complain if a file is being overwritten, even
2417 when it didn't exist when editing it. This is a
2418 protection against a file unexpectedly created by
2419 someone else. Vi didn't complain about this.
2420 *cpo-p*
2421 p Vi compatible Lisp indenting. When not present, a
2422 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002423 *cpo-P*
2424 P When included, a ":write" command that appends to a
2425 file will set the file name for the current buffer, if
2426 the current buffer doesn't have a file name yet and
2427 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002428 *cpo-q*
2429 q When joining multiple lines leave the cursor at the
2430 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 *cpo-r*
2432 r Redo ("." command) uses "/" to repeat a search
2433 command, instead of the actually used search string.
2434 *cpo-R*
2435 R Remove marks from filtered lines. Without this flag
2436 marks are kept like |:keepmarks| was used.
2437 *cpo-s*
2438 s Set buffer options when entering the buffer for the
2439 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002440 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 set when the buffer is created.
2442 *cpo-S*
2443 S Set buffer options always when entering a buffer
2444 (except 'readonly', 'fileformat', 'filetype' and
2445 'syntax'). This is the (most) Vi compatible setting.
2446 The options are set to the values in the current
2447 buffer. When you change an option and go to another
2448 buffer, the value is copied. Effectively makes the
2449 buffer options global to all buffers.
2450
2451 's' 'S' copy buffer options
2452 no no when buffer created
2453 yes no when buffer first entered (default)
2454 X yes each time when buffer entered (vi comp.)
2455 *cpo-t*
2456 t Search pattern for the tag command is remembered for
2457 "n" command. Otherwise Vim only puts the pattern in
2458 the history for search pattern, but doesn't change the
2459 last used search pattern.
2460 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002461 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 *cpo-v*
2463 v Backspaced characters remain visible on the screen in
2464 Insert mode. Without this flag the characters are
2465 erased from the screen right away. With this flag the
2466 screen newly typed text overwrites backspaced
2467 characters.
2468 *cpo-w*
2469 w When using "cw" on a blank character, only change one
2470 character and not all blanks until the start of the
2471 next word.
2472 *cpo-W*
2473 W Don't overwrite a readonly file. When omitted, ":w!"
2474 overwrites a readonly file, if possible.
2475 *cpo-x*
2476 x <Esc> on the command-line executes the command-line.
2477 The default in Vim is to abandon the command-line,
2478 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002479 *cpo-X*
2480 X When using a count with "R" the replaced text is
2481 deleted only once. Also when repeating "R" with "."
2482 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002484 y A yank command can be redone with ".". Think twice if
2485 you really want to use this, it may break some
2486 plugins, since most people expect "." to only repeat a
2487 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002488 *cpo-Z*
2489 Z When using "w!" while the 'readonly' option is set,
2490 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002491 *cpo-z*
2492 z Special casing the "cw" and "d" command (see |cw| and
2493 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 *cpo-!*
2495 ! When redoing a filter command, use the last used
2496 external command, whatever it was. Otherwise the last
2497 used -filter- command is used.
2498 *cpo-$*
2499 $ When making a change to one line, don't redisplay the
2500 line, but put a '$' at the end of the changed text.
2501 The changed text will be overwritten when you type the
2502 new text. The line is redisplayed if you type any
2503 command that moves the cursor from the insertion
2504 point.
2505 *cpo-%*
2506 % Vi-compatible matching is done for the "%" command.
2507 Does not recognize "#if", "#endif", etc.
2508 Does not recognize "/*" and "*/".
2509 Parens inside single and double quotes are also
2510 counted, causing a string that contains a paren to
2511 disturb the matching. For example, in a line like
2512 "if (strcmp("foo(", s))" the first paren does not
2513 match the last one. When this flag is not included,
2514 parens inside single and double quotes are treated
2515 specially. When matching a paren outside of quotes,
2516 everything inside quotes is ignored. When matching a
2517 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002518 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002519 This flag is also used for other features, such as
2520 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002521 *cpo--*
2522 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002523 it would go above the first line or below the last
2524 line. Without it the cursor moves to the first or
2525 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002526 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002527 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002528 *cpo-+*
2529 + When included, a ":write file" command will reset the
2530 'modified' flag of the buffer, even though the buffer
2531 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002532 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 * Use ":*" in the same way as ":@". When not included,
2534 ":*" is an alias for ":'<,'>", select the Visual area.
2535 *cpo-<*
2536 < Disable the recognition of special key codes in |<>|
2537 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002538 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 ":map X <Tab>" results in X being mapped to:
2540 '<' included: "<Tab>" (5 characters)
2541 '<' excluded: "^I" (^I is a real <Tab>)
2542 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002543 *cpo->*
2544 > When appending to a register, put a line break before
2545 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002546 *cpo-;*
2547 ; When using |,| or |;| to repeat the last |t| search
2548 and the cursor is right in front of the searched
2549 character, the cursor won't move. When not included,
2550 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002551 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002552
2553 POSIX flags. These are not included in the Vi default value, except
2554 when $VIM_POSIX was set on startup. |posix|
2555
2556 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002557 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002558 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002559 *cpo-&*
2560 & When ":preserve" was used keep the swap file when
2561 exiting normally while this buffer is still loaded.
2562 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002563 *cpo-\*
2564 \ Backslash in a [] range in a search pattern is taken
2565 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002566 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2567 '\' excluded: "/[ \-]" finds <Space> and '-'
2568 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002569 *cpo-/*
2570 / When "%" is used as the replacement string in a |:s|
2571 command, use the previous replacement string. |:s%|
2572 *cpo-{*
2573 { The |{| and |}| commands also stop at a "{" character
2574 at the start of a line.
2575 *cpo-.*
2576 . The ":chdir" and ":cd" commands fail if the current
2577 buffer is modified, unless ! is used. Vim doesn't
2578 need this, since it remembers the full path of an
2579 opened file.
2580 *cpo-bar*
2581 | The value of the $LINES and $COLUMNS environment
2582 variables overrule the terminal size values obtained
2583 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002584
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002585 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002586'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002587 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002588 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002589 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002590 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002591 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002592 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002593 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002594 blowfish Blowfish method. Medium strong encryption but it has
2595 an implementation flaw. Requires Vim 7.3 or later,
2596 files can NOT be read by Vim 7.2 and older. This adds
2597 a "seed" to the file, every time you write the file
2598 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002599 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002600 *blowfish2*
2601 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002602 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002603 and older. This adds a "seed" to the file, every time
2604 you write the file the encrypted bytes will be
2605 different. The whole undo file is encrypted, not just
2606 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002607 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002608 *E1197* *E1198* *E1199* *E1200* *E1201*
2609 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2610 Code. Medium strong till strong encryption.
2611 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002612 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002613 It adds a seed and a message authentication code (MAC)
2614 to the file. This needs at least a Vim 8.2.3022 to
2615 read the encrypted file.
2616 Encryption of swap files is not supported, therefore
2617 no swap file will be used when xchacha20 encryption is
2618 enabled.
2619 Encryption of undo files is not yet supported,
2620 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002621 CAREFUL: Files written with this method might have to
2622 be read back with the same version of Vim if the
2623 binary format changes later.
2624 Obsolete, please do no longer use.
2625 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2626 stores the key derivation parameters together with the
2627 encrypted file. Should work better in case the
2628 parameters in the libsodium library ever change.
2629 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002630 might have to be read back with the same version of
2631 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002632
Christian Brabandtaae58342023-04-23 17:50:22 +01002633 You should use "blowfish2", also to re-encrypt older files. The
2634 "xchacha20" method provides better encryption, but it does not work
2635 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002636
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002637 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002638 to the detected method of the file being read. Thus if you write it
2639 without changing 'cryptmethod' the same method will be used.
2640 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002641 explicitly write it, you don't get a warning unless there are other
2642 modifications. Also see |:X|.
2643
2644 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002645 the value "blowfish2". When setting the local value to an empty
2646 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002647
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002648 When a new encryption method is added in a later version of Vim, and
2649 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002650 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002651
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 *'cscopepathcomp'* *'cspc'*
2653'cscopepathcomp' 'cspc' number (default 0)
2654 global
2655 {not available when compiled without the |+cscope|
2656 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 Determines how many components of the path to show in a list of tags.
2658 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002659 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660
2661 *'cscopeprg'* *'csprg'*
2662'cscopeprg' 'csprg' string (default "cscope")
2663 global
2664 {not available when compiled without the |+cscope|
2665 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 Specifies the command to execute cscope. See |cscopeprg|.
2667 This option cannot be set from a |modeline| or in the |sandbox|, for
2668 security reasons.
2669
2670 *'cscopequickfix'* *'csqf'*
2671'cscopequickfix' 'csqf' string (default "")
2672 global
2673 {not available when compiled without the |+cscope|
2674 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 Specifies whether to use quickfix window to show cscope results.
2676 See |cscopequickfix|.
2677
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002678 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002679'cscoperelative' 'csre' boolean (default off)
2680 global
2681 {not available when compiled without the |+cscope|
2682 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002683 In the absence of a prefix (-P) for cscope. setting this option enables
2684 to use the basename of cscope.out path as the prefix.
2685 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002686 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002687
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2689'cscopetag' 'cst' boolean (default off)
2690 global
2691 {not available when compiled without the |+cscope|
2692 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 Use cscope for tag commands. See |cscope-options|.
2694 NOTE: This option is reset when 'compatible' is set.
2695
2696 *'cscopetagorder'* *'csto'*
2697'cscopetagorder' 'csto' number (default 0)
2698 global
2699 {not available when compiled without the |+cscope|
2700 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 Determines the order in which ":cstag" performs a search. See
2702 |cscopetagorder|.
2703 NOTE: This option is set to 0 when 'compatible' is set.
2704
2705 *'cscopeverbose'* *'csverb'*
2706 *'nocscopeverbose'* *'nocsverb'*
2707'cscopeverbose' 'csverb' boolean (default off)
2708 global
2709 {not available when compiled without the |+cscope|
2710 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 Give messages when adding a cscope database. See |cscopeverbose|.
2712 NOTE: This option is reset when 'compatible' is set.
2713
Bram Moolenaar860cae12010-06-05 23:22:07 +02002714 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2715'cursorbind' 'crb' boolean (default off)
2716 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002717 When this option is set, as the cursor in the current
2718 window moves other cursorbound windows (windows that also have
2719 this option set) move their cursors to the corresponding line and
2720 column. This option is useful for viewing the
2721 differences between two versions of a file (see 'diff'); in diff mode,
2722 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002723 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002724
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002725 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2726'cursorcolumn' 'cuc' boolean (default off)
2727 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002728 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002729 feature}
2730 Highlight the screen column of the cursor with CursorColumn
2731 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2732 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002733 If you only want the highlighting in the current window you can use
2734 these autocommands: >
2735 au WinLeave * set nocursorline nocursorcolumn
2736 au WinEnter * set cursorline cursorcolumn
2737<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002738
2739 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2740'cursorline' 'cul' boolean (default off)
2741 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002742 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002743 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002744 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2745 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002746 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002747 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002748
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002749 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002750'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002751 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002752 {not available when compiled without the |+syntax|
2753 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002754 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002755 Valid values:
2756 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002757 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002758 "screenline" Highlight only the screen line of the cursor with
2759 CursorLine |hl-CursorLine|.
2760 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002761 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002762
2763 Special value:
2764 "both" Alias for the values "line,number".
2765
2766 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002767
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 *'debug'*
2769'debug' string (default "")
2770 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002771 These values can be used:
2772 msg Error messages that would otherwise be omitted will be given
2773 anyway.
2774 throw Error messages that would otherwise be omitted will be given
2775 anyway and also throw an exception and set |v:errmsg|.
2776 beep A message will be given when otherwise only a beep would be
2777 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002778 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002779 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2780 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
2782 *'define'* *'def'*
2783'define' 'def' string (default "^\s*#\s*define")
2784 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002785 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 pattern, just like for the "/" command. This option is used for the
2787 commands like "[i" and "[d" |include-search|. The 'isident' option is
2788 used to recognize the defined name after the match:
2789 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2790 See |option-backslash| about inserting backslashes to include a space
2791 or backslash.
2792 The default value is for C programs. For C++ this value would be
2793 useful, to include const type declarations: >
2794 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002795< You can also use "\ze" just before the name and continue the pattern
2796 to check what is following. E.g. for Javascript, if a function is
2797 defined with "func_name = function(args)": >
2798 ^\s*\ze\i\+\s*=\s*function(
2799< If the function is defined with "func_name : function() {...": >
2800 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002802 To avoid that use `:let` with a single quote string: >
2803 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002804<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2807'delcombine' 'deco' boolean (default off)
2808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 If editing Unicode and this option is set, backspace and Normal mode
2810 "x" delete each combining character on its own. When it is off (the
2811 default) the character along with its combining characters are
2812 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002813 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815 This is useful for Arabic, Hebrew and many other languages where one
2816 may have combining characters overtop of base characters, and want
2817 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002818 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819
2820 *'dictionary'* *'dict'*
2821'dictionary' 'dict' string (default "")
2822 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 List of file names, separated by commas, that are used to lookup words
2824 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2825 contain a list of words. This can be one word per line, or several
2826 words per line, separated by non-keyword characters (white space is
2827 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002828
2829 When this option is empty or an entry "spell" is present, and spell
2830 checking is enabled, words in the word lists for the currently active
2831 'spelllang' are used. See |spell|.
2832
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002833 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 after a comma are ignored, otherwise spaces are included in the file
2835 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002836 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 Where to find a list of words?
2838 - On FreeBSD, there is the file "/usr/share/dict/words".
2839 - In the Simtel archive, look in the "msdos/linguist" directory.
2840 - In "miscfiles" of the GNU collection.
2841 The use of |:set+=| and |:set-=| is preferred when adding or removing
2842 directories from the list. This avoids problems when a future version
2843 uses another default.
2844 Backticks cannot be used in this option for security reasons.
2845
2846 *'diff'* *'nodiff'*
2847'diff' boolean (default off)
2848 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 {not available when compiled without the |+diff|
2850 feature}
2851 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002852 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 *'dex'* *'diffexpr'*
2855'diffexpr' 'dex' string (default "")
2856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 {not available when compiled without the |+diff|
2858 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002859 Expression which is evaluated to obtain a diff file (either ed-style
2860 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 This option cannot be set from a |modeline| or in the |sandbox|, for
2862 security reasons.
2863
2864 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002865'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 {not available when compiled without the |+diff|
2868 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002869 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 All are optional. Items must be separated by a comma.
2871
2872 filler Show filler lines, to keep the text
2873 synchronized with a window that has inserted
2874 lines at the same position. Mostly useful
2875 when windows are side-by-side and 'scrollbind'
2876 is set.
2877
2878 context:{n} Use a context of {n} lines between a change
2879 and a fold that contains unchanged lines.
2880 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002881 When using zero the context is actually one,
2882 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002883 for a deleted line. Set it to a very large
2884 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 See |fold-diff|.
2886
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002887 iblank Ignore changes where lines are all blank. Adds
2888 the "-B" flag to the "diff" command if
2889 'diffexpr' is empty. Check the documentation
2890 of the "diff" command for what this does
2891 exactly.
2892 NOTE: the diff windows will get out of sync,
2893 because no differences between blank lines are
2894 taken into account.
2895
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 icase Ignore changes in case of text. "a" and "A"
2897 are considered the same. Adds the "-i" flag
2898 to the "diff" command if 'diffexpr' is empty.
2899
2900 iwhite Ignore changes in amount of white space. Adds
2901 the "-b" flag to the "diff" command if
2902 'diffexpr' is empty. Check the documentation
2903 of the "diff" command for what this does
2904 exactly. It should ignore adding trailing
2905 white space, but not leading white space.
2906
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002907 iwhiteall Ignore all white space changes. Adds
2908 the "-w" flag to the "diff" command if
2909 'diffexpr' is empty. Check the documentation
2910 of the "diff" command for what this does
2911 exactly.
2912
2913 iwhiteeol Ignore white space changes at end of line.
2914 Adds the "-Z" flag to the "diff" command if
2915 'diffexpr' is empty. Check the documentation
2916 of the "diff" command for what this does
2917 exactly.
2918
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002919 horizontal Start diff mode with horizontal splits (unless
2920 explicitly specified otherwise).
2921
2922 vertical Start diff mode with vertical splits (unless
2923 explicitly specified otherwise).
2924
Bram Moolenaarc8234772019-11-10 21:00:27 +01002925 closeoff When a window is closed where 'diff' is set
2926 and there is only one window remaining in the
2927 same tab page with 'diff' set, execute
2928 `:diffoff` in that window. This undoes a
2929 `:diffsplit` command.
2930
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002931 hiddenoff Do not use diff mode for a buffer when it
2932 becomes hidden.
2933
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002934 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2935 starting diff mode. Without this 2 is used.
2936
Bram Moolenaar4223d432021-02-10 13:18:17 +01002937 followwrap Follow the 'wrap' option and leave as it is.
2938
Bram Moolenaare828b762018-09-10 17:51:58 +02002939 internal Use the internal diff library. This is
2940 ignored when 'diffexpr' is set. *E960*
2941 When running out of memory when writing a
2942 buffer this item will be ignored for diffs
2943 involving that buffer. Set the 'verbose'
2944 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
Bram Moolenaare828b762018-09-10 17:51:58 +02002946 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002947 Use the indent heuristic for the internal
2948 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002949
zeertzjqd086b8f2024-02-25 15:42:52 +08002950 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002951 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002952 algorithms are:
2953 myers the default algorithm
2954 minimal spend extra time to generate the
2955 smallest possible diff
2956 patience patience diff algorithm
2957 histogram histogram diff algorithm
2958
2959 Examples: >
2960 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002962 :set diffopt=internal,filler,foldcolumn:3
2963 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964<
2965 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2966'digraph' 'dg' boolean (default off)
2967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 {not available when compiled without the |+digraphs|
2969 feature}
2970 Enable the entering of digraphs in Insert mode with {char1} <BS>
2971 {char2}. See |digraphs|.
2972 NOTE: This option is reset when 'compatible' is set.
2973
2974 *'directory'* *'dir'*
2975'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002976 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 for Unix: ".,~/tmp,/var/tmp,/tmp")
2978 global
2979 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002980 Recommended value: ".,~/vimswap//" - this will put the swap file next
2981 to the edited file if possible, and in your personal swap directory
2982 otherwise. Make sure "~/vimswap//" is only readable for you.
2983
2984 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 - The swap file will be created in the first directory where this is
2986 possible.
2987 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002988 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 - A directory "." means to put the swap file in the same directory as
2990 the edited file. On Unix, a dot is prepended to the file name, so
2991 it doesn't show in a directory listing. On MS-Windows the "hidden"
2992 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002993 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2994 the swap file relative to where the edited file is. The leading "."
2995 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002996 - For Unix and Win32, if a directory ends in two path separators "//",
2997 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002998 with all path separators replaced by percent '%' signs (including
2999 the colon following the drive letter on Win32). This will ensure
3000 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003001 On Win32, it is also possible to end with "\\". However, When a
3002 separating comma is following, you must use "//", since "\\" will
3003 include the comma in the file name. Therefore it is recommended to
3004 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 - Spaces after the comma are ignored, other spaces are considered part
3006 of the directory name. To have a space at the start of a directory
3007 name, precede it with a backslash.
3008 - To include a comma in a directory name precede it with a backslash.
3009 - A directory name may end in an ':' or '/'.
3010 - Environment variables are expanded |:set_env|.
3011 - Careful with '\' characters, type one before a space, type two to
3012 get one in the option (see |option-backslash|), for example: >
3013 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3014< - For backwards compatibility with Vim version 3.0 a '>' at the start
3015 of the option is removed.
3016 Using "." first in the list is recommended. This means that editing
3017 the same file twice will result in a warning. Using "/tmp" on Unix is
3018 discouraged: When the system crashes you lose the swap file.
3019 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003020 choice than "/tmp". But others on the computer may be able to see the
3021 files, and it can contain a lot of files, your swap files get lost in
3022 the crowd. That is why a "tmp" directory in your home directory is
3023 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 The use of |:set+=| and |:set-=| is preferred when adding or removing
3025 directories from the list. This avoids problems when a future version
3026 uses another default.
3027 This option cannot be set from a |modeline| or in the |sandbox|, for
3028 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029
3030 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003031'display' 'dy' string (default "", set to "truncate" in
3032 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003034 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 flags:
3036 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003037 in a window will be displayed. "@@@" is put in the
3038 last columns of the last screen line to indicate the
3039 rest of the line is not displayed.
3040 truncate Like "lastline", but "@@@" is displayed in the first
3041 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 uhex Show unprintable characters hexadecimal as <xx>
3043 instead of using ^C and ~C.
3044
Bram Moolenaard0796902016-09-16 20:02:31 +02003045 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003046 doesn't fit is replaced with "@" lines.
3047
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003048 The "@" character can be changed by setting the "lastline" item in
3049 'fillchars'. The character is highlighted with |hl-NonText|.
3050
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 *'eadirection'* *'ead'*
3052'eadirection' 'ead' string (default "both")
3053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 Tells when the 'equalalways' option applies:
3055 ver vertically, width of windows is not affected
3056 hor horizontally, height of windows is not affected
3057 both width and height of windows is affected
3058
3059 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3060'edcompatible' 'ed' boolean (default off)
3061 global
3062 Makes the 'g' and 'c' flags of the ":substitute" command to be
3063 toggled each time the flag is given. See |complex-change|. See
3064 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003065 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003066 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067
Bram Moolenaar03413f42016-04-12 21:07:15 +02003068 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003069'emoji' 'emo' boolean (default: on)
3070 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003071 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003072 This excludes "text emoji" characters, which are normally displayed as
3073 single width. Unfortunately there is no good specification for this
3074 and it has been determined on trial-and-error basis. Use the
3075 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003076
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003078'encoding' 'enc' string (default for MS-Windows: "utf-8",
3079 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 Sets the character encoding used inside Vim. It applies to text in
3082 the buffers, registers, Strings in expressions, text stored in the
3083 viminfo file, etc. It sets the kind of characters which Vim can work
3084 with. See |encoding-names| for the possible values.
3085
3086 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003087 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003089 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090
Bram Moolenaar865242e2010-07-14 21:12:05 +02003091 This option cannot be set from a |modeline|. It would most likely
3092 corrupt the text.
3093
Bram Moolenaar3df01732017-02-17 22:47:16 +01003094 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3095 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 'encoding', "utf-8" is the natural choice for the environment and
3097 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003098 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 versions, and to avoid changing the encoding of newly created files
3100 without your knowledge (in case 'fileencodings' is empty).
3101
3102 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003103 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 iconv() or as specified with 'charconvert'.
3105
Bram Moolenaar207f0092020-08-30 17:20:20 +02003106 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003107 can use: >
3108 if has("multi_byte_encoding")
3109<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 Normally 'encoding' will be equal to your current locale. This will
3111 be the default if Vim recognizes your environment settings. If
3112 'encoding' is not set to the current locale, 'termencoding' must be
3113 set to convert typed and displayed text. See |encoding-table|.
3114
3115 When you set this option, it fires the |EncodingChanged| autocommand
3116 event so that you can set up fonts if necessary.
3117
3118 When the option is set, the value is converted to lowercase. Thus
3119 you can set it with uppercase values too. Underscores are translated
3120 to '-' signs.
3121 When the encoding is recognized, it is changed to the standard name.
3122 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3123 "iso-8859-2" and "utf8" becomes "utf-8".
3124
3125 Note: "latin1" is also used when the encoding could not be detected.
3126 This only works when editing files in the same encoding! When the
3127 actual character set is not latin1, make sure 'fileencoding' and
3128 'fileencodings' are empty. When conversion is needed, switch to using
3129 utf-8.
3130
3131 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3132 You don't notice this while editing, but it does matter for the
3133 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3134 setting 'encoding' to one of these values instead of utf-8 only has
3135 effect for encoding used for files when 'fileencoding' is empty.
3136
Bram Moolenaar661b1822005-07-28 22:36:45 +00003137 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3138 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003140 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003141'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003143 Indicates that a CTRL-Z character was found at the end of the file
3144 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003146 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003147 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003148 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003149
3150 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3151'endofline' 'eol' boolean (default on)
3152 local to buffer
3153 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003154 is on, or 'fixeol' option is off, no <EOL> will be written for the
3155 last line in the file. This option is automatically set or reset when
3156 starting to edit a new file, depending on whether file has an <EOL>
3157 for the last line in the file. Normally you don't have to set or
3158 reset this option.
3159 When 'binary' is off and 'fixeol' is on the value is not used when
3160 writing the file. When 'binary' is on or 'fixeol' is off it is used
3161 to remember the presence of a <EOL> for the last line in the file, so
3162 that when you write the file the situation from the original file can
3163 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003164 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165
3166 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3167'equalalways' 'ea' boolean (default on)
3168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003170 splitting or closing a window. This also happens the moment the
3171 option is switched on. When off, splitting a window will reduce the
3172 size of the current window and leave the other windows the same. When
3173 closing a window the extra lines are given to the window next to it
3174 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 When mixing vertically and horizontally split windows, a minimal size
3176 is computed and some windows may be larger if there is room. The
3177 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003178 Changing the height and width of a window can be avoided by setting
3179 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003180 If a window size is specified when creating a new window sizes are
3181 currently not equalized (it's complicated, but may be implemented in
3182 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183
3184 *'equalprg'* *'ep'*
3185'equalprg' 'ep' string (default "")
3186 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003188 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003189 or 'indentexpr'. When Vim was compiled without internal formatting,
3190 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003191 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 about including spaces and backslashes.
3193 This option cannot be set from a |modeline| or in the |sandbox|, for
3194 security reasons.
3195
3196 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3197'errorbells' 'eb' boolean (default off)
3198 global
3199 Ring the bell (beep or screen flash) for error messages. This only
3200 makes a difference for error messages, the bell will be used always
3201 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003202 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003203 screen flash or do nothing. See 'belloff' to finetune when to ring the
3204 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205
3206 *'errorfile'* *'ef'*
3207'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3208 others: "errors.err")
3209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 {not available when compiled without the |+quickfix|
3211 feature}
3212 Name of the errorfile for the QuickFix mode (see |:cf|).
3213 When the "-q" command-line argument is used, 'errorfile' is set to the
3214 following argument. See |-q|.
3215 NOT used for the ":make" command. See 'makeef' for that.
3216 Environment variables are expanded |:set_env|.
3217 See |option-backslash| about including spaces and backslashes.
3218 This option cannot be set from a |modeline| or in the |sandbox|, for
3219 security reasons.
3220
3221 *'errorformat'* *'efm'*
3222'errorformat' 'efm' string (default is very long)
3223 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 {not available when compiled without the |+quickfix|
3225 feature}
3226 Scanf-like description of the format for the lines in the error file
3227 (see |errorformat|).
3228
3229 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3230'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 Function keys that start with an <Esc> are recognized in Insert
3233 mode. When this option is off, the cursor and function keys cannot be
3234 used in Insert mode if they start with an <Esc>. The advantage of
3235 this is that the single <Esc> is recognized immediately, instead of
3236 after one second. Instead of resetting this option, you might want to
3237 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3238 when 'esckeys' is off, you can still map anything, but the cursor keys
3239 won't work by default.
3240 NOTE: This option is set to the Vi default value when 'compatible' is
3241 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003242 NOTE: when this option is off then the |modifyOtherKeys| and
3243 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3244 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245
3246 *'eventignore'* *'ei'*
3247'eventignore' 'ei' string (default "")
3248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003250 When set to "all" or when "all" is one of the items, all autocommand
3251 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003252 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 :set ei=WinEnter,WinLeave
3254<
3255 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3256'expandtab' 'et' boolean (default off)
3257 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003259 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3261 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003262 This option is reset when the 'paste' option is set and restored when
3263 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 NOTE: This option is reset when 'compatible' is set.
3265
3266 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3267'exrc' 'ex' boolean (default off)
3268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003270 directory.
3271
3272 Setting this option is a potential security leak. E.g., consider
3273 unpacking a package or fetching files from github, a .vimrc in there
3274 might be a trojan horse. BETTER NOT SET THIS OPTION!
3275 Instead, define an autocommand in your .vimrc to set options for a
3276 matching directory.
3277
3278 If you do switch this option on you should also consider setting the
3279 'secure' option (see |initialization|).
3280 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 This option cannot be set from a |modeline| or in the |sandbox|, for
3282 security reasons.
3283
3284 *'fileencoding'* *'fenc'* *E213*
3285'fileencoding' 'fenc' string (default: "")
3286 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003288
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 When 'fileencoding' is empty, the same value as 'encoding' will be
3292 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003293 No error will be given when the value is set, only when it is used,
3294 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003295 Conversion will also be done when 'encoding' and 'fileencoding' are
3296 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3297 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003299 'encoding' is "utf-8" or another Unicode encoding, conversion
3300 is most likely done in a way that the reverse conversion
3301 results in the same text. When 'encoding' is not "utf-8" some
3302 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003303
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 See 'encoding' for the possible values. Additionally, values may be
3305 specified that can be handled by the converter, see
3306 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003307
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 When reading a file 'fileencoding' will be set from 'fileencodings'.
3309 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003310 'fileencoding', use the |++enc| argument. One exception: when
3311 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003312 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3315 When the option is set, the value is converted to lowercase. Thus
3316 you can set it with uppercase values too. '_' characters are
3317 replaced with '-'. If a name is recognized from the list for
3318 'encoding', it is replaced by the standard name. For example
3319 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003320
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 When this option is set, after starting to edit a file, the 'modified'
3322 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003323
3324 Keep in mind that changing 'fenc' from a modeline happens
3325 AFTER the text has been read, thus it applies to when the file will be
3326 written. If you do set 'fenc' in a modeline, you might want to set
3327 'nomodified' to avoid not being able to ":q".
3328
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 This option can not be changed when 'modifiable' is off.
3330
3331 *'fe'*
3332 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003333 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 old short name was 'fe', which is no longer used.
3335
3336 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003337'fileencodings' 'fencs' string (default: "ucs-bom",
3338 "ucs-bom,utf-8,default,latin1" when
3339 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 This is a list of character encodings considered when starting to edit
3342 an existing file. When a file is read, Vim tries to use the first
3343 mentioned character encoding. If an error is detected, the next one
3344 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003345 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 an empty string, which means the value of 'encoding' is used.
3347 WARNING: Conversion can cause loss of information! When
3348 'encoding' is "utf-8" (or one of the other Unicode variants)
3349 conversion is most likely done in a way that the reverse
3350 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003351 "utf-8" some non-ASCII characters may be lost! You can use
3352 the |++bad| argument to specify what is done with characters
3353 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 For an empty file or a file with only ASCII characters most encodings
3355 will work and the first entry of 'fileencodings' will be used (except
3356 "ucs-bom", which requires the BOM to be present). If you prefer
3357 another encoding use an BufReadPost autocommand event to test if your
3358 preferred encoding is to be used. Example: >
3359 au BufReadPost * if search('\S', 'w') == 0 |
3360 \ set fenc=iso-2022-jp | endif
3361< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3362 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003363 When the |++enc| argument is used then the value of 'fileencodings' is
3364 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003365 Note that 'fileencodings' is not used for a new file, the global value
3366 of 'fileencoding' is used instead. You can set it with: >
3367 :setglobal fenc=iso-8859-2
3368< This means that a non-existing file may get a different encoding than
3369 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 The special value "ucs-bom" can be used to check for a Unicode BOM
3371 (Byte Order Mark) at the start of the file. It must not be preceded
3372 by "utf-8" or another Unicode encoding for this to work properly.
3373 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3374 because Vim cannot detect an error, thus the encoding is always
3375 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003376 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003377 environment. On MS-Windows this is the system encoding. Otherwise
3378 this is the default value for 'encoding'. It is useful when
3379 'encoding' is set to "utf-8" and your environment uses a non-latin1
3380 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003381 When 'encoding' is "utf-8" and a file contains an illegal byte
3382 sequence it won't be recognized as UTF-8. You can use the |8g8|
3383 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 WRONG VALUES: WHAT'S WRONG:
3385 latin1,utf-8 "latin1" will always be used
3386 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3387 file
3388 cp1250,latin1 "cp1250" will always be used
3389 If 'fileencodings' is empty, 'fileencoding' is not modified.
3390 See 'fileencoding' for the possible values.
3391 Setting this option does not have an effect until the next time a file
3392 is read.
3393
3394 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003395'fileformat' 'ff' string (MS-Windows default: "dos",
3396 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 This gives the <EOL> of the current buffer, which is used for
3399 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003400 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 unix <NL>
3402 mac <CR>
3403 When "dos" is used, CTRL-Z at the end of a file is ignored.
3404 See |file-formats| and |file-read|.
3405 For the character encoding of the file see 'fileencoding'.
3406 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003407 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 This option is set automatically when starting to edit a file and
3409 'fileformats' is not empty and 'binary' is off.
3410 When this option is set, after starting to edit a file, the 'modified'
3411 option is set, because the file would be different when written.
3412 This option can not be changed when 'modifiable' is off.
3413 For backwards compatibility: When this option is set to "dos",
3414 'textmode' is set, otherwise 'textmode' is reset.
3415
3416 *'fileformats'* *'ffs'*
3417'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003418 Vim+Vi MS-Windows: "dos,unix",
3419 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 Vi Cygwin: "unix,dos",
3421 Vi others: "")
3422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 This gives the end-of-line (<EOL>) formats that will be tried when
3424 starting to edit a new buffer and when reading a file into an existing
3425 buffer:
3426 - When empty, the format defined with 'fileformat' will be used
3427 always. It is not set automatically.
3428 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003429 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 'fileformats' name will be used when a file is read into an existing
3431 buffer, no matter what 'fileformat' for that buffer is set to.
3432 - When more than one name is present, separated by commas, automatic
3433 <EOL> detection will be done when reading a file. When starting to
3434 edit a file, a check is done for the <EOL>:
3435 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3436 'fileformat' is set to "dos".
3437 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003438 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003440 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3441 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003442 This means that "mac" is only chosen when:
3443 "unix" is not present or no <NL> is found in the file, and
3444 "dos" is not present or no <CR><NL> is found in the file.
3445 Except: if "unix" was chosen, but there is a <CR> before
3446 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003447 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 4. If 'fileformat' is still not set, the first name from
3449 'fileformats' is used.
3450 When reading a file into an existing buffer, the same is done, but
3451 this happens like 'fileformat' has been set appropriately for that
3452 file only, the option is not changed.
3453 When 'binary' is set, the value of 'fileformats' is not used.
3454
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003455 When Vim starts up with an empty buffer the first item is used. You
3456 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003457
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3459 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3460 done:
3461 - When 'fileformats' is empty, there is no automatic detection. Dos
3462 format will be used.
3463 - When 'fileformats' is set to one or more names, automatic detection
3464 is done. This is based on the first <NL> in the file: If there is a
3465 <CR> in front of it, Dos format is used, otherwise Unix format is
3466 used.
3467 Also see |file-formats|.
3468 For backwards compatibility: When this option is set to an empty
3469 string or one format (no comma is included), 'textauto' is reset,
3470 otherwise 'textauto' is set.
3471 NOTE: This option is set to the Vi default value when 'compatible' is
3472 set and to the Vim default value when 'compatible' is reset.
3473
Bram Moolenaarbf884932013-04-05 22:26:15 +02003474 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3475'fileignorecase' 'fic' boolean (default on for systems where case in file
3476 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003477 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003478 When set case is ignored when using file names and directories.
3479 See 'wildignorecase' for only ignoring case when doing completion.
3480
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 *'filetype'* *'ft'*
3482'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003483 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 When this option is set, the FileType autocommand event is triggered.
3485 All autocommands that match with the value of this option will be
3486 executed. Thus the value of 'filetype' is used in place of the file
3487 name.
3488 Otherwise this option does not always reflect the current file type.
3489 This option is normally set when the file type is detected. To enable
3490 this use the ":filetype on" command. |:filetype|
3491 Setting this option to a different value is most useful in a modeline,
3492 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003493 Example, for in an IDL file:
3494 /* vim: set filetype=idl : */ ~
3495 |FileType| |filetypes|
3496 When a dot appears in the value then this separates two filetype
3497 names. Example:
3498 /* vim: set filetype=c.doxygen : */ ~
3499 This will use the "c" filetype first, then the "doxygen" filetype.
3500 This works both for filetype plugins and for syntax files. More than
3501 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 This option is not copied to another buffer, independent of the 's' or
3503 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003504 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505
3506 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003507'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003508 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003509 Characters to fill the statuslines, vertical separators and special
3510 lines in the window.
3511 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003512 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003514 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003515 stl ' ' statusline of the current window
3516 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003517 vert '|' vertical separators |:vsplit|
3518 fold '-' filling 'foldtext'
3519 foldopen '-' mark the beginning of a fold
3520 foldclose '+' show a closed fold
3521 foldsep '|' open fold middle character
3522 diff '-' deleted lines of the 'diff' option
3523 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003524 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003526 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527
3528 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003529 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3530<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003531 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3532 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003533 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003536 item name highlight group ~
3537 stl StatusLine |hl-StatusLine|
3538 stlnc StatusLineNC |hl-StatusLineNC|
3539 vert VertSplit |hl-VertSplit|
3540 fold Folded |hl-Folded|
3541 diff DiffDelete |hl-DiffDelete|
3542 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003543 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003545 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3546'fixendofline' 'fixeol' boolean (default on)
3547 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003548 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003549 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003550 preserve the situation from the original file.
3551 When the 'binary' option is set the value of this option doesn't
3552 matter.
3553 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003554 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003555
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003557'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 {only available when compiled with the |+rightleft|
3560 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003561 This option was for using Farsi, which has been removed. See
3562 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563
3564 *'foldclose'* *'fcl'*
3565'foldclose' 'fcl' string (default "")
3566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 {not available when compiled without the |+folding|
3568 feature}
3569 When set to "all", a fold is closed when the cursor isn't in it and
3570 its level is higher than 'foldlevel'. Useful if you want folds to
3571 automatically close when moving out of them.
3572
3573 *'foldcolumn'* *'fdc'*
3574'foldcolumn' 'fdc' number (default 0)
3575 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 {not available when compiled without the |+folding|
3577 feature}
3578 When non-zero, a column with the specified width is shown at the side
3579 of the window which indicates open and closed folds. The maximum
3580 value is 12.
3581 See |folding|.
3582
3583 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3584'foldenable' 'fen' boolean (default on)
3585 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 {not available when compiled without the |+folding|
3587 feature}
3588 When off, all folds are open. This option can be used to quickly
3589 switch between showing all text unfolded and viewing the text with
3590 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003591 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 'foldenable' is off.
3593 This option is set by commands that create a new fold or close a fold.
3594 See |folding|.
3595
3596 *'foldexpr'* *'fde'*
3597'foldexpr' 'fde' string (default: "0")
3598 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003600 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003602 for each line to obtain its fold level. The context is set to the
3603 script where 'foldexpr' was set, script-local items can be accessed.
3604 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003605
Bram Moolenaar30b65812012-07-12 22:01:11 +02003606 The expression will be evaluated in the |sandbox| if set from a
3607 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003608 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003609 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003610
3611 It is not allowed to change text or jump to another window while
3612 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613
3614 *'foldignore'* *'fdi'*
3615'foldignore' 'fdi' string (default: "#")
3616 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 {not available when compiled without the |+folding|
3618 feature}
3619 Used only when 'foldmethod' is "indent". Lines starting with
3620 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003621 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 The default "#" works well for C programs. See |fold-indent|.
3623
3624 *'foldlevel'* *'fdl'*
3625'foldlevel' 'fdl' number (default: 0)
3626 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 {not available when compiled without the |+folding|
3628 feature}
3629 Sets the fold level: Folds with a higher level will be closed.
3630 Setting this option to zero will close all folds. Higher numbers will
3631 close fewer folds.
3632 This option is set by commands like |zm|, |zM| and |zR|.
3633 See |fold-foldlevel|.
3634
3635 *'foldlevelstart'* *'fdls'*
3636'foldlevelstart' 'fdls' number (default: -1)
3637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 {not available when compiled without the |+folding|
3639 feature}
3640 Sets 'foldlevel' when starting to edit another buffer in a window.
3641 Useful to always start editing with all folds closed (value zero),
3642 some folds closed (one) or no folds closed (99).
3643 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003644 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 ignores this option and closes all folds.
3646 It is also done before BufReadPre autocommands, to allow an autocmd to
3647 overrule the 'foldlevel' value for specific files.
3648 When the value is negative, it is not used.
3649
3650 *'foldmarker'* *'fmr'* *E536*
3651'foldmarker' 'fmr' string (default: "{{{,}}}")
3652 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 {not available when compiled without the |+folding|
3654 feature}
3655 The start and end marker used when 'foldmethod' is "marker". There
3656 must be one comma, which separates the start and end marker. The
3657 marker is a literal string (a regular expression would be too slow).
3658 See |fold-marker|.
3659
3660 *'foldmethod'* *'fdm'*
3661'foldmethod' 'fdm' string (default: "manual")
3662 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 {not available when compiled without the |+folding|
3664 feature}
3665 The kind of folding used for the current window. Possible values:
3666 |fold-manual| manual Folds are created manually.
3667 |fold-indent| indent Lines with equal indent form a fold.
3668 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3669 |fold-marker| marker Markers are used to specify folds.
3670 |fold-syntax| syntax Syntax highlighting items specify folds.
3671 |fold-diff| diff Fold text that is not changed.
3672
3673 *'foldminlines'* *'fml'*
3674'foldminlines' 'fml' number (default: 1)
3675 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 {not available when compiled without the |+folding|
3677 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003678 Sets the number of screen lines above which a fold can be displayed
3679 closed. Also for manually closed folds. With the default value of
3680 one a fold can only be closed if it takes up two or more screen lines.
3681 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003682 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 "zc" to close a fold, which is displayed open because it's smaller
3684 than 'foldminlines', a following "zc" may close a containing fold.
3685
3686 *'foldnestmax'* *'fdn'*
3687'foldnestmax' 'fdn' number (default: 20)
3688 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 {not available when compiled without the |+folding|
3690 feature}
3691 Sets the maximum nesting of folds for the "indent" and "syntax"
3692 methods. This avoids that too many folds will be created. Using more
3693 than 20 doesn't work, because the internal limit is 20.
3694
3695 *'foldopen'* *'fdo'*
3696'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3697 search,tag,undo")
3698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 {not available when compiled without the |+folding|
3700 feature}
3701 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003702 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003704 NOTE: When the command is part of a mapping this option is not used.
3705 Add the |zv| command to the mapping to get the same effect.
3706 (rationale: the mapping may want to control opening folds itself)
3707
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 item commands ~
3709 all any
3710 block "(", "{", "[[", "[{", etc.
3711 hor horizontal movements: "l", "w", "fx", etc.
3712 insert any command in Insert mode
3713 jump far jumps: "G", "gg", etc.
3714 mark jumping to a mark: "'m", CTRL-O, etc.
3715 percent "%"
3716 quickfix ":cn", ":crew", ":make", etc.
3717 search search for a pattern: "/", "n", "*", "gd", etc.
3718 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003719 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 tag jumping to a tag: ":ta", CTRL-T, etc.
3721 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 When a movement command is used for an operator (e.g., "dl" or "y%")
3723 this option is not used. This means the operator will include the
3724 whole closed fold.
3725 Note that vertical movements are not here, because it would make it
3726 very difficult to move onto a closed fold.
3727 In insert mode the folds containing the cursor will always be open
3728 when text is inserted.
3729 To close folds you can re-apply 'foldlevel' with the |zx| command or
3730 set the 'foldclose' option to "all".
3731
3732 *'foldtext'* *'fdt'*
3733'foldtext' 'fdt' string (default: "foldtext()")
3734 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 {not available when compiled without the |+folding|
3736 feature}
3737 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003738 fold. The context is set to the script where 'foldexpr' was set,
3739 script-local items can be accessed. See |fold-foldtext| for the
3740 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741
Bram Moolenaar30b65812012-07-12 22:01:11 +02003742 The expression will be evaluated in the |sandbox| if set from a
3743 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003744 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003745
3746 It is not allowed to change text or jump to another window while
3747 evaluating 'foldtext' |textlock|.
3748
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003749 *'formatexpr'* *'fex'*
3750'formatexpr' 'fex' string (default "")
3751 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003752 {not available when compiled without the |+eval|
3753 feature}
3754 Expression which is evaluated to format a range of lines for the |gq|
3755 operator or automatic formatting (see 'formatoptions'). When this
3756 option is empty 'formatprg' is used.
3757
3758 The |v:lnum| variable holds the first line to be formatted.
3759 The |v:count| variable holds the number of lines to be formatted.
3760 The |v:char| variable holds the character that is going to be
3761 inserted if the expression is being evaluated due to
3762 automatic formatting. This can be empty. Don't insert
3763 it yet!
3764
3765 Example: >
3766 :set formatexpr=mylang#Format()
3767< This will invoke the mylang#Format() function in the
3768 autoload/mylang.vim file in 'runtimepath'. |autoload|
3769
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003770 The advantage of using a function call without arguments is that it is
3771 faster, see |expr-option-function|.
3772
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003773 The expression is also evaluated when 'textwidth' is set and adding
3774 text beyond that limit. This happens under the same conditions as
3775 when internal formatting is used. Make sure the cursor is kept in the
3776 same spot relative to the text then! The |mode()| function will
3777 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003778
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003779 When the expression evaluates to non-zero Vim will fall back to using
3780 the internal format mechanism.
3781
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003782 If the expression starts with s: or |<SID>|, then it is replaced with
3783 the script ID (|local-function|). Example: >
3784 set formatexpr=s:MyFormatExpr()
3785 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003786< Otherwise, the expression is evaluated in the context of the script
3787 where the option was set, thus script-local items are available.
3788
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003789 The expression will be evaluated in the |sandbox| when set from a
3790 modeline, see |sandbox-option|. That stops the option from working,
3791 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003792 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003793 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003794
Bram Moolenaar86b68352004-12-27 21:59:20 +00003795 *'formatlistpat'* *'flp'*
3796'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3797 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003798 A pattern that is used to recognize a list header. This is used for
3799 the "n" flag in 'formatoptions'.
3800 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003801 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003802 while still checking more characters. There must be a character
3803 following the pattern, when it matches the whole line it is handled
3804 like there is no match.
3805 The default recognizes a number, followed by an optional punctuation
3806 character and white space.
3807
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003808 *'formatoptions'* *'fo'*
3809'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3810 local to buffer
3811 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003812 formatting is to be done.
3813 See |fo-table| for possible values and |gq| for how to format text.
3814 When the 'paste' option is on, no formatting is done (like
3815 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003816 To avoid problems with flags that are added in the future, use the
3817 "+=" and "-=" feature of ":set" |add-option-flags|.
3818 NOTE: This option is set to the Vi default value when 'compatible' is
3819 set and to the Vim default value when 'compatible' is reset.
3820
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 *'formatprg'* *'fp'*
3822'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003823 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003825 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003827 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003828 If the 'formatexpr' option is not empty it will be used instead.
3829 Otherwise, if 'formatprg' option is an empty string, the internal
3830 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003831 Environment variables are expanded |:set_env|. See |option-backslash|
3832 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003833 This option cannot be set from a |modeline| or in the |sandbox|, for
3834 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835
Bram Moolenaard94464e2015-11-02 15:28:18 +01003836 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003837'fsync' 'fs' boolean (default on)
3838 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003839 When on, the library function fsync() will be called after writing a
3840 file. This will flush a file to disk, ensuring that it is safely
3841 written even on filesystems which do metadata-only journaling. This
3842 will force the harddrive to spin up on Linux systems running in laptop
3843 mode, so it may be undesirable in some situations. Be warned that
3844 turning this off increases the chances of data loss after a crash. On
3845 systems without an fsync() implementation, this variable is always
3846 off.
3847 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003848 'fsync' also applies to |writefile()| (unless a flag is used to
3849 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003850 This option cannot be set from a |modeline| or in the |sandbox|, for
3851 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003852
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3854'gdefault' 'gd' boolean (default off)
3855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 When on, the ":substitute" flag 'g' is default on. This means that
3857 all matches in a line are substituted instead of one. When a 'g' flag
3858 is given to a ":substitute" command, this will toggle the substitution
3859 of all or one match. See |complex-change|.
3860
3861 command 'gdefault' on 'gdefault' off ~
3862 :s/// subst. all subst. one
3863 :s///g subst. one subst. all
3864 :s///gg subst. all subst. one
3865
3866 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003867 Setting this option may break plugins that rely on the default
3868 behavior of the 'g' flag. This will also make the 'g' flag have the
3869 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003870 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871
3872 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003873'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 Format to recognize for the ":grep" command output.
3876 This is a scanf-like string that uses the same format as the
3877 'errorformat' option: see |errorformat|.
3878
3879 *'grepprg'* *'gp'*
3880'grepprg' 'gp' string (default "grep -n ",
3881 Unix: "grep -n $* /dev/null",
3882 Win32: "findstr /n" or "grep -n",
3883 VMS: "SEARCH/NUMBERS ")
3884 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003885 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 and '#' characters, which are expanded like when used in a command-
3887 line. The placeholder "$*" is allowed to specify where the arguments
3888 will be included. Environment variables are expanded |:set_env|. See
3889 |option-backslash| about including spaces and backslashes.
3890 When your "grep" accepts the "-H" argument, use this to make ":grep"
3891 also work well with a single file: >
3892 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003893< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003894 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3895 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003896 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 apply equally to 'grepprg'.
3898 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3899 otherwise it's "grep -n".
3900 This option cannot be set from a |modeline| or in the |sandbox|, for
3901 security reasons.
3902
3903 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3904'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3905 ve:ver35-Cursor,
3906 o:hor50-Cursor,
3907 i-ci:ver25-Cursor/lCursor,
3908 r-cr:hor20-Cursor/lCursor,
3909 sm:block-Cursor
3910 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003911 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 "n-v-c:block,o:hor50,i-ci:hor15,
3913 r-cr:hor30,sm:block")
3914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003916 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003918 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003919 height of the cursor can be changed. This can be done by specifying a
3920 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003921 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3922 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003924 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 mode-list and an argument-list:
3926 mode-list:argument-list,mode-list:argument-list,..
3927 The mode-list is a dash separated list of these modes:
3928 n Normal mode
3929 v Visual mode
3930 ve Visual mode with 'selection' "exclusive" (same as 'v',
3931 if not specified)
3932 o Operator-pending mode
3933 i Insert mode
3934 r Replace mode
3935 c Command-line Normal (append) mode
3936 ci Command-line Insert mode
3937 cr Command-line Replace mode
3938 sm showmatch in Insert mode
3939 a all modes
3940 The argument-list is a dash separated list of these arguments:
3941 hor{N} horizontal bar, {N} percent of the character height
3942 ver{N} vertical bar, {N} percent of the character width
3943 block block cursor, fills the whole character
3944 [only one of the above three should be present]
3945 blinkwait{N} *cursor-blinking*
3946 blinkon{N}
3947 blinkoff{N}
3948 blink times for cursor: blinkwait is the delay before
3949 the cursor starts blinking, blinkon is the time that
3950 the cursor is shown and blinkoff is the time that the
3951 cursor is not shown. The times are in msec. When one
3952 of the numbers is zero, there is no blinking. The
3953 default is: "blinkwait700-blinkon400-blinkoff250".
3954 These numbers are used for a missing entry. This
3955 means that blinking is enabled by default. To switch
3956 blinking off you can use "blinkon0". The cursor only
3957 blinks when Vim is waiting for input, not while
3958 executing a command.
3959 To make the cursor blink in an xterm, see
3960 |xterm-blink|.
3961 {group-name}
3962 a highlight group name, that sets the color and font
3963 for the cursor
3964 {group-name}/{group-name}
3965 Two highlight group names, the first is used when
3966 no language mappings are used, the other when they
3967 are. |language-mapping|
3968
3969 Examples of parts:
3970 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3971 block cursor with colors from the "nCursor"
3972 highlight group
3973 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3974 In Insert and Command-line Insert mode, use a
3975 30% vertical bar cursor with colors from the
3976 "iCursor" highlight group. Blink a bit
3977 faster.
3978
3979 The 'a' mode is different. It will set the given argument-list for
3980 all modes. It does not reset anything to defaults. This can be used
3981 to do a common setting for all modes. For example, to switch off
3982 blinking: "a:blinkon0"
3983
3984 Examples of cursor highlighting: >
3985 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3986 :highlight Cursor gui=NONE guifg=bg guibg=fg
3987<
3988 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003989 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990'guifont' 'gfn' string (default "")
3991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 {only available when compiled with GUI enabled}
3993 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003994 In its simplest form the value is just one font name.
3995 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996
3997 *'guifontset'* *'gfs'*
3998 *E250* *E252* *E234* *E597* *E598*
3999'guifontset' 'gfs' string (default "")
4000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 {only available when compiled with GUI enabled and
4002 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004003 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 When not empty, specifies two (or more) fonts to be used. The first
4005 one for normal English, the second one for your special language. See
4006 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004007
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4009'guifontwide' 'gfw' string (default "")
4010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 {only available when compiled with GUI enabled}
4012 When not empty, specifies a comma-separated list of fonts to be used
4013 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004014 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004015
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 *'guiheadroom'* *'ghr'*
4017'guiheadroom' 'ghr' number (default 50)
4018 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004019 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 The number of pixels subtracted from the screen height when fitting
4021 the GUI window on the screen. Set this before the GUI is started,
4022 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 lines will be left for window decorations and other items on the
4025 screen. Set it to a negative value to allow windows taller than the
4026 screen.
4027
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004028 *'guiligatures'* *'gli'* *E1243*
4029'guiligatures' 'gli' string (default "")
4030 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004031 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004032 List of ASCII characters that, when combined together, can create more
4033 complex shapes. Each character must be a printable ASCII character
4034 with a value in the 32-127 range.
4035 Example: >
4036 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4037< Changing this option updates screen output immediately. Set it to an
4038 empty string to disable ligatures.
4039
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004041'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4042 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004043 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004044 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004047 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 sequence of letters which describes what components and options of the
4049 GUI should be used.
4050 To avoid problems with flags that are added in the future, use the
4051 "+=" and "-=" feature of ":set" |add-option-flags|.
4052
Bram Moolenaar13568252018-03-16 20:46:58 +01004053 Valid characters are as follows:
4054 *'go-!'*
4055 '!' External commands are executed in a terminal window. Without
4056 this flag the MS-Windows GUI will open a console window to
4057 execute the command. The Unix GUI will simulate a dumb
4058 terminal to list the command output.
4059 The terminal window will be positioned at the bottom, and grow
4060 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004061 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 'a' Autoselect: If present, then whenever VISUAL mode is started,
4063 or the Visual area extended, Vim tries to become the owner of
4064 the windowing system's global selection. This means that the
4065 Visually highlighted text is available for pasting into other
4066 applications as well as into Vim itself. When the Visual mode
4067 ends, possibly due to an operation on the text, or when an
4068 application wants to paste the selection, the highlighted text
4069 is automatically yanked into the "* selection register.
4070 Thus the selection is still available for pasting into other
4071 applications after the VISUAL mode has ended.
4072 If not present, then Vim won't become the owner of the
4073 windowing system's global selection unless explicitly told to
4074 by a yank or delete operation for the "* register.
4075 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004076 *'go-P'*
4077 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004078 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004079 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 applies to the modeless selection.
4082
4083 'guioptions' autoselect Visual autoselect modeless ~
4084 "" - -
4085 "a" yes yes
4086 "A" - yes
4087 "aA" yes yes
4088
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004089 When using a terminal see the 'clipboard' option.
4090
Bram Moolenaar02467872007-05-06 13:22:01 +00004091 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 'c' Use console dialogs instead of popup dialogs for simple
4093 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004094 *'go-d'*
4095 'd' Use dark theme variant if available. Currently only works for
4096 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004097 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004098 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004099 'guitablabel' can be used to change the text in the labels.
4100 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004101 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004102 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004103 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 'f' Foreground: Don't use fork() to detach the GUI from the shell
4105 where it was started. Use this for programs that wait for the
4106 editor to finish (e.g., an e-mail program). Alternatively you
4107 can use "gvim -f" or ":gui -f" to start the GUI in the
4108 foreground. |gui-fork|
4109 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004110 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004111 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4113 corner of the window. It's black&white on non-GTK, because of
4114 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004115 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004117 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004118 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004120 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004122 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004123 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 'g' Grey menu items: Make menu items that are not active grey. If
4125 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004126 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 't' Include tearoff menu items. Currently only works for Win32,
4128 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004129 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004130 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4131 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004132 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004134 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 'R' Right-hand scrollbar is present when there is a vertically
4136 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004137 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004139 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 'L' Left-hand scrollbar is present when there is a vertically
4141 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004142 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4144 the longest visible line, or on the cursor line if the 'h'
4145 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004146 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 'h' Limit horizontal scrollbar size to the length of the cursor
4148 line. Reduces computations. |gui-horiz-scroll|
4149
4150 And yes, you may even have scrollbars on the left AND the right if
4151 you really want to :-). See |gui-scrollbars| for more information.
4152
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004153 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 'v' Use a vertical button layout for dialogs. When not included,
4155 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004156 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004157 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 'p' Use Pointer callbacks for X11 GUI. This is required for some
4159 window managers. If the cursor is not blinking or hollow at
4160 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004161 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004163 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004164 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004165 *'go-k'*
4166 'k' Keep the GUI window size when adding/removing a scrollbar, or
4167 toolbar, tabline, etc. Instead, the behavior is similar to
4168 when the window is maximized and will adjust 'lines' and
4169 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004170 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004171 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 *'guipty'* *'noguipty'*
4174'guipty' boolean (default on)
4175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 {only available when compiled with GUI enabled}
4177 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4178 I/O to/from shell commands. See |gui-pty|.
4179
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004180 *'guitablabel'* *'gtl'*
4181'guitablabel' 'gtl' string (default empty)
4182 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004183 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004184 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004185 pages line. When empty and when the result is empty Vim will use a
4186 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004187
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004188 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004189 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004190 The expression will be evaluated in the |sandbox| when set from a
4191 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004192 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004193
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004194 Only used when the GUI tab pages line is displayed. 'e' must be
4195 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4196 used.
4197
Bram Moolenaar57657d82006-04-21 22:12:41 +00004198 *'guitabtooltip'* *'gtt'*
4199'guitabtooltip' 'gtt' string (default empty)
4200 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004201 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004202 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004203 pages line. When empty Vim will use a default tooltip.
4204 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004205 You can include a line break. Simplest method is to use |:let|: >
4206 :let &guitabtooltip = "line one\nline two"
4207<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004208
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004210'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 (others) "$VIMRUNTIME/doc/help.txt")
4212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 Name of the main help file. All distributed help files should be
4214 placed together in one directory. Additionally, all "doc" directories
4215 in 'runtimepath' will be used.
4216 Environment variables are expanded |:set_env|. For example:
4217 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004218 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 spaces and backslashes.
4220 This option cannot be set from a |modeline| or in the |sandbox|, for
4221 security reasons.
4222
4223 *'helpheight'* *'hh'*
4224'helpheight' 'hh' number (default 20)
4225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 Minimal initial height of the help window when it is opened with the
4227 ":help" command. The initial height of the help window is half of the
4228 current window, or (when the 'ea' option is on) the same as other
4229 windows. When the height is less than 'helpheight', the height is
4230 set to 'helpheight'. Set to zero to disable.
4231
4232 *'helplang'* *'hlg'*
4233'helplang' 'hlg' string (default: messages language or empty)
4234 global
4235 {only available when compiled with the |+multi_lang|
4236 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004237 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 for which the desired help can be found. The English help will always
4239 be used as a last resort. You can add "en" to prefer English over
4240 another language, but that will only find tags that exist in that
4241 language and not in the English help.
4242 Example: >
4243 :set helplang=de,it
4244< This will first search German, then Italian and finally English help
4245 files.
4246 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4247 try to find the tag in the current language before using this option.
4248 See |help-translated|.
4249
4250 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4251'hidden' 'hid' boolean (default off)
4252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 When off a buffer is unloaded when it is |abandon|ed. When on a
4254 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4255 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004256
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004258 hidden even if the 'hidden' option is off when these three are true:
4259 - the buffer is modified
4260 - 'autowrite' is off or writing is not possible
4261 - the '!' flag was used
4262 Also see |windows.txt|.
4263
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004264 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 This option is set for one command with ":hide {command}" |:hide|.
4266 WARNING: It's easy to forget that you have changes in hidden buffers.
4267 Think twice when using ":q!" or ":qa!".
4268
4269 *'highlight'* *'hl'*
4270'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004271 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4272 d:Directory,e:ErrorMsg,i:IncSearch,
4273 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004274 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004275 N:CursorLineNr,r:Question,s:StatusLine,
4276 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004277 v:Visual,V:VisualNOS,w:WarningMsg,
4278 W:WildMenu,f:Folded,F:FoldColumn,
4279 A:DiffAdd,C:DiffChange,D:DiffDelete,
4280 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004281 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004282 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004283 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004284 [:PmenuKind,]:PmenuKindSel,
4285 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004286 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4287 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004288 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004289 z:StatusLineTerm,Z:StatusLineTermNC,
4290 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004293 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004297 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4298 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 characters from 'showbreak'
4300 |hl-Directory| d directories in CTRL-D listing and other special
4301 things in listings
4302 |hl-ErrorMsg| e error messages
4303 h (obsolete, ignored)
4304 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004305 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4307 |hl-MoreMsg| m |more-prompt|
4308 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004309 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004310 |hl-LineNr| n line number for ":number" and ":#" commands, and
4311 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004312 |hl-LineNrAbove| a line number above the cursor for when the
4313 'relativenumber' option is set.
4314 |hl-LineNrBelow| b line number below the cursor for when the
4315 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004316 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4317 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 |hl-Question| r |hit-enter| prompt and yes/no questions
4319 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004320 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4322 |hl-VertSplit| c column used to separate vertically split windows
4323 |hl-Visual| v Visual mode
4324 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4325 Selection" Only X11 Gui's |gui-x11| and
4326 |xterm-clipboard|.
4327 |hl-WarningMsg| w warning messages
4328 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4329 |hl-Folded| f line used for closed folds
4330 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004331 |hl-DiffAdd| A added line in diff mode
4332 |hl-DiffChange| C changed line in diff mode
4333 |hl-DiffDelete| D deleted line in diff mode
4334 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004336 |hl-Conceal| - the placeholders used for concealed characters
4337 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004338 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004339 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004340 |hl-SpellRare| R rare word |spell|
4341 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004342 |hl-Pmenu| + popup menu normal line
4343 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004344 |hl-PmenuKind| [ popup menu "kind" normal line
4345 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004346 |hl-PmenuExtra| { popup menu "extra" normal line
4347 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004348 |hl-PmenuSbar| x popup menu scrollbar
4349 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004350 |hl-PmenuMatch| k popup menu matched text
4351 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352
4353 The display modes are:
4354 r reverse (termcap entry "mr" and "me")
4355 i italic (termcap entry "ZH" and "ZR")
4356 b bold (termcap entry "md" and "me")
4357 s standout (termcap entry "so" and "se")
4358 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004359 c undercurl (termcap entry "Us" and "Ce")
4360 2 double underline (termcap entry "Ds" and "Ce")
4361 d dotted underline (termcap entry "ds" and "Ce")
4362 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004363 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 n no highlighting
4365 - no highlighting
4366 : use a highlight group
4367 The default is used for occasions that are not included.
4368 If you want to change what the display modes do, see |dos-colors|
4369 for an example.
4370 When using the ':' display mode, this must be followed by the name of
4371 a highlight group. A highlight group can be used to define any type
4372 of highlighting, including using color. See |:highlight| on how to
4373 define one. The default uses a different group for each occasion.
4374 See |highlight-default| for the default highlight groups.
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004377'history' 'hi' number (Vim default: 50, Vi default: 0,
4378 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004381 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004383 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 NOTE: This option is set to the Vi default value when 'compatible' is
4385 set and to the Vim default value when 'compatible' is reset.
4386
4387 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4388'hkmap' 'hk' boolean (default off)
4389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 {only available when compiled with the |+rightleft|
4391 feature}
4392 When on, the keyboard is mapped for the Hebrew character set.
4393 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4394 toggle this option. See |rileft.txt|.
4395 NOTE: This option is reset when 'compatible' is set.
4396
4397 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4398'hkmapp' 'hkp' boolean (default off)
4399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 {only available when compiled with the |+rightleft|
4401 feature}
4402 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4403 This is useful if you have a non-Hebrew keyboard.
4404 See |rileft.txt|.
4405 NOTE: This option is reset when 'compatible' is set.
4406
Bram Moolenaar036986f2017-03-16 17:41:02 +01004407 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4408'hlsearch' 'hls' boolean (default off)
4409 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004410 {not available when compiled without the
4411 |+extra_search| feature}
4412 When there is a previous search pattern, highlight all its matches.
4413 The type of highlighting used can be set with the 'l' occasion in the
4414 'highlight' option. This uses the "Search" highlight group by
4415 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004416 are not applied. If the "CurSearch" highlight group is set then the
4417 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004418 See also: 'incsearch' and |:match|.
4419 When you get bored looking at the highlighted matches, you can turn it
4420 off with |:nohlsearch|. This does not change the option value, as
4421 soon as you use a search command, the highlighting comes back.
4422 'redrawtime' specifies the maximum time spent on finding matches.
4423 When the search pattern can match an end-of-line, Vim will try to
4424 highlight all of the matched text. However, this depends on where the
4425 search starts. This will be the first line in the window or the first
4426 line below a closed fold. A match in a previous line which is not
4427 drawn may not continue in a newly drawn line.
4428 You can specify whether the highlight status is restored on startup
4429 with the 'h' flag in 'viminfo' |viminfo-h|.
4430 NOTE: This option is reset when 'compatible' is set.
4431
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 *'icon'* *'noicon'*
4433'icon' boolean (default off, on when title can be restored)
4434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 When on, the icon text of the window will be set to the value of
4436 'iconstring' (if it is not empty), or to the name of the file
4437 currently being edited. Only the last part of the name is used.
4438 Overridden by the 'iconstring' option.
4439 Only works if the terminal supports setting window icons (currently
4440 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4441 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4442 builtin termcap).
4443 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004444 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004446 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 *'iconstring'*
4449'iconstring' string (default "")
4450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 When this option is not empty, it will be used for the icon text of
4452 the window. This happens only when the 'icon' option is on.
4453 Only works if the terminal supports setting window icon text
4454 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004455 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 When Vim was compiled with HAVE_X11 defined, the original icon will be
4457 restored if possible |X11|.
4458 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004459 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004461 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 {not available when compiled without the |+statusline| feature}
4463
4464 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4465'ignorecase' 'ic' boolean (default off)
4466 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004467 Ignore case in search patterns, |cmdline-completion|, when
4468 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004469 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 Can be overruled by using "\c" or "\C" in the pattern, see
4471 |/ignorecase|.
4472
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004473 *'imactivatefunc'* *'imaf'*
4474'imactivatefunc' 'imaf' string (default "")
4475 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004476 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004477 activate or deactivate the Input Method. The value can be the name of
4478 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4479 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004480 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004481 The expression will be evaluated in the |sandbox| when set from a
4482 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004483
4484 Example: >
4485 function ImActivateFunc(active)
4486 if a:active
4487 ... do something
4488 else
4489 ... do something
4490 endif
4491 " return value is not used
4492 endfunction
4493 set imactivatefunc=ImActivateFunc
4494<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 *'imactivatekey'* *'imak'*
4496'imactivatekey' 'imak' string (default "")
4497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004499 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 Specifies the key that your Input Method in X-Windows uses for
4501 activation. When this is specified correctly, vim can fully control
4502 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4503 You can't use this option to change the activation key, the option
4504 tells Vim what the key is.
4505 Format:
4506 [MODIFIER_FLAG-]KEY_STRING
4507
4508 These characters can be used for MODIFIER_FLAG (case is ignored):
4509 S Shift key
4510 L Lock key
4511 C Control key
4512 1 Mod1 key
4513 2 Mod2 key
4514 3 Mod3 key
4515 4 Mod4 key
4516 5 Mod5 key
4517 Combinations are allowed, for example "S-C-space" or "SC-space" are
4518 both shift+ctrl+space.
4519 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4520
4521 Example: >
4522 :set imactivatekey=S-space
4523< "S-space" means shift+space. This is the activation key for kinput2 +
4524 canna (Japanese), and ami (Korean).
4525
4526 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4527'imcmdline' 'imc' boolean (default off)
4528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 When set the Input Method is always on when starting to edit a command
4530 line, unless entering a search pattern (see 'imsearch' for that).
4531 Setting this option is useful when your input method allows entering
4532 English characters directly, e.g., when it's used to type accented
4533 characters with dead keys.
4534
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004535 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 When set the Input Method is never used. This is useful to disable
4539 the IM when it doesn't work properly.
4540 Currently this option is on by default for SGI/IRIX machines. This
4541 may change in later releases.
4542
4543 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004544'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 Specifies whether :lmap or an Input Method (IM) is to be used in
4547 Insert mode. Valid values:
4548 0 :lmap is off and IM is off
4549 1 :lmap is ON and IM is off
4550 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 To always reset the option to zero when leaving Insert mode with <Esc>
4552 this can be used: >
4553 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4554< This makes :lmap and IM turn off automatically when leaving Insert
4555 mode.
4556 Note that this option changes when using CTRL-^ in Insert mode
4557 |i_CTRL-^|.
4558 The value is set to 1 when setting 'keymap' to a valid keymap name.
4559 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004560 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 methods. Use 'imdisable' to disable XIM then.
4562
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004563 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004564 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004565 |+multi_byte_ime| or |global-ime|.
4566
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004568'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 Specifies whether :lmap or an Input Method (IM) is to be used when
4571 entering a search pattern. Valid values:
4572 -1 the value of 'iminsert' is used, makes it look like
4573 'iminsert' is also used when typing a search pattern
4574 0 :lmap is off and IM is off
4575 1 :lmap is ON and IM is off
4576 2 :lmap is off and IM is ON
4577 Note that this option changes when using CTRL-^ in Command-line mode
4578 |c_CTRL-^|.
4579 The value is set to 1 when it is not -1 and setting the 'keymap'
4580 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004581 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 methods. Use 'imdisable' to disable XIM then.
4583
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004584 *'imstatusfunc'* *'imsf'*
4585'imstatusfunc' 'imsf' string (default "")
4586 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004587 This option specifies a function that is called to obtain the status
4588 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004589 The value can be the name of a function, a |lambda| or a |Funcref|.
4590 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004591 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004592
4593 Example: >
4594 function ImStatusFunc()
4595 let is_active = ...do something
4596 return is_active ? 1 : 0
4597 endfunction
4598 set imstatusfunc=ImStatusFunc
4599<
4600 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004601 The expression will be evaluated in the |sandbox| when set from a
4602 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004603
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004604 *'imstyle'* *'imst'*
4605'imstyle' 'imst' number (default 1)
4606 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004607 {only available when compiled with |+xim| and
4608 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004609 This option specifies the input style of Input Method:
4610 0 use on-the-spot style
4611 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004612 See: |xim-input-style|
4613
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004614 For a long time on-the-spot style had been used in the GTK version of
4615 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004616 |single-repeat|, etc. Therefore over-the-spot style becomes the
4617 default now. This should work fine for most people, however if you
4618 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004619 The expression will be evaluated in the |sandbox| when set from a
4620 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004621
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 *'include'* *'inc'*
4623'include' 'inc' string (default "^\s*#\s*include")
4624 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 {not available when compiled without the
4626 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 pattern, just like for the "/" command (See |pattern|). The default
4629 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004630 "]I", "[d", etc.
4631 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004632 comes after the matched pattern. But if "\zs" appears in the pattern
4633 then the text matched from "\zs" to the end, or until "\ze" if it
4634 appears, is used as the file name. Use this to include characters
4635 that are not in 'isfname', such as a space. You can then use
4636 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004637 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638
4639 *'includeexpr'* *'inex'*
4640'includeexpr' 'inex' string (default "")
4641 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004643 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004645 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004646 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004648 Note the double backslash: the `:set` command first halves them, then
4649 one remains it the value, where "\." matches a dot literally. For
4650 simple character replacements `tr()` avoids the need for escaping: >
4651 :setlocal includeexpr=tr(v:fname,'.','/')
4652<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004654 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 Also used for |<cfile>|.
4656
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004657 If the expression starts with s: or |<SID>|, then it is replaced with
4658 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004659 setlocal includeexpr=s:MyIncludeExpr()
4660 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004661< Otherwise, the expression is evaluated in the context of the script
4662 where the option was set, thus script-local items are available.
4663
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004664 It is more efficient if the value is just a function call without
4665 arguments, see |expr-option-function|.
4666
Bram Moolenaar30b65812012-07-12 22:01:11 +02004667 The expression will be evaluated in the |sandbox| when set from a
4668 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004669 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004670
4671 It is not allowed to change text or jump to another window while
4672 evaluating 'includeexpr' |textlock|.
4673
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004675'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004676 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004679 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004680 While typing a search command, show where the pattern, as it was typed
4681 so far, matches. The matched string is highlighted. If the pattern
4682 is invalid or not found, nothing is shown. The screen will be updated
4683 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004684 Also applies to the pattern in commands: >
4685 :global
4686 :lvimgrep
4687 :lvimgrepadd
4688 :smagic
4689 :snomagic
4690 :sort
4691 :substitute
4692 :vglobal
4693 :vimgrep
4694 :vimgrepadd
4695< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004696 original position when no match is found and when pressing <Esc>. You
4697 still need to finish the search command with <Enter> to move the
4698 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004699 You can use the CTRL-G and CTRL-T keys to move to the next and
4700 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004701 When compiled with the |+reltime| feature Vim only searches for about
4702 half a second. With a complicated pattern and/or a lot of text the
4703 match may not be found. This is to avoid that Vim hangs while you
4704 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004705 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004706 When 'hlsearch' is on, all matched strings are highlighted too while
4707 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004708 If you don't want to turn 'hlsearch' on, but want to highlight all
4709 matches while searching, you can turn on and off 'hlsearch' with
4710 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004711 augroup vimrc-incsearch-highlight
4712 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004713 autocmd CmdlineEnter /,\? :set hlsearch
4714 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004715 augroup END
4716<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004717 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004718 to the command line. If 'ignorecase' and 'smartcase' are set and the
4719 command line has no uppercase characters, the added character is
4720 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004721 CTRL-R CTRL-W can be used to add the word at the end of the current
4722 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 NOTE: This option is reset when 'compatible' is set.
4724
4725 *'indentexpr'* *'inde'*
4726'indentexpr' 'inde' string (default "")
4727 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004728 {not available when compiled without the |+eval|
4729 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 Expression which is evaluated to obtain the proper indent for a line.
4731 It is used when a new line is created, for the |=| operator and
4732 in Insert mode as specified with the 'indentkeys' option.
4733 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004734 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004735 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 When 'paste' is set this option is not used for indenting.
4737 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004738 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004740
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004741 If the expression starts with s: or |<SID>|, then it is replaced with
4742 the script ID (|local-function|). Example: >
4743 set indentexpr=s:MyIndentExpr()
4744 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004745< Otherwise, the expression is evaluated in the context of the script
4746 where the option was set, thus script-local items are available.
4747
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004748 The advantage of using a function call without arguments is that it is
4749 faster, see |expr-option-function|.
4750
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 The expression must return the number of spaces worth of indent. It
4752 can return "-1" to keep the current indent (this means 'autoindent' is
4753 used for the indent).
4754 Functions useful for computing the indent are |indent()|, |cindent()|
4755 and |lispindent()|.
4756 The evaluation of the expression must not have side effects! It must
4757 not change the text, jump to another window, etc. Afterwards the
4758 cursor position is always restored, thus the cursor may be moved.
4759 Normally this option would be set to call a function: >
4760 :set indentexpr=GetMyIndent()
4761< Error messages will be suppressed, unless the 'debug' option contains
4762 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004763 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004764 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765
Bram Moolenaar30b65812012-07-12 22:01:11 +02004766 The expression will be evaluated in the |sandbox| when set from a
4767 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004768 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004769
4770 It is not allowed to change text or jump to another window while
4771 evaluating 'indentexpr' |textlock|.
4772
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004774'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 A list of keys that, when typed in Insert mode, cause reindenting of
4777 the current line. Only happens if 'indentexpr' isn't empty.
4778 The format is identical to 'cinkeys', see |indentkeys-format|.
4779 See |C-indenting| and |indent-expression|.
4780
4781 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4782'infercase' 'inf' boolean (default off)
4783 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004785 'ignorecase' is also on, the case of the match is adjusted depending
4786 on the typed text. If the typed text contains a lowercase letter
4787 where the match has an upper case letter, the completed part is made
4788 lowercase. If the typed text has no lowercase letters and the match
4789 has a lowercase letter where the typed text has an uppercase letter,
4790 and there is a letter before it, the completed part is made uppercase.
4791 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4794'insertmode' 'im' boolean (default off)
4795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 Makes Vim work in a way that Insert mode is the default mode. Useful
4797 if you want to use Vim as a modeless editor. Used for |evim|.
4798 These Insert mode commands will be useful:
4799 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004800 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 this is a mapping, it is executed as if 'insertmode' was off.
4802 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004804 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4805 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807 These items change when 'insertmode' is set:
4808 - when starting to edit of a file, Vim goes to Insert mode.
4809 - <Esc> in Insert mode is a no-op and beeps.
4810 - <Esc> in Normal mode makes Vim go to Insert mode.
4811 - CTRL-L in Insert mode is a command, it is not inserted.
4812 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4813 However, when <Esc> is used inside a mapping, it behaves like
4814 'insertmode' was not set. This was done to be able to use the same
4815 mappings with 'insertmode' set or not set.
4816 When executing commands with |:normal| 'insertmode' is not used.
4817
4818 NOTE: This option is reset when 'compatible' is set.
4819
4820 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004821'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4823 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4824 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4825 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4826 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 The characters specified by this option are included in file names and
4829 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004830 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 Multi-byte characters 256 and above are always included, only the
4832 characters up to 255 are specified with this option.
4833 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004834 Think twice before adding white space to this option. Although a
4835 space may appear inside a file name, the effect will be that Vim
4836 doesn't know where a file name starts or ends when doing completion.
4837 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838
4839 Note that on systems using a backslash as path separator, Vim tries to
4840 do its best to make it work as you would expect. That is a bit
4841 tricky, since Vi originally used the backslash to escape special
4842 characters. Vim will not remove a backslash in front of a normal file
4843 name character on these systems, but it will on Unix and alikes. The
4844 '&' and '^' are not included by default, because these are special for
4845 cmd.exe.
4846
4847 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004848 Each part can be a single character number or a range. A range is two
4849 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 decimal number between 0 and 255 or the ASCII character itself (does
4851 not work for digits). Example:
4852 "_,-,128-140,#-43" (include '_' and '-' and the range
4853 128 to 140 and '#' to 43)
4854 If a part starts with '^', the following character number or range
4855 will be excluded from the option. The option is interpreted from left
4856 to right. Put the excluded character after the range where it is
4857 included. To include '^' itself use it as the last character of the
4858 option or the end of a range. Example:
4859 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4860 If the character is '@', all characters where isalpha() returns TRUE
4861 are included. Normally these are the characters a to z and A to Z,
4862 plus accented characters. To include '@' itself use "@-@". Examples:
4863 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004864 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 "a-z,A-Z,@-@" All letters plus the '@' character.
4866 A comma can be included by using it where a character number is
4867 expected. Example:
4868 "48-57,,,_" Digits, comma and underscore.
4869 A comma can be excluded by prepending a '^'. Example:
4870 " -~,^,,9" All characters from space to '~', excluding
4871 comma, plus <Tab>.
4872 See |option-backslash| about including spaces and backslashes.
4873
4874 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004875'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 "@,48-57,_,128-167,224-235"
4877 otherwise: "@,48-57,_,192-255")
4878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 The characters given by this option are included in identifiers.
4880 Identifiers are used in recognizing environment variables and after a
4881 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004882 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004883 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004885 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4887
4888 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004889'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 "@,48-57,_,128-167,224-235"
4891 otherwise: "@,48-57,_,192-255"
4892 Vi default: "@,48-57,_")
4893 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004895 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004896 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004897 characters above 255 check the "word" character class (any character
4898 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004899 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 For a help file it is set to all non-blank printable characters except
4901 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4902 command).
4903 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004904 This option also influences syntax highlighting, unless the syntax
4905 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 NOTE: This option is set to the Vi default value when 'compatible' is
4907 set and to the Vim default value when 'compatible' is reset.
4908
4909 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004910'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 "@,~-255"; otherwise: "@,161-255")
4912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 The characters given by this option are displayed directly on the
4914 screen. It is also used for "\p" in a |pattern|. The characters from
4915 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4916 even when they are not included in 'isprint' or excluded. See
4917 'isfname' for a description of the format of this option.
4918
4919 Non-printable characters are displayed with two characters:
4920 0 - 31 "^@" - "^_"
4921 32 - 126 always single characters
4922 127 "^?"
4923 128 - 159 "~@" - "~_"
4924 160 - 254 "| " - "|~"
4925 255 "~?"
4926 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4927 displayed as <xx>, with the hexadecimal value of the byte.
4928 When 'display' contains "uhex" all unprintable characters are
4929 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004930 The SpecialKey highlighting will be used for unprintable characters.
4931 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932
4933 Multi-byte characters 256 and above are always included, only the
4934 characters up to 255 are specified with this option. When a character
4935 is printable but it is not available in the current font, a
4936 replacement character will be shown.
4937 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4938 There is no option to specify these characters.
4939
4940 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4941'joinspaces' 'js' boolean (default on)
4942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 Insert two spaces after a '.', '?' and '!' with a join command.
4944 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4945 Otherwise only one space is inserted.
4946 NOTE: This option is set when 'compatible' is set.
4947
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004948 *'jumpoptions'* *'jop'*
4949'jumpoptions' 'jop' string (default "")
4950 global
4951 List of words that change the behavior of the |jumplist|.
4952 stack Make the jumplist behave like the tagstack.
4953 Relative location of entries in the jumplist is
4954 preserved at the cost of discarding subsequent entries
4955 when navigating backwards in the jumplist and then
4956 jumping to a location. |jumplist-stack|
4957
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 *'key'*
4959'key' string (default "")
4960 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004961 {only available when compiled with the |+cryptv|
4962 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004964 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 Careful: Do not set the key value by hand, someone might see the typed
4966 key. Use the |:X| command. But you can make 'key' empty: >
4967 :set key=
4968< It is not possible to get the value of this option with ":set key" or
4969 "echo &key". This is to avoid showing it to someone who shouldn't
4970 know. It also means you cannot see it yourself once you have set it,
4971 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004972 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4973 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004974 You can use "&key" in an expression to detect whether encryption is
4975 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976
4977 *'keymap'* *'kmp'* *E544*
4978'keymap' 'kmp' string (default "")
4979 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 {only available when compiled with the |+keymap|
4981 feature}
4982 Name of a keyboard mapping. See |mbyte-keymap|.
4983 Setting this option to a valid keymap name has the side effect of
4984 setting 'iminsert' to one, so that the keymap becomes effective.
4985 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004986 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987
4988 *'keymodel'* *'km'*
4989'keymodel' 'km' string (default "")
4990 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004991 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 can do. These values can be used:
4993 startsel Using a shifted special key starts selection (either
4994 Select mode or Visual mode, depending on "key" being
4995 present in 'selectmode').
4996 stopsel Using a not-shifted special key stops selection.
4997 Special keys in this context are the cursor keys, <End>, <Home>,
4998 <PageUp> and <PageDown>.
4999 The 'keymodel' option is set by the |:behave| command.
5000
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005001 *'keyprotocol'* *'kpc'*
5002'keyprotocol' 'kpc' string (default: see below)
5003 global
5004 Specifies what keyboard protocol to use depending on the value of
5005 'term'. The supported keyboard protocols names are:
5006 none whatever the terminal uses
5007 mok2 modifyOtherKeys level 2, as supported by xterm
5008 kitty Kitty keyboard protocol, as supported by Kitty
5009
Bram Moolenaara87749e2022-11-30 10:23:17 +00005010 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005011 a pattern that is matched against the 'term' option, a colon and the
5012 protocol name to be used. To illustrate this, the default value would
5013 be set with: >
5014 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5015
5016< This means that when 'term' contains "kitty, "foot" or "wezterm"
5017 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005018 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005019
5020 The first match is used, thus if you want to have "kitty" use the
5021 kitty protocol, but "badkitty" not, then you should match "badkitty"
5022 first and use the "none" value: >
5023 set keyprotocol=badkitty:none,kitty:kitty
5024<
5025 The option is used after 'term' has been changed. First the termcap
5026 entries are set, possibly using the builtin list, see |builtin-terms|.
5027 Then this option is inspected and if there is a match and a protocol
5028 is specified the following happens:
5029 none Nothing, the regular t_TE and t_TI values remain
5030
5031 mok2 The t_TE value is changed to:
5032 CSI >4;m disables modifyOtherKeys
5033 The t_TI value is changed to:
5034 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005035 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005036
5037 kitty The t_TE value is changed to:
5038 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005039 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005040 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005041 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005042 CSI ?u request kitty keyboard protocol state
5043 CSI >c request the termresponse
5044
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005045 If you notice problems, such as characters being displayed that
5046 disappear after `CTRL-L`, you might want to try making this option
5047 empty. Then set the 'term' option to have it take effect: >
5048 set keyprotocol=
5049 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005050<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 *'keywordprg'* *'kp'*
5053'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005054 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 Program to use for the |K| command. Environment variables are
5057 expanded |:set_env|. ":help" may be used to access the Vim internal
5058 help. (Note that previously setting the global option to the empty
5059 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005060 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005061 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005062 When "man", "man -s" or an Ex command is used, Vim will automatically
5063 translate a count for the "K" command and pass it as the first
5064 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 See |option-backslash| about including spaces and backslashes.
5066 Example: >
5067 :set keywordprg=man\ -s
5068< This option cannot be set from a |modeline| or in the |sandbox|, for
5069 security reasons.
5070
5071 *'langmap'* *'lmap'* *E357* *E358*
5072'langmap' 'lmap' string (default "")
5073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 {only available when compiled with the |+langmap|
5075 feature}
5076 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005077 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005078 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 care of translating these special characters to the original meaning
5080 of the key. This means you don't have to change the keyboard mode to
5081 be able to execute Normal mode commands.
5082 This is the opposite of the 'keymap' option, where characters are
5083 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005084 Also consider setting 'langremap' to off, to prevent 'langmap' from
5085 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005086 This option cannot be set from a |modeline| or in the |sandbox|, for
5087 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005089 Example (for Greek, in UTF-8): *greek* >
5090 :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 +00005091< Example (exchanges meaning of z and y for commands): >
5092 :set langmap=zy,yz,ZY,YZ
5093<
5094 The 'langmap' option is a list of parts, separated with commas. Each
5095 part can be in one of two forms:
5096 1. A list of pairs. Each pair is a "from" character immediately
5097 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005098 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 characters. Example: "abc;ABC"
5100 Example: "aA,fgh;FGH,cCdDeE"
5101 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005102 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103
5104 This will allow you to activate vim actions without having to switch
5105 back and forth between the languages. Your language characters will
5106 be understood as normal vim English characters (according to the
5107 langmap mappings) in the following cases:
5108 o Normal/Visual mode (commands, buffer/register names, user mappings)
5109 o Insert/Replace Mode: Register names after CTRL-R
5110 o Insert/Replace Mode: Mappings
5111 Characters entered in Command-line mode will NOT be affected by
5112 this option. Note that this option can be changed at any time
5113 allowing to switch between mappings for different languages/encodings.
5114 Use a mapping to avoid having to type it each time!
5115
5116 *'langmenu'* *'lm'*
5117'langmenu' 'lm' string (default "")
5118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 {only available when compiled with the |+menu| and
5120 |+multi_lang| features}
5121 Language to use for menu translation. Tells which file is loaded
5122 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005123 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124< (without the spaces). For example, to always use the Dutch menus, no
5125 matter what $LANG is set to: >
5126 :set langmenu=nl_NL.ISO_8859-1
5127< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005128 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 If your $LANG is set to a non-English language but you do want to use
5130 the English menus: >
5131 :set langmenu=none
5132< This option must be set before loading menus, switching on filetype
5133 detection or syntax highlighting. Once the menus are defined setting
5134 this option has no effect. But you could do this: >
5135 :source $VIMRUNTIME/delmenu.vim
5136 :set langmenu=de_DE.ISO_8859-1
5137 :source $VIMRUNTIME/menu.vim
5138< Warning: This deletes all menus that you defined yourself!
5139
Bram Moolenaard94464e2015-11-02 15:28:18 +01005140 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005141'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005142 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005143 {only available when compiled with the |+langmap|
5144 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005145 This is just like 'langremap' but with the value inverted. It only
5146 exists for backwards compatibility. When setting 'langremap' then
5147 'langnoremap' is set to the inverted value, and the other way around.
5148
5149 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005150'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005151 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005152 {only available when compiled with the |+langmap|
5153 feature}
5154 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005155 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005156 'langmap' disables some of your mappings, try resetting this option.
5157 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005158 that works for you to avoid mappings to break.
5159
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 *'laststatus'* *'ls'*
5161'laststatus' 'ls' number (default 1)
5162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 The value of this option influences when the last window will have a
5164 status line:
5165 0: never
5166 1: only if there are at least two windows
5167 2: always
5168 The screen looks nicer with a status line if you have several
5169 windows, but it takes another screen line. |status-line|
5170
5171 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5172'lazyredraw' 'lz' boolean (default off)
5173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 When this option is set, the screen will not be redrawn while
5175 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005176 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005178 This may occasionally cause display errors. It is only meant to be set
5179 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005180 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181
5182 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5183'linebreak' 'lbr' boolean (default off)
5184 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005185 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005187 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 than at the last character that fits on the screen. Unlike
5189 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005190 it only affects the way the file is displayed, not its contents.
5191 If 'breakindent' is set, line is visually indented. Then, the value
5192 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005193 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 Note that <Tab> characters after an <EOL> are mostly not displayed
5195 with the right amount of white space.
5196
5197 *'lines'* *E593*
5198'lines' number (default 24 or terminal height)
5199 global
5200 Number of lines of the Vim window.
5201 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005202 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 When Vim is running in the GUI or in a resizable window, setting this
5204 option will cause the window size to be changed. When you only want
5205 to use the size for the GUI, put the command in your |gvimrc| file.
5206 Vim limits the number of lines to what fits on the screen. You can
5207 use this command to get the tallest window possible: >
5208 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005209< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005210 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 When you set this option and Vim is unable to change the physical
5212 number of lines of the display, the display may be messed up.
5213
5214 *'linespace'* *'lsp'*
5215'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 {only in the GUI}
5218 Number of pixel lines inserted between characters. Useful if the font
5219 uses the full character cell height, making lines touch each other.
5220 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005221 With some fonts there can be too much room between lines (to have
5222 space for ascents and descents). Then it makes sense to set
5223 'linespace' to a negative value. This may cause display problems
5224 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225
5226 *'lisp'* *'nolisp'*
5227'lisp' boolean (default off)
5228 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 Lisp mode: When <Enter> is typed in insert mode set the indent for
5230 the next line to Lisp standards (well, sort of). Also happens with
5231 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5232 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5233 better. Also see 'lispwords'.
5234 The '-' character is included in keyword characters. Redefines the
5235 "=" operator to use this same indentation algorithm rather than
5236 calling an external program if 'equalprg' is empty.
5237 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005239 *'lispoptions'* *'lop'*
5240'lispoptions' 'lop' string (default "")
5241 local to buffer
5242 Comma-separated list of items that influence the Lisp indenting when
5243 enabled with the |'lisp'| option. Currently only one item is
5244 supported:
5245 expr:1 use 'indentexpr' for Lisp indenting when it is set
5246 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5247 Note that when using 'indentexpr' the `=` operator indents all the
5248 lines, otherwise the first line is not indented (Vi-compatible).
5249
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 *'lispwords'* *'lw'*
5251'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005252 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005253 Comma-separated list of words that influence the Lisp indenting when
5254 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255
5256 *'list'* *'nolist'*
5257'list' boolean (default off)
5258 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005259 List mode: By default show tabs as CTRL-I is displayed, display $
5260 after end of line. Useful to see the difference between tabs and
5261 spaces and for trailing blanks. Further changed by the 'listchars'
5262 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005263
5264 The cursor is displayed at the start of the space a Tab character
5265 occupies, not at the end as usual in Normal mode. To get this cursor
5266 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005267 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005268<
5269 Note that list mode will also affect formatting (set with 'textwidth'
5270 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 changing the way tabs are displayed.
5272
5273 *'listchars'* *'lcs'*
5274'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005275 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005276 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005277 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005278 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 eol:c Character to show at the end of each line. When
5280 omitted, there is no extra character at the end of the
5281 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005282 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005283 tab:xy[z] Two or three characters to be used to show a tab.
5284 The third character is optional.
5285
5286 tab:xy The 'x' is always used, then 'y' as many times as will
5287 fit. Thus "tab:>-" displays:
5288 >
5289 >-
5290 >--
5291 etc.
5292
5293 tab:xyz The 'z' is always used, then 'x' is prepended, and
5294 then 'y' is used as many times as will fit. Thus
5295 "tab:<->" displays:
5296 >
5297 <>
5298 <->
5299 <-->
5300 etc.
5301
5302 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005303 *lcs-space*
5304 space:c Character to show for a space. When omitted, spaces
5305 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005306 *lcs-multispace*
5307 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005308 One or more characters to use cyclically to show for
5309 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005310 setting, except for single spaces. When omitted, the
5311 "space" setting is used. For example,
5312 `:set listchars=multispace:---+` shows ten consecutive
5313 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005314 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005315 *lcs-lead*
5316 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005317 leading spaces are blank. Overrides the "space" and
5318 "multispace" settings for leading spaces. You can
5319 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005320 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005321< *lcs-leadmultispace*
5322 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005323 Like the |lcs-multispace| value, but for leading
5324 spaces only. Also overrides |lcs-lead| for leading
5325 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005326 `:set listchars=leadmultispace:---+` shows ten
5327 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005328 ---+---+--XXX ~
5329 Where "XXX" denotes the first non-blank characters in
5330 the line.
5331 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005332 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005333 trailing spaces are blank. Overrides the "space" and
5334 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005335 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 extends:c Character to show in the last column, when 'wrap' is
5337 off and the line continues beyond the right of the
5338 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005339 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005340 precedes:c Character to show in the first visible column of the
5341 physical line, when there is text preceding the
5342 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005343 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005344 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005345 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005346 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005347 nbsp:c Character to show for a non-breakable space character
5348 (0xA0 (160 decimal) and U+202F). Left blank when
5349 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005351 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005353 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005355 Each character can be specified as hex: >
5356 set listchars=eol:\\x24
5357 set listchars=eol:\\u21b5
5358 set listchars=eol:\\U000021b5
5359< Note that a double backslash is used. The number of hex characters
5360 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5361
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 Examples: >
5363 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005364 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 :set lcs=extends:>,precedes:<
5366< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005367 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5368 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005369 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370
5371 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5372'loadplugins' 'lpl' boolean (default on)
5373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 When on the plugin scripts are loaded when starting up |load-plugins|.
5375 This option can be reset in your |vimrc| file to disable the loading
5376 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005377 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5378 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
Bram Moolenaard94464e2015-11-02 15:28:18 +01005380 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005381'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005382 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005383 {only available when compiled with the |+lua/dyn|
5384 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005385 Specifies the name of the Lua shared library. The default is
5386 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005387 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005388 This option cannot be set from a |modeline| or in the |sandbox|, for
5389 security reasons.
5390
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005391 *'macatsui'* *'nomacatsui'*
5392'macatsui' boolean (default on)
5393 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005394 {not supported}
5395 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005396
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 *'magic'* *'nomagic'*
5398'magic' boolean (default on)
5399 global
5400 Changes the special characters that can be used in search patterns.
5401 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005402 WARNING: Switching this option off most likely breaks plugins! That
5403 is because many patterns assume it's on and will fail when it's off.
5404 Only switch it off when working with old Vi scripts. In any other
5405 situation write patterns that work when 'magic' is on. Include "\M"
5406 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005407 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5408 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409
5410 *'makeef'* *'mef'*
5411'makeef' 'mef' string (default: "")
5412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 {not available when compiled without the |+quickfix|
5414 feature}
5415 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5416 and the |:grep| command.
5417 When it is empty, an internally generated temp file will be used.
5418 When "##" is included, it is replaced by a number to make the name
5419 unique. This makes sure that the ":make" command doesn't overwrite an
5420 existing file.
5421 NOT used for the ":cf" command. See 'errorfile' for that.
5422 Environment variables are expanded |:set_env|.
5423 See |option-backslash| about including spaces and backslashes.
5424 This option cannot be set from a |modeline| or in the |sandbox|, for
5425 security reasons.
5426
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005427 *'makeencoding'* *'menc'*
5428'makeencoding' 'menc' string (default "")
5429 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005430 Encoding used for reading the output of external commands. When empty,
5431 encoding is not converted.
5432 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5433 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5434 and `:laddfile`.
5435
5436 This would be mostly useful when you use MS-Windows and set 'encoding'
5437 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5438 'makeencoding' to "char" has the same effect as setting to the system
5439 locale encoding. Example: >
5440 :set encoding=utf-8
5441 :set makeencoding=char " system locale is used
5442<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 *'makeprg'* *'mp'*
5444'makeprg' 'mp' string (default "make", VMS: "MMS")
5445 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005446 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005447 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5448 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005449 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005450 Environment variables are expanded |:set_env|. See |option-backslash|
5451 about including spaces and backslashes.
5452 Note that a '|' must be escaped twice: once for ":set" and once for
5453 the interpretation of a command. When you use a filter called
5454 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 :set makeprg=gmake\ \\\|\ myfilter
5456< The placeholder "$*" can be given (even multiple times) to specify
5457 where the arguments will be included, for example: >
5458 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5459< This option cannot be set from a |modeline| or in the |sandbox|, for
5460 security reasons.
5461
5462 *'matchpairs'* *'mps'*
5463'matchpairs' 'mps' string (default "(:),{:},[:]")
5464 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005466 other.
5467 Only character pairs are allowed that are different, thus you cannot
5468 jump between two double quotes.
5469 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005470 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005471 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 :set mps+=<:>
5473
5474< A more exotic example, to jump between the '=' and ';' in an
5475 assignment, useful for languages like C and Java: >
5476 :au FileType c,cpp,java set mps+==:;
5477
5478< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005479 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480
5481 *'matchtime'* *'mat'*
5482'matchtime' 'mat' number (default 5)
5483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 Tenths of a second to show the matching paren, when 'showmatch' is
5485 set. Note that this is not in milliseconds, like other options that
5486 set a time. This is to be compatible with Nvi.
5487
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005488 *'maxcombine'* *'mco'*
5489'maxcombine' 'mco' number (default 2)
5490 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005491 The maximum number of combining characters supported for displaying.
5492 Only used when 'encoding' is "utf-8".
5493 The default is OK for most languages. Hebrew may require 4.
5494 Maximum value is 6.
5495 Even when this option is set to 2 you can still edit text with more
5496 combining characters, you just can't see them. Use |g8| or |ga|.
5497 See |mbyte-combining|.
5498
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 *'maxfuncdepth'* *'mfd'*
5500'maxfuncdepth' 'mfd' number (default 100)
5501 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005502 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005503 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 Maximum depth of function calls for user functions. This normally
5505 catches endless recursion. When using a recursive function with
5506 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5507 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005508 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005509 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005511 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512
5513 *'maxmapdepth'* *'mmd'* *E223*
5514'maxmapdepth' 'mmd' number (default 1000)
5515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 Maximum number of times a mapping is done without resulting in a
5517 character to be used. This normally catches endless mappings, like
5518 ":map x y" with ":map y x". It still does not catch ":map g wg",
5519 because the 'w' is used before the next mapping is done. See also
5520 |key-mapping|.
5521
5522 *'maxmem'* *'mm'*
5523'maxmem' 'mm' number (default between 256 to 5120 (system
5524 dependent) or half the amount of memory
5525 available)
5526 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5528 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005529 other memory to be freed.
5530 The maximum usable value is about 2000000. Use this to work without a
5531 limit.
5532 The value is ignored when 'swapfile' is off.
5533 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005535 *'maxmempattern'* *'mmp'*
5536'maxmempattern' 'mmp' number (default 1000)
5537 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005538 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005539 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005540 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005541 When Vim runs into the limit it gives an error message and mostly
5542 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005543 Running into the limit often means that the pattern is very
5544 inefficient or too complex. This may already happen with the pattern
5545 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005546 Might also happen on redraw, when syntax rules try to match a complex
5547 text structure.
5548 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5549 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005550
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 *'maxmemtot'* *'mmt'*
5552'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5553 dependent) or half the amount of memory
5554 available)
5555 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005556 Maximum amount of memory in Kbyte to use for all buffers together.
5557 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005558 without a limit.
5559 On 64 bit machines higher values might work. But hey, do you really
5560 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005561 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005562 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005563 Buffers with 'swapfile' off still count to the total amount of memory
5564 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005565 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566
5567 *'menuitems'* *'mis'*
5568'menuitems' 'mis' number (default 25)
5569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 {not available when compiled without the |+menu|
5571 feature}
5572 Maximum number of items to use in a menu. Used for menus that are
5573 generated from a list of items, e.g., the Buffers menu. Changing this
5574 option has no direct effect, the menu must be refreshed first.
5575
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005576 *'mkspellmem'* *'msm'*
5577'mkspellmem' 'msm' string (default "460000,2000,500")
5578 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005579 {not available when compiled without the |+syntax|
5580 feature}
5581 Parameters for |:mkspell|. This tunes when to start compressing the
5582 word tree. Compression can be slow when there are many words, but
5583 it's needed to avoid running out of memory. The amount of memory used
5584 per word depends very much on how similar the words are, that's why
5585 this tuning is complicated.
5586
5587 There are three numbers, separated by commas:
5588 {start},{inc},{added}
5589
5590 For most languages the uncompressed word tree fits in memory. {start}
5591 gives the amount of memory in Kbyte that can be used before any
5592 compression is done. It should be a bit smaller than the amount of
5593 memory that is available to Vim.
5594
5595 When going over the {start} limit the {inc} number specifies the
5596 amount of memory in Kbyte that can be allocated before another
5597 compression is done. A low number means compression is done after
5598 less words are added, which is slow. A high number means more memory
5599 will be allocated.
5600
5601 After doing compression, {added} times 1024 words can be added before
5602 the {inc} limit is ignored and compression is done when any extra
5603 amount of memory is needed. A low number means there is a smaller
5604 chance of hitting the {inc} limit, less memory is used but it's
5605 slower.
5606
5607 The languages for which these numbers are important are Italian and
5608 Hungarian. The default works for when you have about 512 Mbyte. If
5609 you have 1 Gbyte you could use: >
5610 :set mkspellmem=900000,3000,800
5611< If you have less than 512 Mbyte |:mkspell| may fail for some
5612 languages, no matter what you set 'mkspellmem' to.
5613
dkearns8ebdbc92023-10-29 06:26:19 +11005614 This option cannot be set from a |modeline| or in the |sandbox|, for
5615 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005616
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005618'modeline' 'ml' boolean (Vim default: on (off for root),
5619 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005621 If 'modeline' is on 'modelines' gives the number of lines that is
5622 checked for set commands. If 'modeline' is off or 'modelines' is zero
5623 no lines are checked. See |modeline|.
5624
5625 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5626'modelineexpr' 'mle' boolean (default: off)
5627 global
5628 When on allow some options that are an expression to be set in the
5629 modeline. Check the option for whether it is affected by
5630 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005631 This option cannot be set from a |modeline| or in the |sandbox|, for
5632 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005633
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 *'modelines'* *'mls'*
5635'modelines' 'mls' number (default 5)
5636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 If 'modeline' is on 'modelines' gives the number of lines that is
5638 checked for set commands. If 'modeline' is off or 'modelines' is zero
5639 no lines are checked. See |modeline|.
5640 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5641 set and to the Vim default value when 'compatible' is reset.
5642
5643 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005644 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645'modifiable' 'ma' boolean (default on)
5646 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 When off the buffer contents cannot be changed. The 'fileformat' and
5648 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005649 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650
5651 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5652'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005653 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 When on, the buffer is considered to be modified. This option is set
5655 when:
5656 1. A change was made to the text since it was last written. Using the
5657 |undo| command to go back to the original text will reset the
5658 option. But undoing changes that were made before writing the
5659 buffer will set the option again, since the text is different from
5660 when it was written.
5661 2. 'fileformat' or 'fileencoding' is different from its original
5662 value. The original value is set when the buffer is read or
5663 written. A ":set nomodified" command also resets the original
5664 values to the current values and the 'modified' option will be
5665 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005666 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005667 This option is not set when a change is made to the buffer as the
5668 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5669 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5670 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5672 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005673 Note that the text may actually be the same, e.g. 'modified' is set
5674 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675
5676 *'more'* *'nomore'*
5677'more' boolean (Vim default: on, Vi default: off)
5678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 When on, listings pause when the whole screen is filled. You will get
5680 the |more-prompt|. When this option is off there are no pauses, the
5681 listing continues until finished.
5682 NOTE: This option is set to the Vi default value when 'compatible' is
5683 set and to the Vim default value when 'compatible' is reset.
5684
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005685 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005686'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005687 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005689 Enable the use of the mouse. Works for most terminals (xterm, Win32
5690 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5691 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5692 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005693 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 v Visual mode
5695 i Insert mode
5696 c Command-line mode
5697 h all previous modes when editing a help file
5698 a all previous modes
5699 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005700 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005702< If your terminal can't overrule the mouse events going to the
5703 application, use: >
5704 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005705< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005706 back to Vim using the mouse events.
5707 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5708 "xterm".
5709
5710 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 modeless selection. This doesn't move the text cursor.
5712
5713 See |mouse-using|. Also see |'clipboard'|.
5714
5715 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005716 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 the mouse buttons can still be used by keeping the shift key pressed.
5718 Also see the 'clipboard' option.
5719
5720 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5721'mousefocus' 'mousef' boolean (default off)
5722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 {only works in the GUI}
5724 The window that the mouse pointer is on is automatically activated.
5725 When changing the window layout or window focus in another way, the
5726 mouse pointer is moved to the window with keyboard focus. Off is the
5727 default because it makes using the pull down menus a little goofy, as
5728 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005729 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005730 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731
5732 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5733'mousehide' 'mh' boolean (default on)
5734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 {only works in the GUI}
5736 When on, the mouse pointer is hidden when characters are typed.
5737 The mouse pointer is restored when the mouse is moved.
5738
5739 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005740'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 Sets the model to use for the mouse. The name mostly specifies what
5743 the right mouse button is used for:
5744 extend Right mouse button extends a selection. This works
5745 like in an xterm.
5746 popup Right mouse button pops up a menu. The shifted left
5747 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005748 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 popup_setpos Like "popup", but the cursor will be moved to the
5750 position where the mouse was clicked, and thus the
5751 selected operation will act upon the clicked object.
5752 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005753 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 course, that right clicking outside a selection will
5755 end Visual mode.
5756 Overview of what button does what for each model:
5757 mouse extend popup(_setpos) ~
5758 left click place cursor place cursor
5759 left drag start selection start selection
5760 shift-left search word extend selection
5761 right click extend selection popup menu (place cursor)
5762 right drag extend selection -
5763 middle click paste paste
5764
5765 In the "popup" model the right mouse button produces a pop-up menu.
5766 You need to define this first, see |popup-menu|.
5767
5768 Note that you can further refine the meaning of buttons with mappings.
5769 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5770 selection (because that's handled in the GUI code directly).
5771
5772 The 'mousemodel' option is set by the |:behave| command.
5773
h_east59858792023-10-25 22:47:05 +09005774 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005775'mousemoveevent' 'mousemev' boolean (default off)
5776 global
5777 {only works in the GUI}
5778 When on, mouse move events are delivered to the input queue and are
5779 available for mapping. The default, off, avoids the mouse movement
5780 overhead except when needed. See |gui-mouse-mapping|.
5781 Warning: Setting this option can make pending mappings to be aborted
5782 when the mouse is moved.
5783 Currently only works in the GUI, may be made to work in a terminal
5784 later.
5785
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005787'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5788 vs:leftright,vd:lrsizing,m:no,
5789 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 {only available when compiled with the |+mouseshape|
5792 feature}
5793 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005794 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 like used for 'guicursor'. Each part consist of a mode/location-list
5796 and an argument-list:
5797 mode-list:shape,mode-list:shape,..
5798 The mode-list is a dash separated list of these modes/locations:
5799 In a normal window: ~
5800 n Normal mode
5801 v Visual mode
5802 ve Visual mode with 'selection' "exclusive" (same as 'v',
5803 if not specified)
5804 o Operator-pending mode
5805 i Insert mode
5806 r Replace mode
5807
5808 Others: ~
5809 c appending to the command-line
5810 ci inserting in the command-line
5811 cr replacing in the command-line
5812 m at the 'Hit ENTER' or 'More' prompts
5813 ml idem, but cursor in the last line
5814 e any mode, pointer below last window
5815 s any mode, pointer on a status line
5816 sd any mode, while dragging a status line
5817 vs any mode, pointer on a vertical separator line
5818 vd any mode, while dragging a vertical separator line
5819 a everywhere
5820
5821 The shape is one of the following:
5822 avail name looks like ~
5823 w x arrow Normal mouse pointer
5824 w x blank no pointer at all (use with care!)
5825 w x beam I-beam
5826 w x updown up-down sizing arrows
5827 w x leftright left-right sizing arrows
5828 w x busy The system's usual busy pointer
5829 w x no The system's usual 'no input' pointer
5830 x udsizing indicates up-down resizing
5831 x lrsizing indicates left-right resizing
5832 x crosshair like a big thin +
5833 x hand1 black hand
5834 x hand2 white hand
5835 x pencil what you write with
5836 x question big ?
5837 x rightup-arrow arrow pointing right-up
5838 w x up-arrow arrow pointing up
5839 x <number> any X11 pointer number (see X11/cursorfont.h)
5840
5841 The "avail" column contains a 'w' if the shape is available for Win32,
5842 x for X11.
5843 Any modes not specified or shapes not available use the normal mouse
5844 pointer.
5845
5846 Example: >
5847 :set mouseshape=s:udsizing,m:no
5848< will make the mouse turn to a sizing arrow over the status lines and
5849 indicate no input when the hit-enter prompt is displayed (since
5850 clicking the mouse has no effect in this state.)
5851
5852 *'mousetime'* *'mouset'*
5853'mousetime' 'mouset' number (default 500)
5854 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005855 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 time in msec between two mouse clicks for the second click to be
5857 recognized as a multi click.
5858
laburnumT3f7855a2023-12-05 18:37:03 +01005859 *'mzquantum'* *'mzq'*
5860'mzquantum' 'mzq' number (default 100)
5861 global
5862 {not available when compiled without the |+mzscheme|
5863 feature}
5864 The number of milliseconds between polls for MzScheme threads.
5865 Negative or zero value means no thread scheduling.
5866 NOTE: This option is set to the Vim default value when 'compatible'
5867 is reset.
5868
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005869 *'mzschemedll'*
5870'mzschemedll' string (default depends on the build)
5871 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005872 {only available when compiled with the |+mzscheme/dyn|
5873 feature}
5874 Specifies the name of the MzScheme shared library. The default is
5875 DYNAMIC_MZSCH_DLL which was specified at compile time.
5876 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005877 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005878 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005879 This option cannot be set from a |modeline| or in the |sandbox|, for
5880 security reasons.
5881
5882 *'mzschemegcdll'*
5883'mzschemegcdll' string (default depends on the build)
5884 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005885 {only available when compiled with the |+mzscheme/dyn|
5886 feature}
5887 Specifies the name of the MzScheme GC shared library. The default is
5888 DYNAMIC_MZGC_DLL which was specified at compile time.
5889 The value can be equal to 'mzschemedll' if it includes the GC code.
5890 Environment variables are expanded |:set_env|.
5891 This option cannot be set from a |modeline| or in the |sandbox|, for
5892 security reasons.
5893
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005895'nrformats' 'nf' string (default "bin,octal,hex",
5896 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 This defines what bases Vim will consider for numbers when using the
5899 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5900 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005901 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005903 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005904 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005906 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 considered to be hexadecimal. Example: Using CTRL-X on
5908 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005909 bin If included, numbers starting with "0b" or "0B" will be
5910 considered to be binary. Example: Using CTRL-X on
5911 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005912 unsigned If included, numbers are recognized as unsigned. Thus a
5913 leading dash or negative sign won't be considered as part of
5914 the number. Examples:
5915 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5916 (without "unsigned" it would become "9-2021").
5917 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5918 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005919 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5920 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005921 blank If included, treat numbers as signed or unsigned based on
5922 preceding whitespace. If a number with a leading dash has its
5923 dash immediately preceded by a non-whitespace character (i.e.,
5924 not a tab or a " "), the negative sign won't be considered as
5925 part of the number. For example:
5926 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5927 (without "blank" it would become "Carbon-13").
5928 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
5929 (because -8 is preceded by whitespace. If "unsigned" was
5930 set, it would result in "Carbon -7").
5931 If this format is included, overflow is prevented as if
5932 "unsigned" were set. If both this format and "unsigned" are
5933 included, "unsigned" will take precedence.
5934
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 Numbers which simply begin with a digit in the range 1-9 are always
5936 considered decimal. This also happens for numbers that are not
5937 recognized as octal or hex.
5938
5939 *'number'* *'nu'* *'nonumber'* *'nonu'*
5940'number' 'nu' boolean (default off)
5941 local to window
5942 Print the line number in front of each line. When the 'n' option is
5943 excluded from 'cpoptions' a wrapped line will not use the column of
5944 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005945 The 'numberwidth' option can be used to set the room used for the line
5946 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 When a long, wrapped line doesn't start with the first character, '-'
5948 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005949 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5950 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005951 *number_relativenumber*
5952 The 'relativenumber' option changes the displayed number to be
5953 relative to the cursor. Together with 'number' there are these
5954 four combinations (cursor in line 3):
5955
Bram Moolenaar3848e002016-03-19 18:42:29 +01005956 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005957 'nornu' 'nornu' 'rnu' 'rnu'
5958
5959 |apple | 1 apple | 2 apple | 2 apple
5960 |pear | 2 pear | 1 pear | 1 pear
5961 |nobody | 3 nobody | 0 nobody |3 nobody
5962 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005964 *'numberwidth'* *'nuw'*
5965'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5966 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005967 {only available when compiled with the |+linebreak|
5968 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005969 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005970 when the 'number' or 'relativenumber' option is set or printing lines
5971 with a line number. Since one space is always between the number and
5972 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005973 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005974 fit the highest line number in the buffer respectively the number of
5975 rows in the window, depending on whether 'number' or 'relativenumber'
5976 is set. Thus with the Vim default of 4 there is room for a line number
5977 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005978 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005979 NOTE: This option is set to the Vi default value when 'compatible' is
5980 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005981
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005982 *'omnifunc'* *'ofu'*
5983'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005984 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005985 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005986 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005987 This option specifies a function to be used for Insert mode omni
5988 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005989 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005990 invoked and what it should return. The value can be the name of a
5991 function, a |lambda| or a |Funcref|. See |option-value-function| for
5992 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005993 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005994 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005995 This option cannot be set from a |modeline| or in the |sandbox|, for
5996 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005997
Bram Moolenaar02467872007-05-06 13:22:01 +00005998 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005999'opendevice' 'odev' boolean (default off)
6000 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006001 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006002 Enable reading and writing from devices. This may get Vim stuck on a
6003 device that can be opened but doesn't actually do the I/O. Therefore
6004 it is off by default.
6005 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6006 result in editing a device.
6007
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006008 *'operatorfunc'* *'opfunc'*
6009'operatorfunc' 'opfunc' string (default: empty)
6010 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006011 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006012 See |:map-operator| for more info and an example. The value can be
6013 the name of a function, a |lambda| or a |Funcref|. See
6014 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006015
6016 This option cannot be set from a |modeline| or in the |sandbox|, for
6017 security reasons.
6018
Bram Moolenaar251e1912011-06-19 05:09:16 +02006019 *'osfiletype'* *'oft'*
6020'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006022 This option was supported on RISC OS, which has been removed.
6023
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006024 *'packpath'* *'pp'*
6025'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006026 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006027 This option cannot be set from a |modeline| or in the |sandbox|, for
6028 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006029
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006031'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 global
6033 Specifies the nroff macros that separate paragraphs. These are pairs
6034 of two letters (see |object-motions|).
6035
6036 *'paste'* *'nopaste'*
6037'paste' boolean (default off)
6038 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006039 Put Vim in Paste mode. This is useful if you want to cut or copy
6040 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 unexpected effects.
6042 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006043 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 knows about pasting and will mostly do the right thing without 'paste'
6045 being set. The same is true for a terminal where Vim handles the
6046 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006047 This option is reset when starting the GUI. Thus if you set it in
6048 your .vimrc it will work in a terminal, but not in the GUI. Setting
6049 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6050 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 When the 'paste' option is switched on (also when it was already on):
6052 - mapping in Insert mode and Command-line mode is disabled
6053 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006055 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006056 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 - 'revins' is reset
6058 - 'ruler' is reset
6059 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006060 - 'smarttab' is reset
6061 - 'softtabstop' is set to 0
6062 - 'textwidth' is set to 0
6063 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006064 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006067 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006068 - 'indentexpr'
6069 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006070 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 NOTE: When you start editing another file while the 'paste' option is
6072 on, settings from the modelines or autocommands may change the
6073 settings again, causing trouble when pasting text. You might want to
6074 set the 'paste' option again.
6075 When the 'paste' option is reset the mentioned options are restored to
6076 the value before the moment 'paste' was switched from off to on.
6077 Resetting 'paste' before ever setting it does not have any effect.
6078 Since mapping doesn't work while 'paste' is active, you need to use
6079 the 'pastetoggle' option to toggle the 'paste' option with some key.
6080
6081 *'pastetoggle'* *'pt'*
6082'pastetoggle' 'pt' string (default "")
6083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 When non-empty, specifies the key sequence that toggles the 'paste'
6085 option. This is like specifying a mapping: >
6086 :map {keys} :set invpaste<CR>
6087< Where {keys} is the value of 'pastetoggle'.
6088 The difference is that it will work even when 'paste' is set.
6089 'pastetoggle' works in Insert mode and Normal mode, but not in
6090 Command-line mode.
6091 Mappings are checked first, thus overrule 'pastetoggle'. However,
6092 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6093 this: >
6094 :map <F10> :set paste<CR>
6095 :map <F11> :set nopaste<CR>
6096 :imap <F10> <C-O>:set paste<CR>
6097 :imap <F11> <nop>
6098 :set pastetoggle=<F11>
6099< This will make <F10> start paste mode and <F11> stop paste mode.
6100 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6101 mode everything is inserted literally, except the 'pastetoggle' key
6102 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006103 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
6105 *'pex'* *'patchexpr'*
6106'patchexpr' 'pex' string (default "")
6107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 {not available when compiled without the |+diff|
6109 feature}
6110 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006111 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006112 This option cannot be set from a |modeline| or in the |sandbox|, for
6113 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114
Bram Moolenaardbc28022014-07-26 13:40:44 +02006115 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116'patchmode' 'pm' string (default "")
6117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 When non-empty the oldest version of a file is kept. This can be used
6119 to keep the original version of a file if you are changing files in a
6120 source distribution. Only the first time that a file is written a
6121 copy of the original file will be kept. The name of the copy is the
6122 name of the original file with the string in the 'patchmode' option
6123 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006124 ".orig" or ".org". 'backupdir' must not be empty for this to work
6125 (Detail: The backup file is renamed to the patchmode file after the
6126 new file has been successfully written, that's why it must be possible
6127 to write a backup file). If there was no file to be backed up, an
6128 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 When the 'backupskip' pattern matches, a patchmode file is not made.
6130 Using 'patchmode' for compressed files appends the extension at the
6131 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6132 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006133 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006135 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 other systems: ".,,")
6138 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006140 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6141 provided that the file being searched for has a relative path (not
6142 starting with "/", "./" or "../"). The directories in the 'path'
6143 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 - Use commas to separate directory names: >
6145 :set path=.,/usr/local/include,/usr/include
6146< - Spaces can also be used to separate directory names (for backwards
6147 compatibility with version 3.0). To have a space in a directory
6148 name, precede it with an extra backslash, and escape the space: >
6149 :set path=.,/dir/with\\\ space
6150< - To include a comma in a directory name precede it with an extra
6151 backslash: >
6152 :set path=.,/dir/with\\,comma
6153< - To search relative to the directory of the current file, use: >
6154 :set path=.
6155< - To search in the current directory use an empty string between two
6156 commas: >
6157 :set path=,,
6158< - A directory name may end in a ':' or '/'.
6159 - Environment variables are expanded |:set_env|.
6160 - When using |netrw.vim| URLs can be used. For example, adding
6161 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006162 - Search upwards and downwards in a directory tree using "*", "**" and
6163 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 - Careful with '\' characters, type two to get one in the option: >
6165 :set path=.,c:\\include
6166< Or just use '/' instead: >
6167 :set path=.,c:/include
6168< Don't forget "." or files won't even be found in the same directory as
6169 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006170 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 it is something like 256 or 1024 characters.
6172 You can check if all the include files are found, using the value of
6173 'path', see |:checkpath|.
6174 The use of |:set+=| and |:set-=| is preferred when adding or removing
6175 directories from the list. This avoids problems when a future version
6176 uses another default. To remove the current directory use: >
6177 :set path-=
6178< To add the current directory use: >
6179 :set path+=
6180< To use an environment variable, you probably need to replace the
6181 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006182 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006183 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184< Replace the ';' with a ':' or whatever separator is used. Note that
6185 this doesn't work when $INCL contains a comma or white space.
6186
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006187 *'perldll'*
6188'perldll' string (default depends on the build)
6189 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006190 {only available when compiled with the |+perl/dyn|
6191 feature}
6192 Specifies the name of the Perl shared library. The default is
6193 DYNAMIC_PERL_DLL, which was specified at compile time.
6194 Environment variables are expanded |:set_env|.
6195 This option cannot be set from a |modeline| or in the |sandbox|, for
6196 security reasons.
6197
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6199'preserveindent' 'pi' boolean (default off)
6200 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 When changing the indent of the current line, preserve as much of the
6202 indent structure as possible. Normally the indent is replaced by a
6203 series of tabs followed by spaces as required (unless |'expandtab'| is
6204 enabled, in which case only spaces are used). Enabling this option
6205 means the indent will preserve as many existing characters as possible
6206 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006207 'expandtab' does not apply to the preserved white space, a Tab remains
6208 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 NOTE: When using ">>" multiple times the resulting indent is a mix of
6210 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006211 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 Also see 'copyindent'.
6213 Use |:retab| to clean up white space.
6214
6215 *'previewheight'* *'pvh'*
6216'previewheight' 'pvh' number (default 12)
6217 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006218 {not available when compiled without the |+quickfix|
6219 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006221 commands. Used for |CTRL-W_}| when no count is given. Not used when
6222 'previewpopup' is set.
6223
6224 *'previewpopup'* *'pvp'*
6225'previewpopup' 'pvp' string (default empty)
6226 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006227 {not available when compiled without the |+textprop|
6228 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006229 When not empty a popup window is used for commands that would open a
6230 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006231 Not used for the insert completion info, add "popup" to
6232 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233
6234 *'previewwindow'* *'nopreviewwindow'*
6235 *'pvw'* *'nopvw'* *E590*
6236'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006237 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006238 {not available when compiled without the |+quickfix|
6239 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006240 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 set. It's normally not set directly, but by using one of the commands
6242 |:ptag|, |:pedit|, etc.
6243
6244 *'printdevice'* *'pdev'*
6245'printdevice' 'pdev' string (default empty)
6246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 {only available when compiled with the |+printer|
6248 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006249 The name of the printer to be used for |:hardcopy|.
6250 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006251 This option cannot be set from a |modeline| or in the |sandbox|, for
6252 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253
Bram Moolenaar8299df92004-07-10 09:47:34 +00006254 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006255'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 {only available when compiled with the |+printer|
6258 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006259 Sets the character encoding used when printing.
6260 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261
6262 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006263'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 {only available when compiled with the |+printer|
6266 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006267 Expression used to print the PostScript produced with |:hardcopy|.
6268 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006269 This option cannot be set from a |modeline| or in the |sandbox|, for
6270 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271
Bram Moolenaar8299df92004-07-10 09:47:34 +00006272 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273'printfont' 'pfn' string (default "courier")
6274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 {only available when compiled with the |+printer|
6276 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006277 The name of the font that will be used for |:hardcopy|.
6278 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279
6280 *'printheader'* *'pheader'*
6281'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 {only available when compiled with the |+printer|
6284 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006285 The format of the header produced in |:hardcopy| output.
6286 See |pheader-option|.
6287
6288 *'printmbcharset'* *'pmbcs'*
6289'printmbcharset' 'pmbcs' string (default "")
6290 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006291 {only available when compiled with the |+printer|
6292 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006293 The CJK character set to be used for CJK output from |:hardcopy|.
6294 See |pmbcs-option|.
6295
6296 *'printmbfont'* *'pmbfn'*
6297'printmbfont' 'pmbfn' string (default "")
6298 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006299 {only available when compiled with the |+printer|
6300 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006301 List of font names to be used for CJK output from |:hardcopy|.
6302 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303
6304 *'printoptions'* *'popt'*
6305'printoptions' 'popt' string (default "")
6306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006308 List of items that control the format of the output of |:hardcopy|.
6309 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006311 *'prompt'* *'noprompt'*
6312'prompt' boolean (default on)
6313 global
6314 When on a ":" prompt is used in Ex mode.
6315
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006316 *'pumheight'* *'ph'*
6317'pumheight' 'ph' number (default 0)
6318 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006319 Determines the maximum number of items to show in the popup menu for
6320 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006321 |ins-completion-menu|.
6322
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006323 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006324'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006325 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006326 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006327 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006328
Bram Moolenaard94464e2015-11-02 15:28:18 +01006329 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006330'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006331 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006332 {only available when compiled with the |+python/dyn|
6333 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006334 Specifies the name of the Python 2.x shared library. The default is
6335 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006336 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006337 This option cannot be set from a |modeline| or in the |sandbox|, for
6338 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006339
Bram Moolenaar94073162018-01-31 21:49:05 +01006340 *'pythonhome'*
6341'pythonhome' string (default "")
6342 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006343 {only available when compiled with the |+python/dyn|
6344 feature}
6345 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6346 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6347 which was specified at compile time, will be used for the Python 2.x
6348 home directory.
6349 Environment variables are expanded |:set_env|.
6350 This option cannot be set from a |modeline| or in the |sandbox|, for
6351 security reasons.
6352
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006353 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006354'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006355 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006356 {only available when compiled with the |+python3/dyn|
6357 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006358 Specifies the name of the Python 3 shared library. The default is
6359 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006360 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006361 This option cannot be set from a |modeline| or in the |sandbox|, for
6362 security reasons.
6363
Bram Moolenaar94073162018-01-31 21:49:05 +01006364 *'pythonthreehome'*
6365'pythonthreehome' string (default "")
6366 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006367 {only available when compiled with the |+python3/dyn|
6368 feature}
6369 Specifies the name of the Python 3 home directory. When
6370 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6371 PYTHON3_HOME, which was specified at compile time, will be used for
6372 the Python 3 home directory.
6373 Environment variables are expanded |:set_env|.
6374 This option cannot be set from a |modeline| or in the |sandbox|, for
6375 security reasons.
6376
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006377 *'pyxversion'* *'pyx'*
6378'pyxversion' 'pyx' number (default depends on the build)
6379 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006380 {only available when compiled with the |+python| or
6381 the |+python3| feature}
6382 Specifies the python version used for pyx* functions and commands
6383 |python_x|. The default value is as follows:
6384
6385 Compiled with Default ~
6386 |+python| and |+python3| 0
6387 only |+python| 2
6388 only |+python3| 3
6389
6390 Available values are 0, 2 and 3.
6391 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6392 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6393 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6394 to 2 if Python 2 is available.
6395 See also: |has-pythonx|
6396
6397 If Vim is compiled with only |+python| or |+python3| setting
6398 'pyxversion' has no effect. The pyx* functions and commands are
6399 always the same as the compiled version.
6400
6401 This option cannot be set from a |modeline| or in the |sandbox|, for
6402 security reasons.
6403
Bram Moolenaar858ba062020-05-31 23:11:59 +02006404 *'quickfixtextfunc'* *'qftf'*
6405'quickfixtextfunc' 'qftf' string (default "")
6406 global
6407 {only available when compiled with the |+quickfix|
6408 feature}
6409 This option specifies a function to be used to get the text to display
6410 in the quickfix and location list windows. This can be used to
6411 customize the information displayed in the quickfix or location window
6412 for each entry in the corresponding quickfix or location list. See
6413 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006414 function and an example. The value can be the name of a function, a
6415 |lambda| or a |Funcref|. See |option-value-function| for more
6416 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006417
6418 This option cannot be set from a |modeline| or in the |sandbox|, for
6419 security reasons.
6420
Bram Moolenaar677ee682005-01-27 14:41:15 +00006421 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006422'quoteescape' 'qe' string (default "\")
6423 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006424 The characters that are used to escape quotes in a string. Used for
6425 objects like a', a" and a` |a'|.
6426 When one of the characters in this option is found inside a string,
6427 the following character will be skipped. The default value makes the
6428 text "foo\"bar\\" considered to be one string.
6429
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6431'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006432 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 If on, writes fail unless you use a '!'. Protects you from
6434 accidentally overwriting a file. Default on when Vim is started
6435 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006436 When using ":w!" the 'readonly' option is reset for the current
6437 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006438 When using the ":view" command the 'readonly' option is set for the
6439 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006440 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006442 *'redrawtime'* *'rdt'*
6443'redrawtime' 'rdt' number (default 2000)
6444 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006445 {only available when compiled with the |+reltime|
6446 feature}
6447 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006448 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006449 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006450 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006451 matches will be highlighted.
6452 For syntax highlighting the time applies per window. When over the
6453 limit syntax highlighting is disabled until |CTRL-L| is used.
6454 This is used to avoid that Vim hangs when using a very complicated
6455 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006456
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006457 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006458'regexpengine' 're' number (default 0)
6459 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006460 This selects the default regexp engine. |two-engines|
6461 The possible values are:
6462 0 automatic selection
6463 1 old engine
6464 2 NFA engine
6465 Note that when using the NFA engine and the pattern contains something
6466 that is not supported the pattern will not match. This is only useful
6467 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006468 Using automatic selection enables Vim to switch the engine, if the
6469 default engine becomes too costly. E.g., when the NFA engine uses too
6470 many states. This should prevent Vim from hanging on a combination of
6471 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006472
Bram Moolenaar64486672010-05-16 15:46:46 +02006473 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6474'relativenumber' 'rnu' boolean (default off)
6475 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006476 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006477 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006478 precede some vertical motion commands (e.g. j k + -) with, without
6479 having to calculate it yourself. Especially useful in combination with
6480 other commands (e.g. y d c < > gq gw =).
6481 When the 'n' option is excluded from 'cpoptions' a wrapped
6482 line will not use the column of line numbers (this is the default when
6483 'compatible' isn't set).
6484 The 'numberwidth' option can be used to set the room used for the line
6485 number.
6486 When a long, wrapped line doesn't start with the first character, '-'
6487 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006488 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6489 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006490
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006491 The number in front of the cursor line also depends on the value of
6492 'number', see |number_relativenumber| for all combinations of the two
6493 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006494
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 *'remap'* *'noremap'*
6496'remap' boolean (default on)
6497 global
6498 Allows for mappings to work recursively. If you do not want this for
6499 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006500 NOTE: To avoid portability problems with Vim scripts, always keep
6501 this option at the default "on". Only switch it off when working with
6502 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503
zeertzjqd086b8f2024-02-25 15:42:52 +08006504 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006505'renderoptions' 'rop' string (default: empty)
6506 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006507 {only available when compiled with GUI and DIRECTX on
6508 MS-Windows}
6509 Select a text renderer and set its options. The options depend on the
6510 renderer.
6511
6512 Syntax: >
6513 set rop=type:{renderer}(,{name}:{value})*
6514<
6515 Currently, only one optional renderer is available.
6516
6517 render behavior ~
6518 directx Vim will draw text using DirectX (DirectWrite). It makes
6519 drawn glyphs more beautiful than default GDI.
6520 It requires 'encoding' is "utf-8", and only works on
6521 MS-Windows Vista or newer version.
6522
6523 Options:
6524 name meaning type value ~
6525 gamma gamma float 1.0 - 2.2 (maybe)
6526 contrast enhancedContrast float (unknown)
6527 level clearTypeLevel float (unknown)
6528 geom pixelGeometry int 0 - 2 (see below)
6529 renmode renderingMode int 0 - 6 (see below)
6530 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006531 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006532
Bram Moolenaar92467d32017-12-05 13:22:16 +01006533 See this URL for detail (except for scrlines):
6534 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006535
6536 For geom: structure of a device pixel.
6537 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6538 1 - DWRITE_PIXEL_GEOMETRY_RGB
6539 2 - DWRITE_PIXEL_GEOMETRY_BGR
6540
6541 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006542 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006543
6544 For renmode: method of rendering glyphs.
6545 0 - DWRITE_RENDERING_MODE_DEFAULT
6546 1 - DWRITE_RENDERING_MODE_ALIASED
6547 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6548 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6549 4 - DWRITE_RENDERING_MODE_NATURAL
6550 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6551 6 - DWRITE_RENDERING_MODE_OUTLINE
6552
6553 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006554 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006555
6556 For taamode: antialiasing mode used for drawing text.
6557 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6558 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6559 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6560 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6561
6562 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006563 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6564
Bram Moolenaara338adc2018-01-31 20:51:47 +01006565 For scrlines:
6566 This was used for optimizing scrolling behavior, however this
6567 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006568
6569 Example: >
6570 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006571 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006572 set rop=type:directx
6573<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006574 If select a raster font (Courier, Terminal or FixedSys which
6575 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006576 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006577
6578 NOTE: It is known that some fonts and options combination
6579 causes trouble on drawing glyphs.
6580
Bram Moolenaar92467d32017-12-05 13:22:16 +01006581 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006582 special made fonts (True-Type fonts which includes only
6583 bitmap glyphs).
6584 - 'taamode:3' will not work with some vector fonts.
6585
6586 NOTE: With this option, you can display colored emoji
6587 (emoticon) in Windows 8.1 or later. To display colored emoji,
6588 there are some conditions which you should notice.
6589
6590 - If your font includes non-colored emoji already, it will
6591 be used.
6592 - If your font doesn't have emoji, the system chooses an
6593 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6594 will be used.
6595 - When this alternative font didn't have fixed width glyph,
6596 emoji might be rendered beyond the bounding box of drawing
6597 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006598
6599 Other render types are currently not supported.
6600
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 *'report'*
6602'report' number (default 2)
6603 global
6604 Threshold for reporting number of lines changed. When the number of
6605 changed lines is more than 'report' a message will be given for most
6606 ":" commands. If you want it always, set 'report' to 0.
6607 For the ":substitute" command the number of substitutions is used
6608 instead of the number of lines.
6609
6610 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6611'restorescreen' 'rs' boolean (default on)
6612 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006613 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 When set, the screen contents is restored when exiting Vim. This also
6615 happens when executing external commands.
6616
6617 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6618 options in your .vimrc. To disable restoring:
6619 set t_ti= t_te=
6620 To enable restoring (for an xterm):
6621 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6622 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6623
6624 *'revins'* *'ri'* *'norevins'* *'nori'*
6625'revins' 'ri' boolean (default off)
6626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 {only available when compiled with the |+rightleft|
6628 feature}
6629 Inserting characters in Insert mode will work backwards. See "typing
6630 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6631 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006632 NOTE: This option is reset when 'compatible' is set.
6633 This option is reset when 'paste' is set and restored when 'paste' is
6634 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635
6636 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6637'rightleft' 'rl' boolean (default off)
6638 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 {only available when compiled with the |+rightleft|
6640 feature}
6641 When on, display orientation becomes right-to-left, i.e., characters
6642 that are stored in the file appear from the right to the left.
6643 Using this option, it is possible to edit files for languages that
6644 are written from the right to the left such as Hebrew and Arabic.
6645 This option is per window, so it is possible to edit mixed files
6646 simultaneously, or to view the same file in both ways (this is
6647 useful whenever you have a mixed text file with both right-to-left
6648 and left-to-right strings so that both sets are displayed properly
6649 in different windows). Also see |rileft.txt|.
6650
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006651 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652'rightleftcmd' 'rlc' string (default "search")
6653 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 {only available when compiled with the |+rightleft|
6655 feature}
6656 Each word in this option enables the command line editing to work in
6657 right-to-left mode for a group of commands:
6658
6659 search "/" and "?" commands
6660
6661 This is useful for languages such as Hebrew, Arabic and Farsi.
6662 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6663
Bram Moolenaard94464e2015-11-02 15:28:18 +01006664 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006665'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006666 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006667 {only available when compiled with the |+ruby/dyn|
6668 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006669 Specifies the name of the Ruby shared library. The default is
6670 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006671 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006672 This option cannot be set from a |modeline| or in the |sandbox|, for
6673 security reasons.
6674
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006676'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 text in the file is shown on the far right:
6681 Top first line is visible
6682 Bot last line is visible
6683 All first and last line are visible
6684 45% relative position in the file
6685 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006686 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006687 ruler is shown there. Otherwise it is shown in the last line of the
6688 screen. If the statusline is given by 'statusline' (i.e. not empty),
6689 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006691 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 the text column (byte number) and the screen column are shown,
6693 separated with a dash.
6694 For an empty line "0-1" is shown.
6695 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006696 This option is reset when 'paste' is set and restored when 'paste' is
6697 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 If you don't want to see the ruler all the time but want to know where
6699 you are, use "g CTRL-G" |g_CTRL-G|.
6700 NOTE: This option is reset when 'compatible' is set.
6701
6702 *'rulerformat'* *'ruf'*
6703'rulerformat' 'ruf' string (default empty)
6704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 {not available when compiled without the |+statusline|
6706 feature}
6707 When this option is not empty, it determines the content of the ruler
6708 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006709 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006710 This option cannot be set in a modeline when 'modelineexpr' is off.
6711
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 The default ruler width is 17 characters. To make the ruler 15
6713 characters wide, put "%15(" at the start and "%)" at the end.
6714 Example: >
6715 :set rulerformat=%15(%c%V\ %p%%%)
6716<
6717 *'runtimepath'* *'rtp'* *vimfiles*
6718'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006719 Unix: "$HOME/.vim or
6720 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 $VIM/vimfiles,
6722 $VIMRUNTIME,
6723 $VIM/vimfiles/after,
6724 $HOME/.vim/after"
6725 Amiga: "home:vimfiles,
6726 $VIM/vimfiles,
6727 $VIMRUNTIME,
6728 $VIM/vimfiles/after,
6729 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006730 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 $VIM/vimfiles,
6732 $VIMRUNTIME,
6733 $VIM/vimfiles/after,
6734 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006735 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 $VIMRUNTIME,
6737 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006738 Haiku: "$BE_USER_SETTINGS/vim,
6739 $VIM/vimfiles,
6740 $VIMRUNTIME,
6741 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006742 $BE_USER_SETTINGS/vim/after"
6743 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 $VIM/vimfiles,
6745 $VIMRUNTIME,
6746 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006747 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 This is a list of directories which will be searched for runtime
6750 files:
6751 filetype.vim filetypes by file name |new-filetype|
6752 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006753 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 colors/ color scheme files |:colorscheme|
6755 compiler/ compiler files |:compiler|
6756 doc/ documentation |write-local-help|
6757 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006758 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 indent/ indent scripts |indent-expression|
6760 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006761 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006763 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 plugin/ plugin scripts |write-plugin|
6765 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006766 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 syntax/ syntax files |mysyntaxfile|
6768 tutor/ files for vimtutor |tutor|
6769
6770 And any other file searched for with the |:runtime| command.
6771
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006772 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6773
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 The defaults for most systems are setup to search five locations:
6775 1. In your home directory, for your personal preferences.
6776 2. In a system-wide Vim directory, for preferences from the system
6777 administrator.
6778 3. In $VIMRUNTIME, for files distributed with Vim.
6779 *after-directory*
6780 4. In the "after" directory in the system-wide Vim directory. This is
6781 for the system administrator to overrule or add to the distributed
6782 defaults (rarely needed)
6783 5. In the "after" directory in your home directory. This is for
6784 personal preferences to overrule or add to the distributed defaults
6785 or system-wide settings (rarely needed).
6786
Bram Moolenaard0796902016-09-16 20:02:31 +02006787 More entries are added when using |packages|. If it gets very long
6788 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6789 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006790
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6792 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 wildcards.
6795 See |:runtime|.
6796 Example: >
6797 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6798< This will use the directory "~/vimruntime" first (containing your
6799 personal Vim runtime files), then "/mygroup/vim" (shared between a
6800 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6801 files).
6802 You probably should always include $VIMRUNTIME somewhere, to use the
6803 distributed runtime files. You can put a directory before $VIMRUNTIME
6804 to find files which replace a distributed runtime files. You can put
6805 a directory after $VIMRUNTIME to find files which add to distributed
6806 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006807 When Vim is started with |--clean| the home directory entries are not
6808 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 This option cannot be set from a |modeline| or in the |sandbox|, for
6810 security reasons.
6811
6812 *'scroll'* *'scr'*
6813'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006814 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6816 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006817 changes. This may happen when enabling the |status-line| or
6818 'tabline' option after setting the 'scroll' option.
6819 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006820 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006821 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822
6823 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6824'scrollbind' 'scb' boolean (default off)
6825 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006826 See also |scroll-binding|. When this option is set, scrolling the
6827 current window also scrolls other scrollbind windows (windows that
6828 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 differences between two versions of a file, see 'diff'.
6830 See |'scrollopt'| for options that determine how this option should be
6831 interpreted.
6832 This option is mostly reset when splitting a window to edit another
6833 file. This means that ":split | edit file" results in two windows
6834 with scroll-binding, but ":split file" does not.
6835
Bram Moolenaarae20f342019-11-05 21:09:23 +01006836 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6837'scrollfocus' 'scf' boolean (default off)
6838 global
6839 {only for MS-Windows GUI}
6840 When using the scroll wheel and this option is set, the window under
6841 the mouse pointer is scrolled. With this option off the current
6842 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006843 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006844
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 *'scrolljump'* *'sj'*
6846'scrolljump' 'sj' number (default 1)
6847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 Minimal number of lines to scroll when the cursor gets off the
6849 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6850 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006851 When set to a negative number from -1 to -100 this is used as the
6852 percentage of the window height. Thus -50 scrolls half the window
6853 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 NOTE: This option is set to 1 when 'compatible' is set.
6855
6856 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006857'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006858 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 Minimal number of screen lines to keep above and below the cursor.
6860 This will make some context visible around where you are working. If
6861 you set it to a very large value (999) the cursor line will always be
6862 in the middle of the window (except at the start or end of the file or
6863 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006864 After using the local value, go back the global value with one of
6865 these two: >
6866 setlocal scrolloff<
6867 setlocal scrolloff=-1
6868< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 NOTE: This option is set to 0 when 'compatible' is set.
6870
6871 *'scrollopt'* *'sbo'*
6872'scrollopt' 'sbo' string (default "ver,jump")
6873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006875 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6876 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 The following words are available:
6878 ver Bind vertical scrolling for 'scrollbind' windows
6879 hor Bind horizontal scrolling for 'scrollbind' windows
6880 jump Applies to the offset between two windows for vertical
6881 scrolling. This offset is the difference in the first
6882 displayed line of the bound windows. When moving
6883 around in a window, another 'scrollbind' window may
6884 reach a position before the start or after the end of
6885 the buffer. The offset is not changed though, when
6886 moving back the 'scrollbind' window will try to scroll
6887 to the desired position when possible.
6888 When now making that window the current one, two
6889 things can be done with the relative offset:
6890 1. When "jump" is not included, the relative offset is
6891 adjusted for the scroll position in the new current
6892 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006893 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 2. When "jump" is included, the other windows are
6895 scrolled to keep the same relative offset. When
6896 going back to the other window, it still uses the
6897 same relative offset.
6898 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006899 When 'diff' mode is active there always is vertical scroll binding,
6900 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901
6902 *'sections'* *'sect'*
6903'sections' 'sect' string (default "SHNHH HUnhsh")
6904 global
6905 Specifies the nroff macros that separate sections. These are pairs of
6906 two letters (See |object-motions|). The default makes a section start
6907 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6908
6909 *'secure'* *'nosecure'* *E523*
6910'secure' boolean (default off)
6911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 When on, ":autocmd", shell and write commands are not allowed in
6913 ".vimrc" and ".exrc" in the current directory and map commands are
6914 displayed. Switch it off only if you know that you will not run into
6915 problems, or when the 'exrc' option is off. On Unix this option is
6916 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006917 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 'secure' at the end of your ~/.vimrc then.
6919 This option cannot be set from a |modeline| or in the |sandbox|, for
6920 security reasons.
6921
6922 *'selection'* *'sel'*
6923'selection' 'sel' string (default "inclusive")
6924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 This option defines the behavior of the selection. It is only used
6926 in Visual and Select mode.
6927 Possible values:
6928 value past line inclusive ~
6929 old no yes
6930 inclusive yes yes
6931 exclusive yes no
6932 "past line" means that the cursor is allowed to be positioned one
6933 character past the line.
6934 "inclusive" means that the last character of the selection is included
6935 in an operation. For example, when "x" is used to delete the
6936 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006937 When "old" is used and 'virtualedit' allows the cursor to move past
6938 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 Note that when "exclusive" is used and selecting from the end
6940 backwards, you cannot include the last character of a line, when
6941 starting in Normal mode and 'virtualedit' empty.
6942
6943 The 'selection' option is set by the |:behave| command.
6944
6945 *'selectmode'* *'slm'*
6946'selectmode' 'slm' string (default "")
6947 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006948 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 Select mode instead of Visual mode, when a selection is started.
6950 Possible values:
6951 mouse when using the mouse
6952 key when using shifted special keys
6953 cmd when using "v", "V" or CTRL-V
6954 See |Select-mode|.
6955 The 'selectmode' option is set by the |:behave| command.
6956
6957 *'sessionoptions'* *'ssop'*
6958'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006959 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006961 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 feature}
6963 Changes the effect of the |:mksession| command. It is a comma
6964 separated list of words. Each word enables saving and restoring
6965 something:
6966 word save and restore ~
6967 blank empty windows
6968 buffers hidden and unloaded buffers, not just those in windows
6969 curdir the current directory
6970 folds manually created folds, opened/closed folds and local
6971 fold options
6972 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006973 and contain at least one lowercase letter. Only
6974 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 help the help window
6976 localoptions options and mappings local to a window or buffer (not
6977 global values for local options)
6978 options all options and mappings (also global values for local
6979 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006980 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 resize size of the Vim window: 'lines' and 'columns'
6982 sesdir the directory in which the session file is located
6983 will become the current directory (useful with
6984 projects accessed over a network from different
6985 systems)
6986 slash backslashes in file names replaced with forward
6987 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006988 tabpages all tab pages; without this only the current tab page
6989 is restored, so that you can make a session for each
6990 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006991 terminal include terminal windows where the command can be
6992 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 unix with Unix end-of-line format (single <NL>), even when
6994 on Windows or DOS
6995 winpos position of the whole Vim window
6996 winsize window sizes
6997
6998 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006999 When neither "curdir" nor "sesdir" is included, file names are stored
7000 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007001 If you leave out "options" many things won't work well after restoring
7002 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 "slash" and "unix" are useful on Windows when sharing session files
7004 with Unix. The Unix version of Vim cannot source dos format scripts,
7005 but the Windows version of Vim can source unix format scripts.
7006
7007 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007008'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 global
7010 Name of the shell to use for ! and :! commands. When changing the
7011 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7012 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007013 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 See |option-backslash| about including spaces and backslashes.
7015 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007016
Bram Moolenaara2baa732022-02-04 16:09:54 +00007017 In |restricted-mode| shell commands will not be possible. This mode
7018 is used if the value of $SHELL ends in "false" or "nologin".
7019
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007020 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007021 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7023< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007024 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007026 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007028 Example with escaped space (Vim will do this when initializing the
7029 option from $SHELL): >
7030 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007031< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007032 backslashes are consumed by `:set`.
7033
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 Under MS-Windows, when the executable ends in ".com" it must be
7035 included. Thus setting the shell to "command.com" or "4dos.com"
7036 works, but "command" and "4dos" do not work for all commands (e.g.,
7037 filtering).
7038 For unknown reasons, when using "4dos.com" the current directory is
7039 changed to "C:\". To avoid this set 'shell' like this: >
7040 :set shell=command.com\ /c\ 4dos
7041< This option cannot be set from a |modeline| or in the |sandbox|, for
7042 security reasons.
7043
7044 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007045'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007046 Win32, when 'shell' contains "powershell":
7047 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007048 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007051 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7052 For MS-Windows, the default is set according to the value of 'shell',
7053 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007054 On Unix it can have more than one flag. Each white space separated
7055 part is passed as an argument to the shell command.
7056 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007057 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 This option cannot be set from a |modeline| or in the |sandbox|, for
7059 security reasons.
7060
7061 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007062'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7063 "2>&1| tee", or
7064 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 {not available when compiled without the |+quickfix|
7067 feature}
7068 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007069 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 including spaces and backslashes.
7071 The name of the temporary file can be represented by "%s" if necessary
7072 (the file name is appended automatically if no %s appears in the value
7073 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007074 For the Amiga the default is ">". For MS-Windows using powershell the
7075 default is "2>&1 | Out-File -Encoding default", otherwise the default
7076 is ">%s 2>&1". The output is directly saved in a file and not echoed
7077 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007078 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 in a file and echoed to the screen. If the 'shell' option is "csh" or
7080 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007081 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007082 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7083 means that stderr is also included. Before using the 'shell' option a
7084 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007085 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7086 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 The initialization of this option is done after reading the ".vimrc"
7088 and the other initializations, so that when the 'shell' option is set
7089 there, the 'shellpipe' option changes automatically, unless it was
7090 explicitly set before.
7091 When 'shellpipe' is set to an empty string, no redirection of the
7092 ":make" output will be done. This is useful if you use a 'makeprg'
7093 that writes to 'makeef' by itself. If you want no piping, but do
7094 want to include the 'makeef', set 'shellpipe' to a single space.
7095 Don't forget to precede the space with a backslash: ":set sp=\ ".
7096 In the future pipes may be used for filtering and this option will
7097 become obsolete (at least for Unix).
7098 This option cannot be set from a |modeline| or in the |sandbox|, for
7099 security reasons.
7100
7101 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007102'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 Quoting character(s), put around the command passed to the shell, for
7105 the "!" and ":!" commands. The redirection is kept outside of the
7106 quoting. See 'shellxquote' to include the redirection. It's
7107 probably not useful to set both options.
7108 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007109 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007110 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 This option cannot be set from a |modeline| or in the |sandbox|, for
7112 security reasons.
7113
7114 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007115'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7116 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 String to be used to put the output of a filter command in a temporary
7119 file. See also |:!|. See |option-backslash| about including spaces
7120 and backslashes.
7121 The name of the temporary file can be represented by "%s" if necessary
7122 (the file name is appended automatically if no %s appears in the value
7123 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007124 The default is ">". For Unix, if the 'shell' option is "csh" or
7125 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007126 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007127 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7128 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007129 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7130 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007131 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7132 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 The initialization of this option is done after reading the ".vimrc"
7134 and the other initializations, so that when the 'shell' option is set
7135 there, the 'shellredir' option changes automatically unless it was
7136 explicitly set before.
7137 In the future pipes may be used for filtering and this option will
7138 become obsolete (at least for Unix).
7139 This option cannot be set from a |modeline| or in the |sandbox|, for
7140 security reasons.
7141
7142 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7143'shellslash' 'ssl' boolean (default off)
7144 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007145 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007147 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007148 powershell.exe. Backward slashes can still be typed, but they are
7149 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 Note that setting or resetting this option has no effect for some
7151 existing file names, thus this option needs to be set before opening
7152 any file for best results. This might change in the future.
7153 'shellslash' only works when a backslash can be used as a path
7154 separator. To test if this is so use: >
7155 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007156< Also see 'completeslash'.
7157
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007158 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7159'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7160 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007161 When on, use temp files for shell commands. When off use a pipe.
7162 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007163 Currently a pipe is only supported on Unix and MS-Windows 2K and
7164 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007165 :if has("filterpipe")
7166< The advantage of using a pipe is that nobody can read the temp file
7167 and the 'shell' command does not need to support redirection.
7168 The advantage of using a temp file is that the file type and encoding
7169 can be detected.
7170 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7171 |FilterWritePost| autocommands event are not triggered when
7172 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007173 The `system()` function does not respect this option and always uses
7174 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007175 NOTE: This option is set to the Vim default value when 'compatible'
7176 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007177
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 *'shelltype'* *'st'*
7179'shelltype' 'st' number (default 0)
7180 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007181 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 On the Amiga this option influences the way how the commands work
7183 which use a shell.
7184 0 and 1: always use the shell
7185 2 and 3: use the shell only to filter lines
7186 4 and 5: use shell only for ':sh' command
7187 When not using the shell, the command is executed directly.
7188
7189 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7190 1 and 3: use "shell cmd" to start external commands
7191
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007192 *'shellxescape'* *'sxe'*
7193'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007194 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007195 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007196 When 'shellxquote' is set to "(" then the characters listed in this
7197 option will be escaped with a '^' character. This makes it possible
7198 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007199 This option cannot be set from a |modeline| or in the |sandbox|, for
7200 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007201
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 *'shellxquote'* *'sxq'*
7203'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007204 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007205 for Win32, when 'shell' is
7206 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007207 for Win32, when 'shell' contains "sh"
7208 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 for Unix, when using system(): "\"")
7210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 Quoting character(s), put around the command passed to the shell, for
7212 the "!" and ":!" commands. Includes the redirection. See
7213 'shellquote' to exclude the redirection. It's probably not useful
7214 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007215 When the value is '(' then ')' is appended. When the value is '"('
7216 then ')"' is appended.
7217 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007218 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007219 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7220 pwsh.exe which automatically strips off the first and last quote on a
7221 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7222 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007223 'shell', to reduce the need to set this option by the user. See
7224 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 This option cannot be set from a |modeline| or in the |sandbox|, for
7226 security reasons.
7227
7228 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7229'shiftround' 'sr' boolean (default off)
7230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 Round indent to multiple of 'shiftwidth'. Applies to > and <
7232 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7233 a multiple of 'shiftwidth' (this is Vi compatible).
7234 NOTE: This option is reset when 'compatible' is set.
7235
7236 *'shiftwidth'* *'sw'*
7237'shiftwidth' 'sw' number (default 8)
7238 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007239 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007241 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007242 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243
7244 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007245'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7246 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007247 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007249 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 It is a list of flags:
7251 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007252 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7253 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7254 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7255 m use "[+]" instead of "[Modified]" *shm-m*
7256 n use "[New]" instead of "[New File]" *shm-n*
7257 r use "[RO]" instead of "[readonly]" *shm-r*
7258 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007260 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7261 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007262 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007263 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007265 o overwrite message for writing a file with subsequent *shm-o*
7266 message for reading a file (useful for ":wn" or when
7267 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007268 O message for reading a file overwrites any previous *shm-O*
7269 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007270 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7271 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007272 the search count do not show "W" before the count message
7273 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007274 t truncate file message at the start if it is too long *shm-t*
7275 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007276 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007277 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007278 long to fit on the command line; "..." will appear in the
7279 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007280 W don't give "written" or "[w]" when writing a file *shm-W*
7281 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007282 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007283 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007284 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007285 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007286 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7287 match", "Pattern not found", "Back at original", etc.
7288 C don't give messages while scanning for ins-completion *shm-C*
7289 items, for instance "scanning tags"
7290 q use "recording" instead of "recording @a" *shm-q*
7291 F don't give the file info when editing a file, like *shm-F*
7292 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007293 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007294 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007295 "[1/5]". When the "S" flag is not present (e.g. search count
7296 is shown), the "search hit BOTTOM, continuing at TOP" and
7297 "search hit TOP, continuing at BOTTOM" messages are only
7298 indicated by a "W" (Mnemonic: Wrapped) letter before the
7299 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
7301 This gives you the opportunity to avoid that a change between buffers
7302 requires you to hit <Enter>, but still gives as useful a message as
7303 possible for the space available. To get the whole message that you
7304 would have got with 'shm' empty, use ":file!"
7305 Useful values:
7306 shm= No abbreviation of message.
7307 shm=a Abbreviation, but no loss of information.
7308 shm=at Abbreviation, and truncate message when necessary.
7309
7310 NOTE: This option is set to the Vi default value when 'compatible' is
7311 set and to the Vim default value when 'compatible' is reset.
7312
7313 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7314'shortname' 'sn' boolean (default off)
7315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 Filenames are assumed to be 8 characters plus one extension of 3
7317 characters. Multiple dots in file names are not allowed. When this
7318 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007319 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007321 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322
7323 *'showbreak'* *'sbr'* *E595*
7324'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007325 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007326 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327 feature}
7328 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007329 values are "> " or "+++ ": >
7330 :set showbreak=>\
7331< Note the backslash to escape the trailing space. It's easier like
7332 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007333 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007334< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 comma (in a future version the comma might be used to separate the
7336 part that is shown at the end and at the start of a line).
7337 The characters are highlighted according to the '@' flag in
7338 'highlight'.
7339 Note that tabs after the showbreak will be displayed differently.
7340 If you want the 'showbreak' to appear in between line numbers, add the
7341 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007342 A window-local value overrules a global value. If the global value is
7343 set and you want no value in the current window use NONE: >
7344 :setlocal showbreak=NONE
7345<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007347'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7348 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007350 Show (partial) command in the last line of the screen. Set this
7351 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352 In Visual mode the size of the selected area is shown:
7353 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007354 If the number of bytes is different it is also displayed: "2-6"
7355 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007357 - When selecting a block, the size in screen characters:
7358 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007359 This information can be displayed in an alternative location using the
7360 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 NOTE: This option is set to the Vi default value when 'compatible' is
7362 set and to the Vim default value when 'compatible' is reset.
7363
Luuk van Baalba936f62022-12-15 13:15:39 +00007364 *'showcmdloc'* *'sloc'*
7365'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007366 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007367 This option can be used to display the (partially) entered command in
7368 another location. Possible values are:
7369 last Last line of the screen (default).
7370 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007371 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007372 Setting this option to "statusline" or "tabline" means that these will
7373 be redrawn whenever the command changes, which can be on every key
7374 pressed.
7375 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7376 place the text. Without a custom 'statusline' or 'tabline' it will be
7377 displayed in a convenient location.
7378
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7380'showfulltag' 'sft' boolean (default off)
7381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 When completing a word in insert mode (see |ins-completion|) from the
7383 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007384 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 matched a C function, you can see a template for what arguments are
7386 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007387 Note that this doesn't work well together with having "longest" in
7388 'completeopt', because the completion from the search pattern may not
7389 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390
7391 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7392'showmatch' 'sm' boolean (default off)
7393 global
7394 When a bracket is inserted, briefly jump to the matching one. The
7395 jump is only done if the match can be seen on the screen. The time to
7396 show the match can be set with 'matchtime'.
7397 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007398 seen or not).
7399 This option is reset when 'paste' is set and restored when 'paste' is
7400 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 When the 'm' flag is not included in 'cpoptions', typing a character
7402 will immediately move the cursor back to where it belongs.
7403 See the "sm" field in 'guicursor' for setting the cursor shape and
7404 blinking when showing the match.
7405 The 'matchpairs' option can be used to specify the characters to show
7406 matches for. 'rightleft' and 'revins' are used to look for opposite
7407 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007408 Also see the matchparen plugin for highlighting the match when moving
7409 around |pi_paren.txt|.
7410 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411
7412 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7413'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7414 global
7415 If in Insert, Replace or Visual mode put a message on the last line.
7416 Use the 'M' flag in 'highlight' to set the type of highlighting for
7417 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007418 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 doesn't mean XIM is really active, especially when 'imactivatekey' is
7420 not set.
7421 NOTE: This option is set to the Vi default value when 'compatible' is
7422 set and to the Vim default value when 'compatible' is reset.
7423
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007424 *'showtabline'* *'stal'*
7425'showtabline' 'stal' number (default 1)
7426 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007427 The value of this option specifies when the line with tab page labels
7428 will be displayed:
7429 0: never
7430 1: only if there are at least two tab pages
7431 2: always
7432 This is both for the GUI and non-GUI implementation of the tab pages
7433 line.
7434 See |tab-page| for more information about tab pages.
7435
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 *'sidescroll'* *'ss'*
7437'sidescroll' 'ss' number (default 0)
7438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 The minimal number of columns to scroll horizontally. Used only when
7440 the 'wrap' option is off and the cursor is moved off of the screen.
7441 When it is zero the cursor will be put in the middle of the screen.
7442 When using a slow terminal set it to a large number or 0. When using
7443 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7444 commands.
7445
7446 *'sidescrolloff'* *'siso'*
7447'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007448 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007450 right of the cursor if 'nowrap' is set. Setting this option to a
7451 value greater than 0 while having |'sidescroll'| also at a non-zero
7452 value makes some context visible in the line you are scrolling in
7453 horizontally (except at beginning of the line). Setting this option
7454 to a large value (like 999) has the effect of keeping the cursor
7455 horizontally centered in the window, as long as one does not come too
7456 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007457 After using the local value, go back the global value with one of
7458 these two: >
7459 setlocal sidescrolloff<
7460 setlocal sidescrolloff=-1
7461< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462
7463 Example: Try this together with 'sidescroll' and 'listchars' as
7464 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007465 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466
7467 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7468 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007469<
7470 *'signcolumn'* *'scl'*
7471'signcolumn' 'scl' string (default "auto")
7472 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007473 {not available when compiled without the |+signs|
7474 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007475 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007476 "auto" only when there is a sign to display
7477 "no" never
7478 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007479 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007480 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7483'smartcase' 'scs' boolean (default off)
7484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 Override the 'ignorecase' option if the search pattern contains upper
7486 case characters. Only used when the search pattern is typed and
7487 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007488 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7490 recalling the search pattern from history and hitting <Enter>.
7491 NOTE: This option is reset when 'compatible' is set.
7492
7493 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7494'smartindent' 'si' boolean (default off)
7495 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 Do smart autoindenting when starting a new line. Works for C-like
7497 programs, but can also be used for other languages. 'cindent' does
7498 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007499 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007500 setting 'si' has no effect. 'indentexpr' is a more advanced
7501 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 Normally 'autoindent' should also be on when using 'smartindent'.
7503 An indent is automatically inserted:
7504 - After a line ending in '{'.
7505 - After a line starting with a keyword from 'cinwords'.
7506 - Before a line starting with '}' (only with the "O" command).
7507 When typing '}' as the first character in a new line, that line is
7508 given the same indent as the matching '{'.
7509 When typing '#' as the first character in a new line, the indent for
7510 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007511 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7513 When using the ">>" command, lines starting with '#' are not shifted
7514 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007515 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007516 This option is reset when 'paste' is set and restored when 'paste' is
7517 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518
7519 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7520'smarttab' 'sta' boolean (default off)
7521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007523 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7524 <BS> will delete a 'shiftwidth' worth of space at the start of the
7525 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007526 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007527 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7528 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007529 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007531 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007532 This option is reset when 'paste' is set and restored when 'paste' is
7533 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 NOTE: This option is reset when 'compatible' is set.
7535
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007536 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7537'smoothscroll' 'sms' boolean (default off)
7538 local to window
7539 Scrolling works with screen lines. When 'wrap' is set and the first
7540 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007541 above the window. "<<<" is displayed at the start of the first line,
7542 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007543 You may also want to add "lastline" to the 'display' option to show as
7544 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007545 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007546
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 *'softtabstop'* *'sts'*
7548'softtabstop' 'sts' number (default 0)
7549 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 Number of spaces that a <Tab> counts for while performing editing
7551 operations, like inserting a <Tab> or using <BS>. It "feels" like
7552 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7553 used. This is useful to keep the 'ts' setting at its standard value
7554 of 8, while being able to edit like it is set to 'sts'. However,
7555 commands like "x" still work on the actual characters.
7556 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007557 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007558 'softtabstop' is set to 0 when the 'paste' option is set and restored
7559 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7561 spaces is minimized by using <Tab>s.
7562 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7563 set.
7564 NOTE: This option is set to 0 when 'compatible' is set.
7565
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007566 If Vim is compiled with the |+vartabs| feature then the value of
7567 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7568 anything other than an empty string.
7569
Bram Moolenaar217ad922005-03-20 22:37:15 +00007570 *'spell'* *'nospell'*
7571'spell' boolean (default off)
7572 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007573 {not available when compiled without the |+syntax|
7574 feature}
7575 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007576 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007577
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007578 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007579'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007580 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007581 {not available when compiled without the |+syntax|
7582 feature}
7583 Pattern to locate the end of a sentence. The following word will be
7584 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007585 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007586 When this check is not wanted make this option empty.
7587 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007588 Be careful with special characters, see |option-backslash| about
7589 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007590 To set this option automatically depending on the language, see
7591 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007592
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007593 *'spellfile'* *'spf'*
7594'spellfile' 'spf' string (default empty)
7595 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007596 {not available when compiled without the |+syntax|
7597 feature}
7598 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007599 commands. It must end in ".{encoding}.add". You need to include the
7600 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007601 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007602 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007603 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007604 |zg| and |zw| commands can be used to access each. This allows using
7605 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007606 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007607 you: Using the first directory in 'runtimepath' that is writable. If
7608 there is no "spell" directory yet it will be created. For the file
7609 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007610 ignoring the region.
7611 The resulting ".spl" file will be used for spell checking, it does not
7612 have to appear in 'spelllang'.
7613 Normally one file is used for all regions, but you can add the region
7614 name if you want to. However, it will then only be used when
7615 'spellfile' is set to it, for entries in 'spelllang' only files
7616 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007617 This option cannot be set from a |modeline| or in the |sandbox|, for
7618 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007619
Bram Moolenaar217ad922005-03-20 22:37:15 +00007620 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007621'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007622 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007623 {not available when compiled without the |+syntax|
7624 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007625 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007626 on spellchecking will be done for these languages. Example: >
7627 set spelllang=en_us,nl,medical
7628< This means US English, Dutch and medical words are recognized. Words
7629 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007630 The word list name must consist of alphanumeric characters, a dash or
7631 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007632 recommended to separate the two letter language name from a
7633 specification. Thus "en-rare" is used for rare English words.
7634 A region name must come last and have the form "_xx", where "xx" is
7635 the two-letter, lower case region name. You can use more than one
7636 region by listing them: "en_us,en_ca" supports both US and Canadian
7637 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007638 Britain. (Note: currently en_au and en_nz dictionaries are older than
7639 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007640 If the name "cjk" is included East Asian characters are excluded from
7641 spell checking. This is useful when editing text that also has Asian
7642 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007643 Note that the "medical" dictionary does not exist, it is just an
7644 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007645 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007646 As a special case the name of a .spl file can be given as-is. The
7647 first "_xx" in the name is removed and used as the region name
7648 (_xx is an underscore, two letters and followed by a non-letter).
7649 This is mainly for testing purposes. You must make sure the correct
7650 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007651 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007652 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7653 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007654 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007655
Bram Moolenaar98692072006-02-04 00:57:42 +00007656 If the |spellfile.vim| plugin is active and you use a language name
7657 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7658 will ask you if you want to download the file.
7659
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007660 After this option has been set successfully, Vim will source the files
7661 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007662 up to the first character that is not an ASCII letter or number and
7663 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007664
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007665 *'spelloptions'* *'spo'*
7666'spelloptions' 'spo' string (default "")
7667 local to buffer
7668 {not available when compiled without the |+syntax|
7669 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007670 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007671 camel When a word is CamelCased, assume "Cased" is a
7672 separate word: every upper-case character in a word
7673 that comes after a lower case character indicates the
7674 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007675
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007676 *'spellsuggest'* *'sps'*
7677'spellsuggest' 'sps' string (default "best")
7678 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007679 {not available when compiled without the |+syntax|
7680 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007681 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007682 the |spellsuggest()| function. This is a comma-separated list of
7683 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007684
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007685 best Internal method that works best for English. Finds
7686 changes like "fast" and uses a bit of sound-a-like
7687 scoring to improve the ordering.
7688
7689 double Internal method that uses two methods and mixes the
7690 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007691 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007692 word. That only works when the language specifies
7693 sound folding. Can be slow and doesn't always give
7694 better results.
7695
7696 fast Internal method that only checks for simple changes:
7697 character inserts/deletes/swaps. Works well for
7698 simple typing mistakes.
7699
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007700 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007701 Not used for |spellsuggest()|. The number of
7702 suggestions is never more than the value of 'lines'
7703 minus two.
7704
Bram Moolenaar585ee072022-01-29 11:22:17 +00007705 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007706 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007707 methods. When omitted the limit is 5000. When
7708 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007709 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007710
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007711 file:{filename} Read file {filename}, which must have two columns,
7712 separated by a slash. The first column contains the
7713 bad word, the second column the suggested good word.
7714 Example:
7715 theribal/terrible ~
7716 Use this for common mistakes that do not appear at the
7717 top of the suggestion list with the internal methods.
7718 Lines without a slash are ignored, use this for
7719 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007720 The word in the second column must be correct,
7721 otherwise it will not be used. Add the word to an
7722 ".add" file if it is currently flagged as a spelling
7723 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007724 The file is used for all languages.
7725
7726 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007727 trouble with spaces. Best is to call a function
7728 without arguments, see |expr-option-function|.
7729 |v:val| holds the badly spelled word. The expression
7730 must evaluate to a List of Lists, each with a
7731 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007732 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007733 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007734 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007735 internal methods use. A lower score is better.
7736 This may invoke |spellsuggest()| if you temporarily
7737 set 'spellsuggest' to exclude the "expr:" part.
7738 Errors are silently ignored, unless you set the
7739 'verbose' option to a non-zero value.
7740
7741 Only one of "best", "double" or "fast" may be used. The others may
7742 appear several times in any order. Example: >
7743 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7744<
7745 This option cannot be set from a |modeline| or in the |sandbox|, for
7746 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007747
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7749'splitbelow' 'sb' boolean (default off)
7750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 When on, splitting a window will put the new window below the current
7752 one. |:split|
7753
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007754 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007755'splitkeep' 'spk' string (default "cursor")
7756 global
7757 The value of this option determines the scroll behavior when opening,
7758 closing or resizing horizontal splits.
7759
7760 Possible values are:
7761 cursor Keep the same relative cursor position.
7762 screen Keep the text on the same screen line.
7763 topline Keep the topline the same.
7764
7765 For the "screen" and "topline" values, the cursor position will be
7766 changed when necessary. In this case, the jumplist will be populated
7767 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007768 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007769
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7771'splitright' 'spr' boolean (default off)
7772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 When on, splitting a window will put the new window right of the
7774 current one. |:vsplit|
7775
7776 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7777'startofline' 'sol' boolean (default on)
7778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007780 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007781 (if possible). This applies to the commands:
7782 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7783 - "d", "<<" and ">>" with a linewise operator
7784 - "%" with a count
7785 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7786 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 In case of buffer changing commands the cursor is placed at the column
7788 where it was the last time the buffer was edited.
7789 NOTE: This option is set when 'compatible' is set.
7790
Bram Moolenaar00654022011-02-25 14:42:19 +01007791 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007793 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 {not available when compiled without the |+statusline|
7795 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007796 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 Also see |status-line|.
7798
7799 The option consists of printf style '%' items interspersed with
7800 normal text. Each status line item is of the form:
7801 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007802 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007803 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804
Bram Moolenaar238a5642006-02-21 22:12:05 +00007805 When the option starts with "%!" then it is used as an expression,
7806 evaluated and the result is used as the option value. Example: >
7807 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007808< The *g:statusline_winid* variable will be set to the |window-ID| of the
7809 window that the status line belongs to.
7810 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007811 Note that the "%!" expression is evaluated in the context of the
7812 current window and buffer, while %{} items are evaluated in the
7813 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007814
7815 When there is error while evaluating the option then it will be made
7816 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007817 When the result contains unprintable characters the result is
7818 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007819
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 Note that the only effect of 'ruler' when this option is set (and
7821 'laststatus' is 2) is controlling the output of |CTRL-G|.
7822
7823 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007824 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007826 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 minwid Minimum width of the item, padding as set by '-' & '0'.
7828 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007829 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 on the left for text items. Numeric items will be
7831 shifted down to maxwid-2 digits followed by '>'number
7832 where number is the amount of missing digits, much like
7833 an exponential notation.
7834 item A one letter code as described below.
7835
7836 Following is a description of the possible statusline items. The
7837 second character in "item" is the type:
7838 N for number
7839 S for string
7840 F for flags as described below
7841 - not applicable
7842
7843 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007844 f S Path to the file in the buffer, as typed or relative to current
7845 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 F S Full path to the file in the buffer.
7847 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007848 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007850 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007852 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007854 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007856 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007858 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7860 being used: "<keymap>"
7861 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007862 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 B N As above, in hexadecimal.
7864 o N Byte number in file of byte under cursor, first byte is 1.
7865 Mnemonic: Offset from start of file (with one added)
7866 {not available when compiled without |+byte_offset| feature}
7867 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007868 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 l N Line number.
7870 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007871 c N Column number (byte index).
7872 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007873 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 p N Percentage through file in lines as in |CTRL-G|.
7875 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007876 percentage described for 'ruler'. Always 3 in length, unless
7877 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007878 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007879 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007881 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007882 Note that there is no '%' before the closing '}'. The
7883 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007884 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007885 {% - This is almost same as { except the result of the expression is
7886 re-evaluated as a statusline format string. Thus if the
7887 return value of expr contains % items they will get expanded.
7888 The expression can contain the } character, the end of
7889 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007890 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007891 func! Stl_filename() abort
7892 return "%t"
7893 endfunc
7894< `stl=%{Stl_filename()}` results in `"%t"`
7895 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007896 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 ( - Start of item group. Can be used for setting the width and
7898 alignment of a section. Must be followed by %) somewhere.
7899 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007900 T N For 'tabline': start of tab page N label. Use %T after the last
7901 label. This information is used for mouse clicks.
7902 X N For 'tabline': start of close tab N label. Use %X after the
7903 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7904 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 < - Where to truncate line if too long. Default is at the start.
7906 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007907 = - Separation point between alignment sections. Each section will
7908 be separated by an equal number of spaces. With one %= what
7909 comes after it will be right-aligned. With two %= there is a
7910 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007912 # - Set highlight group. The name must follow and then a # again.
7913 Thus use %#HLname# for highlight group HLname. The same
7914 highlighting is used, also for the statusline of non-current
7915 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007917 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007918 The difference between User{N} and StatusLine will be applied to
7919 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 The number N must be between 1 and 9. See |hl-User1..9|
7921
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007922 When displaying a flag, Vim removes the leading comma, if any, when
7923 that flag comes right after plaintext. This will make a nice display
7924 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925
Bram Moolenaar582fd852005-03-28 20:58:01 +00007926 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 not set) and a minwid is not set for the group, the whole group will
7928 become empty. This will make a group like the following disappear
7929 completely from the statusline when none of the flags are set. >
7930 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007931< Beware that an expression is evaluated each and every time the status
7932 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007933 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007934 While evaluating %{} the current buffer and current window will be set
7935 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007936 currently being drawn. The expression will evaluate in this context.
7937 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7938 real current buffer and "g:actual_curwin" to the |window-ID| of the
7939 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007940
Bram Moolenaar30b65812012-07-12 22:01:11 +02007941 The 'statusline' option will be evaluated in the |sandbox| if set from
7942 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007943 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007944
7945 It is not allowed to change text or jump to another window while
7946 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947
7948 If the statusline is not updated when you want it (e.g., after setting
7949 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007950 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007952 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 Otherwise the result is taken as flag text and applied to the rules
7954 described above.
7955
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007956 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007958 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959
7960 Examples:
7961 Emulate standard status line with 'ruler' set >
7962 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7963< Similar, but add ASCII value of char under the cursor (like "ga") >
7964 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7965< Display byte count and byte value, modified flag in red. >
7966 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7967 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7968< Display a ,GZ flag if a compressed file is loaded >
7969 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7970< In the |:autocmd|'s: >
7971 :let b:gzflag = 1
7972< And: >
7973 :unlet b:gzflag
7974< And define this function: >
7975 :function VarExists(var, val)
7976 : if exists(a:var) | return a:val | else | return '' | endif
7977 :endfunction
7978<
7979 *'suffixes'* *'su'*
7980'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 Files with these suffixes get a lower priority when multiple files
7983 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007984 suffixes. Spaces after the comma are ignored. A dot is also seen as
7985 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 separator, precede it with a backslash (see |option-backslash| about
7987 including spaces and backslashes).
7988 See 'wildignore' for completely ignoring files.
7989 The use of |:set+=| and |:set-=| is preferred when adding or removing
7990 suffixes from the list. This avoids problems when a future version
7991 uses another default.
7992
7993 *'suffixesadd'* *'sua'*
7994'suffixesadd' 'sua' string (default "")
7995 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007996 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 file for the "gf", "[I", etc. commands. Example: >
7998 :set suffixesadd=.java
7999<
8000 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8001'swapfile' 'swf' boolean (default on)
8002 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008003 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 swapfile is not wanted for a specific buffer. For example, with
8005 confidential information that even root must not be able to access.
8006 Careful: All text will be in memory:
8007 - Don't use this for big files.
8008 - Recovery will be impossible!
8009 A swapfile will only be present when |'updatecount'| is non-zero and
8010 'swapfile' is set.
8011 When 'swapfile' is reset, the swap file for the current buffer is
8012 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8013 non-zero, a swap file is immediately created.
8014 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008015 If you want to open a new buffer without creating a swap file for it,
8016 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008017 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018
8019 This option is used together with 'bufhidden' and 'buftype' to
8020 specify special kinds of buffers. See |special-buffers|.
8021
8022 *'swapsync'* *'sws'*
8023'swapsync' 'sws' string (default "fsync")
8024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008026 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 When this option is empty parts of the swap file may be in memory and
8028 not written to disk. When the system crashes you may lose more work.
8029 On Unix the system does a sync now and then without Vim asking for it,
8030 so the disadvantage of setting this option off is small. On some
8031 systems the swap file will not be written at all. For a unix system
8032 setting it to "sync" will use the sync() call instead of the default
8033 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008034 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035
8036 *'switchbuf'* *'swb'*
8037'switchbuf' 'swb' string (default "")
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008040 This option is checked, when
8041 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008042 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008043 - jumping to a tag using the |:stag| command.
8044 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8045 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8046 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008047 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008048 useopen If included, jump to the first open window in the
8049 current tab page that contains the specified buffer
8050 (if there is one). Otherwise: Do not examine other
8051 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008052 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008053 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008055 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008056 Otherwise: do not split, use current window (when used
8057 in the quickfix window: the previously used window or
8058 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008059 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008060 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008061 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008062 uselast If included, jump to the previously used window when
8063 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008064 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8065 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008067 *'synmaxcol'* *'smc'*
8068'synmaxcol' 'smc' number (default 3000)
8069 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008070 {not available when compiled without the |+syntax|
8071 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008072 Maximum column in which to search for syntax items. In long lines the
8073 text after this column is not highlighted and following lines may not
8074 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008075 This helps to avoid very slow redrawing for an XML file that is one
8076 long line.
8077 Set to zero to remove the limit.
8078
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 *'syntax'* *'syn'*
8080'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008081 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 {not available when compiled without the |+syntax|
8083 feature}
8084 When this option is set, the syntax with this name is loaded, unless
8085 syntax highlighting has been switched off with ":syntax off".
8086 Otherwise this option does not always reflect the current syntax (the
8087 b:current_syntax variable does).
8088 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008089 not automatically recognized. Example, in an IDL file:
8090 /* vim: set syntax=idl : */ ~
8091 When a dot appears in the value then this separates two filetype
8092 names. Example:
8093 /* vim: set syntax=c.doxygen : */ ~
8094 This will use the "c" syntax first, then the "doxygen" syntax.
8095 Note that the second one must be prepared to be loaded as an addition,
8096 otherwise it will be skipped. More than one dot may appear.
8097 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 :set syntax=OFF
8099< To switch syntax highlighting on according to the current value of the
8100 'filetype' option: >
8101 :set syntax=ON
8102< What actually happens when setting the 'syntax' option is that the
8103 Syntax autocommand event is triggered with the value as argument.
8104 This option is not copied to another buffer, independent of the 's' or
8105 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008106 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107
LemonBoy5247b0b2024-07-12 19:30:58 +02008108 *'tabclose'* *'tcl'*
8109'tabclose' 'tcl' string (default "")
8110 global
8111 This option controls the behavior when closing tab pages (e.g., using
8112 |:tabclose|). When empty Vim goes to the next (right) tab page.
8113
8114 Possible values (comma-separated list):
8115 left If included, go to the previous tab page instead of
8116 the next one.
8117 uselast If included, go to the previously used tab page if
8118 possible. This option takes precedence over the
8119 others.
8120
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008121 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008122'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008123 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008124 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008125 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008126 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008127
8128 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008129 option and only when there is no GUI tab line. When 'e' is in
8130 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008131 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008132
8133 The value is evaluated like with 'statusline'. You can use
8134 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008135 the text to be displayed. Use "%1T" for the first label, "%2T" for
8136 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008137
Bram Moolenaare12bab32019-01-08 22:02:56 +01008138 When changing something that is used in 'tabline' that does not
8139 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008140 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008141
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008142 Keep in mind that only one of the tab pages is the current one, others
8143 are invisible and you can't jump to their windows.
8144
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008145 *'tabpagemax'* *'tpm'*
8146'tabpagemax' 'tpm' number (default 10)
8147 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008148 Maximum number of tab pages to be opened by the |-p| command line
8149 argument or the ":tab all" command. |tabpage|
8150
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008151 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152'tabstop' 'ts' number (default 8)
8153 local to buffer
8154 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008155 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156
8157 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008158 appear wrong in many places, e.g., when printing it.
8159 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008161 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8163 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008164 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008166 This is the recommended way, the file will look the same with other
8167 tools and when listing it in a terminal.
8168 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8169 'expandtab'. This way you will always insert spaces. The
8170 formatting will never be messed up when 'tabstop' is changed (leave
8171 it at 8 just in case). The file will be a bit larger.
8172 You do need to check if no Tabs exist in the file. You can get rid
8173 of them by first setting 'expandtab' and using `%retab!`, making
8174 sure the value of 'tabstop' is set correctly.
8175 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 'expandtab'. This way you will always insert spaces. The
8177 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008178 You do need to check if no Tabs exist in the file, just like in the
8179 item just above.
8180 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008181 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008182 works when using Vim to edit the file, other tools assume a tabstop
8183 is worth 8 spaces.
8184 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 'noexpandtab'. This should then work (for initial indents only)
8186 for any tabstop setting that people use. It might be nice to have
8187 tabs after the first non-blank inserted as spaces if you do this
8188 though. Otherwise aligned comments will be wrong when 'tabstop' is
8189 changed.
8190
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008191 If Vim is compiled with the |+vartabs| feature then the value of
8192 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8193 than an empty string.
8194
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8196'tagbsearch' 'tbs' boolean (default on)
8197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008199 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 searching makes searching for a tag a LOT faster, but a linear search
8201 will find more tags if the tags file wasn't properly sorted.
8202 Vim normally assumes that your tags files are sorted, or indicate that
8203 they are not sorted. Only when this is not the case does the
8204 'tagbsearch' option need to be switched off.
8205
8206 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008207 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 certain files, or retry all files with a linear search. When
8209 'tagbsearch' is off, only a linear search is done.
8210
8211 Linear searching is done anyway, for one file, when Vim finds a line
8212 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008213 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214< [The whitespace before and after the '0' must be a single <Tab>]
8215
8216 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008217 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218 instead of a normal tag name, a retry is done with a linear search.
8219 Tags in unsorted tags files, and matches with different case will only
8220 be found in the retry.
8221
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008222 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008223 linear search can be avoided when case is ignored. Use a value of '2'
8224 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8225 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008226 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8227 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8228 used for this as well. Note that case must be folded to uppercase for
8229 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008230
8231 By default, tag searches are case-sensitive. Case is ignored when
8232 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8233 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008234 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8235 'tagcase' is "smart", and the pattern contains only lowercase
8236 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237
8238 When 'tagbsearch' is off, tags searching is slower when a full match
8239 exists, but faster when no full match exists. Tags in unsorted tags
8240 files may only be found with 'tagbsearch' off.
8241 When the tags file is not sorted, or sorted in a wrong way (not on
8242 ASCII byte value), 'tagbsearch' should be off, or the line given above
8243 must be included in the tags file.
8244 This option doesn't affect commands that find all matching tags (e.g.,
8245 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008247 *'tagcase'* *'tc'*
8248'tagcase' 'tc' string (default "followic")
8249 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008250 This option specifies how case is handled when searching the tags
8251 file:
8252 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008253 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008254 ignore Ignore case
8255 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008256 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008257 NOTE: This option is set to the Vi default value when 'compatible' is
8258 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008259
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008260 *'tagfunc'* *'tfu'*
8261'tagfunc' 'tfu' string (default: empty)
8262 local to buffer
8263 {not available when compiled without the |+eval|
8264 feature}
8265 This option specifies a function to be used to perform tag searches.
8266 The function gets the tag pattern and should return a List of matching
8267 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008268 function and an example. The value can be the name of a function, a
8269 |lambda| or a |Funcref|. See |option-value-function| for more
8270 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008271 This option cannot be set from a |modeline| or in the |sandbox|, for
8272 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008273
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 *'taglength'* *'tl'*
8275'taglength' 'tl' number (default 0)
8276 global
8277 If non-zero, tags are significant up to this number of characters.
8278
8279 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8280'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8281 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008282 If on and using a tags file in another directory, file names in that
8283 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 NOTE: This option is set to the Vi default value when 'compatible' is
8285 set and to the Vim default value when 'compatible' is reset.
8286
8287 *'tags'* *'tag'* *E433*
8288'tags' 'tag' string (default "./tags,tags", when compiled with
8289 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8290 global or local to buffer |global-local|
8291 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008292 include a space or comma in a file name, precede it with backslashes
8293 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 When a file name starts with "./", the '.' is replaced with the path
8295 of the current file. But only when the 'd' flag is not included in
8296 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8297 |tags-option|.
8298 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008299 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8300 find all files named "tags" below "/lib". The filename itself cannot
8301 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008302 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008303 The |tagfiles()| function can be used to get a list of the file names
8304 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8306 files are also supported. They are automatically recognized. The
8307 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8308 differences are ignored (MS-Windows). |emacs-tags|
8309 The use of |:set+=| and |:set-=| is preferred when adding or removing
8310 file names from the list. This avoids problems when a future version
8311 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312
8313 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8314'tagstack' 'tgst' boolean (default on)
8315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 When on, the |tagstack| is used normally. When off, a ":tag" or
8317 ":tselect" command with an argument will not push the tag onto the
8318 tagstack. A following ":tag" without an argument, a ":pop" command or
8319 any other command that uses the tagstack will use the unmodified
8320 tagstack, but does change the pointer to the active entry.
8321 Resetting this option is useful when using a ":tag" command in a
8322 mapping which should not change the tagstack.
8323
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008324 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008325'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008326 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008327 {only available when compiled with the |+tcl/dyn|
8328 feature}
8329 Specifies the name of the Tcl shared library. The default is
8330 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008331 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008332 This option cannot be set from a |modeline| or in the |sandbox|, for
8333 security reasons.
8334
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 *'term'* *E529* *E530* *E531*
8336'term' string (default is $TERM, if that fails:
8337 in the GUI: "builtin_gui"
8338 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008339 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 on Unix: "ansi"
8342 on VMS: "ansi"
8343 on Win 32: "win32")
8344 global
8345 Name of the terminal. Used for choosing the terminal control
8346 characters. Environment variables are expanded |:set_env|.
8347 For example: >
8348 :set term=$TERM
8349< See |termcap|.
8350
8351 *'termbidi'* *'tbidi'*
8352 *'notermbidi'* *'notbidi'*
8353'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 {only available when compiled with the |+arabic|
8356 feature}
8357 The terminal is in charge of Bi-directionality of text (as specified
8358 by Unicode). The terminal is also expected to do the required shaping
8359 that some languages (such as Arabic) require.
8360 Setting this option implies that 'rightleft' will not be set when
8361 'arabic' is set and the value of 'arabicshape' will be ignored.
8362 Note that setting 'termbidi' has the immediate effect that
8363 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8364 This option is reset when the GUI is started.
8365 For further details see |arabic.txt|.
8366
8367 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008368'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 Encoding used for the terminal. This specifies what character
8371 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008372 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008373 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008374 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008375 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8377 Any attempts to set a different value will be rejected, and an error
8378 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008379 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 because the Win32 system always passes Unicode characters.
8381 When empty, the same encoding is used as for the 'encoding' option.
8382 This is the normal value.
8383 Not all combinations for 'termencoding' and 'encoding' are valid. See
8384 |encoding-table|.
8385 The value for this option must be supported by internal conversions or
8386 iconv(). When this is not possible no conversion will be done and you
8387 will probably experience problems with non-ASCII characters.
8388 Example: You are working with the locale set to euc-jp (Japanese) and
8389 want to edit a UTF-8 file: >
8390 :let &termencoding = &encoding
8391 :set encoding=utf-8
8392< You need to do this when your system has no locale support for UTF-8.
8393
Bram Moolenaar938ae282023-02-20 20:44:55 +00008394 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008395'termguicolors' 'tgc' boolean (default off)
8396 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008397 {not available when compiled without the
8398 |+termguicolors| feature}
8399 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008400 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008401
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008402 Requires a ISO-8613-3 compatible terminal. If setting this option
8403 does not work (produces a colorless UI) reading |xterm-true-color|
8404 might help.
8405
8406 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8407 is required. Use this check to find out: >
8408 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008409< This requires Vim to be built with the |+vtp| feature.
8410
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008411 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008412
8413 When using Vim with Windows Terminal, the background of Windows
8414 Terminal is normally filled with the Vim background color. Setting
8415 'termguicolors' and the guibg of the Normal highlight group to NONE
8416 will make the background transparent: >
8417 :hi Normal guibg=NONE
8418<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008419 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008420
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008421 *'termwinkey'* *'twk'*
8422'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008423 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008424 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008425 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008426 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008427 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008428< The string must be one key stroke but can be multiple bytes.
8429 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008430 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008431 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008432
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008433 *'termwinscroll'* *'twsl'*
8434'termwinscroll' 'twsl' number (default 10000)
8435 local to buffer
8436 {not available when compiled without the
8437 |+terminal| feature}
8438 Number of scrollback lines to keep. When going over this limit the
8439 first 10% of the scrollback lines are deleted. This is just to reduce
8440 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008441 Also used as a limit for text sent to the terminal in one write,
8442 multiplied by the number of columns times 3 (average number of bytes
8443 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008444
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008445 *'termwinsize'* *'tws'*
8446'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008447 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008448 Size used when opening the |terminal| window. Format:
8449 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008450 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008451 - When set with a "x" (e.g., "24x80") the terminal size is not
8452 adjusted to the window size. If the window is smaller only the
8453 top-left part is displayed.
8454 - When set with a "*" (e.g., "10*50") the terminal size follows the
8455 window size, but will not be smaller than the specified rows and/or
8456 columns.
8457 - When rows is zero then use the height of the window.
8458 - When columns is zero then use the width of the window.
8459 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008460 - Can be overruled in the |term_start()| options with "term_rows" and
8461 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008462
8463 Examples:
8464 "30x0" uses 30 rows and the current window width.
8465 "20*0" uses at least 20 rows and the current window width.
8466 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008467 Note that the command running in the terminal window may still change
8468 the size of the terminal. In that case the Vim window will be
8469 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008470
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008471 *'termwintype'* *'twt'*
8472'termwintype' 'twt' string (default "")
8473 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008474 {only available when compiled with the |terminal|
8475 feature on MS-Windows}
8476 Specify the virtual console (pty) used when opening the terminal
8477 window.
8478
8479 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008480 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008481 "winpty" use winpty, fail if not supported
8482 "conpty" use |ConPTY|, fail if not supported
8483
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008484 |ConPTY| support depends on the platform. Windows 10 October 2018
8485 Update is the first version that supports ConPTY, however it is still
8486 considered unstable. ConPTY might become stable in the next release
8487 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008488 supported then you cannot open a terminal window.
8489
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 *'terse'* *'noterse'*
8491'terse' boolean (default off)
8492 global
8493 When set: Add 's' flag to 'shortmess' option (this makes the message
8494 for a search that hits the start or end of the file not being
8495 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8496 shortens a lot of messages}
8497
8498 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8499'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 This option is obsolete. Use 'fileformats'.
8502 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8503 set to the default value for the current system. When 'textauto' is
8504 reset, 'fileformats' is made empty.
8505 NOTE: This option is set to the Vi default value when 'compatible' is
8506 set and to the Vim default value when 'compatible' is reset.
8507
8508 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008509'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 others: default off)
8511 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 This option is obsolete. Use 'fileformat'.
8513 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8514 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8515 "unix".
8516
8517 *'textwidth'* *'tw'*
8518'textwidth' 'tw' number (default 0)
8519 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 Maximum width of text that is being inserted. A longer line will be
8521 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008522 this.
8523 'textwidth' is set to 0 when the 'paste' option is set and restored
8524 when 'paste' is reset.
8525 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008527 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 NOTE: This option is set to 0 when 'compatible' is set.
8529
8530 *'thesaurus'* *'tsr'*
8531'thesaurus' 'tsr' string (default "")
8532 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008534 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8535 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008536
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008537 This option is not used if 'thesaurusfunc' is set, either for the
8538 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008539
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008540 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008542 name. See |option-backslash| about using backslashes. The use of
8543 |:set+=| and |:set-=| is preferred when adding or removing directories
8544 from the list. This avoids problems when a future version uses
8545 another default. Backticks cannot be used in this option for security
8546 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008548 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008549'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008550 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008551 {not available when compiled without the |+eval|
8552 feature}
8553 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008554 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008555 The value can be the name of a function, a |lambda| or a |Funcref|.
8556 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008557
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008558 This option cannot be set from a |modeline| or in the |sandbox|, for
8559 security reasons.
8560
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8562'tildeop' 'top' boolean (default off)
8563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 When on: The tilde command "~" behaves like an operator.
8565 NOTE: This option is reset when 'compatible' is set.
8566
8567 *'timeout'* *'to'* *'notimeout'* *'noto'*
8568'timeout' 'to' boolean (default on)
8569 global
laburnumT3f7855a2023-12-05 18:37:03 +01008570
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008572'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 These two options together determine the behavior when part of a
8575 mapped key sequence or keyboard code has been received:
8576
8577 'timeout' 'ttimeout' action ~
8578 off off do not time out
8579 on on or off time out on :mappings and key codes
8580 off on time out on key codes
8581
8582 If both options are off, Vim will wait until either the complete
8583 mapping or key sequence has been received, or it is clear that there
8584 is no mapping or key sequence for the received characters. For
8585 example: if you have mapped "vl" and Vim has received 'v', the next
8586 character is needed to see if the 'v' is followed by an 'l'.
8587 When one of the options is on, Vim will wait for about 1 second for
8588 the next character to arrive. After that the already received
8589 characters are interpreted as single characters. The waiting time can
8590 be changed with the 'timeoutlen' option.
8591 On slow terminals or very busy systems timing out may cause
8592 malfunctioning cursor keys. If both options are off, Vim waits
8593 forever after an entered <Esc> if there are key codes that start
8594 with <Esc>. You will have to type <Esc> twice. If you do not have
8595 problems with key codes, but would like to have :mapped key
8596 sequences not timing out in 1 second, set the 'ttimeout' option and
8597 reset the 'timeout' option.
8598
8599 NOTE: 'ttimeout' is reset when 'compatible' is set.
8600
8601 *'timeoutlen'* *'tm'*
8602'timeoutlen' 'tm' number (default 1000)
8603 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008604
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008606'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 The time in milliseconds that is waited for a key code or mapped key
8609 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8610 when part of a command has been typed.
8611 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8612 different timeout value for key codes is desired set 'ttimeoutlen' to
8613 a non-negative number.
8614
8615 ttimeoutlen mapping delay key code delay ~
8616 < 0 'timeoutlen' 'timeoutlen'
8617 >= 0 'timeoutlen' 'ttimeoutlen'
8618
8619 The timeout only happens when the 'timeout' and 'ttimeout' options
8620 tell so. A useful setting would be >
8621 :set timeout timeoutlen=3000 ttimeoutlen=100
8622< (time out on mapping after three seconds, time out on key codes after
8623 a tenth of a second).
8624
8625 *'title'* *'notitle'*
8626'title' boolean (default off, on when title can be restored)
8627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 When on, the title of the window will be set to the value of
8629 'titlestring' (if it is not empty), or to:
8630 filename [+=-] (path) - VIM
8631 Where:
8632 filename the name of the file being edited
8633 - indicates the file cannot be modified, 'ma' off
8634 + indicates the file was modified
8635 = indicates the file is read-only
8636 =+ indicates the file is read-only and modified
8637 (path) is the path of the file being edited
8638 - VIM the server name |v:servername| or "VIM"
8639 Only works if the terminal supports setting window titles
8640 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008641 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8643 *X11*
8644 When Vim was compiled with HAVE_X11 defined, the original title will
8645 be restored if possible. The output of ":version" will include "+X11"
8646 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8647 works for the icon name |'icon'|.
8648 But: When Vim was started with the |-X| argument, restoring the title
8649 will not work (except in the GUI).
8650 If the title cannot be restored, it is set to the value of 'titleold'.
8651 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008652 When using an xterm from a remote machine you can use this command: >
8653
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008655 ssh -X machine_name xterm &
8656<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 then the WINDOWID environment variable should be inherited and the
8658 title of the window should change back to what it should be after
8659 exiting Vim.
8660
8661 *'titlelen'*
8662'titlelen' number (default 85)
8663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008665 title. When the title is longer, only the end of the path name is
8666 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 Using a percentage makes this adapt to the width of the window. But
8668 it won't work perfectly, because the actual number of characters
8669 available also depends on the font used and other things in the title
8670 bar. When 'titlelen' is zero the full path is used. Otherwise,
8671 values from 1 to 30000 percent can be used.
8672 'titlelen' is also used for the 'titlestring' option.
8673
8674 *'titleold'*
8675'titleold' string (default "Thanks for flying Vim")
8676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 This option will be used for the window title when exiting Vim if the
8678 original title cannot be restored. Only happens if 'title' is on or
8679 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008680 This option cannot be set from a |modeline| or in the |sandbox|, for
8681 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 *'titlestring'*
8683'titlestring' string (default "")
8684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 When this option is not empty, it will be used for the title of the
8686 window. This happens only when the 'title' option is on.
8687 Only works if the terminal supports setting window titles (currently
8688 Amiga console, Win32 console, all GUI versions and terminals with a
8689 non-empty 't_ts' option).
8690 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008691 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008692
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 When this option contains printf-style '%' items, they will be
8694 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008695 This option cannot be set in a modeline when 'modelineexpr' is off.
8696
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008698 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8700< The value of 'titlelen' is used to align items in the middle or right
8701 of the available space.
8702 Some people prefer to have the file name first: >
8703 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8704< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008705 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 separating space only when needed.
8707 NOTE: Use of special characters in 'titlestring' may cause the display
8708 to be garbled (e.g., when it contains a CR or NL character).
8709 {not available when compiled without the |+statusline| feature}
8710
8711 *'toolbar'* *'tb'*
8712'toolbar' 'tb' string (default "icons,tooltips")
8713 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008714 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008715 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 possible values are:
8717 icons Toolbar buttons are shown with icons.
8718 text Toolbar buttons shown with text.
8719 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008720 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 tooltips Tooltips are active for toolbar buttons.
8722 Tooltips refer to the popup help text which appears after the mouse
8723 cursor is placed over a toolbar button for a brief moment.
8724
8725 If you want the toolbar to be shown with icons as well as text, do the
8726 following: >
8727 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008728< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 will show icons if both are requested.
8730
8731 If none of the strings specified in 'toolbar' are valid or if
8732 'toolbar' is empty, this option is ignored. If you want to disable
8733 the toolbar, you need to set the 'guioptions' option. For example: >
8734 :set guioptions-=T
8735< Also see |gui-toolbar|.
8736
8737 *'toolbariconsize'* *'tbis'*
8738'toolbariconsize' 'tbis' string (default "small")
8739 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008740 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008742 tiny Use tiny icons.
8743 small Use small icons (default).
8744 medium Use medium-sized icons.
8745 large Use large icons.
8746 huge Use even larger icons.
8747 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008749 the current theme. Common dimensions are giant=48x48, huge=32x32,
8750 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751
8752 If 'toolbariconsize' is empty, the global default size as determined
8753 by user preferences or the current theme is used.
8754
8755 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8756'ttybuiltin' 'tbi' boolean (default on)
8757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 When on, the builtin termcaps are searched before the external ones.
8759 When off the builtin termcaps are searched after the external ones.
8760 When this option is changed, you should set the 'term' option next for
8761 the change to take effect, for example: >
8762 :set notbi term=$TERM
8763< See also |termcap|.
8764 Rationale: The default for this option is "on", because the builtin
8765 termcap entries are generally better (many systems contain faulty
8766 xterm entries...).
8767
8768 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008769'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 Indicates a fast terminal connection. More characters will be sent to
8772 the screen for redrawing, instead of using insert/delete line
8773 commands. Improves smoothness of redrawing when there are multiple
8774 windows and the terminal does not support a scrolling region.
8775 Also enables the extra writing of characters at the end of each screen
8776 line for lines that wrap. This helps when using copy/paste with the
8777 mouse in an xterm and other terminals.
8778
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008779 The default used to be set only for some terminal names, but these
8780 days nearly all terminals are fast, therefore the default is now "on".
8781 If you have a slow connection you may want to set this option off,
8782 e.g. depending on the host name: >
8783 if hostname() =~ 'faraway'
8784 set nottyfast
8785 endif
8786<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 *'ttymouse'* *'ttym'*
8788'ttymouse' 'ttym' string (default depends on 'term')
8789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 {only in Unix and VMS, doesn't work in the GUI; not
8791 available when compiled without |+mouse|}
8792 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008793 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 *xterm-mouse*
8795 xterm xterm-like mouse handling. The mouse generates
8796 "<Esc>[Mscr", where "scr" is three bytes:
8797 "s" = button state
8798 "c" = column plus 33
8799 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008800 This only works up to 223 columns! See "dec",
8801 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 xterm2 Works like "xterm", but with the xterm reporting the
8803 mouse position while the mouse is dragged. This works
8804 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008805 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 work. See below for how Vim detects this
8807 automatically.
8808 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008809 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008811 for the row and column. No other mouse events are
8812 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 *dec-mouse*
8814 dec DEC terminal mouse handling. The mouse generates a
8815 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008816 This is also available for an Xterm, if it was
8817 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 *jsbterm-mouse*
8819 jsbterm JSB term mouse handling.
8820 *pterm-mouse*
8821 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008822 *urxvt-mouse*
8823 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008824 The mouse works only if the terminal supports this
8825 encoding style, but it does not have 223 columns limit
8826 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008827 *sgr-mouse*
8828 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008829 mouse reporting. The mouse works even in columns
8830 beyond 223. This option is backward compatible with
8831 "xterm2" because it can also decode "xterm2" style
8832 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833
8834 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008835 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8836 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8838 recognized, if enabled at compile time. DEC terminal mouse codes
8839 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008840 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8841 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008843 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8844 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8845 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008846 If the terminfo/termcap entry "XM" exists and the first number is
8847 "1006" then 'ttymouse' will be set to "sgr". This works for many
8848 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008849 Additionally, if vim is compiled with the |+termresponse| feature and
8850 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008851 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008853 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8854 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8855 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008856 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8857 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 :set t_RV=
8859<
8860 *'ttyscroll'* *'tsl'*
8861'ttyscroll' 'tsl' number (default 999)
8862 global
8863 Maximum number of lines to scroll the screen. If there are more lines
8864 to scroll the window is redrawn. For terminals where scrolling is
8865 very slow and redrawing is not slow this can be set to a small number,
8866 e.g., 3, to speed up displaying.
8867
8868 *'ttytype'* *'tty'*
8869'ttytype' 'tty' string (default from $TERM)
8870 global
8871 Alias for 'term', see above.
8872
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008873 *'undodir'* *'udir'*
8874'undodir' 'udir' string (default ".")
8875 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008876 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008877 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008878 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008879 "." means using the directory of the file. The undo file name for
8880 "file.txt" is ".file.txt.un~".
8881 For other directories the file name is the full path of the edited
8882 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008883 When writing: The first directory that exists is used. "." always
8884 works, no directories after "." will be used for writing.
8885 When reading all entries are tried to find an undo file. The first
8886 undo file that exists is used. When it cannot be read an error is
8887 given, no further entry is used.
8888 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008889 This option cannot be set from a |modeline| or in the |sandbox|, for
8890 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008891
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008892 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008893'undofile' 'udf' boolean (default off)
8894 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008895 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008896 When on, Vim automatically saves undo history to an undo file when
8897 writing a buffer to a file, and restores undo history from the same
8898 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008899 The directory where the undo file is stored is specified by 'undodir'.
8900 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008901 The undo file is not read when 'undoreload' causes the buffer from
8902 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008903 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008904 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008905
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008907'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008908 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008910 is kept in memory, higher numbers will cause more memory to be used.
8911 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8913 itself: >
8914 set ul=0
8915< But you can also get Vi compatibility by including the 'u' flag in
8916 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008917 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008918 Set to -1 for no undo at all. You might want to do this only for the
8919 current buffer: >
8920 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008922
8923 The local value is set to -123456 when the global value is to be used.
8924
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008925 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008927 *'undoreload'* *'ur'*
8928'undoreload' 'ur' number (default 10000)
8929 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008930 Save the whole buffer for undo when reloading it. This applies to the
8931 ":e!" command and reloading for when the buffer changed outside of
8932 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008933 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008934 of lines is smaller than the value of this option.
8935 Set this option to zero to disable undo for a reload.
8936
8937 When saving undo for a reload, any undo file is not read.
8938
8939 Note that this causes the whole buffer to be stored in memory. Set
8940 this option to a lower value if you run out of memory.
8941
Bram Moolenaar071d4272004-06-13 20:20:40 +00008942 *'updatecount'* *'uc'*
8943'updatecount' 'uc' number (default: 200)
8944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 After typing this many characters the swap file will be written to
8946 disk. When zero, no swap file will be created at all (see chapter on
8947 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8948 Vim with the "-n" option, see |startup|. When editing in readonly
8949 mode this option will be initialized to 10000.
8950 The swapfile can be disabled per buffer with |'swapfile'|.
8951 When 'updatecount' is set from zero to non-zero, swap files are
8952 created for all buffers that have 'swapfile' set. When 'updatecount'
8953 is set to zero, existing swap files are not deleted.
8954 Also see |'swapsync'|.
8955 This option has no meaning in buffers where |'buftype'| is "nofile"
8956 or "nowrite".
8957
8958 *'updatetime'* *'ut'*
8959'updatetime' 'ut' number (default 4000)
8960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 If this many milliseconds nothing is typed the swap file will be
8962 written to disk (see |crash-recovery|). Also used for the
8963 |CursorHold| autocommand event.
8964
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008965 *'varsofttabstop'* *'vsts'*
8966'varsofttabstop' 'vsts' string (default "")
8967 local to buffer
8968 {only available when compiled with the |+vartabs|
8969 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008970 A list of the number of spaces that a <Tab> counts for while editing,
8971 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8972 width <Tab>s are being inserted, while in fact a mixture of spaces
8973 and <Tab>s is used. Tab widths are separated with commas, with the
8974 final value applying to all subsequent tabs.
8975
8976 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008977 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008978 to use the following: >
8979 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008980< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8981 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008982
8983 Note that the value of |'softtabstop'| will be ignored while
8984 'varsofttabstop' is set.
8985
8986 *'vartabstop'* *'vts'*
8987'vartabstop' 'vts' string (default "")
8988 local to buffer
8989 {only available when compiled with the |+vartabs|
8990 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008991 A list of the number of spaces that a <Tab> in the file counts for,
8992 separated by commas. Each value corresponds to one tab, with the
8993 final value applying to all subsequent tabs. For example: >
8994 :set vartabstop=4,20,10,8
8995< This will make the first tab 4 spaces wide, the second 20 spaces,
8996 the third 10 spaces, and all following tabs 8 spaces.
8997
8998 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8999 is set.
9000
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 *'verbose'* *'vbs'*
9002'verbose' 'vbs' number (default 0)
9003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 When bigger than zero, Vim will give messages about what it is doing.
9005 Currently, these messages are given:
9006 >= 1 When the viminfo file is read or written.
9007 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009008 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009009 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 >= 8 Files for which a group of autocommands is executed.
9011 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009012 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 >= 12 Every executed function.
9014 >= 13 When an exception is thrown, caught, finished, or discarded.
9015 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009016 >= 15 Every executed Ex command from a script (truncated at 200
9017 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009018 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019
9020 This option can also be set with the "-V" argument. See |-V|.
9021 This option is also set by the |:verbose| command.
9022
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009023 When the 'verbosefile' option is set then the verbose messages are not
9024 displayed.
9025
9026 *'verbosefile'* *'vfile'*
9027'verbosefile' 'vfile' string (default empty)
9028 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009029 When not empty all messages are written in a file with this name.
9030 When the file exists messages are appended.
9031 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009032 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009033 Setting 'verbosefile' to a new value is like making it empty first.
9034 The difference with |:redir| is that verbose messages are not
9035 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009036 This option cannot be set from a |modeline| or in the |sandbox|, for
9037 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009038
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009040'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009041 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009042 for Unix: "$HOME/.vim/view" or
9043 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009044 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009045 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009047 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 feature}
9049 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009050 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 This option cannot be set from a |modeline| or in the |sandbox|, for
9052 security reasons.
9053
9054 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009055'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009057 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009059 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009060 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009061 word save and restore ~
9062 cursor cursor position in file and in window
9063 folds manually created folds, opened/closed folds and local
9064 fold options
9065 options options and mappings local to a window or buffer (not
9066 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009067 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 slash backslashes in file names replaced with forward
9069 slashes
9070 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009071 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009072 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009074 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009076 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077
9078 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009079'viminfo' 'vi' string (Vi default: "", Vim default for
9080 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009081 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9082 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009084 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085 feature}
9086 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009087 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9088 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009089 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009090 consisting of a single character identifying the particular parameter,
9091 followed by a number or string which specifies the value of that
9092 parameter. If a particular character is left out, then the default
9093 value is used for that parameter. The following is a list of the
9094 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009096 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 ! When included, save and restore global variables that start
9098 with an uppercase letter, and don't contain a lowercase
9099 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009100 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009101 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009102 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 " Maximum number of lines saved for each register. Old name of
9104 the '<' item, with the disadvantage that you need to put a
9105 backslash before the ", otherwise it will be recognized as the
9106 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009107 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 % When included, save and restore the buffer list. If Vim is
9109 started with a file name argument, the buffer list is not
9110 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009111 buffer list is restored from the viminfo file. Quickfix
9112 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9113 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009114 When followed by a number, the number specifies the maximum
9115 number of buffers that are stored. Without a number all
9116 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009117 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 ' Maximum number of previously edited files for which the marks
9119 are remembered. This parameter must always be included when
9120 'viminfo' is non-empty.
9121 Including this item also means that the |jumplist| and the
9122 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009123 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009125 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126 patterns are also saved. When not included, the value of
9127 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009128 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009130 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009131 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132 < Maximum number of lines saved for each register. If zero then
9133 registers are not saved. When not included, all lines are
9134 saved. '"' is the old name for this item.
9135 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009136 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009138 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009139 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 c When included, convert the text in the viminfo file from the
9141 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009142 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009143 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 f Whether file marks need to be stored. If zero, file marks ('0
9145 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009146 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009148 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 h Disable the effect of 'hlsearch' when loading the viminfo
9150 file. When not included, it depends on whether ":nohlsearch"
9151 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009152 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009154 the 'n'. Must be at the end of the option! If the
9155 'viminfofile' option is set, that file name overrides the one
9156 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009157 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009158 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 r Removable media. The argument is a string (up to the next
9160 ','). This parameter can be given several times. Each
9161 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009162 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009163 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9164 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9165 ignored. Maximum length of each 'r' argument is 50
9166 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009167 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009168 s Maximum size of an item in Kbyte. If zero then registers are
9169 not saved. Currently only applies to registers. The default
9170 "s10" will exclude registers with more than 10 Kbyte of text.
9171 Also see the '<' item above: line count limit.
9172
9173 Example: >
9174 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9175<
9176 '50 Marks will be remembered for the last 50 files you
9177 edited.
9178 <1000 Contents of registers (up to 1000 lines each) will be
9179 remembered.
9180 s100 Registers with more than 100 Kbyte text are skipped.
9181 :0 Command-line history will not be saved.
9182 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9183 no / Since '/' is not specified, the default will be used,
9184 that is, save all of the search history, and also the
9185 previous search and substitute patterns.
9186 no % The buffer list will not be saved nor read back.
9187 no h 'hlsearch' highlighting will be restored.
9188
9189 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9190 load the contents of the file, this is not done automatically.
9191
9192 This option cannot be set from a |modeline| or in the |sandbox|, for
9193 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009194 NOTE: This option is set to the Vim default value when 'compatible'
9195 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009197 *'viminfofile'* *'vif'*
9198'viminfofile' 'vif' string (default: "")
9199 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009200 {not available when compiled without the |+viminfo|
9201 feature}
9202 When non-empty, overrides the file name used for viminfo.
9203 When equal to "NONE" no viminfo file will be read or written.
9204 This option can be set with the |-i| command line flag. The |--clean|
9205 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009206 This option cannot be set from a |modeline| or in the |sandbox|, for
9207 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009208
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 *'virtualedit'* *'ve'*
9210'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009211 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009212 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009213 block Allow virtual editing in Visual block mode.
9214 insert Allow virtual editing in Insert mode.
9215 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009216 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009217 none When used as the local value, do not allow virtual
9218 editing even when the global value is set. When used
9219 as the global value, "none" is the same as "".
9220 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009221
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009223 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 of the line. Useful for selecting a rectangle in Visual mode and
9225 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009226 "onemore" is not the same, it will only allow moving the cursor just
9227 after the last character of the line. This makes some commands more
9228 consistent. Previously the cursor was always past the end of the line
9229 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009230 break some plugins or Vim scripts. For example because |l| can move
9231 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009232 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009233 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009234 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009235 It doesn't make sense to combine "all" with "onemore", but you will
9236 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009237 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009238 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239
9240 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9241'visualbell' 'vb' boolean (default off)
9242 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009243 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009244 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009245 use: >
9246 :set vb t_vb=
9247< If you want a short flash, you can use this on many terminals: >
9248 :set vb t_vb=[?5h$<100>[?5l
9249< Here $<100> specifies the time, you can use a smaller or bigger value
9250 to get a shorter or longer flash.
9251
9252 Note: Vim will limit the bell to once per half a second. This avoids
9253 having to wait for the flashing to finish when there are lots of
9254 bells, e.g. on key repeat. This also happens without 'visualbell'
9255 set.
9256
Bram Moolenaar071d4272004-06-13 20:20:40 +00009257 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9258 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9259 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009260
9261 Note: When the GUI starts, 't_vb' is reset to its default value. You
9262 might want to set it again in your |gvimrc|.
9263
Bram Moolenaar071d4272004-06-13 20:20:40 +00009264 Does not work on the Amiga, you always get a screen flash.
9265 Also see 'errorbells'.
9266
9267 *'warn'* *'nowarn'*
9268'warn' boolean (default on)
9269 global
9270 Give a warning message when a shell command is used while the buffer
9271 has been changed.
9272
9273 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9274'weirdinvert' 'wiv' boolean (default off)
9275 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009276 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 It is provided for backwards compatibility with version 4.x.
9278 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9279 vice versa. Has no effect when the GUI is running.
9280
9281 *'whichwrap'* *'ww'*
9282'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 Allow specified keys that move the cursor left/right to move to the
9285 previous/next line when the cursor is on the first/last character in
9286 the line. Concatenate characters to allow this for these keys:
9287 char key mode ~
9288 b <BS> Normal and Visual
9289 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009290 h "h" Normal and Visual (not recommended)
9291 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 < <Left> Normal and Visual
9293 > <Right> Normal and Visual
9294 ~ "~" Normal
9295 [ <Left> Insert and Replace
9296 ] <Right> Insert and Replace
9297 For example: >
9298 :set ww=<,>,[,]
9299< allows wrap only when cursor keys are used.
9300 When the movement keys are used in combination with a delete or change
9301 operator, the <EOL> also counts for a character. This makes "3h"
9302 different from "3dh" when the cursor crosses the end of a line. This
9303 is also true for "x" and "X", because they do the same as "dl" and
9304 "dh". If you use this, you may also want to use the mapping
9305 ":map <BS> X" to make backspace delete the character in front of the
9306 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009307 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009308 line (not an empty line) then it will not move to the next line. This
9309 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 NOTE: This option is set to the Vi default value when 'compatible' is
9311 set and to the Vim default value when 'compatible' is reset.
9312
9313 *'wildchar'* *'wc'*
9314'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 Character you have to type to start wildcard expansion in the
9317 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009318 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 The character is not recognized when used inside a macro. See
9320 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009321 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009322 <Esc> can be used, but hitting it twice in a row will still exit
9323 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009324 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009325 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326< NOTE: This option is set to the Vi default value when 'compatible' is
9327 set and to the Vim default value when 'compatible' is reset.
9328
9329 *'wildcharm'* *'wcm'*
9330'wildcharm' 'wcm' number (default: none (0))
9331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009332 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009333 recognized when used inside a macro. You can find "spare" command-line
9334 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009335 you'll never actually type 'wildcharm', just use it in mappings that
9336 automatically invoke completion mode, e.g.: >
9337 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009338 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339< Then after typing :ss you can use CTRL-P & CTRL-N.
9340
9341 *'wildignore'* *'wig'*
9342'wildignore' 'wig' string (default "")
9343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009345 patterns is ignored when expanding |wildcards|, completing file or
9346 directory names, and influences the result of |expand()|, |glob()| and
9347 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9349 Also see 'suffixes'.
9350 Example: >
9351 :set wildignore=*.o,*.obj
9352< The use of |:set+=| and |:set-=| is preferred when adding or removing
9353 a pattern from the list. This avoids problems when a future version
9354 uses another default.
9355
h_east596a9f22023-11-21 21:24:23 +09009356 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009357'wildignorecase' 'wic' boolean (default off)
9358 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009359 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009360 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009361 Does not apply when the shell is used to expand wildcards, which
9362 happens when there are special characters.
9363
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009365'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 When 'wildmenu' is on, command-line completion operates in an enhanced
9368 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009369 the possible matches are shown.
9370 When 'wildoptions' contains "pum", then the completion matches are
9371 shown in a popup menu. Otherwise they are displayed just above the
9372 command line, with the first match highlighted (overwriting the status
9373 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009374 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009375 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9376 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9377 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009378 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379 If there are more matches than can fit in the line, a ">" is shown on
9380 the right and/or a "<" is shown on the left. The status line scrolls
9381 as needed.
9382 The "wildmenu" mode is abandoned when a key is hit that is not used
9383 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009384 While the "wildmenu" is active, the following keys have special
9385 meanings:
9386 CTRL-P - go to the previous entry
9387 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009388 <CR> - in menu completion, when the cursor is just after a
9389 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009390 CTRL-E - end completion, go back to what was there before
9391 selecting a match.
9392 CTRL-Y - accept the currently selected match and stop
9393 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009394
9395 When not using the popup menu for command line completion, the
9396 following keys have special meanings:
9397 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009398 <Up> - in filename/menu name completion: move up into
9399 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009400 <Down> - in filename/menu name completion: move into a
9401 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009403 When using the popup menu for command line completion, the following
9404 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009405 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009406 <PageUp> - select a match several entries back
9407 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009408 <Left> - in filename/menu name completion: move up into
9409 parent directory or parent menu.
9410 <Right> - in filename/menu name completion: move into a
9411 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009412
Bram Moolenaar071d4272004-06-13 20:20:40 +00009413 This makes the menus accessible from the console |console-menus|.
9414
9415 If you prefer the <Left> and <Right> keys to move the cursor instead
9416 of selecting a different match, use this: >
9417 :cnoremap <Left> <Space><BS><Left>
9418 :cnoremap <Right> <Space><BS><Right>
9419<
9420 The "WildMenu" highlighting is used for displaying the current match
9421 |hl-WildMenu|.
9422
9423 *'wildmode'* *'wim'*
9424'wildmode' 'wim' string (Vim default: "full")
9425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009426 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009427 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009428 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009429 first part specifies the behavior for the first use of 'wildchar',
9430 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009431
9432 Each part consists of a colon separated list consisting of the
9433 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009434 "" Complete only the first match.
9435 "full" Complete the next full match. After the last match,
9436 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009437 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009438 "longest" Complete till longest common string. If this doesn't
9439 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009440 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009441 "lastused" When completing buffer names and more than one buffer
9442 matches, sort buffers by time last used (other than
9443 the current buffer).
9444 When there is only a single match, it is fully completed in all cases.
9445
9446 Examples of useful colon-separated values:
9447 "longest:full" Like "longest", but also start 'wildmenu' if it is
9448 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009449 "list:full" When more than one match, list all matches and
9450 complete first match.
9451 "list:longest" When more than one match, list all matches and
9452 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009453 "list:lastused" When more than one buffer matches, list all matches
9454 and sort buffers by time last used (other than the
9455 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009456
9457 Examples: >
9458 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009459< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009460 :set wildmode=longest,full
9461< Complete longest common string, then each full match >
9462 :set wildmode=list:full
9463< List all matches and complete each full match >
9464 :set wildmode=list,full
9465< List all matches without completing, then each full match >
9466 :set wildmode=longest,list
9467< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009468 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009469
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009470 *'wildoptions'* *'wop'*
9471'wildoptions' 'wop' string (default "")
9472 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009473 A list of words that change how |cmdline-completion| is done.
9474 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009475 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009476 this value is specified, wildcard expansion will not
9477 be used for completion. The matches will be sorted by
9478 the "best match" rather than alphabetically sorted.
9479 This will find more matches than the wildcard
9480 expansion. Currently fuzzy matching based completion
9481 is not supported for file and directory names and
9482 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009483 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009484 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009485 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009486 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009487 is displayed per line. Often used tag kinds are:
9488 d #define
9489 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009490
Bram Moolenaar071d4272004-06-13 20:20:40 +00009491 *'winaltkeys'* *'wak'*
9492'winaltkeys' 'wak' string (default "menu")
9493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009494 {only used in Win32, Motif, GTK and Photon GUI}
9495 Some GUI versions allow the access to menu entries by using the ALT
9496 key in combination with a character that appears underlined in the
9497 menu. This conflicts with the use of the ALT key for mappings and
9498 entering special characters. This option tells what to do:
9499 no Don't use ALT keys for menus. ALT key combinations can be
9500 mapped, but there is no automatic handling. This can then be
9501 done with the |:simalt| command.
9502 yes ALT key handling is done by the windowing system. ALT key
9503 combinations cannot be mapped.
9504 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009505 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009506 keys can be mapped.
9507 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9508 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009509 This option is not used for <F10>; on Win32 and with GTK <F10> will
9510 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009512 *'wincolor'* *'wcr'*
9513'wincolor' 'wcr' string (default empty)
9514 local to window
9515 Highlight group name to use for this window instead of the Normal
9516 color |hl-Normal|.
9517
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009518 *'window'* *'wi'*
9519'window' 'wi' number (default screen height - 1)
9520 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009521 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9522 window and the value is smaller than 'lines' minus one. The screen
9523 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009524 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9525 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009526 When resizing the Vim window, and the value is smaller than 1 or more
9527 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009528 Note: Do not confuse this with the height of the Vim window, use
9529 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009530
Colin Kennedy21570352024-03-03 16:16:47 +01009531 *'winfixbuf'*
9532'winfixbuf' 'wfb' boolean (default off)
9533 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009534 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009535 For example, attempting to change the buffer with |:edit| will fail.
9536 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009537 also skip any window with 'winfixbuf' enabled. However if an Ex
9538 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009539
laburnumT3f7855a2023-12-05 18:37:03 +01009540 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9541'winfixheight' 'wfh' boolean (default off)
9542 local to window |local-noglobal|
9543 Keep the window height when windows are opened or closed and
9544 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9545 |preview-window| and |quickfix-window|.
9546 The height may be changed anyway when running out of room.
9547
9548 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9549'winfixwidth' 'wfw' boolean (default off)
9550 local to window |local-noglobal|
9551 Keep the window width when windows are opened or closed and
9552 'equalalways' is set. Also for |CTRL-W_=|.
9553 The width may be changed anyway when running out of room.
9554
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 *'winheight'* *'wh'* *E591*
9556'winheight' 'wh' number (default 1)
9557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009558 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009559 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009560 focus goes to a window that is smaller, its size is increased, at the
9561 cost of the height of other windows.
9562 Set 'winheight' to a small number for normal editing.
9563 Set it to 999 to make the current window fill most of the screen.
9564 Other windows will be only 'winminheight' high. This has the drawback
9565 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9566 to create only two windows, set the option after startup is done,
9567 using the |VimEnter| event: >
9568 au VimEnter * set winheight=999
9569< Minimum value is 1.
9570 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009571 height of the current window.
9572 'winheight' applies to the current window. Use 'winminheight' to set
9573 the minimal height for other windows.
9574
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 *'winminheight'* *'wmh'*
9576'winminheight' 'wmh' number (default 1)
9577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578 The minimal height of a window, when it's not the current window.
9579 This is a hard minimum, windows will never become smaller.
9580 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9581 status bar) if necessary. They will return to at least one line when
9582 they become active (since the cursor has to have somewhere to go.)
9583 Use 'winheight' to set the minimal height of the current window.
9584 This option is only checked when making a window smaller. Don't use a
9585 large number, it will cause errors when opening more than a few
9586 windows. A value of 0 to 3 is reasonable.
9587
9588 *'winminwidth'* *'wmw'*
9589'winminwidth' 'wmw' number (default 1)
9590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591 The minimal width of a window, when it's not the current window.
9592 This is a hard minimum, windows will never become smaller.
9593 When set to zero, windows may be "squashed" to zero columns (i.e. just
9594 a vertical separator) if necessary. They will return to at least one
9595 line when they become active (since the cursor has to have somewhere
9596 to go.)
9597 Use 'winwidth' to set the minimal width of the current window.
9598 This option is only checked when making a window smaller. Don't use a
9599 large number, it will cause errors when opening more than a few
9600 windows. A value of 0 to 12 is reasonable.
9601
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009602 *'winptydll'*
9603'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9604 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009605 {only available when compiled with the |terminal|
9606 feature on MS-Windows}
9607 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009608 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009609 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009610 a fallback.
9611 Environment variables are expanded |:set_env|.
9612 This option cannot be set from a |modeline| or in the |sandbox|, for
9613 security reasons.
9614
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 *'winwidth'* *'wiw'* *E592*
9616'winwidth' 'wiw' number (default 20)
9617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 Minimal number of columns for the current window. This is not a hard
9619 minimum, Vim will use fewer columns if there is not enough room. If
9620 the current window is smaller, its size is increased, at the cost of
9621 the width of other windows. Set it to 999 to make the current window
9622 always fill the screen. Set it to a small number for normal editing.
9623 The width is not adjusted after one of the commands to change the
9624 width of the current window.
9625 'winwidth' applies to the current window. Use 'winminwidth' to set
9626 the minimal width for other windows.
9627
9628 *'wrap'* *'nowrap'*
9629'wrap' boolean (default on)
9630 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009631 This option changes how text is displayed. It doesn't change the text
9632 in the buffer, see 'textwidth' for that.
9633 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009634 displaying continues on the next line. When off lines will not wrap
9635 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009636 moved to a part that is not shown, the screen will scroll
9637 horizontally.
9638 The line will be broken in the middle of a word if necessary. See
9639 'linebreak' to get the break at a word boundary.
9640 To make scrolling horizontally a bit more useful, try this: >
9641 :set sidescroll=5
9642 :set listchars+=precedes:<,extends:>
9643< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009644 This option can't be set from a |modeline| when the 'diff' option is
9645 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009646
9647 *'wrapmargin'* *'wm'*
9648'wrapmargin' 'wm' number (default 0)
9649 local to buffer
9650 Number of characters from the right window border where wrapping
9651 starts. When typing text beyond this limit, an <EOL> will be inserted
9652 and inserting continues on the next line.
9653 Options that add a margin, such as 'number' and 'foldcolumn', cause
9654 the text width to be further reduced. This is Vi compatible.
9655 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009656 This option is set to 0 when 'paste' is set and restored when 'paste'
9657 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009658 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009659
9660 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9661'wrapscan' 'ws' boolean (default on) *E384* *E385*
9662 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009663 Searches wrap around the end of the file. Also applies to |]s| and
9664 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009665
9666 *'write'* *'nowrite'*
9667'write' boolean (default on)
9668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009669 Allows writing files. When not set, writing a file is not allowed.
9670 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009671 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009672 argument. Filtering text is still possible, even though this requires
9673 writing a temporary file.
9674
9675 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9676'writeany' 'wa' boolean (default off)
9677 global
9678 Allows writing to any file with no need for "!" override.
9679
9680 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9681'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9682 otherwise)
9683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009684 Make a backup before overwriting a file. The backup is removed after
9685 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009686 also on.
9687 WARNING: Switching this option off means that when Vim fails to write
9688 your buffer correctly and then, for whatever reason, Vim exits, you
9689 lose both the original file and what you were writing. Only reset
9690 this option if your file system is almost full and it makes the write
9691 fail (and make sure not to exit Vim until the write was successful).
9692 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009693 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009694 Depending on 'backupcopy' the backup is a new file or the original
9695 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009696 NOTE: This option is set to the default value when 'compatible' is
9697 set.
9698
9699 *'writedelay'* *'wd'*
9700'writedelay' 'wd' number (default 0)
9701 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009702 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009703 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009704 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009705
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009706 *'xtermcodes'* *'noxtermcodes'*
9707'xtermcodes' boolean (default on)
9708 global
9709 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009710 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009711 key codes and number of colors from the terminal. This takes care of
9712 various configuration options of the terminal that cannot be obtained
9713 from the termlib/terminfo entry, see |xterm-codes|.
9714 A side effect may be that t_Co changes and Vim will redraw the
9715 display.
9716
9717
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009718 vim:tw=78:ts=8:noet:ft=help:norl: