blob: 26779ad8e4b8bc353770c701ca5ce278f701a24b [file] [log] [blame]
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02001*options.txt* For Vim version 9.1. Last change: 2024 Sep 10
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).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001494 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001495 list:-1 Uses the width of a match with 'formatlistpat' for
1496 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 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
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002151 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002152
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002153 *'completepopup'* *'cpp'*
2154'completepopup' 'cpp' string (default empty)
2155 global
2156 {not available when compiled without the |+textprop|
2157 or |+quickfix| feature}
2158 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002159 properties of the info popup when it is created. If an info popup
2160 window already exists it is closed, so that the option value is
2161 applied when it is created again.
2162 You can also use |popup_findinfo()| and then set properties for an
2163 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002164
laburnumT3f7855a2023-12-05 18:37:03 +01002165 *'completeslash'* *'csl'*
2166'completeslash' 'csl' string (default: "")
2167 local to buffer
2168 {only for MS-Windows}
2169 When this option is set it overrules 'shellslash' for completion:
2170 - When this option is set to "slash", a forward slash is used for path
2171 completion in insert mode. This is useful when editing HTML tag, or
2172 Makefile with 'noshellslash' on MS-Windows.
2173 - When this option is set to "backslash", backslash is used. This is
2174 useful when editing a batch file with 'shellslash' set on MS-Windows.
2175 - When this option is empty, same character is used as for
2176 'shellslash'.
2177 For Insert mode completion the buffer-local value is used. For
2178 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002179
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002180 *'concealcursor'* *'cocu'*
2181'concealcursor' 'cocu' string (default: "")
2182 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002183 {not available when compiled without the |+conceal|
2184 feature}
2185 Sets the modes in which text in the cursor line can also be concealed.
2186 When the current mode is listed then concealing happens just like in
2187 other lines.
2188 n Normal mode
2189 v Visual mode
2190 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002191 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002192
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002193 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002194 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002195 are moving around text is concealed, but when starting to insert text
2196 or selecting a Visual area the concealed text is displayed, so that
2197 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002198 Keep in mind that the cursor position is not always where it's
2199 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002200
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002201 *'conceallevel'* *'cole'*
2202'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002203 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002204 {not available when compiled without the |+conceal|
2205 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002206 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2207 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002208
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002209 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002210 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002211 1 Each block of concealed text is replaced with one
2212 character. If the syntax item does not have a custom
2213 replacement character defined (see |:syn-cchar|) the
2214 character defined in 'listchars' is used (default is a
2215 space).
2216 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002217 2 Concealed text is completely hidden unless it has a
2218 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002219 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002220 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002221
Bram Moolenaara7781e02010-07-19 20:13:22 +02002222 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002223 edit and copy the text. This can be changed with the 'concealcursor'
2224 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002225
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2227'confirm' 'cf' boolean (default off)
2228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 When 'confirm' is on, certain operations that would normally
2230 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2231 instead raise a |dialog| asking if you wish to save the current
2232 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2233 If 'confirm' is off you can still activate confirmation for one
2234 command only (this is most useful in mappings) with the |:confirm|
2235 command.
2236 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2237
2238 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2239'conskey' 'consk' boolean (default off)
2240 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002241 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242
2243 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2244'copyindent' 'ci' boolean (default off)
2245 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 Copy the structure of the existing lines indent when autoindenting a
2247 new line. Normally the new indent is reconstructed by a series of
2248 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2249 in which case only spaces are used). Enabling this option makes the
2250 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002251 existing line. 'expandtab' has no effect on these characters, a Tab
2252 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002254 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 Also see 'preserveindent'.
2256
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002257 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002258'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2259 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002260 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002263 this indicates Vi-compatible behavior. This is used for things where
2264 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 'cpoptions' stands for "compatible-options".
2266 Commas can be added for readability.
2267 To avoid problems with flags that are added in the future, use the
2268 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002269
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 NOTE: This option is set to the Vi default value when 'compatible' is
2271 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002272
2273 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2274 is saved, 'cpoptions' is set to the Vim default, and the saved value
2275 is restored at the end of the script. Changes to the value of
2276 'cpoptions' will be applied to the saved value, but keep in mind that
2277 removing a flag that is not present when 'cpoptions' is changed has no
2278 effect. In the |.vimrc| file the value is not restored, thus using
2279 `vim9script` in the |.vimrc| file results in using the Vim default.
2280
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002281 NOTE: This option is set to the POSIX default value at startup when
2282 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002283 variable exists |posix|. This means Vim tries to behave like the
2284 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285
2286 contains behavior ~
2287 *cpo-a*
2288 a When included, a ":read" command with a file name
2289 argument will set the alternate file name for the
2290 current window.
2291 *cpo-A*
2292 A When included, a ":write" command with a file name
2293 argument will set the alternate file name for the
2294 current window.
2295 *cpo-b*
2296 b "\|" in a ":map" command is recognized as the end of
2297 the map command. The '\' is included in the mapping,
2298 the text after the '|' is interpreted as the next
2299 command. Use a CTRL-V instead of a backslash to
2300 include the '|' in the mapping. Applies to all
2301 mapping, abbreviation, menu and autocmd commands.
2302 See also |map_bar|.
2303 *cpo-B*
2304 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002305 abbreviations, user commands and the "to" part of the
2306 menu commands. Remove this flag to be able to use a
2307 backslash like a CTRL-V. For example, the command
2308 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 'B' included: "\^[" (^[ is a real <Esc>)
2310 'B' excluded: "<Esc>" (5 characters)
2311 ('<' excluded in both cases)
2312 *cpo-c*
2313 c Searching continues at the end of any match at the
2314 cursor position, but not further than the start of the
2315 next line. When not present searching continues
2316 one character from the cursor position. With 'c'
2317 "abababababab" only gets three matches when repeating
2318 "/abab", without 'c' there are five matches.
2319 *cpo-C*
2320 C Do not concatenate sourced lines that start with a
2321 backslash. See |line-continuation|.
2322 *cpo-d*
2323 d Using "./" in the 'tags' option doesn't mean to use
2324 the tags file relative to the current file, but the
2325 tags file in the current directory.
2326 *cpo-D*
2327 D Can't use CTRL-K to enter a digraph after Normal mode
2328 commands with a character argument, like |r|, |f| and
2329 |t|.
2330 *cpo-e*
2331 e When executing a register with ":@r", always add a
2332 <CR> to the last line, also when the register is not
2333 linewise. If this flag is not present, the register
2334 is not linewise and the last line does not end in a
2335 <CR>, then the last line is put on the command-line
2336 and can be edited before hitting <CR>.
2337 *cpo-E*
2338 E It is an error when using "y", "d", "c", "g~", "gu" or
2339 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002340 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 This makes "y0" fail in the first column.
2342 *cpo-f*
2343 f When included, a ":read" command with a file name
2344 argument will set the file name for the current buffer,
2345 if the current buffer doesn't have a file name yet.
2346 *cpo-F*
2347 F When included, a ":write" command with a file name
2348 argument will set the file name for the current
2349 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002350 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 *cpo-g*
2352 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002353 *cpo-H*
2354 H When using "I" on a line with only blanks, insert
2355 before the last blank. Without this flag insert after
2356 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 *cpo-i*
2358 i When included, interrupting the reading of a file will
2359 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002360 *cpo-I*
2361 I When moving the cursor up or down just after inserting
2362 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 *cpo-j*
2364 j When joining lines, only add two spaces after a '.',
2365 not after '!' or '?'. Also see 'joinspaces'.
2366 *cpo-J*
2367 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002368 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 white space.
2370 *cpo-k*
2371 k Disable the recognition of raw key codes in
2372 mappings, abbreviations, and the "to" part of menu
2373 commands. For example, if <Key> sends ^[OA (where ^[
2374 is <Esc>), the command ":map X ^[OA" results in X
2375 being mapped to:
2376 'k' included: "^[OA" (3 characters)
2377 'k' excluded: "<Key>" (one key code)
2378 Also see the '<' flag below.
2379 *cpo-K*
2380 K Don't wait for a key code to complete when it is
2381 halfway a mapping. This breaks mapping <F1><F1> when
2382 only part of the second <F1> has been read. It
2383 enables cancelling the mapping by typing <F1><Esc>.
2384 *cpo-l*
2385 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002386 literally, only "\]", "\^", "\-" and "\\" are special.
2387 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2389 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002390 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 *cpo-L*
2392 L When the 'list' option is set, 'wrapmargin',
2393 'textwidth', 'softtabstop' and Virtual Replace mode
2394 (see |gR|) count a <Tab> as two characters, instead of
2395 the normal behavior of a <Tab>.
2396 *cpo-m*
2397 m When included, a showmatch will always wait half a
2398 second. When not included, a showmatch will wait half
2399 a second or until a character is typed. |'showmatch'|
2400 *cpo-M*
2401 M When excluded, "%" matching will take backslashes into
2402 account. Thus in "( \( )" and "\( ( \)" the outer
2403 parenthesis match. When included "%" ignores
2404 backslashes, which is Vi compatible.
2405 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002406 n When included, the column used for 'number' and
2407 'relativenumber' will also be used for text of wrapped
2408 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 *cpo-o*
2410 o Line offset to search command is not remembered for
2411 next search.
2412 *cpo-O*
2413 O Don't complain if a file is being overwritten, even
2414 when it didn't exist when editing it. This is a
2415 protection against a file unexpectedly created by
2416 someone else. Vi didn't complain about this.
2417 *cpo-p*
2418 p Vi compatible Lisp indenting. When not present, a
2419 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002420 *cpo-P*
2421 P When included, a ":write" command that appends to a
2422 file will set the file name for the current buffer, if
2423 the current buffer doesn't have a file name yet and
2424 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002425 *cpo-q*
2426 q When joining multiple lines leave the cursor at the
2427 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 *cpo-r*
2429 r Redo ("." command) uses "/" to repeat a search
2430 command, instead of the actually used search string.
2431 *cpo-R*
2432 R Remove marks from filtered lines. Without this flag
2433 marks are kept like |:keepmarks| was used.
2434 *cpo-s*
2435 s Set buffer options when entering the buffer for the
2436 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002437 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 set when the buffer is created.
2439 *cpo-S*
2440 S Set buffer options always when entering a buffer
2441 (except 'readonly', 'fileformat', 'filetype' and
2442 'syntax'). This is the (most) Vi compatible setting.
2443 The options are set to the values in the current
2444 buffer. When you change an option and go to another
2445 buffer, the value is copied. Effectively makes the
2446 buffer options global to all buffers.
2447
2448 's' 'S' copy buffer options
2449 no no when buffer created
2450 yes no when buffer first entered (default)
2451 X yes each time when buffer entered (vi comp.)
2452 *cpo-t*
2453 t Search pattern for the tag command is remembered for
2454 "n" command. Otherwise Vim only puts the pattern in
2455 the history for search pattern, but doesn't change the
2456 last used search pattern.
2457 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002458 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 *cpo-v*
2460 v Backspaced characters remain visible on the screen in
2461 Insert mode. Without this flag the characters are
2462 erased from the screen right away. With this flag the
2463 screen newly typed text overwrites backspaced
2464 characters.
2465 *cpo-w*
2466 w When using "cw" on a blank character, only change one
2467 character and not all blanks until the start of the
2468 next word.
2469 *cpo-W*
2470 W Don't overwrite a readonly file. When omitted, ":w!"
2471 overwrites a readonly file, if possible.
2472 *cpo-x*
2473 x <Esc> on the command-line executes the command-line.
2474 The default in Vim is to abandon the command-line,
2475 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476 *cpo-X*
2477 X When using a count with "R" the replaced text is
2478 deleted only once. Also when repeating "R" with "."
2479 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002481 y A yank command can be redone with ".". Think twice if
2482 you really want to use this, it may break some
2483 plugins, since most people expect "." to only repeat a
2484 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002485 *cpo-Z*
2486 Z When using "w!" while the 'readonly' option is set,
2487 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002488 *cpo-z*
2489 z Special casing the "cw" and "d" command (see |cw| and
2490 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 *cpo-!*
2492 ! When redoing a filter command, use the last used
2493 external command, whatever it was. Otherwise the last
2494 used -filter- command is used.
2495 *cpo-$*
2496 $ When making a change to one line, don't redisplay the
2497 line, but put a '$' at the end of the changed text.
2498 The changed text will be overwritten when you type the
2499 new text. The line is redisplayed if you type any
2500 command that moves the cursor from the insertion
2501 point.
2502 *cpo-%*
2503 % Vi-compatible matching is done for the "%" command.
2504 Does not recognize "#if", "#endif", etc.
2505 Does not recognize "/*" and "*/".
2506 Parens inside single and double quotes are also
2507 counted, causing a string that contains a paren to
2508 disturb the matching. For example, in a line like
2509 "if (strcmp("foo(", s))" the first paren does not
2510 match the last one. When this flag is not included,
2511 parens inside single and double quotes are treated
2512 specially. When matching a paren outside of quotes,
2513 everything inside quotes is ignored. When matching a
2514 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002515 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002516 This flag is also used for other features, such as
2517 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002518 *cpo--*
2519 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002520 it would go above the first line or below the last
2521 line. Without it the cursor moves to the first or
2522 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002523 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002524 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002525 *cpo-+*
2526 + When included, a ":write file" command will reset the
2527 'modified' flag of the buffer, even though the buffer
2528 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002529 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 * Use ":*" in the same way as ":@". When not included,
2531 ":*" is an alias for ":'<,'>", select the Visual area.
2532 *cpo-<*
2533 < Disable the recognition of special key codes in |<>|
2534 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002535 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 ":map X <Tab>" results in X being mapped to:
2537 '<' included: "<Tab>" (5 characters)
2538 '<' excluded: "^I" (^I is a real <Tab>)
2539 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002540 *cpo->*
2541 > When appending to a register, put a line break before
2542 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002543 *cpo-;*
2544 ; When using |,| or |;| to repeat the last |t| search
2545 and the cursor is right in front of the searched
2546 character, the cursor won't move. When not included,
2547 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002548 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002549
2550 POSIX flags. These are not included in the Vi default value, except
2551 when $VIM_POSIX was set on startup. |posix|
2552
2553 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002554 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002555 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002556 *cpo-&*
2557 & When ":preserve" was used keep the swap file when
2558 exiting normally while this buffer is still loaded.
2559 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002560 *cpo-\*
2561 \ Backslash in a [] range in a search pattern is taken
2562 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002563 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2564 '\' excluded: "/[ \-]" finds <Space> and '-'
2565 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002566 *cpo-/*
2567 / When "%" is used as the replacement string in a |:s|
2568 command, use the previous replacement string. |:s%|
2569 *cpo-{*
2570 { The |{| and |}| commands also stop at a "{" character
2571 at the start of a line.
2572 *cpo-.*
2573 . The ":chdir" and ":cd" commands fail if the current
2574 buffer is modified, unless ! is used. Vim doesn't
2575 need this, since it remembers the full path of an
2576 opened file.
2577 *cpo-bar*
2578 | The value of the $LINES and $COLUMNS environment
2579 variables overrule the terminal size values obtained
2580 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002581
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002582 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002583'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002584 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002585 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002586 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002587 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002588 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002589 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002590 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002591 blowfish Blowfish method. Medium strong encryption but it has
2592 an implementation flaw. Requires Vim 7.3 or later,
2593 files can NOT be read by Vim 7.2 and older. This adds
2594 a "seed" to the file, every time you write the file
2595 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002596 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002597 *blowfish2*
2598 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002599 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002600 and older. This adds a "seed" to the file, every time
2601 you write the file the encrypted bytes will be
2602 different. The whole undo file is encrypted, not just
2603 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002604 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002605 *E1197* *E1198* *E1199* *E1200* *E1201*
2606 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2607 Code. Medium strong till strong encryption.
2608 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002609 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002610 It adds a seed and a message authentication code (MAC)
2611 to the file. This needs at least a Vim 8.2.3022 to
2612 read the encrypted file.
2613 Encryption of swap files is not supported, therefore
2614 no swap file will be used when xchacha20 encryption is
2615 enabled.
2616 Encryption of undo files is not yet supported,
2617 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002618 CAREFUL: Files written with this method might have to
2619 be read back with the same version of Vim if the
2620 binary format changes later.
2621 Obsolete, please do no longer use.
2622 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2623 stores the key derivation parameters together with the
2624 encrypted file. Should work better in case the
2625 parameters in the libsodium library ever change.
2626 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002627 might have to be read back with the same version of
2628 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002629
Christian Brabandtaae58342023-04-23 17:50:22 +01002630 You should use "blowfish2", also to re-encrypt older files. The
2631 "xchacha20" method provides better encryption, but it does not work
2632 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002633
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002634 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002635 to the detected method of the file being read. Thus if you write it
2636 without changing 'cryptmethod' the same method will be used.
2637 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002638 explicitly write it, you don't get a warning unless there are other
2639 modifications. Also see |:X|.
2640
2641 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002642 the value "blowfish2". When setting the local value to an empty
2643 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002644
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002645 When a new encryption method is added in a later version of Vim, and
2646 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002647 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002648
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 *'cscopepathcomp'* *'cspc'*
2650'cscopepathcomp' 'cspc' number (default 0)
2651 global
2652 {not available when compiled without the |+cscope|
2653 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 Determines how many components of the path to show in a list of tags.
2655 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002656 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657
2658 *'cscopeprg'* *'csprg'*
2659'cscopeprg' 'csprg' string (default "cscope")
2660 global
2661 {not available when compiled without the |+cscope|
2662 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 Specifies the command to execute cscope. See |cscopeprg|.
2664 This option cannot be set from a |modeline| or in the |sandbox|, for
2665 security reasons.
2666
2667 *'cscopequickfix'* *'csqf'*
2668'cscopequickfix' 'csqf' string (default "")
2669 global
2670 {not available when compiled without the |+cscope|
2671 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 Specifies whether to use quickfix window to show cscope results.
2673 See |cscopequickfix|.
2674
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002675 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002676'cscoperelative' 'csre' boolean (default off)
2677 global
2678 {not available when compiled without the |+cscope|
2679 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002680 In the absence of a prefix (-P) for cscope. setting this option enables
2681 to use the basename of cscope.out path as the prefix.
2682 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002683 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2686'cscopetag' 'cst' boolean (default off)
2687 global
2688 {not available when compiled without the |+cscope|
2689 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 Use cscope for tag commands. See |cscope-options|.
2691 NOTE: This option is reset when 'compatible' is set.
2692
2693 *'cscopetagorder'* *'csto'*
2694'cscopetagorder' 'csto' number (default 0)
2695 global
2696 {not available when compiled without the |+cscope|
2697 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 Determines the order in which ":cstag" performs a search. See
2699 |cscopetagorder|.
2700 NOTE: This option is set to 0 when 'compatible' is set.
2701
2702 *'cscopeverbose'* *'csverb'*
2703 *'nocscopeverbose'* *'nocsverb'*
2704'cscopeverbose' 'csverb' boolean (default off)
2705 global
2706 {not available when compiled without the |+cscope|
2707 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 Give messages when adding a cscope database. See |cscopeverbose|.
2709 NOTE: This option is reset when 'compatible' is set.
2710
Bram Moolenaar860cae12010-06-05 23:22:07 +02002711 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2712'cursorbind' 'crb' boolean (default off)
2713 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002714 When this option is set, as the cursor in the current
2715 window moves other cursorbound windows (windows that also have
2716 this option set) move their cursors to the corresponding line and
2717 column. This option is useful for viewing the
2718 differences between two versions of a file (see 'diff'); in diff mode,
2719 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002720 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002721
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002722 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2723'cursorcolumn' 'cuc' boolean (default off)
2724 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002725 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002726 feature}
2727 Highlight the screen column of the cursor with CursorColumn
2728 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2729 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002730 If you only want the highlighting in the current window you can use
2731 these autocommands: >
2732 au WinLeave * set nocursorline nocursorcolumn
2733 au WinEnter * set cursorline cursorcolumn
2734<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002735
2736 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2737'cursorline' 'cul' boolean (default off)
2738 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002739 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002740 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002741 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2742 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002743 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002744 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002745
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002746 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002747'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002748 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002749 {not available when compiled without the |+syntax|
2750 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002751 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002752 Valid values:
2753 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002754 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002755 "screenline" Highlight only the screen line of the cursor with
2756 CursorLine |hl-CursorLine|.
2757 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002758 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002759
2760 Special value:
2761 "both" Alias for the values "line,number".
2762
2763 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002764
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 *'debug'*
2766'debug' string (default "")
2767 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002768 These values can be used:
2769 msg Error messages that would otherwise be omitted will be given
2770 anyway.
2771 throw Error messages that would otherwise be omitted will be given
2772 anyway and also throw an exception and set |v:errmsg|.
2773 beep A message will be given when otherwise only a beep would be
2774 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002775 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002776 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2777 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
2779 *'define'* *'def'*
2780'define' 'def' string (default "^\s*#\s*define")
2781 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 pattern, just like for the "/" command. This option is used for the
2784 commands like "[i" and "[d" |include-search|. The 'isident' option is
2785 used to recognize the defined name after the match:
2786 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2787 See |option-backslash| about inserting backslashes to include a space
2788 or backslash.
2789 The default value is for C programs. For C++ this value would be
2790 useful, to include const type declarations: >
2791 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002792< You can also use "\ze" just before the name and continue the pattern
2793 to check what is following. E.g. for Javascript, if a function is
2794 defined with "func_name = function(args)": >
2795 ^\s*\ze\i\+\s*=\s*function(
2796< If the function is defined with "func_name : function() {...": >
2797 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002799 To avoid that use `:let` with a single quote string: >
2800 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002801<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
2803 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2804'delcombine' 'deco' boolean (default off)
2805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 If editing Unicode and this option is set, backspace and Normal mode
2807 "x" delete each combining character on its own. When it is off (the
2808 default) the character along with its combining characters are
2809 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002810 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
2812 This is useful for Arabic, Hebrew and many other languages where one
2813 may have combining characters overtop of base characters, and want
2814 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002815 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
2817 *'dictionary'* *'dict'*
2818'dictionary' 'dict' string (default "")
2819 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 List of file names, separated by commas, that are used to lookup words
2821 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2822 contain a list of words. This can be one word per line, or several
2823 words per line, separated by non-keyword characters (white space is
2824 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002825
2826 When this option is empty or an entry "spell" is present, and spell
2827 checking is enabled, words in the word lists for the currently active
2828 'spelllang' are used. See |spell|.
2829
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002830 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 after a comma are ignored, otherwise spaces are included in the file
2832 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002833 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 Where to find a list of words?
2835 - On FreeBSD, there is the file "/usr/share/dict/words".
2836 - In the Simtel archive, look in the "msdos/linguist" directory.
2837 - In "miscfiles" of the GNU collection.
2838 The use of |:set+=| and |:set-=| is preferred when adding or removing
2839 directories from the list. This avoids problems when a future version
2840 uses another default.
2841 Backticks cannot be used in this option for security reasons.
2842
2843 *'diff'* *'nodiff'*
2844'diff' boolean (default off)
2845 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 {not available when compiled without the |+diff|
2847 feature}
2848 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850
2851 *'dex'* *'diffexpr'*
2852'diffexpr' 'dex' string (default "")
2853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 {not available when compiled without the |+diff|
2855 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002856 Expression which is evaluated to obtain a diff file (either ed-style
2857 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 This option cannot be set from a |modeline| or in the |sandbox|, for
2859 security reasons.
2860
2861 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002862'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 {not available when compiled without the |+diff|
2865 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002866 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 All are optional. Items must be separated by a comma.
2868
2869 filler Show filler lines, to keep the text
2870 synchronized with a window that has inserted
2871 lines at the same position. Mostly useful
2872 when windows are side-by-side and 'scrollbind'
2873 is set.
2874
2875 context:{n} Use a context of {n} lines between a change
2876 and a fold that contains unchanged lines.
2877 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002878 When using zero the context is actually one,
2879 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002880 for a deleted line. Set it to a very large
2881 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 See |fold-diff|.
2883
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002884 iblank Ignore changes where lines are all blank. Adds
2885 the "-B" flag to the "diff" command if
2886 'diffexpr' is empty. Check the documentation
2887 of the "diff" command for what this does
2888 exactly.
2889 NOTE: the diff windows will get out of sync,
2890 because no differences between blank lines are
2891 taken into account.
2892
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 icase Ignore changes in case of text. "a" and "A"
2894 are considered the same. Adds the "-i" flag
2895 to the "diff" command if 'diffexpr' is empty.
2896
2897 iwhite Ignore changes in amount of white space. Adds
2898 the "-b" flag to the "diff" command if
2899 'diffexpr' is empty. Check the documentation
2900 of the "diff" command for what this does
2901 exactly. It should ignore adding trailing
2902 white space, but not leading white space.
2903
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002904 iwhiteall Ignore all white space changes. Adds
2905 the "-w" flag to the "diff" command if
2906 'diffexpr' is empty. Check the documentation
2907 of the "diff" command for what this does
2908 exactly.
2909
2910 iwhiteeol Ignore white space changes at end of line.
2911 Adds the "-Z" flag to the "diff" command if
2912 'diffexpr' is empty. Check the documentation
2913 of the "diff" command for what this does
2914 exactly.
2915
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002916 horizontal Start diff mode with horizontal splits (unless
2917 explicitly specified otherwise).
2918
2919 vertical Start diff mode with vertical splits (unless
2920 explicitly specified otherwise).
2921
Bram Moolenaarc8234772019-11-10 21:00:27 +01002922 closeoff When a window is closed where 'diff' is set
2923 and there is only one window remaining in the
2924 same tab page with 'diff' set, execute
2925 `:diffoff` in that window. This undoes a
2926 `:diffsplit` command.
2927
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002928 hiddenoff Do not use diff mode for a buffer when it
2929 becomes hidden.
2930
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002931 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2932 starting diff mode. Without this 2 is used.
2933
Bram Moolenaar4223d432021-02-10 13:18:17 +01002934 followwrap Follow the 'wrap' option and leave as it is.
2935
Bram Moolenaare828b762018-09-10 17:51:58 +02002936 internal Use the internal diff library. This is
2937 ignored when 'diffexpr' is set. *E960*
2938 When running out of memory when writing a
2939 buffer this item will be ignored for diffs
2940 involving that buffer. Set the 'verbose'
2941 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942
Bram Moolenaare828b762018-09-10 17:51:58 +02002943 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002944 Use the indent heuristic for the internal
2945 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002946
zeertzjqd086b8f2024-02-25 15:42:52 +08002947 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002948 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002949 algorithms are:
2950 myers the default algorithm
2951 minimal spend extra time to generate the
2952 smallest possible diff
2953 patience patience diff algorithm
2954 histogram histogram diff algorithm
2955
2956 Examples: >
2957 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002959 :set diffopt=internal,filler,foldcolumn:3
2960 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961<
2962 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2963'digraph' 'dg' boolean (default off)
2964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 {not available when compiled without the |+digraphs|
2966 feature}
2967 Enable the entering of digraphs in Insert mode with {char1} <BS>
2968 {char2}. See |digraphs|.
2969 NOTE: This option is reset when 'compatible' is set.
2970
2971 *'directory'* *'dir'*
2972'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002973 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 for Unix: ".,~/tmp,/var/tmp,/tmp")
2975 global
2976 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002977 Recommended value: ".,~/vimswap//" - this will put the swap file next
2978 to the edited file if possible, and in your personal swap directory
2979 otherwise. Make sure "~/vimswap//" is only readable for you.
2980
2981 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 - The swap file will be created in the first directory where this is
2983 possible.
2984 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002985 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 - A directory "." means to put the swap file in the same directory as
2987 the edited file. On Unix, a dot is prepended to the file name, so
2988 it doesn't show in a directory listing. On MS-Windows the "hidden"
2989 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002990 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2991 the swap file relative to where the edited file is. The leading "."
2992 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002993 - For Unix and Win32, if a directory ends in two path separators "//",
2994 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002995 with all path separators replaced by percent '%' signs (including
2996 the colon following the drive letter on Win32). This will ensure
2997 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002998 On Win32, it is also possible to end with "\\". However, When a
2999 separating comma is following, you must use "//", since "\\" will
3000 include the comma in the file name. Therefore it is recommended to
3001 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 - Spaces after the comma are ignored, other spaces are considered part
3003 of the directory name. To have a space at the start of a directory
3004 name, precede it with a backslash.
3005 - To include a comma in a directory name precede it with a backslash.
3006 - A directory name may end in an ':' or '/'.
3007 - Environment variables are expanded |:set_env|.
3008 - Careful with '\' characters, type one before a space, type two to
3009 get one in the option (see |option-backslash|), for example: >
3010 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3011< - For backwards compatibility with Vim version 3.0 a '>' at the start
3012 of the option is removed.
3013 Using "." first in the list is recommended. This means that editing
3014 the same file twice will result in a warning. Using "/tmp" on Unix is
3015 discouraged: When the system crashes you lose the swap file.
3016 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003017 choice than "/tmp". But others on the computer may be able to see the
3018 files, and it can contain a lot of files, your swap files get lost in
3019 the crowd. That is why a "tmp" directory in your home directory is
3020 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 The use of |:set+=| and |:set-=| is preferred when adding or removing
3022 directories from the list. This avoids problems when a future version
3023 uses another default.
3024 This option cannot be set from a |modeline| or in the |sandbox|, for
3025 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026
3027 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003028'display' 'dy' string (default "", set to "truncate" in
3029 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003031 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 flags:
3033 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003034 in a window will be displayed. "@@@" is put in the
3035 last columns of the last screen line to indicate the
3036 rest of the line is not displayed.
3037 truncate Like "lastline", but "@@@" is displayed in the first
3038 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 uhex Show unprintable characters hexadecimal as <xx>
3040 instead of using ^C and ~C.
3041
Bram Moolenaard0796902016-09-16 20:02:31 +02003042 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003043 doesn't fit is replaced with "@" lines.
3044
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003045 The "@" character can be changed by setting the "lastline" item in
3046 'fillchars'. The character is highlighted with |hl-NonText|.
3047
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 *'eadirection'* *'ead'*
3049'eadirection' 'ead' string (default "both")
3050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 Tells when the 'equalalways' option applies:
3052 ver vertically, width of windows is not affected
3053 hor horizontally, height of windows is not affected
3054 both width and height of windows is affected
3055
3056 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3057'edcompatible' 'ed' boolean (default off)
3058 global
3059 Makes the 'g' and 'c' flags of the ":substitute" command to be
3060 toggled each time the flag is given. See |complex-change|. See
3061 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003062 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003063 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
Bram Moolenaar03413f42016-04-12 21:07:15 +02003065 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003066'emoji' 'emo' boolean (default: on)
3067 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003068 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003069 This excludes "text emoji" characters, which are normally displayed as
3070 single width. Unfortunately there is no good specification for this
3071 and it has been determined on trial-and-error basis. Use the
3072 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003073
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003075'encoding' 'enc' string (default for MS-Windows: "utf-8",
3076 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 Sets the character encoding used inside Vim. It applies to text in
3079 the buffers, registers, Strings in expressions, text stored in the
3080 viminfo file, etc. It sets the kind of characters which Vim can work
3081 with. See |encoding-names| for the possible values.
3082
3083 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003084 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003086 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
Bram Moolenaar865242e2010-07-14 21:12:05 +02003088 This option cannot be set from a |modeline|. It would most likely
3089 corrupt the text.
3090
Bram Moolenaar3df01732017-02-17 22:47:16 +01003091 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3092 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 'encoding', "utf-8" is the natural choice for the environment and
3094 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003095 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 versions, and to avoid changing the encoding of newly created files
3097 without your knowledge (in case 'fileencodings' is empty).
3098
3099 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003100 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 iconv() or as specified with 'charconvert'.
3102
Bram Moolenaar207f0092020-08-30 17:20:20 +02003103 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003104 can use: >
3105 if has("multi_byte_encoding")
3106<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 Normally 'encoding' will be equal to your current locale. This will
3108 be the default if Vim recognizes your environment settings. If
3109 'encoding' is not set to the current locale, 'termencoding' must be
3110 set to convert typed and displayed text. See |encoding-table|.
3111
3112 When you set this option, it fires the |EncodingChanged| autocommand
3113 event so that you can set up fonts if necessary.
3114
3115 When the option is set, the value is converted to lowercase. Thus
3116 you can set it with uppercase values too. Underscores are translated
3117 to '-' signs.
3118 When the encoding is recognized, it is changed to the standard name.
3119 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3120 "iso-8859-2" and "utf8" becomes "utf-8".
3121
3122 Note: "latin1" is also used when the encoding could not be detected.
3123 This only works when editing files in the same encoding! When the
3124 actual character set is not latin1, make sure 'fileencoding' and
3125 'fileencodings' are empty. When conversion is needed, switch to using
3126 utf-8.
3127
3128 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3129 You don't notice this while editing, but it does matter for the
3130 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3131 setting 'encoding' to one of these values instead of utf-8 only has
3132 effect for encoding used for files when 'fileencoding' is empty.
3133
Bram Moolenaar661b1822005-07-28 22:36:45 +00003134 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3135 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003137 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003138'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003140 Indicates that a CTRL-Z character was found at the end of the file
3141 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003143 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003144 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003145 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003146
3147 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3148'endofline' 'eol' boolean (default on)
3149 local to buffer
3150 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003151 is on, or 'fixeol' option is off, no <EOL> will be written for the
3152 last line in the file. This option is automatically set or reset when
3153 starting to edit a new file, depending on whether file has an <EOL>
3154 for the last line in the file. Normally you don't have to set or
3155 reset this option.
3156 When 'binary' is off and 'fixeol' is on the value is not used when
3157 writing the file. When 'binary' is on or 'fixeol' is off it is used
3158 to remember the presence of a <EOL> for the last line in the file, so
3159 that when you write the file the situation from the original file can
3160 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003161 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162
3163 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3164'equalalways' 'ea' boolean (default on)
3165 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003167 splitting or closing a window. This also happens the moment the
3168 option is switched on. When off, splitting a window will reduce the
3169 size of the current window and leave the other windows the same. When
3170 closing a window the extra lines are given to the window next to it
3171 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 When mixing vertically and horizontally split windows, a minimal size
3173 is computed and some windows may be larger if there is room. The
3174 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003175 Changing the height and width of a window can be avoided by setting
3176 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003177 If a window size is specified when creating a new window sizes are
3178 currently not equalized (it's complicated, but may be implemented in
3179 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180
3181 *'equalprg'* *'ep'*
3182'equalprg' 'ep' string (default "")
3183 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003185 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003186 or 'indentexpr'. When Vim was compiled without internal formatting,
3187 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003188 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 about including spaces and backslashes.
3190 This option cannot be set from a |modeline| or in the |sandbox|, for
3191 security reasons.
3192
3193 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3194'errorbells' 'eb' boolean (default off)
3195 global
3196 Ring the bell (beep or screen flash) for error messages. This only
3197 makes a difference for error messages, the bell will be used always
3198 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003199 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003200 screen flash or do nothing. See 'belloff' to finetune when to ring the
3201 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202
3203 *'errorfile'* *'ef'*
3204'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3205 others: "errors.err")
3206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 {not available when compiled without the |+quickfix|
3208 feature}
3209 Name of the errorfile for the QuickFix mode (see |:cf|).
3210 When the "-q" command-line argument is used, 'errorfile' is set to the
3211 following argument. See |-q|.
3212 NOT used for the ":make" command. See 'makeef' for that.
3213 Environment variables are expanded |:set_env|.
3214 See |option-backslash| about including spaces and backslashes.
3215 This option cannot be set from a |modeline| or in the |sandbox|, for
3216 security reasons.
3217
3218 *'errorformat'* *'efm'*
3219'errorformat' 'efm' string (default is very long)
3220 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 {not available when compiled without the |+quickfix|
3222 feature}
3223 Scanf-like description of the format for the lines in the error file
3224 (see |errorformat|).
3225
3226 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3227'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 Function keys that start with an <Esc> are recognized in Insert
3230 mode. When this option is off, the cursor and function keys cannot be
3231 used in Insert mode if they start with an <Esc>. The advantage of
3232 this is that the single <Esc> is recognized immediately, instead of
3233 after one second. Instead of resetting this option, you might want to
3234 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3235 when 'esckeys' is off, you can still map anything, but the cursor keys
3236 won't work by default.
3237 NOTE: This option is set to the Vi default value when 'compatible' is
3238 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003239 NOTE: when this option is off then the |modifyOtherKeys| and
3240 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3241 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242
3243 *'eventignore'* *'ei'*
3244'eventignore' 'ei' string (default "")
3245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003247 When set to "all" or when "all" is one of the items, all autocommand
3248 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003249 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 :set ei=WinEnter,WinLeave
3251<
3252 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3253'expandtab' 'et' boolean (default off)
3254 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003256 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3258 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003259 This option is reset when the 'paste' option is set and restored when
3260 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 NOTE: This option is reset when 'compatible' is set.
3262
3263 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3264'exrc' 'ex' boolean (default off)
3265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003267 directory.
3268
3269 Setting this option is a potential security leak. E.g., consider
3270 unpacking a package or fetching files from github, a .vimrc in there
3271 might be a trojan horse. BETTER NOT SET THIS OPTION!
3272 Instead, define an autocommand in your .vimrc to set options for a
3273 matching directory.
3274
3275 If you do switch this option on you should also consider setting the
3276 'secure' option (see |initialization|).
3277 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 This option cannot be set from a |modeline| or in the |sandbox|, for
3279 security reasons.
3280
3281 *'fileencoding'* *'fenc'* *E213*
3282'fileencoding' 'fenc' string (default: "")
3283 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003285
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003287 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 When 'fileencoding' is empty, the same value as 'encoding' will be
3289 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003290 No error will be given when the value is set, only when it is used,
3291 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003292 Conversion will also be done when 'encoding' and 'fileencoding' are
3293 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3294 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003296 'encoding' is "utf-8" or another Unicode encoding, conversion
3297 is most likely done in a way that the reverse conversion
3298 results in the same text. When 'encoding' is not "utf-8" some
3299 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 See 'encoding' for the possible values. Additionally, values may be
3302 specified that can be handled by the converter, see
3303 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003304
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 When reading a file 'fileencoding' will be set from 'fileencodings'.
3306 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003307 'fileencoding', use the |++enc| argument. One exception: when
3308 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003309 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003310
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3312 When the option is set, the value is converted to lowercase. Thus
3313 you can set it with uppercase values too. '_' characters are
3314 replaced with '-'. If a name is recognized from the list for
3315 'encoding', it is replaced by the standard name. For example
3316 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 When this option is set, after starting to edit a file, the 'modified'
3319 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003320
3321 Keep in mind that changing 'fenc' from a modeline happens
3322 AFTER the text has been read, thus it applies to when the file will be
3323 written. If you do set 'fenc' in a modeline, you might want to set
3324 'nomodified' to avoid not being able to ":q".
3325
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 This option can not be changed when 'modifiable' is off.
3327
3328 *'fe'*
3329 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003330 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 old short name was 'fe', which is no longer used.
3332
3333 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003334'fileencodings' 'fencs' string (default: "ucs-bom",
3335 "ucs-bom,utf-8,default,latin1" when
3336 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 This is a list of character encodings considered when starting to edit
3339 an existing file. When a file is read, Vim tries to use the first
3340 mentioned character encoding. If an error is detected, the next one
3341 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003342 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 an empty string, which means the value of 'encoding' is used.
3344 WARNING: Conversion can cause loss of information! When
3345 'encoding' is "utf-8" (or one of the other Unicode variants)
3346 conversion is most likely done in a way that the reverse
3347 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003348 "utf-8" some non-ASCII characters may be lost! You can use
3349 the |++bad| argument to specify what is done with characters
3350 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 For an empty file or a file with only ASCII characters most encodings
3352 will work and the first entry of 'fileencodings' will be used (except
3353 "ucs-bom", which requires the BOM to be present). If you prefer
3354 another encoding use an BufReadPost autocommand event to test if your
3355 preferred encoding is to be used. Example: >
3356 au BufReadPost * if search('\S', 'w') == 0 |
3357 \ set fenc=iso-2022-jp | endif
3358< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3359 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003360 When the |++enc| argument is used then the value of 'fileencodings' is
3361 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003362 Note that 'fileencodings' is not used for a new file, the global value
3363 of 'fileencoding' is used instead. You can set it with: >
3364 :setglobal fenc=iso-8859-2
3365< This means that a non-existing file may get a different encoding than
3366 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 The special value "ucs-bom" can be used to check for a Unicode BOM
3368 (Byte Order Mark) at the start of the file. It must not be preceded
3369 by "utf-8" or another Unicode encoding for this to work properly.
3370 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3371 because Vim cannot detect an error, thus the encoding is always
3372 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003373 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003374 environment. On MS-Windows this is the system encoding. Otherwise
3375 this is the default value for 'encoding'. It is useful when
3376 'encoding' is set to "utf-8" and your environment uses a non-latin1
3377 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003378 When 'encoding' is "utf-8" and a file contains an illegal byte
3379 sequence it won't be recognized as UTF-8. You can use the |8g8|
3380 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 WRONG VALUES: WHAT'S WRONG:
3382 latin1,utf-8 "latin1" will always be used
3383 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3384 file
3385 cp1250,latin1 "cp1250" will always be used
3386 If 'fileencodings' is empty, 'fileencoding' is not modified.
3387 See 'fileencoding' for the possible values.
3388 Setting this option does not have an effect until the next time a file
3389 is read.
3390
3391 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003392'fileformat' 'ff' string (MS-Windows default: "dos",
3393 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 This gives the <EOL> of the current buffer, which is used for
3396 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003397 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 unix <NL>
3399 mac <CR>
3400 When "dos" is used, CTRL-Z at the end of a file is ignored.
3401 See |file-formats| and |file-read|.
3402 For the character encoding of the file see 'fileencoding'.
3403 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003404 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 This option is set automatically when starting to edit a file and
3406 'fileformats' is not empty and 'binary' is off.
3407 When this option is set, after starting to edit a file, the 'modified'
3408 option is set, because the file would be different when written.
3409 This option can not be changed when 'modifiable' is off.
3410 For backwards compatibility: When this option is set to "dos",
3411 'textmode' is set, otherwise 'textmode' is reset.
3412
3413 *'fileformats'* *'ffs'*
3414'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003415 Vim+Vi MS-Windows: "dos,unix",
3416 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 Vi Cygwin: "unix,dos",
3418 Vi others: "")
3419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 This gives the end-of-line (<EOL>) formats that will be tried when
3421 starting to edit a new buffer and when reading a file into an existing
3422 buffer:
3423 - When empty, the format defined with 'fileformat' will be used
3424 always. It is not set automatically.
3425 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003426 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 'fileformats' name will be used when a file is read into an existing
3428 buffer, no matter what 'fileformat' for that buffer is set to.
3429 - When more than one name is present, separated by commas, automatic
3430 <EOL> detection will be done when reading a file. When starting to
3431 edit a file, a check is done for the <EOL>:
3432 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3433 'fileformat' is set to "dos".
3434 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003435 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003437 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3438 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003439 This means that "mac" is only chosen when:
3440 "unix" is not present or no <NL> is found in the file, and
3441 "dos" is not present or no <CR><NL> is found in the file.
3442 Except: if "unix" was chosen, but there is a <CR> before
3443 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003444 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 4. If 'fileformat' is still not set, the first name from
3446 'fileformats' is used.
3447 When reading a file into an existing buffer, the same is done, but
3448 this happens like 'fileformat' has been set appropriately for that
3449 file only, the option is not changed.
3450 When 'binary' is set, the value of 'fileformats' is not used.
3451
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003452 When Vim starts up with an empty buffer the first item is used. You
3453 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003454
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3456 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3457 done:
3458 - When 'fileformats' is empty, there is no automatic detection. Dos
3459 format will be used.
3460 - When 'fileformats' is set to one or more names, automatic detection
3461 is done. This is based on the first <NL> in the file: If there is a
3462 <CR> in front of it, Dos format is used, otherwise Unix format is
3463 used.
3464 Also see |file-formats|.
3465 For backwards compatibility: When this option is set to an empty
3466 string or one format (no comma is included), 'textauto' is reset,
3467 otherwise 'textauto' is set.
3468 NOTE: This option is set to the Vi default value when 'compatible' is
3469 set and to the Vim default value when 'compatible' is reset.
3470
Bram Moolenaarbf884932013-04-05 22:26:15 +02003471 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3472'fileignorecase' 'fic' boolean (default on for systems where case in file
3473 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003474 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003475 When set case is ignored when using file names and directories.
3476 See 'wildignorecase' for only ignoring case when doing completion.
3477
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 *'filetype'* *'ft'*
3479'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003480 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 When this option is set, the FileType autocommand event is triggered.
3482 All autocommands that match with the value of this option will be
3483 executed. Thus the value of 'filetype' is used in place of the file
3484 name.
3485 Otherwise this option does not always reflect the current file type.
3486 This option is normally set when the file type is detected. To enable
3487 this use the ":filetype on" command. |:filetype|
3488 Setting this option to a different value is most useful in a modeline,
3489 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003490 Example, for in an IDL file:
3491 /* vim: set filetype=idl : */ ~
3492 |FileType| |filetypes|
3493 When a dot appears in the value then this separates two filetype
3494 names. Example:
3495 /* vim: set filetype=c.doxygen : */ ~
3496 This will use the "c" filetype first, then the "doxygen" filetype.
3497 This works both for filetype plugins and for syntax files. More than
3498 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 This option is not copied to another buffer, independent of the 's' or
3500 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003501 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502
3503 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003504'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003505 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003506 Characters to fill the statuslines, vertical separators and special
3507 lines in the window.
3508 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003509 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003511 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003512 stl ' ' statusline of the current window
3513 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003514 vert '|' vertical separators |:vsplit|
3515 fold '-' filling 'foldtext'
3516 foldopen '-' mark the beginning of a fold
3517 foldclose '+' show a closed fold
3518 foldsep '|' open fold middle character
3519 diff '-' deleted lines of the 'diff' option
3520 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003521 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003523 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
3525 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003526 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3527<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003528 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3529 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003530 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003531
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003533 item name highlight group ~
3534 stl StatusLine |hl-StatusLine|
3535 stlnc StatusLineNC |hl-StatusLineNC|
3536 vert VertSplit |hl-VertSplit|
3537 fold Folded |hl-Folded|
3538 diff DiffDelete |hl-DiffDelete|
3539 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003540 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003542 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3543'fixendofline' 'fixeol' boolean (default on)
3544 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003545 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003546 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003547 preserve the situation from the original file.
3548 When the 'binary' option is set the value of this option doesn't
3549 matter.
3550 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003551 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003552
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003554'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 {only available when compiled with the |+rightleft|
3557 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003558 This option was for using Farsi, which has been removed. See
3559 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 *'foldclose'* *'fcl'*
3562'foldclose' 'fcl' string (default "")
3563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 {not available when compiled without the |+folding|
3565 feature}
3566 When set to "all", a fold is closed when the cursor isn't in it and
3567 its level is higher than 'foldlevel'. Useful if you want folds to
3568 automatically close when moving out of them.
3569
3570 *'foldcolumn'* *'fdc'*
3571'foldcolumn' 'fdc' number (default 0)
3572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 {not available when compiled without the |+folding|
3574 feature}
3575 When non-zero, a column with the specified width is shown at the side
3576 of the window which indicates open and closed folds. The maximum
3577 value is 12.
3578 See |folding|.
3579
3580 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3581'foldenable' 'fen' boolean (default on)
3582 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 {not available when compiled without the |+folding|
3584 feature}
3585 When off, all folds are open. This option can be used to quickly
3586 switch between showing all text unfolded and viewing the text with
3587 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003588 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 'foldenable' is off.
3590 This option is set by commands that create a new fold or close a fold.
3591 See |folding|.
3592
3593 *'foldexpr'* *'fde'*
3594'foldexpr' 'fde' string (default: "0")
3595 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003597 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003599 for each line to obtain its fold level. The context is set to the
3600 script where 'foldexpr' was set, script-local items can be accessed.
3601 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003602
Bram Moolenaar30b65812012-07-12 22:01:11 +02003603 The expression will be evaluated in the |sandbox| if set from a
3604 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003605 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003606 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003607
3608 It is not allowed to change text or jump to another window while
3609 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610
3611 *'foldignore'* *'fdi'*
3612'foldignore' 'fdi' string (default: "#")
3613 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 {not available when compiled without the |+folding|
3615 feature}
3616 Used only when 'foldmethod' is "indent". Lines starting with
3617 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003618 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 The default "#" works well for C programs. See |fold-indent|.
3620
3621 *'foldlevel'* *'fdl'*
3622'foldlevel' 'fdl' number (default: 0)
3623 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 {not available when compiled without the |+folding|
3625 feature}
3626 Sets the fold level: Folds with a higher level will be closed.
3627 Setting this option to zero will close all folds. Higher numbers will
3628 close fewer folds.
3629 This option is set by commands like |zm|, |zM| and |zR|.
3630 See |fold-foldlevel|.
3631
3632 *'foldlevelstart'* *'fdls'*
3633'foldlevelstart' 'fdls' number (default: -1)
3634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 {not available when compiled without the |+folding|
3636 feature}
3637 Sets 'foldlevel' when starting to edit another buffer in a window.
3638 Useful to always start editing with all folds closed (value zero),
3639 some folds closed (one) or no folds closed (99).
3640 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003641 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 ignores this option and closes all folds.
3643 It is also done before BufReadPre autocommands, to allow an autocmd to
3644 overrule the 'foldlevel' value for specific files.
3645 When the value is negative, it is not used.
3646
3647 *'foldmarker'* *'fmr'* *E536*
3648'foldmarker' 'fmr' string (default: "{{{,}}}")
3649 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 {not available when compiled without the |+folding|
3651 feature}
3652 The start and end marker used when 'foldmethod' is "marker". There
3653 must be one comma, which separates the start and end marker. The
3654 marker is a literal string (a regular expression would be too slow).
3655 See |fold-marker|.
3656
3657 *'foldmethod'* *'fdm'*
3658'foldmethod' 'fdm' string (default: "manual")
3659 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 {not available when compiled without the |+folding|
3661 feature}
3662 The kind of folding used for the current window. Possible values:
3663 |fold-manual| manual Folds are created manually.
3664 |fold-indent| indent Lines with equal indent form a fold.
3665 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3666 |fold-marker| marker Markers are used to specify folds.
3667 |fold-syntax| syntax Syntax highlighting items specify folds.
3668 |fold-diff| diff Fold text that is not changed.
3669
3670 *'foldminlines'* *'fml'*
3671'foldminlines' 'fml' number (default: 1)
3672 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {not available when compiled without the |+folding|
3674 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003675 Sets the number of screen lines above which a fold can be displayed
3676 closed. Also for manually closed folds. With the default value of
3677 one a fold can only be closed if it takes up two or more screen lines.
3678 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003679 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 "zc" to close a fold, which is displayed open because it's smaller
3681 than 'foldminlines', a following "zc" may close a containing fold.
3682
3683 *'foldnestmax'* *'fdn'*
3684'foldnestmax' 'fdn' number (default: 20)
3685 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 {not available when compiled without the |+folding|
3687 feature}
3688 Sets the maximum nesting of folds for the "indent" and "syntax"
3689 methods. This avoids that too many folds will be created. Using more
3690 than 20 doesn't work, because the internal limit is 20.
3691
3692 *'foldopen'* *'fdo'*
3693'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3694 search,tag,undo")
3695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 {not available when compiled without the |+folding|
3697 feature}
3698 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003699 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003701 NOTE: When the command is part of a mapping this option is not used.
3702 Add the |zv| command to the mapping to get the same effect.
3703 (rationale: the mapping may want to control opening folds itself)
3704
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 item commands ~
3706 all any
3707 block "(", "{", "[[", "[{", etc.
3708 hor horizontal movements: "l", "w", "fx", etc.
3709 insert any command in Insert mode
3710 jump far jumps: "G", "gg", etc.
3711 mark jumping to a mark: "'m", CTRL-O, etc.
3712 percent "%"
3713 quickfix ":cn", ":crew", ":make", etc.
3714 search search for a pattern: "/", "n", "*", "gd", etc.
3715 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003716 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 tag jumping to a tag: ":ta", CTRL-T, etc.
3718 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 When a movement command is used for an operator (e.g., "dl" or "y%")
3720 this option is not used. This means the operator will include the
3721 whole closed fold.
3722 Note that vertical movements are not here, because it would make it
3723 very difficult to move onto a closed fold.
3724 In insert mode the folds containing the cursor will always be open
3725 when text is inserted.
3726 To close folds you can re-apply 'foldlevel' with the |zx| command or
3727 set the 'foldclose' option to "all".
3728
3729 *'foldtext'* *'fdt'*
3730'foldtext' 'fdt' string (default: "foldtext()")
3731 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 {not available when compiled without the |+folding|
3733 feature}
3734 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003735 fold. The context is set to the script where 'foldexpr' was set,
3736 script-local items can be accessed. See |fold-foldtext| for the
3737 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738
Bram Moolenaar30b65812012-07-12 22:01:11 +02003739 The expression will be evaluated in the |sandbox| if set from a
3740 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003741 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003742
3743 It is not allowed to change text or jump to another window while
3744 evaluating 'foldtext' |textlock|.
3745
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003746 *'formatexpr'* *'fex'*
3747'formatexpr' 'fex' string (default "")
3748 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003749 {not available when compiled without the |+eval|
3750 feature}
3751 Expression which is evaluated to format a range of lines for the |gq|
3752 operator or automatic formatting (see 'formatoptions'). When this
3753 option is empty 'formatprg' is used.
3754
3755 The |v:lnum| variable holds the first line to be formatted.
3756 The |v:count| variable holds the number of lines to be formatted.
3757 The |v:char| variable holds the character that is going to be
3758 inserted if the expression is being evaluated due to
3759 automatic formatting. This can be empty. Don't insert
3760 it yet!
3761
3762 Example: >
3763 :set formatexpr=mylang#Format()
3764< This will invoke the mylang#Format() function in the
3765 autoload/mylang.vim file in 'runtimepath'. |autoload|
3766
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003767 The advantage of using a function call without arguments is that it is
3768 faster, see |expr-option-function|.
3769
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003770 The expression is also evaluated when 'textwidth' is set and adding
3771 text beyond that limit. This happens under the same conditions as
3772 when internal formatting is used. Make sure the cursor is kept in the
3773 same spot relative to the text then! The |mode()| function will
3774 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003775
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003776 When the expression evaluates to non-zero Vim will fall back to using
3777 the internal format mechanism.
3778
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003779 If the expression starts with s: or |<SID>|, then it is replaced with
3780 the script ID (|local-function|). Example: >
3781 set formatexpr=s:MyFormatExpr()
3782 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003783< Otherwise, the expression is evaluated in the context of the script
3784 where the option was set, thus script-local items are available.
3785
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003786 The expression will be evaluated in the |sandbox| when set from a
3787 modeline, see |sandbox-option|. That stops the option from working,
3788 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003789 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003790 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003791
Bram Moolenaar86b68352004-12-27 21:59:20 +00003792 *'formatlistpat'* *'flp'*
3793'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3794 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003795 A pattern that is used to recognize a list header. This is used for
3796 the "n" flag in 'formatoptions'.
3797 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003798 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003799 while still checking more characters. There must be a character
3800 following the pattern, when it matches the whole line it is handled
3801 like there is no match.
3802 The default recognizes a number, followed by an optional punctuation
3803 character and white space.
3804
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003805 *'formatoptions'* *'fo'*
3806'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3807 local to buffer
3808 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003809 formatting is to be done.
3810 See |fo-table| for possible values and |gq| for how to format text.
3811 When the 'paste' option is on, no formatting is done (like
3812 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003813 To avoid problems with flags that are added in the future, use the
3814 "+=" and "-=" feature of ":set" |add-option-flags|.
3815 NOTE: This option is set to the Vi default value when 'compatible' is
3816 set and to the Vim default value when 'compatible' is reset.
3817
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 *'formatprg'* *'fp'*
3819'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003820 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003822 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003824 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003825 If the 'formatexpr' option is not empty it will be used instead.
3826 Otherwise, if 'formatprg' option is an empty string, the internal
3827 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003828 Environment variables are expanded |:set_env|. See |option-backslash|
3829 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003830 This option cannot be set from a |modeline| or in the |sandbox|, for
3831 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832
Bram Moolenaard94464e2015-11-02 15:28:18 +01003833 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003834'fsync' 'fs' boolean (default on)
3835 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003836 When on, the library function fsync() will be called after writing a
3837 file. This will flush a file to disk, ensuring that it is safely
3838 written even on filesystems which do metadata-only journaling. This
3839 will force the harddrive to spin up on Linux systems running in laptop
3840 mode, so it may be undesirable in some situations. Be warned that
3841 turning this off increases the chances of data loss after a crash. On
3842 systems without an fsync() implementation, this variable is always
3843 off.
3844 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003845 'fsync' also applies to |writefile()| (unless a flag is used to
3846 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003847 This option cannot be set from a |modeline| or in the |sandbox|, for
3848 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003849
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3851'gdefault' 'gd' boolean (default off)
3852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 When on, the ":substitute" flag 'g' is default on. This means that
3854 all matches in a line are substituted instead of one. When a 'g' flag
3855 is given to a ":substitute" command, this will toggle the substitution
3856 of all or one match. See |complex-change|.
3857
3858 command 'gdefault' on 'gdefault' off ~
3859 :s/// subst. all subst. one
3860 :s///g subst. one subst. all
3861 :s///gg subst. all subst. one
3862
3863 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003864 Setting this option may break plugins that rely on the default
3865 behavior of the 'g' flag. This will also make the 'g' flag have the
3866 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003867 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868
3869 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003870'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 Format to recognize for the ":grep" command output.
3873 This is a scanf-like string that uses the same format as the
3874 'errorformat' option: see |errorformat|.
3875
3876 *'grepprg'* *'gp'*
3877'grepprg' 'gp' string (default "grep -n ",
3878 Unix: "grep -n $* /dev/null",
3879 Win32: "findstr /n" or "grep -n",
3880 VMS: "SEARCH/NUMBERS ")
3881 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003882 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 and '#' characters, which are expanded like when used in a command-
3884 line. The placeholder "$*" is allowed to specify where the arguments
3885 will be included. Environment variables are expanded |:set_env|. See
3886 |option-backslash| about including spaces and backslashes.
3887 When your "grep" accepts the "-H" argument, use this to make ":grep"
3888 also work well with a single file: >
3889 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003890< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003891 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3892 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003893 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 apply equally to 'grepprg'.
3895 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3896 otherwise it's "grep -n".
3897 This option cannot be set from a |modeline| or in the |sandbox|, for
3898 security reasons.
3899
3900 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3901'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3902 ve:ver35-Cursor,
3903 o:hor50-Cursor,
3904 i-ci:ver25-Cursor/lCursor,
3905 r-cr:hor20-Cursor/lCursor,
3906 sm:block-Cursor
3907 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003908 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 "n-v-c:block,o:hor50,i-ci:hor15,
3910 r-cr:hor30,sm:block")
3911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003913 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003915 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003916 height of the cursor can be changed. This can be done by specifying a
3917 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003918 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3919 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003921 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 mode-list and an argument-list:
3923 mode-list:argument-list,mode-list:argument-list,..
3924 The mode-list is a dash separated list of these modes:
3925 n Normal mode
3926 v Visual mode
3927 ve Visual mode with 'selection' "exclusive" (same as 'v',
3928 if not specified)
3929 o Operator-pending mode
3930 i Insert mode
3931 r Replace mode
3932 c Command-line Normal (append) mode
3933 ci Command-line Insert mode
3934 cr Command-line Replace mode
3935 sm showmatch in Insert mode
3936 a all modes
3937 The argument-list is a dash separated list of these arguments:
3938 hor{N} horizontal bar, {N} percent of the character height
3939 ver{N} vertical bar, {N} percent of the character width
3940 block block cursor, fills the whole character
3941 [only one of the above three should be present]
3942 blinkwait{N} *cursor-blinking*
3943 blinkon{N}
3944 blinkoff{N}
3945 blink times for cursor: blinkwait is the delay before
3946 the cursor starts blinking, blinkon is the time that
3947 the cursor is shown and blinkoff is the time that the
3948 cursor is not shown. The times are in msec. When one
3949 of the numbers is zero, there is no blinking. The
3950 default is: "blinkwait700-blinkon400-blinkoff250".
3951 These numbers are used for a missing entry. This
3952 means that blinking is enabled by default. To switch
3953 blinking off you can use "blinkon0". The cursor only
3954 blinks when Vim is waiting for input, not while
3955 executing a command.
3956 To make the cursor blink in an xterm, see
3957 |xterm-blink|.
3958 {group-name}
3959 a highlight group name, that sets the color and font
3960 for the cursor
3961 {group-name}/{group-name}
3962 Two highlight group names, the first is used when
3963 no language mappings are used, the other when they
3964 are. |language-mapping|
3965
3966 Examples of parts:
3967 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3968 block cursor with colors from the "nCursor"
3969 highlight group
3970 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3971 In Insert and Command-line Insert mode, use a
3972 30% vertical bar cursor with colors from the
3973 "iCursor" highlight group. Blink a bit
3974 faster.
3975
3976 The 'a' mode is different. It will set the given argument-list for
3977 all modes. It does not reset anything to defaults. This can be used
3978 to do a common setting for all modes. For example, to switch off
3979 blinking: "a:blinkon0"
3980
3981 Examples of cursor highlighting: >
3982 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3983 :highlight Cursor gui=NONE guifg=bg guibg=fg
3984<
3985 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003986 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987'guifont' 'gfn' string (default "")
3988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 {only available when compiled with GUI enabled}
3990 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003991 In its simplest form the value is just one font name.
3992 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993
3994 *'guifontset'* *'gfs'*
3995 *E250* *E252* *E234* *E597* *E598*
3996'guifontset' 'gfs' string (default "")
3997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 {only available when compiled with GUI enabled and
3999 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004000 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 When not empty, specifies two (or more) fonts to be used. The first
4002 one for normal English, the second one for your special language. See
4003 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004004
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4006'guifontwide' 'gfw' string (default "")
4007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 {only available when compiled with GUI enabled}
4009 When not empty, specifies a comma-separated list of fonts to be used
4010 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004011 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004012
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 *'guiheadroom'* *'ghr'*
4014'guiheadroom' 'ghr' number (default 50)
4015 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004016 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 The number of pixels subtracted from the screen height when fitting
4018 the GUI window on the screen. Set this before the GUI is started,
4019 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004020 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 lines will be left for window decorations and other items on the
4022 screen. Set it to a negative value to allow windows taller than the
4023 screen.
4024
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004025 *'guiligatures'* *'gli'* *E1243*
4026'guiligatures' 'gli' string (default "")
4027 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004028 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004029 List of ASCII characters that, when combined together, can create more
4030 complex shapes. Each character must be a printable ASCII character
4031 with a value in the 32-127 range.
4032 Example: >
4033 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4034< Changing this option updates screen output immediately. Set it to an
4035 empty string to disable ligatures.
4036
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004038'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4039 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004040 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004041 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004044 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 sequence of letters which describes what components and options of the
4046 GUI should be used.
4047 To avoid problems with flags that are added in the future, use the
4048 "+=" and "-=" feature of ":set" |add-option-flags|.
4049
Bram Moolenaar13568252018-03-16 20:46:58 +01004050 Valid characters are as follows:
4051 *'go-!'*
4052 '!' External commands are executed in a terminal window. Without
4053 this flag the MS-Windows GUI will open a console window to
4054 execute the command. The Unix GUI will simulate a dumb
4055 terminal to list the command output.
4056 The terminal window will be positioned at the bottom, and grow
4057 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004058 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 'a' Autoselect: If present, then whenever VISUAL mode is started,
4060 or the Visual area extended, Vim tries to become the owner of
4061 the windowing system's global selection. This means that the
4062 Visually highlighted text is available for pasting into other
4063 applications as well as into Vim itself. When the Visual mode
4064 ends, possibly due to an operation on the text, or when an
4065 application wants to paste the selection, the highlighted text
4066 is automatically yanked into the "* selection register.
4067 Thus the selection is still available for pasting into other
4068 applications after the VISUAL mode has ended.
4069 If not present, then Vim won't become the owner of the
4070 windowing system's global selection unless explicitly told to
4071 by a yank or delete operation for the "* register.
4072 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004073 *'go-P'*
4074 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004075 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004076 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004077 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 applies to the modeless selection.
4079
4080 'guioptions' autoselect Visual autoselect modeless ~
4081 "" - -
4082 "a" yes yes
4083 "A" - yes
4084 "aA" yes yes
4085
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004086 When using a terminal see the 'clipboard' option.
4087
Bram Moolenaar02467872007-05-06 13:22:01 +00004088 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 'c' Use console dialogs instead of popup dialogs for simple
4090 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004091 *'go-d'*
4092 'd' Use dark theme variant if available. Currently only works for
4093 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004094 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004095 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004096 'guitablabel' can be used to change the text in the labels.
4097 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004098 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004099 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004100 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 'f' Foreground: Don't use fork() to detach the GUI from the shell
4102 where it was started. Use this for programs that wait for the
4103 editor to finish (e.g., an e-mail program). Alternatively you
4104 can use "gvim -f" or ":gui -f" to start the GUI in the
4105 foreground. |gui-fork|
4106 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004107 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004108 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4110 corner of the window. It's black&white on non-GTK, because of
4111 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004112 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004114 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004115 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004117 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004119 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004120 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 'g' Grey menu items: Make menu items that are not active grey. If
4122 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004123 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 't' Include tearoff menu items. Currently only works for Win32,
4125 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004126 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004127 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4128 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004129 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004131 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 'R' Right-hand scrollbar is present when there is a vertically
4133 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004134 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004136 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 'L' Left-hand scrollbar is present when there is a vertically
4138 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004139 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4141 the longest visible line, or on the cursor line if the 'h'
4142 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004143 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 'h' Limit horizontal scrollbar size to the length of the cursor
4145 line. Reduces computations. |gui-horiz-scroll|
4146
4147 And yes, you may even have scrollbars on the left AND the right if
4148 you really want to :-). See |gui-scrollbars| for more information.
4149
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004150 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 'v' Use a vertical button layout for dialogs. When not included,
4152 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004153 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004154 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 'p' Use Pointer callbacks for X11 GUI. This is required for some
4156 window managers. If the cursor is not blinking or hollow at
4157 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004158 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004160 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004162 *'go-k'*
4163 'k' Keep the GUI window size when adding/removing a scrollbar, or
4164 toolbar, tabline, etc. Instead, the behavior is similar to
4165 when the window is maximized and will adjust 'lines' and
4166 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004167 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004168 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004169
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 *'guipty'* *'noguipty'*
4171'guipty' boolean (default on)
4172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 {only available when compiled with GUI enabled}
4174 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4175 I/O to/from shell commands. See |gui-pty|.
4176
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004177 *'guitablabel'* *'gtl'*
4178'guitablabel' 'gtl' string (default empty)
4179 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004180 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004181 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004182 pages line. When empty and when the result is empty Vim will use a
4183 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004184
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004185 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004186 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004187 The expression will be evaluated in the |sandbox| when set from a
4188 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004189 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004190
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004191 Only used when the GUI tab pages line is displayed. 'e' must be
4192 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4193 used.
4194
Bram Moolenaar57657d82006-04-21 22:12:41 +00004195 *'guitabtooltip'* *'gtt'*
4196'guitabtooltip' 'gtt' string (default empty)
4197 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004198 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004199 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004200 pages line. When empty Vim will use a default tooltip.
4201 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004202 You can include a line break. Simplest method is to use |:let|: >
4203 :let &guitabtooltip = "line one\nline two"
4204<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004205
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004207'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 (others) "$VIMRUNTIME/doc/help.txt")
4209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 Name of the main help file. All distributed help files should be
4211 placed together in one directory. Additionally, all "doc" directories
4212 in 'runtimepath' will be used.
4213 Environment variables are expanded |:set_env|. For example:
4214 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004215 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 spaces and backslashes.
4217 This option cannot be set from a |modeline| or in the |sandbox|, for
4218 security reasons.
4219
4220 *'helpheight'* *'hh'*
4221'helpheight' 'hh' number (default 20)
4222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 Minimal initial height of the help window when it is opened with the
4224 ":help" command. The initial height of the help window is half of the
4225 current window, or (when the 'ea' option is on) the same as other
4226 windows. When the height is less than 'helpheight', the height is
4227 set to 'helpheight'. Set to zero to disable.
4228
4229 *'helplang'* *'hlg'*
4230'helplang' 'hlg' string (default: messages language or empty)
4231 global
4232 {only available when compiled with the |+multi_lang|
4233 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004234 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 for which the desired help can be found. The English help will always
4236 be used as a last resort. You can add "en" to prefer English over
4237 another language, but that will only find tags that exist in that
4238 language and not in the English help.
4239 Example: >
4240 :set helplang=de,it
4241< This will first search German, then Italian and finally English help
4242 files.
4243 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4244 try to find the tag in the current language before using this option.
4245 See |help-translated|.
4246
4247 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4248'hidden' 'hid' boolean (default off)
4249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 When off a buffer is unloaded when it is |abandon|ed. When on a
4251 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4252 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004253
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004255 hidden even if the 'hidden' option is off when these three are true:
4256 - the buffer is modified
4257 - 'autowrite' is off or writing is not possible
4258 - the '!' flag was used
4259 Also see |windows.txt|.
4260
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004261 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 This option is set for one command with ":hide {command}" |:hide|.
4263 WARNING: It's easy to forget that you have changes in hidden buffers.
4264 Think twice when using ":q!" or ":qa!".
4265
4266 *'highlight'* *'hl'*
4267'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004268 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4269 d:Directory,e:ErrorMsg,i:IncSearch,
4270 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004271 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004272 N:CursorLineNr,r:Question,s:StatusLine,
4273 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004274 v:Visual,V:VisualNOS,w:WarningMsg,
4275 W:WildMenu,f:Folded,F:FoldColumn,
4276 A:DiffAdd,C:DiffChange,D:DiffDelete,
4277 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004278 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004279 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004280 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004281 [:PmenuKind,]:PmenuKindSel,
4282 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004283 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4284 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004285 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004286 z:StatusLineTerm,Z:StatusLineTermNC,
4287 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004290 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004292 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004294 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4295 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 characters from 'showbreak'
4297 |hl-Directory| d directories in CTRL-D listing and other special
4298 things in listings
4299 |hl-ErrorMsg| e error messages
4300 h (obsolete, ignored)
4301 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004302 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4304 |hl-MoreMsg| m |more-prompt|
4305 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004306 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004307 |hl-LineNr| n line number for ":number" and ":#" commands, and
4308 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004309 |hl-LineNrAbove| a line number above the cursor for when the
4310 'relativenumber' option is set.
4311 |hl-LineNrBelow| b line number below the cursor for when the
4312 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004313 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4314 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 |hl-Question| r |hit-enter| prompt and yes/no questions
4316 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004317 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4319 |hl-VertSplit| c column used to separate vertically split windows
4320 |hl-Visual| v Visual mode
4321 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4322 Selection" Only X11 Gui's |gui-x11| and
4323 |xterm-clipboard|.
4324 |hl-WarningMsg| w warning messages
4325 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4326 |hl-Folded| f line used for closed folds
4327 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004328 |hl-DiffAdd| A added line in diff mode
4329 |hl-DiffChange| C changed line in diff mode
4330 |hl-DiffDelete| D deleted line in diff mode
4331 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004333 |hl-Conceal| - the placeholders used for concealed characters
4334 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004335 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004336 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004337 |hl-SpellRare| R rare word |spell|
4338 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004339 |hl-Pmenu| + popup menu normal line
4340 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004341 |hl-PmenuKind| [ popup menu "kind" normal line
4342 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004343 |hl-PmenuExtra| { popup menu "extra" normal line
4344 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004345 |hl-PmenuSbar| x popup menu scrollbar
4346 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004347 |hl-PmenuMatch| k popup menu matched text
4348 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349
4350 The display modes are:
4351 r reverse (termcap entry "mr" and "me")
4352 i italic (termcap entry "ZH" and "ZR")
4353 b bold (termcap entry "md" and "me")
4354 s standout (termcap entry "so" and "se")
4355 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004356 c undercurl (termcap entry "Us" and "Ce")
4357 2 double underline (termcap entry "Ds" and "Ce")
4358 d dotted underline (termcap entry "ds" and "Ce")
4359 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004360 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 n no highlighting
4362 - no highlighting
4363 : use a highlight group
4364 The default is used for occasions that are not included.
4365 If you want to change what the display modes do, see |dos-colors|
4366 for an example.
4367 When using the ':' display mode, this must be followed by the name of
4368 a highlight group. A highlight group can be used to define any type
4369 of highlighting, including using color. See |:highlight| on how to
4370 define one. The default uses a different group for each occasion.
4371 See |highlight-default| for the default highlight groups.
4372
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004374'history' 'hi' number (Vim default: 50, Vi default: 0,
4375 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004378 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004380 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 NOTE: This option is set to the Vi default value when 'compatible' is
4382 set and to the Vim default value when 'compatible' is reset.
4383
4384 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4385'hkmap' 'hk' boolean (default off)
4386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 {only available when compiled with the |+rightleft|
4388 feature}
4389 When on, the keyboard is mapped for the Hebrew character set.
4390 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4391 toggle this option. See |rileft.txt|.
4392 NOTE: This option is reset when 'compatible' is set.
4393
4394 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4395'hkmapp' 'hkp' boolean (default off)
4396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 {only available when compiled with the |+rightleft|
4398 feature}
4399 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4400 This is useful if you have a non-Hebrew keyboard.
4401 See |rileft.txt|.
4402 NOTE: This option is reset when 'compatible' is set.
4403
Bram Moolenaar036986f2017-03-16 17:41:02 +01004404 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4405'hlsearch' 'hls' boolean (default off)
4406 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004407 {not available when compiled without the
4408 |+extra_search| feature}
4409 When there is a previous search pattern, highlight all its matches.
4410 The type of highlighting used can be set with the 'l' occasion in the
4411 'highlight' option. This uses the "Search" highlight group by
4412 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004413 are not applied. If the "CurSearch" highlight group is set then the
4414 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004415 See also: 'incsearch' and |:match|.
4416 When you get bored looking at the highlighted matches, you can turn it
4417 off with |:nohlsearch|. This does not change the option value, as
4418 soon as you use a search command, the highlighting comes back.
4419 'redrawtime' specifies the maximum time spent on finding matches.
4420 When the search pattern can match an end-of-line, Vim will try to
4421 highlight all of the matched text. However, this depends on where the
4422 search starts. This will be the first line in the window or the first
4423 line below a closed fold. A match in a previous line which is not
4424 drawn may not continue in a newly drawn line.
4425 You can specify whether the highlight status is restored on startup
4426 with the 'h' flag in 'viminfo' |viminfo-h|.
4427 NOTE: This option is reset when 'compatible' is set.
4428
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 *'icon'* *'noicon'*
4430'icon' boolean (default off, on when title can be restored)
4431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 When on, the icon text of the window will be set to the value of
4433 'iconstring' (if it is not empty), or to the name of the file
4434 currently being edited. Only the last part of the name is used.
4435 Overridden by the 'iconstring' option.
4436 Only works if the terminal supports setting window icons (currently
4437 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4438 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4439 builtin termcap).
4440 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004441 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004443 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444
4445 *'iconstring'*
4446'iconstring' string (default "")
4447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 When this option is not empty, it will be used for the icon text of
4449 the window. This happens only when the 'icon' option is on.
4450 Only works if the terminal supports setting window icon text
4451 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004452 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 When Vim was compiled with HAVE_X11 defined, the original icon will be
4454 restored if possible |X11|.
4455 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004456 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004458 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 {not available when compiled without the |+statusline| feature}
4460
4461 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4462'ignorecase' 'ic' boolean (default off)
4463 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004464 Ignore case in search patterns, |cmdline-completion|, when
4465 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004466 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 Can be overruled by using "\c" or "\C" in the pattern, see
4468 |/ignorecase|.
4469
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004470 *'imactivatefunc'* *'imaf'*
4471'imactivatefunc' 'imaf' string (default "")
4472 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004473 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004474 activate or deactivate the Input Method. The value can be the name of
4475 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4476 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004477 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004478 The expression will be evaluated in the |sandbox| when set from a
4479 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004480
4481 Example: >
4482 function ImActivateFunc(active)
4483 if a:active
4484 ... do something
4485 else
4486 ... do something
4487 endif
4488 " return value is not used
4489 endfunction
4490 set imactivatefunc=ImActivateFunc
4491<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 *'imactivatekey'* *'imak'*
4493'imactivatekey' 'imak' string (default "")
4494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004496 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 Specifies the key that your Input Method in X-Windows uses for
4498 activation. When this is specified correctly, vim can fully control
4499 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4500 You can't use this option to change the activation key, the option
4501 tells Vim what the key is.
4502 Format:
4503 [MODIFIER_FLAG-]KEY_STRING
4504
4505 These characters can be used for MODIFIER_FLAG (case is ignored):
4506 S Shift key
4507 L Lock key
4508 C Control key
4509 1 Mod1 key
4510 2 Mod2 key
4511 3 Mod3 key
4512 4 Mod4 key
4513 5 Mod5 key
4514 Combinations are allowed, for example "S-C-space" or "SC-space" are
4515 both shift+ctrl+space.
4516 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4517
4518 Example: >
4519 :set imactivatekey=S-space
4520< "S-space" means shift+space. This is the activation key for kinput2 +
4521 canna (Japanese), and ami (Korean).
4522
4523 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4524'imcmdline' 'imc' boolean (default off)
4525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 When set the Input Method is always on when starting to edit a command
4527 line, unless entering a search pattern (see 'imsearch' for that).
4528 Setting this option is useful when your input method allows entering
4529 English characters directly, e.g., when it's used to type accented
4530 characters with dead keys.
4531
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004532 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 When set the Input Method is never used. This is useful to disable
4536 the IM when it doesn't work properly.
4537 Currently this option is on by default for SGI/IRIX machines. This
4538 may change in later releases.
4539
4540 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004541'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 Specifies whether :lmap or an Input Method (IM) is to be used in
4544 Insert mode. Valid values:
4545 0 :lmap is off and IM is off
4546 1 :lmap is ON and IM is off
4547 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 To always reset the option to zero when leaving Insert mode with <Esc>
4549 this can be used: >
4550 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4551< This makes :lmap and IM turn off automatically when leaving Insert
4552 mode.
4553 Note that this option changes when using CTRL-^ in Insert mode
4554 |i_CTRL-^|.
4555 The value is set to 1 when setting 'keymap' to a valid keymap name.
4556 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004557 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 methods. Use 'imdisable' to disable XIM then.
4559
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004560 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004561 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004562 |+multi_byte_ime| or |global-ime|.
4563
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004565'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 Specifies whether :lmap or an Input Method (IM) is to be used when
4568 entering a search pattern. Valid values:
4569 -1 the value of 'iminsert' is used, makes it look like
4570 'iminsert' is also used when typing a search pattern
4571 0 :lmap is off and IM is off
4572 1 :lmap is ON and IM is off
4573 2 :lmap is off and IM is ON
4574 Note that this option changes when using CTRL-^ in Command-line mode
4575 |c_CTRL-^|.
4576 The value is set to 1 when it is not -1 and setting the 'keymap'
4577 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004578 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 methods. Use 'imdisable' to disable XIM then.
4580
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004581 *'imstatusfunc'* *'imsf'*
4582'imstatusfunc' 'imsf' string (default "")
4583 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004584 This option specifies a function that is called to obtain the status
4585 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004586 The value can be the name of a function, a |lambda| or a |Funcref|.
4587 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004588 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004589
4590 Example: >
4591 function ImStatusFunc()
4592 let is_active = ...do something
4593 return is_active ? 1 : 0
4594 endfunction
4595 set imstatusfunc=ImStatusFunc
4596<
4597 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004598 The expression will be evaluated in the |sandbox| when set from a
4599 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004600
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004601 *'imstyle'* *'imst'*
4602'imstyle' 'imst' number (default 1)
4603 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004604 {only available when compiled with |+xim| and
4605 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004606 This option specifies the input style of Input Method:
4607 0 use on-the-spot style
4608 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004609 See: |xim-input-style|
4610
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004611 For a long time on-the-spot style had been used in the GTK version of
4612 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004613 |single-repeat|, etc. Therefore over-the-spot style becomes the
4614 default now. This should work fine for most people, however if you
4615 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004616 The expression will be evaluated in the |sandbox| when set from a
4617 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004618
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 *'include'* *'inc'*
4620'include' 'inc' string (default "^\s*#\s*include")
4621 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 {not available when compiled without the
4623 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004624 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 pattern, just like for the "/" command (See |pattern|). The default
4626 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004627 "]I", "[d", etc.
4628 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004629 comes after the matched pattern. But if "\zs" appears in the pattern
4630 then the text matched from "\zs" to the end, or until "\ze" if it
4631 appears, is used as the file name. Use this to include characters
4632 that are not in 'isfname', such as a space. You can then use
4633 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004634 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636 *'includeexpr'* *'inex'*
4637'includeexpr' 'inex' string (default "")
4638 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004640 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004642 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004643 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004645 Note the double backslash: the `:set` command first halves them, then
4646 one remains it the value, where "\." matches a dot literally. For
4647 simple character replacements `tr()` avoids the need for escaping: >
4648 :setlocal includeexpr=tr(v:fname,'.','/')
4649<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004651 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 Also used for |<cfile>|.
4653
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004654 If the expression starts with s: or |<SID>|, then it is replaced with
4655 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004656 setlocal includeexpr=s:MyIncludeExpr()
4657 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004658< Otherwise, the expression is evaluated in the context of the script
4659 where the option was set, thus script-local items are available.
4660
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004661 It is more efficient if the value is just a function call without
4662 arguments, see |expr-option-function|.
4663
Bram Moolenaar30b65812012-07-12 22:01:11 +02004664 The expression will be evaluated in the |sandbox| when set from a
4665 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004666 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004667
4668 It is not allowed to change text or jump to another window while
4669 evaluating 'includeexpr' |textlock|.
4670
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004672'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004673 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004676 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004677 While typing a search command, show where the pattern, as it was typed
4678 so far, matches. The matched string is highlighted. If the pattern
4679 is invalid or not found, nothing is shown. The screen will be updated
4680 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004681 Also applies to the pattern in commands: >
4682 :global
4683 :lvimgrep
4684 :lvimgrepadd
4685 :smagic
4686 :snomagic
4687 :sort
4688 :substitute
4689 :vglobal
4690 :vimgrep
4691 :vimgrepadd
4692< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004693 original position when no match is found and when pressing <Esc>. You
4694 still need to finish the search command with <Enter> to move the
4695 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004696 You can use the CTRL-G and CTRL-T keys to move to the next and
4697 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004698 When compiled with the |+reltime| feature Vim only searches for about
4699 half a second. With a complicated pattern and/or a lot of text the
4700 match may not be found. This is to avoid that Vim hangs while you
4701 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004702 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004703 When 'hlsearch' is on, all matched strings are highlighted too while
4704 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004705 If you don't want to turn 'hlsearch' on, but want to highlight all
4706 matches while searching, you can turn on and off 'hlsearch' with
4707 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004708 augroup vimrc-incsearch-highlight
4709 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004710 autocmd CmdlineEnter /,\? :set hlsearch
4711 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004712 augroup END
4713<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004714 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004715 to the command line. If 'ignorecase' and 'smartcase' are set and the
4716 command line has no uppercase characters, the added character is
4717 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004718 CTRL-R CTRL-W can be used to add the word at the end of the current
4719 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 NOTE: This option is reset when 'compatible' is set.
4721
4722 *'indentexpr'* *'inde'*
4723'indentexpr' 'inde' string (default "")
4724 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004725 {not available when compiled without the |+eval|
4726 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 Expression which is evaluated to obtain the proper indent for a line.
4728 It is used when a new line is created, for the |=| operator and
4729 in Insert mode as specified with the 'indentkeys' option.
4730 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004731 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004732 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 When 'paste' is set this option is not used for indenting.
4734 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004735 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004737
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004738 If the expression starts with s: or |<SID>|, then it is replaced with
4739 the script ID (|local-function|). Example: >
4740 set indentexpr=s:MyIndentExpr()
4741 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004742< Otherwise, the expression is evaluated in the context of the script
4743 where the option was set, thus script-local items are available.
4744
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004745 The advantage of using a function call without arguments is that it is
4746 faster, see |expr-option-function|.
4747
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 The expression must return the number of spaces worth of indent. It
4749 can return "-1" to keep the current indent (this means 'autoindent' is
4750 used for the indent).
4751 Functions useful for computing the indent are |indent()|, |cindent()|
4752 and |lispindent()|.
4753 The evaluation of the expression must not have side effects! It must
4754 not change the text, jump to another window, etc. Afterwards the
4755 cursor position is always restored, thus the cursor may be moved.
4756 Normally this option would be set to call a function: >
4757 :set indentexpr=GetMyIndent()
4758< Error messages will be suppressed, unless the 'debug' option contains
4759 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004760 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004761 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
Bram Moolenaar30b65812012-07-12 22:01:11 +02004763 The expression will be evaluated in the |sandbox| when set from a
4764 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004765 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004766
4767 It is not allowed to change text or jump to another window while
4768 evaluating 'indentexpr' |textlock|.
4769
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004771'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 A list of keys that, when typed in Insert mode, cause reindenting of
4774 the current line. Only happens if 'indentexpr' isn't empty.
4775 The format is identical to 'cinkeys', see |indentkeys-format|.
4776 See |C-indenting| and |indent-expression|.
4777
4778 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4779'infercase' 'inf' boolean (default off)
4780 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004782 'ignorecase' is also on, the case of the match is adjusted depending
4783 on the typed text. If the typed text contains a lowercase letter
4784 where the match has an upper case letter, the completed part is made
4785 lowercase. If the typed text has no lowercase letters and the match
4786 has a lowercase letter where the typed text has an uppercase letter,
4787 and there is a letter before it, the completed part is made uppercase.
4788 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789
4790 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4791'insertmode' 'im' boolean (default off)
4792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 Makes Vim work in a way that Insert mode is the default mode. Useful
4794 if you want to use Vim as a modeless editor. Used for |evim|.
4795 These Insert mode commands will be useful:
4796 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004797 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 this is a mapping, it is executed as if 'insertmode' was off.
4799 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004801 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4802 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803
4804 These items change when 'insertmode' is set:
4805 - when starting to edit of a file, Vim goes to Insert mode.
4806 - <Esc> in Insert mode is a no-op and beeps.
4807 - <Esc> in Normal mode makes Vim go to Insert mode.
4808 - CTRL-L in Insert mode is a command, it is not inserted.
4809 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4810 However, when <Esc> is used inside a mapping, it behaves like
4811 'insertmode' was not set. This was done to be able to use the same
4812 mappings with 'insertmode' set or not set.
4813 When executing commands with |:normal| 'insertmode' is not used.
4814
4815 NOTE: This option is reset when 'compatible' is set.
4816
4817 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004818'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4820 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4821 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4822 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4823 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 The characters specified by this option are included in file names and
4826 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004827 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 Multi-byte characters 256 and above are always included, only the
4829 characters up to 255 are specified with this option.
4830 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004831 Think twice before adding white space to this option. Although a
4832 space may appear inside a file name, the effect will be that Vim
4833 doesn't know where a file name starts or ends when doing completion.
4834 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835
4836 Note that on systems using a backslash as path separator, Vim tries to
4837 do its best to make it work as you would expect. That is a bit
4838 tricky, since Vi originally used the backslash to escape special
4839 characters. Vim will not remove a backslash in front of a normal file
4840 name character on these systems, but it will on Unix and alikes. The
4841 '&' and '^' are not included by default, because these are special for
4842 cmd.exe.
4843
4844 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 Each part can be a single character number or a range. A range is two
4846 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 decimal number between 0 and 255 or the ASCII character itself (does
4848 not work for digits). Example:
4849 "_,-,128-140,#-43" (include '_' and '-' and the range
4850 128 to 140 and '#' to 43)
4851 If a part starts with '^', the following character number or range
4852 will be excluded from the option. The option is interpreted from left
4853 to right. Put the excluded character after the range where it is
4854 included. To include '^' itself use it as the last character of the
4855 option or the end of a range. Example:
4856 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4857 If the character is '@', all characters where isalpha() returns TRUE
4858 are included. Normally these are the characters a to z and A to Z,
4859 plus accented characters. To include '@' itself use "@-@". Examples:
4860 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004861 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 "a-z,A-Z,@-@" All letters plus the '@' character.
4863 A comma can be included by using it where a character number is
4864 expected. Example:
4865 "48-57,,,_" Digits, comma and underscore.
4866 A comma can be excluded by prepending a '^'. Example:
4867 " -~,^,,9" All characters from space to '~', excluding
4868 comma, plus <Tab>.
4869 See |option-backslash| about including spaces and backslashes.
4870
4871 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004872'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 "@,48-57,_,128-167,224-235"
4874 otherwise: "@,48-57,_,192-255")
4875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 The characters given by this option are included in identifiers.
4877 Identifiers are used in recognizing environment variables and after a
4878 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004879 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004880 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004882 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4884
4885 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004886'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 "@,48-57,_,128-167,224-235"
4888 otherwise: "@,48-57,_,192-255"
4889 Vi default: "@,48-57,_")
4890 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004892 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004893 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004894 characters above 255 check the "word" character class (any character
4895 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004896 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 For a help file it is set to all non-blank printable characters except
4898 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4899 command).
4900 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004901 This option also influences syntax highlighting, unless the syntax
4902 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 NOTE: This option is set to the Vi default value when 'compatible' is
4904 set and to the Vim default value when 'compatible' is reset.
4905
4906 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004907'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 "@,~-255"; otherwise: "@,161-255")
4909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 The characters given by this option are displayed directly on the
4911 screen. It is also used for "\p" in a |pattern|. The characters from
4912 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4913 even when they are not included in 'isprint' or excluded. See
4914 'isfname' for a description of the format of this option.
4915
4916 Non-printable characters are displayed with two characters:
4917 0 - 31 "^@" - "^_"
4918 32 - 126 always single characters
4919 127 "^?"
4920 128 - 159 "~@" - "~_"
4921 160 - 254 "| " - "|~"
4922 255 "~?"
4923 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4924 displayed as <xx>, with the hexadecimal value of the byte.
4925 When 'display' contains "uhex" all unprintable characters are
4926 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004927 The SpecialKey highlighting will be used for unprintable characters.
4928 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929
4930 Multi-byte characters 256 and above are always included, only the
4931 characters up to 255 are specified with this option. When a character
4932 is printable but it is not available in the current font, a
4933 replacement character will be shown.
4934 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4935 There is no option to specify these characters.
4936
4937 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4938'joinspaces' 'js' boolean (default on)
4939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 Insert two spaces after a '.', '?' and '!' with a join command.
4941 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4942 Otherwise only one space is inserted.
4943 NOTE: This option is set when 'compatible' is set.
4944
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004945 *'jumpoptions'* *'jop'*
4946'jumpoptions' 'jop' string (default "")
4947 global
4948 List of words that change the behavior of the |jumplist|.
4949 stack Make the jumplist behave like the tagstack.
4950 Relative location of entries in the jumplist is
4951 preserved at the cost of discarding subsequent entries
4952 when navigating backwards in the jumplist and then
4953 jumping to a location. |jumplist-stack|
4954
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 *'key'*
4956'key' string (default "")
4957 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004958 {only available when compiled with the |+cryptv|
4959 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004961 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 Careful: Do not set the key value by hand, someone might see the typed
4963 key. Use the |:X| command. But you can make 'key' empty: >
4964 :set key=
4965< It is not possible to get the value of this option with ":set key" or
4966 "echo &key". This is to avoid showing it to someone who shouldn't
4967 know. It also means you cannot see it yourself once you have set it,
4968 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004969 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4970 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004971 You can use "&key" in an expression to detect whether encryption is
4972 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973
4974 *'keymap'* *'kmp'* *E544*
4975'keymap' 'kmp' string (default "")
4976 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 {only available when compiled with the |+keymap|
4978 feature}
4979 Name of a keyboard mapping. See |mbyte-keymap|.
4980 Setting this option to a valid keymap name has the side effect of
4981 setting 'iminsert' to one, so that the keymap becomes effective.
4982 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004983 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984
4985 *'keymodel'* *'km'*
4986'keymodel' 'km' string (default "")
4987 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004988 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 can do. These values can be used:
4990 startsel Using a shifted special key starts selection (either
4991 Select mode or Visual mode, depending on "key" being
4992 present in 'selectmode').
4993 stopsel Using a not-shifted special key stops selection.
4994 Special keys in this context are the cursor keys, <End>, <Home>,
4995 <PageUp> and <PageDown>.
4996 The 'keymodel' option is set by the |:behave| command.
4997
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004998 *'keyprotocol'* *'kpc'*
4999'keyprotocol' 'kpc' string (default: see below)
5000 global
5001 Specifies what keyboard protocol to use depending on the value of
5002 'term'. The supported keyboard protocols names are:
5003 none whatever the terminal uses
5004 mok2 modifyOtherKeys level 2, as supported by xterm
5005 kitty Kitty keyboard protocol, as supported by Kitty
5006
Bram Moolenaara87749e2022-11-30 10:23:17 +00005007 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005008 a pattern that is matched against the 'term' option, a colon and the
5009 protocol name to be used. To illustrate this, the default value would
5010 be set with: >
5011 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5012
5013< This means that when 'term' contains "kitty, "foot" or "wezterm"
5014 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005015 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005016
5017 The first match is used, thus if you want to have "kitty" use the
5018 kitty protocol, but "badkitty" not, then you should match "badkitty"
5019 first and use the "none" value: >
5020 set keyprotocol=badkitty:none,kitty:kitty
5021<
5022 The option is used after 'term' has been changed. First the termcap
5023 entries are set, possibly using the builtin list, see |builtin-terms|.
5024 Then this option is inspected and if there is a match and a protocol
5025 is specified the following happens:
5026 none Nothing, the regular t_TE and t_TI values remain
5027
5028 mok2 The t_TE value is changed to:
5029 CSI >4;m disables modifyOtherKeys
5030 The t_TI value is changed to:
5031 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005032 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005033
5034 kitty The t_TE value is changed to:
5035 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005036 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005037 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005038 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005039 CSI ?u request kitty keyboard protocol state
5040 CSI >c request the termresponse
5041
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005042 If you notice problems, such as characters being displayed that
5043 disappear after `CTRL-L`, you might want to try making this option
5044 empty. Then set the 'term' option to have it take effect: >
5045 set keyprotocol=
5046 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005047<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005048
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 *'keywordprg'* *'kp'*
5050'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005051 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 Program to use for the |K| command. Environment variables are
5054 expanded |:set_env|. ":help" may be used to access the Vim internal
5055 help. (Note that previously setting the global option to the empty
5056 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005057 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005058 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005059 When "man", "man -s" or an Ex command is used, Vim will automatically
5060 translate a count for the "K" command and pass it as the first
5061 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 See |option-backslash| about including spaces and backslashes.
5063 Example: >
5064 :set keywordprg=man\ -s
5065< This option cannot be set from a |modeline| or in the |sandbox|, for
5066 security reasons.
5067
5068 *'langmap'* *'lmap'* *E357* *E358*
5069'langmap' 'lmap' string (default "")
5070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 {only available when compiled with the |+langmap|
5072 feature}
5073 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005074 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005075 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 care of translating these special characters to the original meaning
5077 of the key. This means you don't have to change the keyboard mode to
5078 be able to execute Normal mode commands.
5079 This is the opposite of the 'keymap' option, where characters are
5080 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005081 Also consider setting 'langremap' to off, to prevent 'langmap' from
5082 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005083 This option cannot be set from a |modeline| or in the |sandbox|, for
5084 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005086 Example (for Greek, in UTF-8): *greek* >
5087 :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 +00005088< Example (exchanges meaning of z and y for commands): >
5089 :set langmap=zy,yz,ZY,YZ
5090<
5091 The 'langmap' option is a list of parts, separated with commas. Each
5092 part can be in one of two forms:
5093 1. A list of pairs. Each pair is a "from" character immediately
5094 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005095 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 characters. Example: "abc;ABC"
5097 Example: "aA,fgh;FGH,cCdDeE"
5098 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005099 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100
5101 This will allow you to activate vim actions without having to switch
5102 back and forth between the languages. Your language characters will
5103 be understood as normal vim English characters (according to the
5104 langmap mappings) in the following cases:
5105 o Normal/Visual mode (commands, buffer/register names, user mappings)
5106 o Insert/Replace Mode: Register names after CTRL-R
5107 o Insert/Replace Mode: Mappings
5108 Characters entered in Command-line mode will NOT be affected by
5109 this option. Note that this option can be changed at any time
5110 allowing to switch between mappings for different languages/encodings.
5111 Use a mapping to avoid having to type it each time!
5112
5113 *'langmenu'* *'lm'*
5114'langmenu' 'lm' string (default "")
5115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 {only available when compiled with the |+menu| and
5117 |+multi_lang| features}
5118 Language to use for menu translation. Tells which file is loaded
5119 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005120 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121< (without the spaces). For example, to always use the Dutch menus, no
5122 matter what $LANG is set to: >
5123 :set langmenu=nl_NL.ISO_8859-1
5124< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005125 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 If your $LANG is set to a non-English language but you do want to use
5127 the English menus: >
5128 :set langmenu=none
5129< This option must be set before loading menus, switching on filetype
5130 detection or syntax highlighting. Once the menus are defined setting
5131 this option has no effect. But you could do this: >
5132 :source $VIMRUNTIME/delmenu.vim
5133 :set langmenu=de_DE.ISO_8859-1
5134 :source $VIMRUNTIME/menu.vim
5135< Warning: This deletes all menus that you defined yourself!
5136
Bram Moolenaard94464e2015-11-02 15:28:18 +01005137 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005138'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005139 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005140 {only available when compiled with the |+langmap|
5141 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005142 This is just like 'langremap' but with the value inverted. It only
5143 exists for backwards compatibility. When setting 'langremap' then
5144 'langnoremap' is set to the inverted value, and the other way around.
5145
5146 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005147'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005148 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005149 {only available when compiled with the |+langmap|
5150 feature}
5151 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005152 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005153 'langmap' disables some of your mappings, try resetting this option.
5154 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005155 that works for you to avoid mappings to break.
5156
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 *'laststatus'* *'ls'*
5158'laststatus' 'ls' number (default 1)
5159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 The value of this option influences when the last window will have a
5161 status line:
5162 0: never
5163 1: only if there are at least two windows
5164 2: always
5165 The screen looks nicer with a status line if you have several
5166 windows, but it takes another screen line. |status-line|
5167
5168 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5169'lazyredraw' 'lz' boolean (default off)
5170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 When this option is set, the screen will not be redrawn while
5172 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005173 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005175 This may occasionally cause display errors. It is only meant to be set
5176 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005177 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
5179 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5180'linebreak' 'lbr' boolean (default off)
5181 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005182 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005184 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 than at the last character that fits on the screen. Unlike
5186 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005187 it only affects the way the file is displayed, not its contents.
5188 If 'breakindent' is set, line is visually indented. Then, the value
5189 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005190 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 Note that <Tab> characters after an <EOL> are mostly not displayed
5192 with the right amount of white space.
5193
5194 *'lines'* *E593*
5195'lines' number (default 24 or terminal height)
5196 global
5197 Number of lines of the Vim window.
5198 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005199 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 When Vim is running in the GUI or in a resizable window, setting this
5201 option will cause the window size to be changed. When you only want
5202 to use the size for the GUI, put the command in your |gvimrc| file.
5203 Vim limits the number of lines to what fits on the screen. You can
5204 use this command to get the tallest window possible: >
5205 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005206< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005207 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 When you set this option and Vim is unable to change the physical
5209 number of lines of the display, the display may be messed up.
5210
5211 *'linespace'* *'lsp'*
5212'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {only in the GUI}
5215 Number of pixel lines inserted between characters. Useful if the font
5216 uses the full character cell height, making lines touch each other.
5217 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005218 With some fonts there can be too much room between lines (to have
5219 space for ascents and descents). Then it makes sense to set
5220 'linespace' to a negative value. This may cause display problems
5221 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
5223 *'lisp'* *'nolisp'*
5224'lisp' boolean (default off)
5225 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 Lisp mode: When <Enter> is typed in insert mode set the indent for
5227 the next line to Lisp standards (well, sort of). Also happens with
5228 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5229 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5230 better. Also see 'lispwords'.
5231 The '-' character is included in keyword characters. Redefines the
5232 "=" operator to use this same indentation algorithm rather than
5233 calling an external program if 'equalprg' is empty.
5234 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005236 *'lispoptions'* *'lop'*
5237'lispoptions' 'lop' string (default "")
5238 local to buffer
5239 Comma-separated list of items that influence the Lisp indenting when
5240 enabled with the |'lisp'| option. Currently only one item is
5241 supported:
5242 expr:1 use 'indentexpr' for Lisp indenting when it is set
5243 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5244 Note that when using 'indentexpr' the `=` operator indents all the
5245 lines, otherwise the first line is not indented (Vi-compatible).
5246
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 *'lispwords'* *'lw'*
5248'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005249 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005250 Comma-separated list of words that influence the Lisp indenting when
5251 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252
5253 *'list'* *'nolist'*
5254'list' boolean (default off)
5255 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005256 List mode: By default show tabs as CTRL-I is displayed, display $
5257 after end of line. Useful to see the difference between tabs and
5258 spaces and for trailing blanks. Further changed by the 'listchars'
5259 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005260
5261 The cursor is displayed at the start of the space a Tab character
5262 occupies, not at the end as usual in Normal mode. To get this cursor
5263 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005264 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005265<
5266 Note that list mode will also affect formatting (set with 'textwidth'
5267 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 changing the way tabs are displayed.
5269
5270 *'listchars'* *'lcs'*
5271'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005272 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005273 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005274 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005275 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 eol:c Character to show at the end of each line. When
5277 omitted, there is no extra character at the end of the
5278 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005279 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005280 tab:xy[z] Two or three characters to be used to show a tab.
5281 The third character is optional.
5282
5283 tab:xy The 'x' is always used, then 'y' as many times as will
5284 fit. Thus "tab:>-" displays:
5285 >
5286 >-
5287 >--
5288 etc.
5289
5290 tab:xyz The 'z' is always used, then 'x' is prepended, and
5291 then 'y' is used as many times as will fit. Thus
5292 "tab:<->" displays:
5293 >
5294 <>
5295 <->
5296 <-->
5297 etc.
5298
5299 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005300 *lcs-space*
5301 space:c Character to show for a space. When omitted, spaces
5302 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005303 *lcs-multispace*
5304 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005305 One or more characters to use cyclically to show for
5306 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005307 setting, except for single spaces. When omitted, the
5308 "space" setting is used. For example,
5309 `:set listchars=multispace:---+` shows ten consecutive
5310 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005311 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005312 *lcs-lead*
5313 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005314 leading spaces are blank. Overrides the "space" and
5315 "multispace" settings for leading spaces. You can
5316 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005317 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005318< *lcs-leadmultispace*
5319 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005320 Like the |lcs-multispace| value, but for leading
5321 spaces only. Also overrides |lcs-lead| for leading
5322 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005323 `:set listchars=leadmultispace:---+` shows ten
5324 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005325 ---+---+--XXX ~
5326 Where "XXX" denotes the first non-blank characters in
5327 the line.
5328 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005329 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005330 trailing spaces are blank. Overrides the "space" and
5331 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005332 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 extends:c Character to show in the last column, when 'wrap' is
5334 off and the line continues beyond the right of the
5335 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005336 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005337 precedes:c Character to show in the first visible column of the
5338 physical line, when there is text preceding the
5339 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005340 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005341 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005342 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005343 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005344 nbsp:c Character to show for a non-breakable space character
5345 (0xA0 (160 decimal) and U+202F). Left blank when
5346 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005348 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005350 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005352 Each character can be specified as hex: >
5353 set listchars=eol:\\x24
5354 set listchars=eol:\\u21b5
5355 set listchars=eol:\\U000021b5
5356< Note that a double backslash is used. The number of hex characters
5357 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5358
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 Examples: >
5360 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005361 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 :set lcs=extends:>,precedes:<
5363< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005364 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5365 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005366 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367
5368 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5369'loadplugins' 'lpl' boolean (default on)
5370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 When on the plugin scripts are loaded when starting up |load-plugins|.
5372 This option can be reset in your |vimrc| file to disable the loading
5373 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005374 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5375 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376
Bram Moolenaard94464e2015-11-02 15:28:18 +01005377 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005378'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005379 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005380 {only available when compiled with the |+lua/dyn|
5381 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005382 Specifies the name of the Lua shared library. The default is
5383 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005384 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005385 This option cannot be set from a |modeline| or in the |sandbox|, for
5386 security reasons.
5387
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005388 *'macatsui'* *'nomacatsui'*
5389'macatsui' boolean (default on)
5390 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005391 {not supported}
5392 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005393
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 *'magic'* *'nomagic'*
5395'magic' boolean (default on)
5396 global
5397 Changes the special characters that can be used in search patterns.
5398 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005399 WARNING: Switching this option off most likely breaks plugins! That
5400 is because many patterns assume it's on and will fail when it's off.
5401 Only switch it off when working with old Vi scripts. In any other
5402 situation write patterns that work when 'magic' is on. Include "\M"
5403 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005404 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5405 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
5407 *'makeef'* *'mef'*
5408'makeef' 'mef' string (default: "")
5409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 {not available when compiled without the |+quickfix|
5411 feature}
5412 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5413 and the |:grep| command.
5414 When it is empty, an internally generated temp file will be used.
5415 When "##" is included, it is replaced by a number to make the name
5416 unique. This makes sure that the ":make" command doesn't overwrite an
5417 existing file.
5418 NOT used for the ":cf" command. See 'errorfile' for that.
5419 Environment variables are expanded |:set_env|.
5420 See |option-backslash| about including spaces and backslashes.
5421 This option cannot be set from a |modeline| or in the |sandbox|, for
5422 security reasons.
5423
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005424 *'makeencoding'* *'menc'*
5425'makeencoding' 'menc' string (default "")
5426 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005427 Encoding used for reading the output of external commands. When empty,
5428 encoding is not converted.
5429 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5430 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5431 and `:laddfile`.
5432
5433 This would be mostly useful when you use MS-Windows and set 'encoding'
5434 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5435 'makeencoding' to "char" has the same effect as setting to the system
5436 locale encoding. Example: >
5437 :set encoding=utf-8
5438 :set makeencoding=char " system locale is used
5439<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 *'makeprg'* *'mp'*
5441'makeprg' 'mp' string (default "make", VMS: "MMS")
5442 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005443 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005444 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5445 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005446 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005447 Environment variables are expanded |:set_env|. See |option-backslash|
5448 about including spaces and backslashes.
5449 Note that a '|' must be escaped twice: once for ":set" and once for
5450 the interpretation of a command. When you use a filter called
5451 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 :set makeprg=gmake\ \\\|\ myfilter
5453< The placeholder "$*" can be given (even multiple times) to specify
5454 where the arguments will be included, for example: >
5455 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5456< This option cannot be set from a |modeline| or in the |sandbox|, for
5457 security reasons.
5458
5459 *'matchpairs'* *'mps'*
5460'matchpairs' 'mps' string (default "(:),{:},[:]")
5461 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005463 other.
5464 Only character pairs are allowed that are different, thus you cannot
5465 jump between two double quotes.
5466 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005467 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005468 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 :set mps+=<:>
5470
5471< A more exotic example, to jump between the '=' and ';' in an
5472 assignment, useful for languages like C and Java: >
5473 :au FileType c,cpp,java set mps+==:;
5474
5475< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005476 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
5478 *'matchtime'* *'mat'*
5479'matchtime' 'mat' number (default 5)
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 Tenths of a second to show the matching paren, when 'showmatch' is
5482 set. Note that this is not in milliseconds, like other options that
5483 set a time. This is to be compatible with Nvi.
5484
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005485 *'maxcombine'* *'mco'*
5486'maxcombine' 'mco' number (default 2)
5487 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005488 The maximum number of combining characters supported for displaying.
5489 Only used when 'encoding' is "utf-8".
5490 The default is OK for most languages. Hebrew may require 4.
5491 Maximum value is 6.
5492 Even when this option is set to 2 you can still edit text with more
5493 combining characters, you just can't see them. Use |g8| or |ga|.
5494 See |mbyte-combining|.
5495
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 *'maxfuncdepth'* *'mfd'*
5497'maxfuncdepth' 'mfd' number (default 100)
5498 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005499 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005500 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 Maximum depth of function calls for user functions. This normally
5502 catches endless recursion. When using a recursive function with
5503 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5504 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005505 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005506 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005508 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509
5510 *'maxmapdepth'* *'mmd'* *E223*
5511'maxmapdepth' 'mmd' number (default 1000)
5512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 Maximum number of times a mapping is done without resulting in a
5514 character to be used. This normally catches endless mappings, like
5515 ":map x y" with ":map y x". It still does not catch ":map g wg",
5516 because the 'w' is used before the next mapping is done. See also
5517 |key-mapping|.
5518
5519 *'maxmem'* *'mm'*
5520'maxmem' 'mm' number (default between 256 to 5120 (system
5521 dependent) or half the amount of memory
5522 available)
5523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5525 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005526 other memory to be freed.
5527 The maximum usable value is about 2000000. Use this to work without a
5528 limit.
5529 The value is ignored when 'swapfile' is off.
5530 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005532 *'maxmempattern'* *'mmp'*
5533'maxmempattern' 'mmp' number (default 1000)
5534 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005535 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005536 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005537 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005538 When Vim runs into the limit it gives an error message and mostly
5539 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005540 Running into the limit often means that the pattern is very
5541 inefficient or too complex. This may already happen with the pattern
5542 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005543 Might also happen on redraw, when syntax rules try to match a complex
5544 text structure.
5545 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5546 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 *'maxmemtot'* *'mmt'*
5549'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5550 dependent) or half the amount of memory
5551 available)
5552 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005553 Maximum amount of memory in Kbyte to use for all buffers together.
5554 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005555 without a limit.
5556 On 64 bit machines higher values might work. But hey, do you really
5557 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005558 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005559 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005560 Buffers with 'swapfile' off still count to the total amount of memory
5561 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005562 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563
5564 *'menuitems'* *'mis'*
5565'menuitems' 'mis' number (default 25)
5566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 {not available when compiled without the |+menu|
5568 feature}
5569 Maximum number of items to use in a menu. Used for menus that are
5570 generated from a list of items, e.g., the Buffers menu. Changing this
5571 option has no direct effect, the menu must be refreshed first.
5572
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005573 *'mkspellmem'* *'msm'*
5574'mkspellmem' 'msm' string (default "460000,2000,500")
5575 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005576 {not available when compiled without the |+syntax|
5577 feature}
5578 Parameters for |:mkspell|. This tunes when to start compressing the
5579 word tree. Compression can be slow when there are many words, but
5580 it's needed to avoid running out of memory. The amount of memory used
5581 per word depends very much on how similar the words are, that's why
5582 this tuning is complicated.
5583
5584 There are three numbers, separated by commas:
5585 {start},{inc},{added}
5586
5587 For most languages the uncompressed word tree fits in memory. {start}
5588 gives the amount of memory in Kbyte that can be used before any
5589 compression is done. It should be a bit smaller than the amount of
5590 memory that is available to Vim.
5591
5592 When going over the {start} limit the {inc} number specifies the
5593 amount of memory in Kbyte that can be allocated before another
5594 compression is done. A low number means compression is done after
5595 less words are added, which is slow. A high number means more memory
5596 will be allocated.
5597
5598 After doing compression, {added} times 1024 words can be added before
5599 the {inc} limit is ignored and compression is done when any extra
5600 amount of memory is needed. A low number means there is a smaller
5601 chance of hitting the {inc} limit, less memory is used but it's
5602 slower.
5603
5604 The languages for which these numbers are important are Italian and
5605 Hungarian. The default works for when you have about 512 Mbyte. If
5606 you have 1 Gbyte you could use: >
5607 :set mkspellmem=900000,3000,800
5608< If you have less than 512 Mbyte |:mkspell| may fail for some
5609 languages, no matter what you set 'mkspellmem' to.
5610
dkearns8ebdbc92023-10-29 06:26:19 +11005611 This option cannot be set from a |modeline| or in the |sandbox|, for
5612 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005613
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005615'modeline' 'ml' boolean (Vim default: on (off for root),
5616 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005618 If 'modeline' is on 'modelines' gives the number of lines that is
5619 checked for set commands. If 'modeline' is off or 'modelines' is zero
5620 no lines are checked. See |modeline|.
5621
5622 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5623'modelineexpr' 'mle' boolean (default: off)
5624 global
5625 When on allow some options that are an expression to be set in the
5626 modeline. Check the option for whether it is affected by
5627 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005628 This option cannot be set from a |modeline| or in the |sandbox|, for
5629 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005630
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 *'modelines'* *'mls'*
5632'modelines' 'mls' number (default 5)
5633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 If 'modeline' is on 'modelines' gives the number of lines that is
5635 checked for set commands. If 'modeline' is off or 'modelines' is zero
5636 no lines are checked. See |modeline|.
5637 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5638 set and to the Vim default value when 'compatible' is reset.
5639
5640 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005641 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642'modifiable' 'ma' boolean (default on)
5643 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 When off the buffer contents cannot be changed. The 'fileformat' and
5645 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005646 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647
5648 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5649'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005650 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 When on, the buffer is considered to be modified. This option is set
5652 when:
5653 1. A change was made to the text since it was last written. Using the
5654 |undo| command to go back to the original text will reset the
5655 option. But undoing changes that were made before writing the
5656 buffer will set the option again, since the text is different from
5657 when it was written.
5658 2. 'fileformat' or 'fileencoding' is different from its original
5659 value. The original value is set when the buffer is read or
5660 written. A ":set nomodified" command also resets the original
5661 values to the current values and the 'modified' option will be
5662 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005663 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005664 This option is not set when a change is made to the buffer as the
5665 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5666 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5667 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5669 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005670 Note that the text may actually be the same, e.g. 'modified' is set
5671 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
5673 *'more'* *'nomore'*
5674'more' boolean (Vim default: on, Vi default: off)
5675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 When on, listings pause when the whole screen is filled. You will get
5677 the |more-prompt|. When this option is off there are no pauses, the
5678 listing continues until finished.
5679 NOTE: This option is set to the Vi default value when 'compatible' is
5680 set and to the Vim default value when 'compatible' is reset.
5681
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005682 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005683'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005684 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005686 Enable the use of the mouse. Works for most terminals (xterm, Win32
5687 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5688 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5689 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005690 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 v Visual mode
5692 i Insert mode
5693 c Command-line mode
5694 h all previous modes when editing a help file
5695 a all previous modes
5696 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005697 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005699< If your terminal can't overrule the mouse events going to the
5700 application, use: >
5701 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005702< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005703 back to Vim using the mouse events.
5704 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5705 "xterm".
5706
5707 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 modeless selection. This doesn't move the text cursor.
5709
5710 See |mouse-using|. Also see |'clipboard'|.
5711
5712 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005713 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 the mouse buttons can still be used by keeping the shift key pressed.
5715 Also see the 'clipboard' option.
5716
5717 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5718'mousefocus' 'mousef' boolean (default off)
5719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 {only works in the GUI}
5721 The window that the mouse pointer is on is automatically activated.
5722 When changing the window layout or window focus in another way, the
5723 mouse pointer is moved to the window with keyboard focus. Off is the
5724 default because it makes using the pull down menus a little goofy, as
5725 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005726 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005727 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728
5729 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5730'mousehide' 'mh' boolean (default on)
5731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 {only works in the GUI}
5733 When on, the mouse pointer is hidden when characters are typed.
5734 The mouse pointer is restored when the mouse is moved.
5735
5736 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005737'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 Sets the model to use for the mouse. The name mostly specifies what
5740 the right mouse button is used for:
5741 extend Right mouse button extends a selection. This works
5742 like in an xterm.
5743 popup Right mouse button pops up a menu. The shifted left
5744 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005745 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 popup_setpos Like "popup", but the cursor will be moved to the
5747 position where the mouse was clicked, and thus the
5748 selected operation will act upon the clicked object.
5749 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005750 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 course, that right clicking outside a selection will
5752 end Visual mode.
5753 Overview of what button does what for each model:
5754 mouse extend popup(_setpos) ~
5755 left click place cursor place cursor
5756 left drag start selection start selection
5757 shift-left search word extend selection
5758 right click extend selection popup menu (place cursor)
5759 right drag extend selection -
5760 middle click paste paste
5761
5762 In the "popup" model the right mouse button produces a pop-up menu.
5763 You need to define this first, see |popup-menu|.
5764
5765 Note that you can further refine the meaning of buttons with mappings.
5766 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5767 selection (because that's handled in the GUI code directly).
5768
5769 The 'mousemodel' option is set by the |:behave| command.
5770
h_east59858792023-10-25 22:47:05 +09005771 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005772'mousemoveevent' 'mousemev' boolean (default off)
5773 global
5774 {only works in the GUI}
5775 When on, mouse move events are delivered to the input queue and are
5776 available for mapping. The default, off, avoids the mouse movement
5777 overhead except when needed. See |gui-mouse-mapping|.
5778 Warning: Setting this option can make pending mappings to be aborted
5779 when the mouse is moved.
5780 Currently only works in the GUI, may be made to work in a terminal
5781 later.
5782
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005784'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5785 vs:leftright,vd:lrsizing,m:no,
5786 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 {only available when compiled with the |+mouseshape|
5789 feature}
5790 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005791 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 like used for 'guicursor'. Each part consist of a mode/location-list
5793 and an argument-list:
5794 mode-list:shape,mode-list:shape,..
5795 The mode-list is a dash separated list of these modes/locations:
5796 In a normal window: ~
5797 n Normal mode
5798 v Visual mode
5799 ve Visual mode with 'selection' "exclusive" (same as 'v',
5800 if not specified)
5801 o Operator-pending mode
5802 i Insert mode
5803 r Replace mode
5804
5805 Others: ~
5806 c appending to the command-line
5807 ci inserting in the command-line
5808 cr replacing in the command-line
5809 m at the 'Hit ENTER' or 'More' prompts
5810 ml idem, but cursor in the last line
5811 e any mode, pointer below last window
5812 s any mode, pointer on a status line
5813 sd any mode, while dragging a status line
5814 vs any mode, pointer on a vertical separator line
5815 vd any mode, while dragging a vertical separator line
5816 a everywhere
5817
5818 The shape is one of the following:
5819 avail name looks like ~
5820 w x arrow Normal mouse pointer
5821 w x blank no pointer at all (use with care!)
5822 w x beam I-beam
5823 w x updown up-down sizing arrows
5824 w x leftright left-right sizing arrows
5825 w x busy The system's usual busy pointer
5826 w x no The system's usual 'no input' pointer
5827 x udsizing indicates up-down resizing
5828 x lrsizing indicates left-right resizing
5829 x crosshair like a big thin +
5830 x hand1 black hand
5831 x hand2 white hand
5832 x pencil what you write with
5833 x question big ?
5834 x rightup-arrow arrow pointing right-up
5835 w x up-arrow arrow pointing up
5836 x <number> any X11 pointer number (see X11/cursorfont.h)
5837
5838 The "avail" column contains a 'w' if the shape is available for Win32,
5839 x for X11.
5840 Any modes not specified or shapes not available use the normal mouse
5841 pointer.
5842
5843 Example: >
5844 :set mouseshape=s:udsizing,m:no
5845< will make the mouse turn to a sizing arrow over the status lines and
5846 indicate no input when the hit-enter prompt is displayed (since
5847 clicking the mouse has no effect in this state.)
5848
5849 *'mousetime'* *'mouset'*
5850'mousetime' 'mouset' number (default 500)
5851 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005852 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 time in msec between two mouse clicks for the second click to be
5854 recognized as a multi click.
5855
laburnumT3f7855a2023-12-05 18:37:03 +01005856 *'mzquantum'* *'mzq'*
5857'mzquantum' 'mzq' number (default 100)
5858 global
5859 {not available when compiled without the |+mzscheme|
5860 feature}
5861 The number of milliseconds between polls for MzScheme threads.
5862 Negative or zero value means no thread scheduling.
5863 NOTE: This option is set to the Vim default value when 'compatible'
5864 is reset.
5865
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005866 *'mzschemedll'*
5867'mzschemedll' string (default depends on the build)
5868 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005869 {only available when compiled with the |+mzscheme/dyn|
5870 feature}
5871 Specifies the name of the MzScheme shared library. The default is
5872 DYNAMIC_MZSCH_DLL which was specified at compile time.
5873 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005874 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005875 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
5879 *'mzschemegcdll'*
5880'mzschemegcdll' string (default depends on the build)
5881 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005882 {only available when compiled with the |+mzscheme/dyn|
5883 feature}
5884 Specifies the name of the MzScheme GC shared library. The default is
5885 DYNAMIC_MZGC_DLL which was specified at compile time.
5886 The value can be equal to 'mzschemedll' if it includes the GC code.
5887 Environment variables are expanded |:set_env|.
5888 This option cannot be set from a |modeline| or in the |sandbox|, for
5889 security reasons.
5890
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005892'nrformats' 'nf' string (default "bin,octal,hex",
5893 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 This defines what bases Vim will consider for numbers when using the
5896 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5897 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005898 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005900 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005901 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005903 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 considered to be hexadecimal. Example: Using CTRL-X on
5905 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005906 bin If included, numbers starting with "0b" or "0B" will be
5907 considered to be binary. Example: Using CTRL-X on
5908 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005909 unsigned If included, numbers are recognized as unsigned. Thus a
5910 leading dash or negative sign won't be considered as part of
5911 the number. Examples:
5912 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5913 (without "unsigned" it would become "9-2021").
5914 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5915 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005916 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5917 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005918 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02005919 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02005920 dash immediately preceded by a non-whitespace character (i.e.,
5921 not a tab or a " "), the negative sign won't be considered as
5922 part of the number. For example:
5923 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5924 (without "blank" it would become "Carbon-13").
5925 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02005926 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02005927 set, it would result in "Carbon -7").
5928 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02005929 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02005930 included, "unsigned" will take precedence.
5931
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 Numbers which simply begin with a digit in the range 1-9 are always
5933 considered decimal. This also happens for numbers that are not
5934 recognized as octal or hex.
5935
5936 *'number'* *'nu'* *'nonumber'* *'nonu'*
5937'number' 'nu' boolean (default off)
5938 local to window
5939 Print the line number in front of each line. When the 'n' option is
5940 excluded from 'cpoptions' a wrapped line will not use the column of
5941 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005942 The 'numberwidth' option can be used to set the room used for the line
5943 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 When a long, wrapped line doesn't start with the first character, '-'
5945 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005946 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5947 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005948 *number_relativenumber*
5949 The 'relativenumber' option changes the displayed number to be
5950 relative to the cursor. Together with 'number' there are these
5951 four combinations (cursor in line 3):
5952
Bram Moolenaar3848e002016-03-19 18:42:29 +01005953 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005954 'nornu' 'nornu' 'rnu' 'rnu'
5955
5956 |apple | 1 apple | 2 apple | 2 apple
5957 |pear | 2 pear | 1 pear | 1 pear
5958 |nobody | 3 nobody | 0 nobody |3 nobody
5959 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005961 *'numberwidth'* *'nuw'*
5962'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5963 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005964 {only available when compiled with the |+linebreak|
5965 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005966 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005967 when the 'number' or 'relativenumber' option is set or printing lines
5968 with a line number. Since one space is always between the number and
5969 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005970 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005971 fit the highest line number in the buffer respectively the number of
5972 rows in the window, depending on whether 'number' or 'relativenumber'
5973 is set. Thus with the Vim default of 4 there is room for a line number
5974 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005975 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005976 NOTE: This option is set to the Vi default value when 'compatible' is
5977 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005978
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005979 *'omnifunc'* *'ofu'*
5980'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005981 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005982 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005983 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005984 This option specifies a function to be used for Insert mode omni
5985 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005986 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005987 invoked and what it should return. The value can be the name of a
5988 function, a |lambda| or a |Funcref|. See |option-value-function| for
5989 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005990 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005991 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005992 This option cannot be set from a |modeline| or in the |sandbox|, for
5993 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005994
Bram Moolenaar02467872007-05-06 13:22:01 +00005995 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005996'opendevice' 'odev' boolean (default off)
5997 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005998 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005999 Enable reading and writing from devices. This may get Vim stuck on a
6000 device that can be opened but doesn't actually do the I/O. Therefore
6001 it is off by default.
6002 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6003 result in editing a device.
6004
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006005 *'operatorfunc'* *'opfunc'*
6006'operatorfunc' 'opfunc' string (default: empty)
6007 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006008 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006009 See |:map-operator| for more info and an example. The value can be
6010 the name of a function, a |lambda| or a |Funcref|. See
6011 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006012
6013 This option cannot be set from a |modeline| or in the |sandbox|, for
6014 security reasons.
6015
Bram Moolenaar251e1912011-06-19 05:09:16 +02006016 *'osfiletype'* *'oft'*
6017'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006019 This option was supported on RISC OS, which has been removed.
6020
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006021 *'packpath'* *'pp'*
6022'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006023 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006024 This option cannot be set from a |modeline| or in the |sandbox|, for
6025 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006026
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006028'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 global
6030 Specifies the nroff macros that separate paragraphs. These are pairs
6031 of two letters (see |object-motions|).
6032
6033 *'paste'* *'nopaste'*
6034'paste' boolean (default off)
6035 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006036 Put Vim in Paste mode. This is useful if you want to cut or copy
6037 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 unexpected effects.
6039 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006040 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 knows about pasting and will mostly do the right thing without 'paste'
6042 being set. The same is true for a terminal where Vim handles the
6043 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006044 This option is reset when starting the GUI. Thus if you set it in
6045 your .vimrc it will work in a terminal, but not in the GUI. Setting
6046 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6047 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 When the 'paste' option is switched on (also when it was already on):
6049 - mapping in Insert mode and Command-line mode is disabled
6050 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006052 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006053 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 - 'revins' is reset
6055 - 'ruler' is reset
6056 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006057 - 'smarttab' is reset
6058 - 'softtabstop' is set to 0
6059 - 'textwidth' is set to 0
6060 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006061 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006064 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006065 - 'indentexpr'
6066 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006067 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 NOTE: When you start editing another file while the 'paste' option is
6069 on, settings from the modelines or autocommands may change the
6070 settings again, causing trouble when pasting text. You might want to
6071 set the 'paste' option again.
6072 When the 'paste' option is reset the mentioned options are restored to
6073 the value before the moment 'paste' was switched from off to on.
6074 Resetting 'paste' before ever setting it does not have any effect.
6075 Since mapping doesn't work while 'paste' is active, you need to use
6076 the 'pastetoggle' option to toggle the 'paste' option with some key.
6077
6078 *'pastetoggle'* *'pt'*
6079'pastetoggle' 'pt' string (default "")
6080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 When non-empty, specifies the key sequence that toggles the 'paste'
6082 option. This is like specifying a mapping: >
6083 :map {keys} :set invpaste<CR>
6084< Where {keys} is the value of 'pastetoggle'.
6085 The difference is that it will work even when 'paste' is set.
6086 'pastetoggle' works in Insert mode and Normal mode, but not in
6087 Command-line mode.
6088 Mappings are checked first, thus overrule 'pastetoggle'. However,
6089 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6090 this: >
6091 :map <F10> :set paste<CR>
6092 :map <F11> :set nopaste<CR>
6093 :imap <F10> <C-O>:set paste<CR>
6094 :imap <F11> <nop>
6095 :set pastetoggle=<F11>
6096< This will make <F10> start paste mode and <F11> stop paste mode.
6097 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6098 mode everything is inserted literally, except the 'pastetoggle' key
6099 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006100 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101
6102 *'pex'* *'patchexpr'*
6103'patchexpr' 'pex' string (default "")
6104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 {not available when compiled without the |+diff|
6106 feature}
6107 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006108 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006109 This option cannot be set from a |modeline| or in the |sandbox|, for
6110 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111
Bram Moolenaardbc28022014-07-26 13:40:44 +02006112 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113'patchmode' 'pm' string (default "")
6114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 When non-empty the oldest version of a file is kept. This can be used
6116 to keep the original version of a file if you are changing files in a
6117 source distribution. Only the first time that a file is written a
6118 copy of the original file will be kept. The name of the copy is the
6119 name of the original file with the string in the 'patchmode' option
6120 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006121 ".orig" or ".org". 'backupdir' must not be empty for this to work
6122 (Detail: The backup file is renamed to the patchmode file after the
6123 new file has been successfully written, that's why it must be possible
6124 to write a backup file). If there was no file to be backed up, an
6125 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 When the 'backupskip' pattern matches, a patchmode file is not made.
6127 Using 'patchmode' for compressed files appends the extension at the
6128 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6129 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006130 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006132 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 other systems: ".,,")
6135 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006137 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6138 provided that the file being searched for has a relative path (not
6139 starting with "/", "./" or "../"). The directories in the 'path'
6140 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 - Use commas to separate directory names: >
6142 :set path=.,/usr/local/include,/usr/include
6143< - Spaces can also be used to separate directory names (for backwards
6144 compatibility with version 3.0). To have a space in a directory
6145 name, precede it with an extra backslash, and escape the space: >
6146 :set path=.,/dir/with\\\ space
6147< - To include a comma in a directory name precede it with an extra
6148 backslash: >
6149 :set path=.,/dir/with\\,comma
6150< - To search relative to the directory of the current file, use: >
6151 :set path=.
6152< - To search in the current directory use an empty string between two
6153 commas: >
6154 :set path=,,
6155< - A directory name may end in a ':' or '/'.
6156 - Environment variables are expanded |:set_env|.
6157 - When using |netrw.vim| URLs can be used. For example, adding
6158 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006159 - Search upwards and downwards in a directory tree using "*", "**" and
6160 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 - Careful with '\' characters, type two to get one in the option: >
6162 :set path=.,c:\\include
6163< Or just use '/' instead: >
6164 :set path=.,c:/include
6165< Don't forget "." or files won't even be found in the same directory as
6166 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006167 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 it is something like 256 or 1024 characters.
6169 You can check if all the include files are found, using the value of
6170 'path', see |:checkpath|.
6171 The use of |:set+=| and |:set-=| is preferred when adding or removing
6172 directories from the list. This avoids problems when a future version
6173 uses another default. To remove the current directory use: >
6174 :set path-=
6175< To add the current directory use: >
6176 :set path+=
6177< To use an environment variable, you probably need to replace the
6178 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006179 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006180 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181< Replace the ';' with a ':' or whatever separator is used. Note that
6182 this doesn't work when $INCL contains a comma or white space.
6183
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006184 *'perldll'*
6185'perldll' string (default depends on the build)
6186 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006187 {only available when compiled with the |+perl/dyn|
6188 feature}
6189 Specifies the name of the Perl shared library. The default is
6190 DYNAMIC_PERL_DLL, which was specified at compile time.
6191 Environment variables are expanded |:set_env|.
6192 This option cannot be set from a |modeline| or in the |sandbox|, for
6193 security reasons.
6194
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6196'preserveindent' 'pi' boolean (default off)
6197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 When changing the indent of the current line, preserve as much of the
6199 indent structure as possible. Normally the indent is replaced by a
6200 series of tabs followed by spaces as required (unless |'expandtab'| is
6201 enabled, in which case only spaces are used). Enabling this option
6202 means the indent will preserve as many existing characters as possible
6203 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006204 'expandtab' does not apply to the preserved white space, a Tab remains
6205 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 NOTE: When using ">>" multiple times the resulting indent is a mix of
6207 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006208 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 Also see 'copyindent'.
6210 Use |:retab| to clean up white space.
6211
6212 *'previewheight'* *'pvh'*
6213'previewheight' 'pvh' number (default 12)
6214 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006215 {not available when compiled without the |+quickfix|
6216 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006218 commands. Used for |CTRL-W_}| when no count is given. Not used when
6219 'previewpopup' is set.
6220
6221 *'previewpopup'* *'pvp'*
6222'previewpopup' 'pvp' string (default empty)
6223 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006224 {not available when compiled without the |+textprop|
6225 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006226 When not empty a popup window is used for commands that would open a
6227 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006228 Not used for the insert completion info, add "popup" to
6229 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230
6231 *'previewwindow'* *'nopreviewwindow'*
6232 *'pvw'* *'nopvw'* *E590*
6233'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006234 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006235 {not available when compiled without the |+quickfix|
6236 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006237 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 set. It's normally not set directly, but by using one of the commands
6239 |:ptag|, |:pedit|, etc.
6240
6241 *'printdevice'* *'pdev'*
6242'printdevice' 'pdev' string (default empty)
6243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 {only available when compiled with the |+printer|
6245 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006246 The name of the printer to be used for |:hardcopy|.
6247 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006248 This option cannot be set from a |modeline| or in the |sandbox|, for
6249 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250
Bram Moolenaar8299df92004-07-10 09:47:34 +00006251 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006252'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 {only available when compiled with the |+printer|
6255 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006256 Sets the character encoding used when printing.
6257 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258
6259 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006260'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 {only available when compiled with the |+printer|
6263 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006264 Expression used to print the PostScript produced with |:hardcopy|.
6265 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006266 This option cannot be set from a |modeline| or in the |sandbox|, for
6267 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268
Bram Moolenaar8299df92004-07-10 09:47:34 +00006269 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270'printfont' 'pfn' string (default "courier")
6271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 {only available when compiled with the |+printer|
6273 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006274 The name of the font that will be used for |:hardcopy|.
6275 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276
6277 *'printheader'* *'pheader'*
6278'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 {only available when compiled with the |+printer|
6281 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006282 The format of the header produced in |:hardcopy| output.
6283 See |pheader-option|.
6284
6285 *'printmbcharset'* *'pmbcs'*
6286'printmbcharset' 'pmbcs' string (default "")
6287 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006288 {only available when compiled with the |+printer|
6289 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006290 The CJK character set to be used for CJK output from |:hardcopy|.
6291 See |pmbcs-option|.
6292
6293 *'printmbfont'* *'pmbfn'*
6294'printmbfont' 'pmbfn' string (default "")
6295 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006296 {only available when compiled with the |+printer|
6297 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006298 List of font names to be used for CJK output from |:hardcopy|.
6299 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300
6301 *'printoptions'* *'popt'*
6302'printoptions' 'popt' string (default "")
6303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006305 List of items that control the format of the output of |:hardcopy|.
6306 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006308 *'prompt'* *'noprompt'*
6309'prompt' boolean (default on)
6310 global
6311 When on a ":" prompt is used in Ex mode.
6312
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006313 *'pumheight'* *'ph'*
6314'pumheight' 'ph' number (default 0)
6315 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006316 Determines the maximum number of items to show in the popup menu for
6317 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006318 |ins-completion-menu|.
6319
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006320 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006321'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006322 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006323 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006324 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006325
Bram Moolenaard94464e2015-11-02 15:28:18 +01006326 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006327'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006328 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006329 {only available when compiled with the |+python/dyn|
6330 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006331 Specifies the name of the Python 2.x shared library. The default is
6332 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006333 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006334 This option cannot be set from a |modeline| or in the |sandbox|, for
6335 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006336
Bram Moolenaar94073162018-01-31 21:49:05 +01006337 *'pythonhome'*
6338'pythonhome' string (default "")
6339 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006340 {only available when compiled with the |+python/dyn|
6341 feature}
6342 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6343 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6344 which was specified at compile time, will be used for the Python 2.x
6345 home directory.
6346 Environment variables are expanded |:set_env|.
6347 This option cannot be set from a |modeline| or in the |sandbox|, for
6348 security reasons.
6349
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006350 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006351'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006352 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006353 {only available when compiled with the |+python3/dyn|
6354 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006355 Specifies the name of the Python 3 shared library. The default is
6356 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006357 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006358 This option cannot be set from a |modeline| or in the |sandbox|, for
6359 security reasons.
6360
Bram Moolenaar94073162018-01-31 21:49:05 +01006361 *'pythonthreehome'*
6362'pythonthreehome' string (default "")
6363 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006364 {only available when compiled with the |+python3/dyn|
6365 feature}
6366 Specifies the name of the Python 3 home directory. When
6367 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6368 PYTHON3_HOME, which was specified at compile time, will be used for
6369 the Python 3 home directory.
6370 Environment variables are expanded |:set_env|.
6371 This option cannot be set from a |modeline| or in the |sandbox|, for
6372 security reasons.
6373
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006374 *'pyxversion'* *'pyx'*
6375'pyxversion' 'pyx' number (default depends on the build)
6376 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006377 {only available when compiled with the |+python| or
6378 the |+python3| feature}
6379 Specifies the python version used for pyx* functions and commands
6380 |python_x|. The default value is as follows:
6381
6382 Compiled with Default ~
6383 |+python| and |+python3| 0
6384 only |+python| 2
6385 only |+python3| 3
6386
6387 Available values are 0, 2 and 3.
6388 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6389 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6390 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6391 to 2 if Python 2 is available.
6392 See also: |has-pythonx|
6393
6394 If Vim is compiled with only |+python| or |+python3| setting
6395 'pyxversion' has no effect. The pyx* functions and commands are
6396 always the same as the compiled version.
6397
6398 This option cannot be set from a |modeline| or in the |sandbox|, for
6399 security reasons.
6400
Bram Moolenaar858ba062020-05-31 23:11:59 +02006401 *'quickfixtextfunc'* *'qftf'*
6402'quickfixtextfunc' 'qftf' string (default "")
6403 global
6404 {only available when compiled with the |+quickfix|
6405 feature}
6406 This option specifies a function to be used to get the text to display
6407 in the quickfix and location list windows. This can be used to
6408 customize the information displayed in the quickfix or location window
6409 for each entry in the corresponding quickfix or location list. See
6410 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006411 function and an example. The value can be the name of a function, a
6412 |lambda| or a |Funcref|. See |option-value-function| for more
6413 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006414
6415 This option cannot be set from a |modeline| or in the |sandbox|, for
6416 security reasons.
6417
Bram Moolenaar677ee682005-01-27 14:41:15 +00006418 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006419'quoteescape' 'qe' string (default "\")
6420 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006421 The characters that are used to escape quotes in a string. Used for
6422 objects like a', a" and a` |a'|.
6423 When one of the characters in this option is found inside a string,
6424 the following character will be skipped. The default value makes the
6425 text "foo\"bar\\" considered to be one string.
6426
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6428'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006429 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 If on, writes fail unless you use a '!'. Protects you from
6431 accidentally overwriting a file. Default on when Vim is started
6432 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006433 When using ":w!" the 'readonly' option is reset for the current
6434 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006435 When using the ":view" command the 'readonly' option is set for the
6436 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006437 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006439 *'redrawtime'* *'rdt'*
6440'redrawtime' 'rdt' number (default 2000)
6441 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006442 {only available when compiled with the |+reltime|
6443 feature}
6444 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006445 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006446 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006447 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006448 matches will be highlighted.
6449 For syntax highlighting the time applies per window. When over the
6450 limit syntax highlighting is disabled until |CTRL-L| is used.
6451 This is used to avoid that Vim hangs when using a very complicated
6452 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006453
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006454 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006455'regexpengine' 're' number (default 0)
6456 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006457 This selects the default regexp engine. |two-engines|
6458 The possible values are:
6459 0 automatic selection
6460 1 old engine
6461 2 NFA engine
6462 Note that when using the NFA engine and the pattern contains something
6463 that is not supported the pattern will not match. This is only useful
6464 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006465 Using automatic selection enables Vim to switch the engine, if the
6466 default engine becomes too costly. E.g., when the NFA engine uses too
6467 many states. This should prevent Vim from hanging on a combination of
6468 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006469
Bram Moolenaar64486672010-05-16 15:46:46 +02006470 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6471'relativenumber' 'rnu' boolean (default off)
6472 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006473 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006474 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006475 precede some vertical motion commands (e.g. j k + -) with, without
6476 having to calculate it yourself. Especially useful in combination with
6477 other commands (e.g. y d c < > gq gw =).
6478 When the 'n' option is excluded from 'cpoptions' a wrapped
6479 line will not use the column of line numbers (this is the default when
6480 'compatible' isn't set).
6481 The 'numberwidth' option can be used to set the room used for the line
6482 number.
6483 When a long, wrapped line doesn't start with the first character, '-'
6484 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006485 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6486 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006487
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006488 The number in front of the cursor line also depends on the value of
6489 'number', see |number_relativenumber| for all combinations of the two
6490 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006491
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 *'remap'* *'noremap'*
6493'remap' boolean (default on)
6494 global
6495 Allows for mappings to work recursively. If you do not want this for
6496 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006497 NOTE: To avoid portability problems with Vim scripts, always keep
6498 this option at the default "on". Only switch it off when working with
6499 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500
zeertzjqd086b8f2024-02-25 15:42:52 +08006501 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006502'renderoptions' 'rop' string (default: empty)
6503 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006504 {only available when compiled with GUI and DIRECTX on
6505 MS-Windows}
6506 Select a text renderer and set its options. The options depend on the
6507 renderer.
6508
6509 Syntax: >
6510 set rop=type:{renderer}(,{name}:{value})*
6511<
6512 Currently, only one optional renderer is available.
6513
6514 render behavior ~
6515 directx Vim will draw text using DirectX (DirectWrite). It makes
6516 drawn glyphs more beautiful than default GDI.
6517 It requires 'encoding' is "utf-8", and only works on
6518 MS-Windows Vista or newer version.
6519
6520 Options:
6521 name meaning type value ~
6522 gamma gamma float 1.0 - 2.2 (maybe)
6523 contrast enhancedContrast float (unknown)
6524 level clearTypeLevel float (unknown)
6525 geom pixelGeometry int 0 - 2 (see below)
6526 renmode renderingMode int 0 - 6 (see below)
6527 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006528 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006529
Bram Moolenaar92467d32017-12-05 13:22:16 +01006530 See this URL for detail (except for scrlines):
6531 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006532
6533 For geom: structure of a device pixel.
6534 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6535 1 - DWRITE_PIXEL_GEOMETRY_RGB
6536 2 - DWRITE_PIXEL_GEOMETRY_BGR
6537
6538 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006539 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006540
6541 For renmode: method of rendering glyphs.
6542 0 - DWRITE_RENDERING_MODE_DEFAULT
6543 1 - DWRITE_RENDERING_MODE_ALIASED
6544 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6545 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6546 4 - DWRITE_RENDERING_MODE_NATURAL
6547 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6548 6 - DWRITE_RENDERING_MODE_OUTLINE
6549
6550 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006551 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006552
6553 For taamode: antialiasing mode used for drawing text.
6554 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6555 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6556 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6557 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6558
6559 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006560 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6561
Bram Moolenaara338adc2018-01-31 20:51:47 +01006562 For scrlines:
6563 This was used for optimizing scrolling behavior, however this
6564 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006565
6566 Example: >
6567 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006568 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006569 set rop=type:directx
6570<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006571 If select a raster font (Courier, Terminal or FixedSys which
6572 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006573 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006574
6575 NOTE: It is known that some fonts and options combination
6576 causes trouble on drawing glyphs.
6577
Bram Moolenaar92467d32017-12-05 13:22:16 +01006578 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006579 special made fonts (True-Type fonts which includes only
6580 bitmap glyphs).
6581 - 'taamode:3' will not work with some vector fonts.
6582
6583 NOTE: With this option, you can display colored emoji
6584 (emoticon) in Windows 8.1 or later. To display colored emoji,
6585 there are some conditions which you should notice.
6586
6587 - If your font includes non-colored emoji already, it will
6588 be used.
6589 - If your font doesn't have emoji, the system chooses an
6590 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6591 will be used.
6592 - When this alternative font didn't have fixed width glyph,
6593 emoji might be rendered beyond the bounding box of drawing
6594 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006595
6596 Other render types are currently not supported.
6597
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 *'report'*
6599'report' number (default 2)
6600 global
6601 Threshold for reporting number of lines changed. When the number of
6602 changed lines is more than 'report' a message will be given for most
6603 ":" commands. If you want it always, set 'report' to 0.
6604 For the ":substitute" command the number of substitutions is used
6605 instead of the number of lines.
6606
6607 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6608'restorescreen' 'rs' boolean (default on)
6609 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006610 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 When set, the screen contents is restored when exiting Vim. This also
6612 happens when executing external commands.
6613
6614 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6615 options in your .vimrc. To disable restoring:
6616 set t_ti= t_te=
6617 To enable restoring (for an xterm):
6618 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6619 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6620
6621 *'revins'* *'ri'* *'norevins'* *'nori'*
6622'revins' 'ri' boolean (default off)
6623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 {only available when compiled with the |+rightleft|
6625 feature}
6626 Inserting characters in Insert mode will work backwards. See "typing
6627 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6628 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006629 NOTE: This option is reset when 'compatible' is set.
6630 This option is reset when 'paste' is set and restored when 'paste' is
6631 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632
6633 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6634'rightleft' 'rl' boolean (default off)
6635 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 {only available when compiled with the |+rightleft|
6637 feature}
6638 When on, display orientation becomes right-to-left, i.e., characters
6639 that are stored in the file appear from the right to the left.
6640 Using this option, it is possible to edit files for languages that
6641 are written from the right to the left such as Hebrew and Arabic.
6642 This option is per window, so it is possible to edit mixed files
6643 simultaneously, or to view the same file in both ways (this is
6644 useful whenever you have a mixed text file with both right-to-left
6645 and left-to-right strings so that both sets are displayed properly
6646 in different windows). Also see |rileft.txt|.
6647
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006648 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649'rightleftcmd' 'rlc' string (default "search")
6650 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 {only available when compiled with the |+rightleft|
6652 feature}
6653 Each word in this option enables the command line editing to work in
6654 right-to-left mode for a group of commands:
6655
6656 search "/" and "?" commands
6657
6658 This is useful for languages such as Hebrew, Arabic and Farsi.
6659 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6660
Bram Moolenaard94464e2015-11-02 15:28:18 +01006661 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006662'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006663 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006664 {only available when compiled with the |+ruby/dyn|
6665 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006666 Specifies the name of the Ruby shared library. The default is
6667 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006668 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006669 This option cannot be set from a |modeline| or in the |sandbox|, for
6670 security reasons.
6671
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006673'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006676 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 text in the file is shown on the far right:
6678 Top first line is visible
6679 Bot last line is visible
6680 All first and last line are visible
6681 45% relative position in the file
6682 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006683 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006684 ruler is shown there. Otherwise it is shown in the last line of the
6685 screen. If the statusline is given by 'statusline' (i.e. not empty),
6686 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006688 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 the text column (byte number) and the screen column are shown,
6690 separated with a dash.
6691 For an empty line "0-1" is shown.
6692 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006693 This option is reset when 'paste' is set and restored when 'paste' is
6694 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 If you don't want to see the ruler all the time but want to know where
6696 you are, use "g CTRL-G" |g_CTRL-G|.
6697 NOTE: This option is reset when 'compatible' is set.
6698
6699 *'rulerformat'* *'ruf'*
6700'rulerformat' 'ruf' string (default empty)
6701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 {not available when compiled without the |+statusline|
6703 feature}
6704 When this option is not empty, it determines the content of the ruler
6705 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006706 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006707 This option cannot be set in a modeline when 'modelineexpr' is off.
6708
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 The default ruler width is 17 characters. To make the ruler 15
6710 characters wide, put "%15(" at the start and "%)" at the end.
6711 Example: >
6712 :set rulerformat=%15(%c%V\ %p%%%)
6713<
6714 *'runtimepath'* *'rtp'* *vimfiles*
6715'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006716 Unix: "$HOME/.vim or
6717 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 $VIM/vimfiles,
6719 $VIMRUNTIME,
6720 $VIM/vimfiles/after,
6721 $HOME/.vim/after"
6722 Amiga: "home:vimfiles,
6723 $VIM/vimfiles,
6724 $VIMRUNTIME,
6725 $VIM/vimfiles/after,
6726 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006727 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 $VIM/vimfiles,
6729 $VIMRUNTIME,
6730 $VIM/vimfiles/after,
6731 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006732 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 $VIMRUNTIME,
6734 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006735 Haiku: "$BE_USER_SETTINGS/vim,
6736 $VIM/vimfiles,
6737 $VIMRUNTIME,
6738 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006739 $BE_USER_SETTINGS/vim/after"
6740 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 $VIM/vimfiles,
6742 $VIMRUNTIME,
6743 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006744 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 This is a list of directories which will be searched for runtime
6747 files:
6748 filetype.vim filetypes by file name |new-filetype|
6749 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006750 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 colors/ color scheme files |:colorscheme|
6752 compiler/ compiler files |:compiler|
6753 doc/ documentation |write-local-help|
6754 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006755 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 indent/ indent scripts |indent-expression|
6757 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006758 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006760 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 plugin/ plugin scripts |write-plugin|
6762 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006763 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 syntax/ syntax files |mysyntaxfile|
6765 tutor/ files for vimtutor |tutor|
6766
6767 And any other file searched for with the |:runtime| command.
6768
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006769 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6770
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 The defaults for most systems are setup to search five locations:
6772 1. In your home directory, for your personal preferences.
6773 2. In a system-wide Vim directory, for preferences from the system
6774 administrator.
6775 3. In $VIMRUNTIME, for files distributed with Vim.
6776 *after-directory*
6777 4. In the "after" directory in the system-wide Vim directory. This is
6778 for the system administrator to overrule or add to the distributed
6779 defaults (rarely needed)
6780 5. In the "after" directory in your home directory. This is for
6781 personal preferences to overrule or add to the distributed defaults
6782 or system-wide settings (rarely needed).
6783
Bram Moolenaard0796902016-09-16 20:02:31 +02006784 More entries are added when using |packages|. If it gets very long
6785 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6786 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006787
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6789 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006790 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 wildcards.
6792 See |:runtime|.
6793 Example: >
6794 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6795< This will use the directory "~/vimruntime" first (containing your
6796 personal Vim runtime files), then "/mygroup/vim" (shared between a
6797 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6798 files).
6799 You probably should always include $VIMRUNTIME somewhere, to use the
6800 distributed runtime files. You can put a directory before $VIMRUNTIME
6801 to find files which replace a distributed runtime files. You can put
6802 a directory after $VIMRUNTIME to find files which add to distributed
6803 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006804 When Vim is started with |--clean| the home directory entries are not
6805 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 This option cannot be set from a |modeline| or in the |sandbox|, for
6807 security reasons.
6808
6809 *'scroll'* *'scr'*
6810'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006811 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6813 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006814 changes. This may happen when enabling the |status-line| or
6815 'tabline' option after setting the 'scroll' option.
6816 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006817 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006818 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819
6820 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6821'scrollbind' 'scb' boolean (default off)
6822 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006823 See also |scroll-binding|. When this option is set, scrolling the
6824 current window also scrolls other scrollbind windows (windows that
6825 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 differences between two versions of a file, see 'diff'.
6827 See |'scrollopt'| for options that determine how this option should be
6828 interpreted.
6829 This option is mostly reset when splitting a window to edit another
6830 file. This means that ":split | edit file" results in two windows
6831 with scroll-binding, but ":split file" does not.
6832
Bram Moolenaarae20f342019-11-05 21:09:23 +01006833 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6834'scrollfocus' 'scf' boolean (default off)
6835 global
6836 {only for MS-Windows GUI}
6837 When using the scroll wheel and this option is set, the window under
6838 the mouse pointer is scrolled. With this option off the current
6839 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006840 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006841
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 *'scrolljump'* *'sj'*
6843'scrolljump' 'sj' number (default 1)
6844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 Minimal number of lines to scroll when the cursor gets off the
6846 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6847 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006848 When set to a negative number from -1 to -100 this is used as the
6849 percentage of the window height. Thus -50 scrolls half the window
6850 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 NOTE: This option is set to 1 when 'compatible' is set.
6852
6853 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006854'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006855 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 Minimal number of screen lines to keep above and below the cursor.
6857 This will make some context visible around where you are working. If
6858 you set it to a very large value (999) the cursor line will always be
6859 in the middle of the window (except at the start or end of the file or
6860 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006861 After using the local value, go back the global value with one of
6862 these two: >
6863 setlocal scrolloff<
6864 setlocal scrolloff=-1
6865< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 NOTE: This option is set to 0 when 'compatible' is set.
6867
6868 *'scrollopt'* *'sbo'*
6869'scrollopt' 'sbo' string (default "ver,jump")
6870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006872 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6873 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 The following words are available:
6875 ver Bind vertical scrolling for 'scrollbind' windows
6876 hor Bind horizontal scrolling for 'scrollbind' windows
6877 jump Applies to the offset between two windows for vertical
6878 scrolling. This offset is the difference in the first
6879 displayed line of the bound windows. When moving
6880 around in a window, another 'scrollbind' window may
6881 reach a position before the start or after the end of
6882 the buffer. The offset is not changed though, when
6883 moving back the 'scrollbind' window will try to scroll
6884 to the desired position when possible.
6885 When now making that window the current one, two
6886 things can be done with the relative offset:
6887 1. When "jump" is not included, the relative offset is
6888 adjusted for the scroll position in the new current
6889 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006890 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 2. When "jump" is included, the other windows are
6892 scrolled to keep the same relative offset. When
6893 going back to the other window, it still uses the
6894 same relative offset.
6895 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006896 When 'diff' mode is active there always is vertical scroll binding,
6897 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898
6899 *'sections'* *'sect'*
6900'sections' 'sect' string (default "SHNHH HUnhsh")
6901 global
6902 Specifies the nroff macros that separate sections. These are pairs of
6903 two letters (See |object-motions|). The default makes a section start
6904 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6905
6906 *'secure'* *'nosecure'* *E523*
6907'secure' boolean (default off)
6908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 When on, ":autocmd", shell and write commands are not allowed in
6910 ".vimrc" and ".exrc" in the current directory and map commands are
6911 displayed. Switch it off only if you know that you will not run into
6912 problems, or when the 'exrc' option is off. On Unix this option is
6913 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006914 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 'secure' at the end of your ~/.vimrc then.
6916 This option cannot be set from a |modeline| or in the |sandbox|, for
6917 security reasons.
6918
6919 *'selection'* *'sel'*
6920'selection' 'sel' string (default "inclusive")
6921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 This option defines the behavior of the selection. It is only used
6923 in Visual and Select mode.
6924 Possible values:
6925 value past line inclusive ~
6926 old no yes
6927 inclusive yes yes
6928 exclusive yes no
6929 "past line" means that the cursor is allowed to be positioned one
6930 character past the line.
6931 "inclusive" means that the last character of the selection is included
6932 in an operation. For example, when "x" is used to delete the
6933 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006934 When "old" is used and 'virtualedit' allows the cursor to move past
6935 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 Note that when "exclusive" is used and selecting from the end
6937 backwards, you cannot include the last character of a line, when
6938 starting in Normal mode and 'virtualedit' empty.
6939
6940 The 'selection' option is set by the |:behave| command.
6941
6942 *'selectmode'* *'slm'*
6943'selectmode' 'slm' string (default "")
6944 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006945 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 Select mode instead of Visual mode, when a selection is started.
6947 Possible values:
6948 mouse when using the mouse
6949 key when using shifted special keys
6950 cmd when using "v", "V" or CTRL-V
6951 See |Select-mode|.
6952 The 'selectmode' option is set by the |:behave| command.
6953
6954 *'sessionoptions'* *'ssop'*
6955'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006956 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006958 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 feature}
6960 Changes the effect of the |:mksession| command. It is a comma
6961 separated list of words. Each word enables saving and restoring
6962 something:
6963 word save and restore ~
6964 blank empty windows
6965 buffers hidden and unloaded buffers, not just those in windows
6966 curdir the current directory
6967 folds manually created folds, opened/closed folds and local
6968 fold options
6969 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006970 and contain at least one lowercase letter. Only
6971 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 help the help window
6973 localoptions options and mappings local to a window or buffer (not
6974 global values for local options)
6975 options all options and mappings (also global values for local
6976 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006977 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 resize size of the Vim window: 'lines' and 'columns'
6979 sesdir the directory in which the session file is located
6980 will become the current directory (useful with
6981 projects accessed over a network from different
6982 systems)
6983 slash backslashes in file names replaced with forward
6984 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006985 tabpages all tab pages; without this only the current tab page
6986 is restored, so that you can make a session for each
6987 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006988 terminal include terminal windows where the command can be
6989 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 unix with Unix end-of-line format (single <NL>), even when
6991 on Windows or DOS
6992 winpos position of the whole Vim window
6993 winsize window sizes
6994
6995 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006996 When neither "curdir" nor "sesdir" is included, file names are stored
6997 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006998 If you leave out "options" many things won't work well after restoring
6999 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 "slash" and "unix" are useful on Windows when sharing session files
7001 with Unix. The Unix version of Vim cannot source dos format scripts,
7002 but the Windows version of Vim can source unix format scripts.
7003
7004 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007005'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 global
7007 Name of the shell to use for ! and :! commands. When changing the
7008 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7009 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007010 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 See |option-backslash| about including spaces and backslashes.
7012 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007013
Bram Moolenaara2baa732022-02-04 16:09:54 +00007014 In |restricted-mode| shell commands will not be possible. This mode
7015 is used if the value of $SHELL ends in "false" or "nologin".
7016
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007017 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007018 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7020< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007021 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007023 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007025 Example with escaped space (Vim will do this when initializing the
7026 option from $SHELL): >
7027 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007028< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007029 backslashes are consumed by `:set`.
7030
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 Under MS-Windows, when the executable ends in ".com" it must be
7032 included. Thus setting the shell to "command.com" or "4dos.com"
7033 works, but "command" and "4dos" do not work for all commands (e.g.,
7034 filtering).
7035 For unknown reasons, when using "4dos.com" the current directory is
7036 changed to "C:\". To avoid this set 'shell' like this: >
7037 :set shell=command.com\ /c\ 4dos
7038< This option cannot be set from a |modeline| or in the |sandbox|, for
7039 security reasons.
7040
7041 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007042'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007043 Win32, when 'shell' contains "powershell":
7044 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007045 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007048 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7049 For MS-Windows, the default is set according to the value of 'shell',
7050 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007051 On Unix it can have more than one flag. Each white space separated
7052 part is passed as an argument to the shell command.
7053 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007054 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 This option cannot be set from a |modeline| or in the |sandbox|, for
7056 security reasons.
7057
7058 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007059'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7060 "2>&1| tee", or
7061 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 {not available when compiled without the |+quickfix|
7064 feature}
7065 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007066 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 including spaces and backslashes.
7068 The name of the temporary file can be represented by "%s" if necessary
7069 (the file name is appended automatically if no %s appears in the value
7070 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007071 For the Amiga the default is ">". For MS-Windows using powershell the
7072 default is "2>&1 | Out-File -Encoding default", otherwise the default
7073 is ">%s 2>&1". The output is directly saved in a file and not echoed
7074 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007075 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 in a file and echoed to the screen. If the 'shell' option is "csh" or
7077 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007078 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007079 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7080 means that stderr is also included. Before using the 'shell' option a
7081 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007082 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7083 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 The initialization of this option is done after reading the ".vimrc"
7085 and the other initializations, so that when the 'shell' option is set
7086 there, the 'shellpipe' option changes automatically, unless it was
7087 explicitly set before.
7088 When 'shellpipe' is set to an empty string, no redirection of the
7089 ":make" output will be done. This is useful if you use a 'makeprg'
7090 that writes to 'makeef' by itself. If you want no piping, but do
7091 want to include the 'makeef', set 'shellpipe' to a single space.
7092 Don't forget to precede the space with a backslash: ":set sp=\ ".
7093 In the future pipes may be used for filtering and this option will
7094 become obsolete (at least for Unix).
7095 This option cannot be set from a |modeline| or in the |sandbox|, for
7096 security reasons.
7097
7098 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007099'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 Quoting character(s), put around the command passed to the shell, for
7102 the "!" and ":!" commands. The redirection is kept outside of the
7103 quoting. See 'shellxquote' to include the redirection. It's
7104 probably not useful to set both options.
7105 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007106 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007107 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 This option cannot be set from a |modeline| or in the |sandbox|, for
7109 security reasons.
7110
7111 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007112'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7113 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 String to be used to put the output of a filter command in a temporary
7116 file. See also |:!|. See |option-backslash| about including spaces
7117 and backslashes.
7118 The name of the temporary file can be represented by "%s" if necessary
7119 (the file name is appended automatically if no %s appears in the value
7120 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007121 The default is ">". For Unix, if the 'shell' option is "csh" or
7122 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007123 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007124 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7125 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007126 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7127 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007128 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7129 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 The initialization of this option is done after reading the ".vimrc"
7131 and the other initializations, so that when the 'shell' option is set
7132 there, the 'shellredir' option changes automatically unless it was
7133 explicitly set before.
7134 In the future pipes may be used for filtering and this option will
7135 become obsolete (at least for Unix).
7136 This option cannot be set from a |modeline| or in the |sandbox|, for
7137 security reasons.
7138
7139 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7140'shellslash' 'ssl' boolean (default off)
7141 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007142 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007144 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007145 powershell.exe. Backward slashes can still be typed, but they are
7146 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 Note that setting or resetting this option has no effect for some
7148 existing file names, thus this option needs to be set before opening
7149 any file for best results. This might change in the future.
7150 'shellslash' only works when a backslash can be used as a path
7151 separator. To test if this is so use: >
7152 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007153< Also see 'completeslash'.
7154
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007155 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7156'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7157 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007158 When on, use temp files for shell commands. When off use a pipe.
7159 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007160 Currently a pipe is only supported on Unix and MS-Windows 2K and
7161 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007162 :if has("filterpipe")
7163< The advantage of using a pipe is that nobody can read the temp file
7164 and the 'shell' command does not need to support redirection.
7165 The advantage of using a temp file is that the file type and encoding
7166 can be detected.
7167 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7168 |FilterWritePost| autocommands event are not triggered when
7169 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007170 The `system()` function does not respect this option and always uses
7171 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007172 NOTE: This option is set to the Vim default value when 'compatible'
7173 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007174
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 *'shelltype'* *'st'*
7176'shelltype' 'st' number (default 0)
7177 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007178 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 On the Amiga this option influences the way how the commands work
7180 which use a shell.
7181 0 and 1: always use the shell
7182 2 and 3: use the shell only to filter lines
7183 4 and 5: use shell only for ':sh' command
7184 When not using the shell, the command is executed directly.
7185
7186 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7187 1 and 3: use "shell cmd" to start external commands
7188
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007189 *'shellxescape'* *'sxe'*
7190'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007191 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007192 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007193 When 'shellxquote' is set to "(" then the characters listed in this
7194 option will be escaped with a '^' character. This makes it possible
7195 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007196 This option cannot be set from a |modeline| or in the |sandbox|, for
7197 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007198
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 *'shellxquote'* *'sxq'*
7200'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007201 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007202 for Win32, when 'shell' is
7203 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007204 for Win32, when 'shell' contains "sh"
7205 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 for Unix, when using system(): "\"")
7207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 Quoting character(s), put around the command passed to the shell, for
7209 the "!" and ":!" commands. Includes the redirection. See
7210 'shellquote' to exclude the redirection. It's probably not useful
7211 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007212 When the value is '(' then ')' is appended. When the value is '"('
7213 then ')"' is appended.
7214 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007215 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007216 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7217 pwsh.exe which automatically strips off the first and last quote on a
7218 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7219 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007220 'shell', to reduce the need to set this option by the user. See
7221 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 This option cannot be set from a |modeline| or in the |sandbox|, for
7223 security reasons.
7224
7225 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7226'shiftround' 'sr' boolean (default off)
7227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 Round indent to multiple of 'shiftwidth'. Applies to > and <
7229 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7230 a multiple of 'shiftwidth' (this is Vi compatible).
7231 NOTE: This option is reset when 'compatible' is set.
7232
7233 *'shiftwidth'* *'sw'*
7234'shiftwidth' 'sw' number (default 8)
7235 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007236 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007238 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007239 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240
7241 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007242'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7243 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007244 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007246 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 It is a list of flags:
7248 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007249 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7250 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7251 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7252 m use "[+]" instead of "[Modified]" *shm-m*
7253 n use "[New]" instead of "[New File]" *shm-n*
7254 r use "[RO]" instead of "[readonly]" *shm-r*
7255 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007257 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7258 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007259 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007260 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007262 o overwrite message for writing a file with subsequent *shm-o*
7263 message for reading a file (useful for ":wn" or when
7264 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007265 O message for reading a file overwrites any previous *shm-O*
7266 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007267 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7268 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007269 the search count do not show "W" before the count message
7270 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007271 t truncate file message at the start if it is too long *shm-t*
7272 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007273 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007274 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007275 long to fit on the command line; "..." will appear in the
7276 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007277 W don't give "written" or "[w]" when writing a file *shm-W*
7278 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007279 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007280 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007281 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007282 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007283 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7284 match", "Pattern not found", "Back at original", etc.
7285 C don't give messages while scanning for ins-completion *shm-C*
7286 items, for instance "scanning tags"
7287 q use "recording" instead of "recording @a" *shm-q*
7288 F don't give the file info when editing a file, like *shm-F*
7289 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007290 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007291 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007292 "[1/5]". When the "S" flag is not present (e.g. search count
7293 is shown), the "search hit BOTTOM, continuing at TOP" and
7294 "search hit TOP, continuing at BOTTOM" messages are only
7295 indicated by a "W" (Mnemonic: Wrapped) letter before the
7296 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297
7298 This gives you the opportunity to avoid that a change between buffers
7299 requires you to hit <Enter>, but still gives as useful a message as
7300 possible for the space available. To get the whole message that you
7301 would have got with 'shm' empty, use ":file!"
7302 Useful values:
7303 shm= No abbreviation of message.
7304 shm=a Abbreviation, but no loss of information.
7305 shm=at Abbreviation, and truncate message when necessary.
7306
7307 NOTE: This option is set to the Vi default value when 'compatible' is
7308 set and to the Vim default value when 'compatible' is reset.
7309
7310 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7311'shortname' 'sn' boolean (default off)
7312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 Filenames are assumed to be 8 characters plus one extension of 3
7314 characters. Multiple dots in file names are not allowed. When this
7315 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007316 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007318 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319
7320 *'showbreak'* *'sbr'* *E595*
7321'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007322 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007323 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 feature}
7325 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007326 values are "> " or "+++ ": >
7327 :set showbreak=>\
7328< Note the backslash to escape the trailing space. It's easier like
7329 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007330 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007331< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 comma (in a future version the comma might be used to separate the
7333 part that is shown at the end and at the start of a line).
7334 The characters are highlighted according to the '@' flag in
7335 'highlight'.
7336 Note that tabs after the showbreak will be displayed differently.
7337 If you want the 'showbreak' to appear in between line numbers, add the
7338 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007339 A window-local value overrules a global value. If the global value is
7340 set and you want no value in the current window use NONE: >
7341 :setlocal showbreak=NONE
7342<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007344'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7345 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007347 Show (partial) command in the last line of the screen. Set this
7348 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 In Visual mode the size of the selected area is shown:
7350 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007351 If the number of bytes is different it is also displayed: "2-6"
7352 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007354 - When selecting a block, the size in screen characters:
7355 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007356 This information can be displayed in an alternative location using the
7357 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 NOTE: This option is set to the Vi default value when 'compatible' is
7359 set and to the Vim default value when 'compatible' is reset.
7360
Luuk van Baalba936f62022-12-15 13:15:39 +00007361 *'showcmdloc'* *'sloc'*
7362'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007363 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007364 This option can be used to display the (partially) entered command in
7365 another location. Possible values are:
7366 last Last line of the screen (default).
7367 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007368 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007369 Setting this option to "statusline" or "tabline" means that these will
7370 be redrawn whenever the command changes, which can be on every key
7371 pressed.
7372 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7373 place the text. Without a custom 'statusline' or 'tabline' it will be
7374 displayed in a convenient location.
7375
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7377'showfulltag' 'sft' boolean (default off)
7378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 When completing a word in insert mode (see |ins-completion|) from the
7380 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007381 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 matched a C function, you can see a template for what arguments are
7383 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007384 Note that this doesn't work well together with having "longest" in
7385 'completeopt', because the completion from the search pattern may not
7386 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387
7388 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7389'showmatch' 'sm' boolean (default off)
7390 global
7391 When a bracket is inserted, briefly jump to the matching one. The
7392 jump is only done if the match can be seen on the screen. The time to
7393 show the match can be set with 'matchtime'.
7394 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007395 seen or not).
7396 This option is reset when 'paste' is set and restored when 'paste' is
7397 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 When the 'm' flag is not included in 'cpoptions', typing a character
7399 will immediately move the cursor back to where it belongs.
7400 See the "sm" field in 'guicursor' for setting the cursor shape and
7401 blinking when showing the match.
7402 The 'matchpairs' option can be used to specify the characters to show
7403 matches for. 'rightleft' and 'revins' are used to look for opposite
7404 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007405 Also see the matchparen plugin for highlighting the match when moving
7406 around |pi_paren.txt|.
7407 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408
7409 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7410'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7411 global
7412 If in Insert, Replace or Visual mode put a message on the last line.
7413 Use the 'M' flag in 'highlight' to set the type of highlighting for
7414 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007415 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 doesn't mean XIM is really active, especially when 'imactivatekey' is
7417 not set.
7418 NOTE: This option is set to the Vi default value when 'compatible' is
7419 set and to the Vim default value when 'compatible' is reset.
7420
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007421 *'showtabline'* *'stal'*
7422'showtabline' 'stal' number (default 1)
7423 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007424 The value of this option specifies when the line with tab page labels
7425 will be displayed:
7426 0: never
7427 1: only if there are at least two tab pages
7428 2: always
7429 This is both for the GUI and non-GUI implementation of the tab pages
7430 line.
7431 See |tab-page| for more information about tab pages.
7432
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 *'sidescroll'* *'ss'*
7434'sidescroll' 'ss' number (default 0)
7435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 The minimal number of columns to scroll horizontally. Used only when
7437 the 'wrap' option is off and the cursor is moved off of the screen.
7438 When it is zero the cursor will be put in the middle of the screen.
7439 When using a slow terminal set it to a large number or 0. When using
7440 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7441 commands.
7442
7443 *'sidescrolloff'* *'siso'*
7444'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007445 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007447 right of the cursor if 'nowrap' is set. Setting this option to a
7448 value greater than 0 while having |'sidescroll'| also at a non-zero
7449 value makes some context visible in the line you are scrolling in
7450 horizontally (except at beginning of the line). Setting this option
7451 to a large value (like 999) has the effect of keeping the cursor
7452 horizontally centered in the window, as long as one does not come too
7453 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007454 After using the local value, go back the global value with one of
7455 these two: >
7456 setlocal sidescrolloff<
7457 setlocal sidescrolloff=-1
7458< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
7460 Example: Try this together with 'sidescroll' and 'listchars' as
7461 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007462 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463
7464 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7465 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007466<
7467 *'signcolumn'* *'scl'*
7468'signcolumn' 'scl' string (default "auto")
7469 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007470 {not available when compiled without the |+signs|
7471 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007472 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007473 "auto" only when there is a sign to display
7474 "no" never
7475 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007476 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007477 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7480'smartcase' 'scs' boolean (default off)
7481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 Override the 'ignorecase' option if the search pattern contains upper
7483 case characters. Only used when the search pattern is typed and
7484 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007485 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7487 recalling the search pattern from history and hitting <Enter>.
7488 NOTE: This option is reset when 'compatible' is set.
7489
7490 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7491'smartindent' 'si' boolean (default off)
7492 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 Do smart autoindenting when starting a new line. Works for C-like
7494 programs, but can also be used for other languages. 'cindent' does
7495 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007496 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007497 setting 'si' has no effect. 'indentexpr' is a more advanced
7498 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 Normally 'autoindent' should also be on when using 'smartindent'.
7500 An indent is automatically inserted:
7501 - After a line ending in '{'.
7502 - After a line starting with a keyword from 'cinwords'.
7503 - Before a line starting with '}' (only with the "O" command).
7504 When typing '}' as the first character in a new line, that line is
7505 given the same indent as the matching '{'.
7506 When typing '#' as the first character in a new line, the indent for
7507 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007508 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7510 When using the ">>" command, lines starting with '#' are not shifted
7511 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007512 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007513 This option is reset when 'paste' is set and restored when 'paste' is
7514 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515
7516 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7517'smarttab' 'sta' boolean (default off)
7518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007520 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7521 <BS> will delete a 'shiftwidth' worth of space at the start of the
7522 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007523 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007524 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7525 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007526 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007528 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007529 This option is reset when 'paste' is set and restored when 'paste' is
7530 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 NOTE: This option is reset when 'compatible' is set.
7532
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007533 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7534'smoothscroll' 'sms' boolean (default off)
7535 local to window
7536 Scrolling works with screen lines. When 'wrap' is set and the first
7537 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007538 above the window. "<<<" is displayed at the start of the first line,
7539 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007540 You may also want to add "lastline" to the 'display' option to show as
7541 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007542 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007543
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 *'softtabstop'* *'sts'*
7545'softtabstop' 'sts' number (default 0)
7546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 Number of spaces that a <Tab> counts for while performing editing
7548 operations, like inserting a <Tab> or using <BS>. It "feels" like
7549 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7550 used. This is useful to keep the 'ts' setting at its standard value
7551 of 8, while being able to edit like it is set to 'sts'. However,
7552 commands like "x" still work on the actual characters.
7553 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007554 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007555 'softtabstop' is set to 0 when the 'paste' option is set and restored
7556 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7558 spaces is minimized by using <Tab>s.
7559 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7560 set.
7561 NOTE: This option is set to 0 when 'compatible' is set.
7562
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007563 If Vim is compiled with the |+vartabs| feature then the value of
7564 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7565 anything other than an empty string.
7566
Bram Moolenaar217ad922005-03-20 22:37:15 +00007567 *'spell'* *'nospell'*
7568'spell' boolean (default off)
7569 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007570 {not available when compiled without the |+syntax|
7571 feature}
7572 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007573 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007574
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007575 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007576'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007577 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007578 {not available when compiled without the |+syntax|
7579 feature}
7580 Pattern to locate the end of a sentence. The following word will be
7581 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007582 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007583 When this check is not wanted make this option empty.
7584 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007585 Be careful with special characters, see |option-backslash| about
7586 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007587 To set this option automatically depending on the language, see
7588 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007589
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007590 *'spellfile'* *'spf'*
7591'spellfile' 'spf' string (default empty)
7592 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007593 {not available when compiled without the |+syntax|
7594 feature}
7595 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007596 commands. It must end in ".{encoding}.add". You need to include the
7597 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007598 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007599 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007600 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007601 |zg| and |zw| commands can be used to access each. This allows using
7602 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007603 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007604 you: Using the first directory in 'runtimepath' that is writable. If
7605 there is no "spell" directory yet it will be created. For the file
7606 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007607 ignoring the region.
7608 The resulting ".spl" file will be used for spell checking, it does not
7609 have to appear in 'spelllang'.
7610 Normally one file is used for all regions, but you can add the region
7611 name if you want to. However, it will then only be used when
7612 'spellfile' is set to it, for entries in 'spelllang' only files
7613 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007614 This option cannot be set from a |modeline| or in the |sandbox|, for
7615 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007616
Bram Moolenaar217ad922005-03-20 22:37:15 +00007617 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007618'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007619 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007620 {not available when compiled without the |+syntax|
7621 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007622 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007623 on spellchecking will be done for these languages. Example: >
7624 set spelllang=en_us,nl,medical
7625< This means US English, Dutch and medical words are recognized. Words
7626 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007627 The word list name must consist of alphanumeric characters, a dash or
7628 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007629 recommended to separate the two letter language name from a
7630 specification. Thus "en-rare" is used for rare English words.
7631 A region name must come last and have the form "_xx", where "xx" is
7632 the two-letter, lower case region name. You can use more than one
7633 region by listing them: "en_us,en_ca" supports both US and Canadian
7634 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007635 Britain. (Note: currently en_au and en_nz dictionaries are older than
7636 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007637 If the name "cjk" is included East Asian characters are excluded from
7638 spell checking. This is useful when editing text that also has Asian
7639 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007640 Note that the "medical" dictionary does not exist, it is just an
7641 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007642 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007643 As a special case the name of a .spl file can be given as-is. The
7644 first "_xx" in the name is removed and used as the region name
7645 (_xx is an underscore, two letters and followed by a non-letter).
7646 This is mainly for testing purposes. You must make sure the correct
7647 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007648 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007649 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7650 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007651 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007652
Bram Moolenaar98692072006-02-04 00:57:42 +00007653 If the |spellfile.vim| plugin is active and you use a language name
7654 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7655 will ask you if you want to download the file.
7656
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007657 After this option has been set successfully, Vim will source the files
7658 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007659 up to the first character that is not an ASCII letter or number and
7660 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007661
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007662 *'spelloptions'* *'spo'*
7663'spelloptions' 'spo' string (default "")
7664 local to buffer
7665 {not available when compiled without the |+syntax|
7666 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007667 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007668 camel When a word is CamelCased, assume "Cased" is a
7669 separate word: every upper-case character in a word
7670 that comes after a lower case character indicates the
7671 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007672
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007673 *'spellsuggest'* *'sps'*
7674'spellsuggest' 'sps' string (default "best")
7675 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007676 {not available when compiled without the |+syntax|
7677 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007678 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007679 the |spellsuggest()| function. This is a comma-separated list of
7680 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007681
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007682 best Internal method that works best for English. Finds
7683 changes like "fast" and uses a bit of sound-a-like
7684 scoring to improve the ordering.
7685
7686 double Internal method that uses two methods and mixes the
7687 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007688 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007689 word. That only works when the language specifies
7690 sound folding. Can be slow and doesn't always give
7691 better results.
7692
7693 fast Internal method that only checks for simple changes:
7694 character inserts/deletes/swaps. Works well for
7695 simple typing mistakes.
7696
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007697 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007698 Not used for |spellsuggest()|. The number of
7699 suggestions is never more than the value of 'lines'
7700 minus two.
7701
Bram Moolenaar585ee072022-01-29 11:22:17 +00007702 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007703 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007704 methods. When omitted the limit is 5000. When
7705 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007706 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007707
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007708 file:{filename} Read file {filename}, which must have two columns,
7709 separated by a slash. The first column contains the
7710 bad word, the second column the suggested good word.
7711 Example:
7712 theribal/terrible ~
7713 Use this for common mistakes that do not appear at the
7714 top of the suggestion list with the internal methods.
7715 Lines without a slash are ignored, use this for
7716 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007717 The word in the second column must be correct,
7718 otherwise it will not be used. Add the word to an
7719 ".add" file if it is currently flagged as a spelling
7720 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007721 The file is used for all languages.
7722
7723 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007724 trouble with spaces. Best is to call a function
7725 without arguments, see |expr-option-function|.
7726 |v:val| holds the badly spelled word. The expression
7727 must evaluate to a List of Lists, each with a
7728 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007729 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007730 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007731 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007732 internal methods use. A lower score is better.
7733 This may invoke |spellsuggest()| if you temporarily
7734 set 'spellsuggest' to exclude the "expr:" part.
7735 Errors are silently ignored, unless you set the
7736 'verbose' option to a non-zero value.
7737
7738 Only one of "best", "double" or "fast" may be used. The others may
7739 appear several times in any order. Example: >
7740 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7741<
7742 This option cannot be set from a |modeline| or in the |sandbox|, for
7743 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007744
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7746'splitbelow' 'sb' boolean (default off)
7747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 When on, splitting a window will put the new window below the current
7749 one. |:split|
7750
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007751 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007752'splitkeep' 'spk' string (default "cursor")
7753 global
7754 The value of this option determines the scroll behavior when opening,
7755 closing or resizing horizontal splits.
7756
7757 Possible values are:
7758 cursor Keep the same relative cursor position.
7759 screen Keep the text on the same screen line.
7760 topline Keep the topline the same.
7761
7762 For the "screen" and "topline" values, the cursor position will be
7763 changed when necessary. In this case, the jumplist will be populated
7764 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007765 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007766
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7768'splitright' 'spr' boolean (default off)
7769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 When on, splitting a window will put the new window right of the
7771 current one. |:vsplit|
7772
7773 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7774'startofline' 'sol' boolean (default on)
7775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007777 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007778 (if possible). This applies to the commands:
7779 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7780 - "d", "<<" and ">>" with a linewise operator
7781 - "%" with a count
7782 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7783 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 In case of buffer changing commands the cursor is placed at the column
7785 where it was the last time the buffer was edited.
7786 NOTE: This option is set when 'compatible' is set.
7787
Bram Moolenaar00654022011-02-25 14:42:19 +01007788 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007790 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 {not available when compiled without the |+statusline|
7792 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007793 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 Also see |status-line|.
7795
7796 The option consists of printf style '%' items interspersed with
7797 normal text. Each status line item is of the form:
7798 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007799 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007800 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801
Bram Moolenaar238a5642006-02-21 22:12:05 +00007802 When the option starts with "%!" then it is used as an expression,
7803 evaluated and the result is used as the option value. Example: >
7804 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007805< The *g:statusline_winid* variable will be set to the |window-ID| of the
7806 window that the status line belongs to.
7807 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007808 Note that the "%!" expression is evaluated in the context of the
7809 current window and buffer, while %{} items are evaluated in the
7810 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007811
7812 When there is error while evaluating the option then it will be made
7813 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007814 When the result contains unprintable characters the result is
7815 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007816
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 Note that the only effect of 'ruler' when this option is set (and
7818 'laststatus' is 2) is controlling the output of |CTRL-G|.
7819
7820 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007821 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007823 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 minwid Minimum width of the item, padding as set by '-' & '0'.
7825 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007826 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 on the left for text items. Numeric items will be
7828 shifted down to maxwid-2 digits followed by '>'number
7829 where number is the amount of missing digits, much like
7830 an exponential notation.
7831 item A one letter code as described below.
7832
7833 Following is a description of the possible statusline items. The
7834 second character in "item" is the type:
7835 N for number
7836 S for string
7837 F for flags as described below
7838 - not applicable
7839
7840 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007841 f S Path to the file in the buffer, as typed or relative to current
7842 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 F S Full path to the file in the buffer.
7844 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007845 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007847 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007849 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007851 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007853 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007855 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7857 being used: "<keymap>"
7858 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007859 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 B N As above, in hexadecimal.
7861 o N Byte number in file of byte under cursor, first byte is 1.
7862 Mnemonic: Offset from start of file (with one added)
7863 {not available when compiled without |+byte_offset| feature}
7864 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007865 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 l N Line number.
7867 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007868 c N Column number (byte index).
7869 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007870 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 p N Percentage through file in lines as in |CTRL-G|.
7872 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007873 percentage described for 'ruler'. Always 3 in length, unless
7874 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007875 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007876 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007878 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007879 Note that there is no '%' before the closing '}'. The
7880 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007881 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007882 {% - This is almost same as { except the result of the expression is
7883 re-evaluated as a statusline format string. Thus if the
7884 return value of expr contains % items they will get expanded.
7885 The expression can contain the } character, the end of
7886 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007887 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007888 func! Stl_filename() abort
7889 return "%t"
7890 endfunc
7891< `stl=%{Stl_filename()}` results in `"%t"`
7892 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007893 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 ( - Start of item group. Can be used for setting the width and
7895 alignment of a section. Must be followed by %) somewhere.
7896 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007897 T N For 'tabline': start of tab page N label. Use %T after the last
7898 label. This information is used for mouse clicks.
7899 X N For 'tabline': start of close tab N label. Use %X after the
7900 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7901 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 < - Where to truncate line if too long. Default is at the start.
7903 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007904 = - Separation point between alignment sections. Each section will
7905 be separated by an equal number of spaces. With one %= what
7906 comes after it will be right-aligned. With two %= there is a
7907 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007909 # - Set highlight group. The name must follow and then a # again.
7910 Thus use %#HLname# for highlight group HLname. The same
7911 highlighting is used, also for the statusline of non-current
7912 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007914 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007915 The difference between User{N} and StatusLine will be applied to
7916 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 The number N must be between 1 and 9. See |hl-User1..9|
7918
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007919 When displaying a flag, Vim removes the leading comma, if any, when
7920 that flag comes right after plaintext. This will make a nice display
7921 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922
Bram Moolenaar582fd852005-03-28 20:58:01 +00007923 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 not set) and a minwid is not set for the group, the whole group will
7925 become empty. This will make a group like the following disappear
7926 completely from the statusline when none of the flags are set. >
7927 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007928< Beware that an expression is evaluated each and every time the status
7929 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007930 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007931 While evaluating %{} the current buffer and current window will be set
7932 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007933 currently being drawn. The expression will evaluate in this context.
7934 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7935 real current buffer and "g:actual_curwin" to the |window-ID| of the
7936 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007937
Bram Moolenaar30b65812012-07-12 22:01:11 +02007938 The 'statusline' option will be evaluated in the |sandbox| if set from
7939 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007940 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007941
7942 It is not allowed to change text or jump to another window while
7943 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944
7945 If the statusline is not updated when you want it (e.g., after setting
7946 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007947 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007949 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 Otherwise the result is taken as flag text and applied to the rules
7951 described above.
7952
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007953 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007955 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956
7957 Examples:
7958 Emulate standard status line with 'ruler' set >
7959 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7960< Similar, but add ASCII value of char under the cursor (like "ga") >
7961 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7962< Display byte count and byte value, modified flag in red. >
7963 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7964 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7965< Display a ,GZ flag if a compressed file is loaded >
7966 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7967< In the |:autocmd|'s: >
7968 :let b:gzflag = 1
7969< And: >
7970 :unlet b:gzflag
7971< And define this function: >
7972 :function VarExists(var, val)
7973 : if exists(a:var) | return a:val | else | return '' | endif
7974 :endfunction
7975<
7976 *'suffixes'* *'su'*
7977'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 Files with these suffixes get a lower priority when multiple files
7980 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007981 suffixes. Spaces after the comma are ignored. A dot is also seen as
7982 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 separator, precede it with a backslash (see |option-backslash| about
7984 including spaces and backslashes).
7985 See 'wildignore' for completely ignoring files.
7986 The use of |:set+=| and |:set-=| is preferred when adding or removing
7987 suffixes from the list. This avoids problems when a future version
7988 uses another default.
7989
7990 *'suffixesadd'* *'sua'*
7991'suffixesadd' 'sua' string (default "")
7992 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007993 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 file for the "gf", "[I", etc. commands. Example: >
7995 :set suffixesadd=.java
7996<
7997 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7998'swapfile' 'swf' boolean (default on)
7999 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008000 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 swapfile is not wanted for a specific buffer. For example, with
8002 confidential information that even root must not be able to access.
8003 Careful: All text will be in memory:
8004 - Don't use this for big files.
8005 - Recovery will be impossible!
8006 A swapfile will only be present when |'updatecount'| is non-zero and
8007 'swapfile' is set.
8008 When 'swapfile' is reset, the swap file for the current buffer is
8009 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8010 non-zero, a swap file is immediately created.
8011 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008012 If you want to open a new buffer without creating a swap file for it,
8013 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008014 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015
8016 This option is used together with 'bufhidden' and 'buftype' to
8017 specify special kinds of buffers. See |special-buffers|.
8018
8019 *'swapsync'* *'sws'*
8020'swapsync' 'sws' string (default "fsync")
8021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008023 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 When this option is empty parts of the swap file may be in memory and
8025 not written to disk. When the system crashes you may lose more work.
8026 On Unix the system does a sync now and then without Vim asking for it,
8027 so the disadvantage of setting this option off is small. On some
8028 systems the swap file will not be written at all. For a unix system
8029 setting it to "sync" will use the sync() call instead of the default
8030 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008031 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
8033 *'switchbuf'* *'swb'*
8034'switchbuf' 'swb' string (default "")
8035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008037 This option is checked, when
8038 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008039 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008040 - jumping to a tag using the |:stag| command.
8041 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8042 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8043 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008044 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008045 useopen If included, jump to the first open window in the
8046 current tab page that contains the specified buffer
8047 (if there is one). Otherwise: Do not examine other
8048 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008049 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008050 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008052 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008053 Otherwise: do not split, use current window (when used
8054 in the quickfix window: the previously used window or
8055 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008056 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008057 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008058 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008059 uselast If included, jump to the previously used window when
8060 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008061 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8062 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008064 *'synmaxcol'* *'smc'*
8065'synmaxcol' 'smc' number (default 3000)
8066 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008067 {not available when compiled without the |+syntax|
8068 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008069 Maximum column in which to search for syntax items. In long lines the
8070 text after this column is not highlighted and following lines may not
8071 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008072 This helps to avoid very slow redrawing for an XML file that is one
8073 long line.
8074 Set to zero to remove the limit.
8075
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076 *'syntax'* *'syn'*
8077'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008078 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 {not available when compiled without the |+syntax|
8080 feature}
8081 When this option is set, the syntax with this name is loaded, unless
8082 syntax highlighting has been switched off with ":syntax off".
8083 Otherwise this option does not always reflect the current syntax (the
8084 b:current_syntax variable does).
8085 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008086 not automatically recognized. Example, in an IDL file:
8087 /* vim: set syntax=idl : */ ~
8088 When a dot appears in the value then this separates two filetype
8089 names. Example:
8090 /* vim: set syntax=c.doxygen : */ ~
8091 This will use the "c" syntax first, then the "doxygen" syntax.
8092 Note that the second one must be prepared to be loaded as an addition,
8093 otherwise it will be skipped. More than one dot may appear.
8094 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 :set syntax=OFF
8096< To switch syntax highlighting on according to the current value of the
8097 'filetype' option: >
8098 :set syntax=ON
8099< What actually happens when setting the 'syntax' option is that the
8100 Syntax autocommand event is triggered with the value as argument.
8101 This option is not copied to another buffer, independent of the 's' or
8102 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008103 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104
LemonBoy5247b0b2024-07-12 19:30:58 +02008105 *'tabclose'* *'tcl'*
8106'tabclose' 'tcl' string (default "")
8107 global
8108 This option controls the behavior when closing tab pages (e.g., using
8109 |:tabclose|). When empty Vim goes to the next (right) tab page.
8110
8111 Possible values (comma-separated list):
8112 left If included, go to the previous tab page instead of
8113 the next one.
8114 uselast If included, go to the previously used tab page if
8115 possible. This option takes precedence over the
8116 others.
8117
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008118 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008119'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008120 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008121 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008122 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008123 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008124
8125 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008126 option and only when there is no GUI tab line. When 'e' is in
8127 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008128 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008129
8130 The value is evaluated like with 'statusline'. You can use
8131 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008132 the text to be displayed. Use "%1T" for the first label, "%2T" for
8133 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008134
Bram Moolenaare12bab32019-01-08 22:02:56 +01008135 When changing something that is used in 'tabline' that does not
8136 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008137 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008138
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008139 Keep in mind that only one of the tab pages is the current one, others
8140 are invisible and you can't jump to their windows.
8141
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008142 *'tabpagemax'* *'tpm'*
8143'tabpagemax' 'tpm' number (default 10)
8144 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008145 Maximum number of tab pages to be opened by the |-p| command line
8146 argument or the ":tab all" command. |tabpage|
8147
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008148 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149'tabstop' 'ts' number (default 8)
8150 local to buffer
8151 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008152 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153
8154 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008155 appear wrong in many places, e.g., when printing it.
8156 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008158 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8160 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008161 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008163 This is the recommended way, the file will look the same with other
8164 tools and when listing it in a terminal.
8165 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8166 'expandtab'. This way you will always insert spaces. The
8167 formatting will never be messed up when 'tabstop' is changed (leave
8168 it at 8 just in case). The file will be a bit larger.
8169 You do need to check if no Tabs exist in the file. You can get rid
8170 of them by first setting 'expandtab' and using `%retab!`, making
8171 sure the value of 'tabstop' is set correctly.
8172 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 'expandtab'. This way you will always insert spaces. The
8174 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008175 You do need to check if no Tabs exist in the file, just like in the
8176 item just above.
8177 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008178 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008179 works when using Vim to edit the file, other tools assume a tabstop
8180 is worth 8 spaces.
8181 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 'noexpandtab'. This should then work (for initial indents only)
8183 for any tabstop setting that people use. It might be nice to have
8184 tabs after the first non-blank inserted as spaces if you do this
8185 though. Otherwise aligned comments will be wrong when 'tabstop' is
8186 changed.
8187
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008188 If Vim is compiled with the |+vartabs| feature then the value of
8189 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8190 than an empty string.
8191
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8193'tagbsearch' 'tbs' boolean (default on)
8194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008196 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 searching makes searching for a tag a LOT faster, but a linear search
8198 will find more tags if the tags file wasn't properly sorted.
8199 Vim normally assumes that your tags files are sorted, or indicate that
8200 they are not sorted. Only when this is not the case does the
8201 'tagbsearch' option need to be switched off.
8202
8203 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008204 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 certain files, or retry all files with a linear search. When
8206 'tagbsearch' is off, only a linear search is done.
8207
8208 Linear searching is done anyway, for one file, when Vim finds a line
8209 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008210 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211< [The whitespace before and after the '0' must be a single <Tab>]
8212
8213 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008214 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 instead of a normal tag name, a retry is done with a linear search.
8216 Tags in unsorted tags files, and matches with different case will only
8217 be found in the retry.
8218
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008219 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008220 linear search can be avoided when case is ignored. Use a value of '2'
8221 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8222 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008223 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8224 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8225 used for this as well. Note that case must be folded to uppercase for
8226 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008227
8228 By default, tag searches are case-sensitive. Case is ignored when
8229 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8230 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008231 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8232 'tagcase' is "smart", and the pattern contains only lowercase
8233 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234
8235 When 'tagbsearch' is off, tags searching is slower when a full match
8236 exists, but faster when no full match exists. Tags in unsorted tags
8237 files may only be found with 'tagbsearch' off.
8238 When the tags file is not sorted, or sorted in a wrong way (not on
8239 ASCII byte value), 'tagbsearch' should be off, or the line given above
8240 must be included in the tags file.
8241 This option doesn't affect commands that find all matching tags (e.g.,
8242 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008244 *'tagcase'* *'tc'*
8245'tagcase' 'tc' string (default "followic")
8246 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008247 This option specifies how case is handled when searching the tags
8248 file:
8249 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008250 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008251 ignore Ignore case
8252 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008253 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008254 NOTE: This option is set to the Vi default value when 'compatible' is
8255 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008256
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008257 *'tagfunc'* *'tfu'*
8258'tagfunc' 'tfu' string (default: empty)
8259 local to buffer
8260 {not available when compiled without the |+eval|
8261 feature}
8262 This option specifies a function to be used to perform tag searches.
8263 The function gets the tag pattern and should return a List of matching
8264 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008265 function and an example. The value can be the name of a function, a
8266 |lambda| or a |Funcref|. See |option-value-function| for more
8267 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008268 This option cannot be set from a |modeline| or in the |sandbox|, for
8269 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008270
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 *'taglength'* *'tl'*
8272'taglength' 'tl' number (default 0)
8273 global
8274 If non-zero, tags are significant up to this number of characters.
8275
8276 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8277'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8278 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008279 If on and using a tags file in another directory, file names in that
8280 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 NOTE: This option is set to the Vi default value when 'compatible' is
8282 set and to the Vim default value when 'compatible' is reset.
8283
8284 *'tags'* *'tag'* *E433*
8285'tags' 'tag' string (default "./tags,tags", when compiled with
8286 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8287 global or local to buffer |global-local|
8288 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008289 include a space or comma in a file name, precede it with backslashes
8290 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 When a file name starts with "./", the '.' is replaced with the path
8292 of the current file. But only when the 'd' flag is not included in
8293 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8294 |tags-option|.
8295 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008296 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8297 find all files named "tags" below "/lib". The filename itself cannot
8298 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008299 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008300 The |tagfiles()| function can be used to get a list of the file names
8301 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8303 files are also supported. They are automatically recognized. The
8304 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8305 differences are ignored (MS-Windows). |emacs-tags|
8306 The use of |:set+=| and |:set-=| is preferred when adding or removing
8307 file names from the list. This avoids problems when a future version
8308 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309
8310 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8311'tagstack' 'tgst' boolean (default on)
8312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 When on, the |tagstack| is used normally. When off, a ":tag" or
8314 ":tselect" command with an argument will not push the tag onto the
8315 tagstack. A following ":tag" without an argument, a ":pop" command or
8316 any other command that uses the tagstack will use the unmodified
8317 tagstack, but does change the pointer to the active entry.
8318 Resetting this option is useful when using a ":tag" command in a
8319 mapping which should not change the tagstack.
8320
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008321 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008322'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008323 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008324 {only available when compiled with the |+tcl/dyn|
8325 feature}
8326 Specifies the name of the Tcl shared library. The default is
8327 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008328 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008329 This option cannot be set from a |modeline| or in the |sandbox|, for
8330 security reasons.
8331
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 *'term'* *E529* *E530* *E531*
8333'term' string (default is $TERM, if that fails:
8334 in the GUI: "builtin_gui"
8335 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008336 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 on Unix: "ansi"
8339 on VMS: "ansi"
8340 on Win 32: "win32")
8341 global
8342 Name of the terminal. Used for choosing the terminal control
8343 characters. Environment variables are expanded |:set_env|.
8344 For example: >
8345 :set term=$TERM
8346< See |termcap|.
8347
8348 *'termbidi'* *'tbidi'*
8349 *'notermbidi'* *'notbidi'*
8350'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 {only available when compiled with the |+arabic|
8353 feature}
8354 The terminal is in charge of Bi-directionality of text (as specified
8355 by Unicode). The terminal is also expected to do the required shaping
8356 that some languages (such as Arabic) require.
8357 Setting this option implies that 'rightleft' will not be set when
8358 'arabic' is set and the value of 'arabicshape' will be ignored.
8359 Note that setting 'termbidi' has the immediate effect that
8360 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8361 This option is reset when the GUI is started.
8362 For further details see |arabic.txt|.
8363
8364 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008365'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 Encoding used for the terminal. This specifies what character
8368 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008369 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008370 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008371 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008372 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8374 Any attempts to set a different value will be rejected, and an error
8375 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008376 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 because the Win32 system always passes Unicode characters.
8378 When empty, the same encoding is used as for the 'encoding' option.
8379 This is the normal value.
8380 Not all combinations for 'termencoding' and 'encoding' are valid. See
8381 |encoding-table|.
8382 The value for this option must be supported by internal conversions or
8383 iconv(). When this is not possible no conversion will be done and you
8384 will probably experience problems with non-ASCII characters.
8385 Example: You are working with the locale set to euc-jp (Japanese) and
8386 want to edit a UTF-8 file: >
8387 :let &termencoding = &encoding
8388 :set encoding=utf-8
8389< You need to do this when your system has no locale support for UTF-8.
8390
Bram Moolenaar938ae282023-02-20 20:44:55 +00008391 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008392'termguicolors' 'tgc' boolean (default off)
8393 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008394 {not available when compiled without the
8395 |+termguicolors| feature}
8396 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008397 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008398
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008399 Requires a ISO-8613-3 compatible terminal. If setting this option
8400 does not work (produces a colorless UI) reading |xterm-true-color|
8401 might help.
8402
8403 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8404 is required. Use this check to find out: >
8405 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008406< This requires Vim to be built with the |+vtp| feature.
8407
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008408 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008409
8410 When using Vim with Windows Terminal, the background of Windows
8411 Terminal is normally filled with the Vim background color. Setting
8412 'termguicolors' and the guibg of the Normal highlight group to NONE
8413 will make the background transparent: >
8414 :hi Normal guibg=NONE
8415<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008416 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008417
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008418 *'termwinkey'* *'twk'*
8419'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008420 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008421 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008422 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008423 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008424 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008425< The string must be one key stroke but can be multiple bytes.
8426 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008427 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008428 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008429
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008430 *'termwinscroll'* *'twsl'*
8431'termwinscroll' 'twsl' number (default 10000)
8432 local to buffer
8433 {not available when compiled without the
8434 |+terminal| feature}
8435 Number of scrollback lines to keep. When going over this limit the
8436 first 10% of the scrollback lines are deleted. This is just to reduce
8437 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008438 Also used as a limit for text sent to the terminal in one write,
8439 multiplied by the number of columns times 3 (average number of bytes
8440 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008441
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008442 *'termwinsize'* *'tws'*
8443'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008444 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008445 Size used when opening the |terminal| window. Format:
8446 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008447 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008448 - When set with a "x" (e.g., "24x80") the terminal size is not
8449 adjusted to the window size. If the window is smaller only the
8450 top-left part is displayed.
8451 - When set with a "*" (e.g., "10*50") the terminal size follows the
8452 window size, but will not be smaller than the specified rows and/or
8453 columns.
8454 - When rows is zero then use the height of the window.
8455 - When columns is zero then use the width of the window.
8456 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008457 - Can be overruled in the |term_start()| options with "term_rows" and
8458 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008459
8460 Examples:
8461 "30x0" uses 30 rows and the current window width.
8462 "20*0" uses at least 20 rows and the current window width.
8463 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008464 Note that the command running in the terminal window may still change
8465 the size of the terminal. In that case the Vim window will be
8466 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008467
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008468 *'termwintype'* *'twt'*
8469'termwintype' 'twt' string (default "")
8470 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008471 {only available when compiled with the |terminal|
8472 feature on MS-Windows}
8473 Specify the virtual console (pty) used when opening the terminal
8474 window.
8475
8476 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008477 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008478 "winpty" use winpty, fail if not supported
8479 "conpty" use |ConPTY|, fail if not supported
8480
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008481 |ConPTY| support depends on the platform. Windows 10 October 2018
8482 Update is the first version that supports ConPTY, however it is still
8483 considered unstable. ConPTY might become stable in the next release
8484 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008485 supported then you cannot open a terminal window.
8486
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 *'terse'* *'noterse'*
8488'terse' boolean (default off)
8489 global
8490 When set: Add 's' flag to 'shortmess' option (this makes the message
8491 for a search that hits the start or end of the file not being
8492 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8493 shortens a lot of messages}
8494
8495 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8496'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 This option is obsolete. Use 'fileformats'.
8499 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8500 set to the default value for the current system. When 'textauto' is
8501 reset, 'fileformats' is made empty.
8502 NOTE: This option is set to the Vi default value when 'compatible' is
8503 set and to the Vim default value when 'compatible' is reset.
8504
8505 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008506'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 others: default off)
8508 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 This option is obsolete. Use 'fileformat'.
8510 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8511 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8512 "unix".
8513
8514 *'textwidth'* *'tw'*
8515'textwidth' 'tw' number (default 0)
8516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 Maximum width of text that is being inserted. A longer line will be
8518 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008519 this.
8520 'textwidth' is set to 0 when the 'paste' option is set and restored
8521 when 'paste' is reset.
8522 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008524 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 NOTE: This option is set to 0 when 'compatible' is set.
8526
8527 *'thesaurus'* *'tsr'*
8528'thesaurus' 'tsr' string (default "")
8529 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008531 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8532 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008533
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008534 This option is not used if 'thesaurusfunc' is set, either for the
8535 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008536
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008537 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008539 name. See |option-backslash| about using backslashes. The use of
8540 |:set+=| and |:set-=| is preferred when adding or removing directories
8541 from the list. This avoids problems when a future version uses
8542 another default. Backticks cannot be used in this option for security
8543 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008545 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008546'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008547 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008548 {not available when compiled without the |+eval|
8549 feature}
8550 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008551 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008552 The value can be the name of a function, a |lambda| or a |Funcref|.
8553 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008554
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008555 This option cannot be set from a |modeline| or in the |sandbox|, for
8556 security reasons.
8557
Bram Moolenaar071d4272004-06-13 20:20:40 +00008558 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8559'tildeop' 'top' boolean (default off)
8560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 When on: The tilde command "~" behaves like an operator.
8562 NOTE: This option is reset when 'compatible' is set.
8563
8564 *'timeout'* *'to'* *'notimeout'* *'noto'*
8565'timeout' 'to' boolean (default on)
8566 global
laburnumT3f7855a2023-12-05 18:37:03 +01008567
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008569'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 These two options together determine the behavior when part of a
8572 mapped key sequence or keyboard code has been received:
8573
8574 'timeout' 'ttimeout' action ~
8575 off off do not time out
8576 on on or off time out on :mappings and key codes
8577 off on time out on key codes
8578
8579 If both options are off, Vim will wait until either the complete
8580 mapping or key sequence has been received, or it is clear that there
8581 is no mapping or key sequence for the received characters. For
8582 example: if you have mapped "vl" and Vim has received 'v', the next
8583 character is needed to see if the 'v' is followed by an 'l'.
8584 When one of the options is on, Vim will wait for about 1 second for
8585 the next character to arrive. After that the already received
8586 characters are interpreted as single characters. The waiting time can
8587 be changed with the 'timeoutlen' option.
8588 On slow terminals or very busy systems timing out may cause
8589 malfunctioning cursor keys. If both options are off, Vim waits
8590 forever after an entered <Esc> if there are key codes that start
8591 with <Esc>. You will have to type <Esc> twice. If you do not have
8592 problems with key codes, but would like to have :mapped key
8593 sequences not timing out in 1 second, set the 'ttimeout' option and
8594 reset the 'timeout' option.
8595
8596 NOTE: 'ttimeout' is reset when 'compatible' is set.
8597
8598 *'timeoutlen'* *'tm'*
8599'timeoutlen' 'tm' number (default 1000)
8600 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008601
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008603'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 The time in milliseconds that is waited for a key code or mapped key
8606 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8607 when part of a command has been typed.
8608 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8609 different timeout value for key codes is desired set 'ttimeoutlen' to
8610 a non-negative number.
8611
8612 ttimeoutlen mapping delay key code delay ~
8613 < 0 'timeoutlen' 'timeoutlen'
8614 >= 0 'timeoutlen' 'ttimeoutlen'
8615
8616 The timeout only happens when the 'timeout' and 'ttimeout' options
8617 tell so. A useful setting would be >
8618 :set timeout timeoutlen=3000 ttimeoutlen=100
8619< (time out on mapping after three seconds, time out on key codes after
8620 a tenth of a second).
8621
8622 *'title'* *'notitle'*
8623'title' boolean (default off, on when title can be restored)
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 When on, the title of the window will be set to the value of
8626 'titlestring' (if it is not empty), or to:
8627 filename [+=-] (path) - VIM
8628 Where:
8629 filename the name of the file being edited
8630 - indicates the file cannot be modified, 'ma' off
8631 + indicates the file was modified
8632 = indicates the file is read-only
8633 =+ indicates the file is read-only and modified
8634 (path) is the path of the file being edited
8635 - VIM the server name |v:servername| or "VIM"
8636 Only works if the terminal supports setting window titles
8637 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008638 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8640 *X11*
8641 When Vim was compiled with HAVE_X11 defined, the original title will
8642 be restored if possible. The output of ":version" will include "+X11"
8643 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8644 works for the icon name |'icon'|.
8645 But: When Vim was started with the |-X| argument, restoring the title
8646 will not work (except in the GUI).
8647 If the title cannot be restored, it is set to the value of 'titleold'.
8648 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008649 When using an xterm from a remote machine you can use this command: >
8650
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008652 ssh -X machine_name xterm &
8653<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 then the WINDOWID environment variable should be inherited and the
8655 title of the window should change back to what it should be after
8656 exiting Vim.
8657
8658 *'titlelen'*
8659'titlelen' number (default 85)
8660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 title. When the title is longer, only the end of the path name is
8663 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 Using a percentage makes this adapt to the width of the window. But
8665 it won't work perfectly, because the actual number of characters
8666 available also depends on the font used and other things in the title
8667 bar. When 'titlelen' is zero the full path is used. Otherwise,
8668 values from 1 to 30000 percent can be used.
8669 'titlelen' is also used for the 'titlestring' option.
8670
8671 *'titleold'*
8672'titleold' string (default "Thanks for flying Vim")
8673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 This option will be used for the window title when exiting Vim if the
8675 original title cannot be restored. Only happens if 'title' is on or
8676 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008677 This option cannot be set from a |modeline| or in the |sandbox|, for
8678 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 *'titlestring'*
8680'titlestring' string (default "")
8681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 When this option is not empty, it will be used for the title of the
8683 window. This happens only when the 'title' option is on.
8684 Only works if the terminal supports setting window titles (currently
8685 Amiga console, Win32 console, all GUI versions and terminals with a
8686 non-empty 't_ts' option).
8687 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008688 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008689
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 When this option contains printf-style '%' items, they will be
8691 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008692 This option cannot be set in a modeline when 'modelineexpr' is off.
8693
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008695 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8697< The value of 'titlelen' is used to align items in the middle or right
8698 of the available space.
8699 Some people prefer to have the file name first: >
8700 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8701< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008702 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 separating space only when needed.
8704 NOTE: Use of special characters in 'titlestring' may cause the display
8705 to be garbled (e.g., when it contains a CR or NL character).
8706 {not available when compiled without the |+statusline| feature}
8707
8708 *'toolbar'* *'tb'*
8709'toolbar' 'tb' string (default "icons,tooltips")
8710 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008711 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008712 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 possible values are:
8714 icons Toolbar buttons are shown with icons.
8715 text Toolbar buttons shown with text.
8716 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008717 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 tooltips Tooltips are active for toolbar buttons.
8719 Tooltips refer to the popup help text which appears after the mouse
8720 cursor is placed over a toolbar button for a brief moment.
8721
8722 If you want the toolbar to be shown with icons as well as text, do the
8723 following: >
8724 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008725< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 will show icons if both are requested.
8727
8728 If none of the strings specified in 'toolbar' are valid or if
8729 'toolbar' is empty, this option is ignored. If you want to disable
8730 the toolbar, you need to set the 'guioptions' option. For example: >
8731 :set guioptions-=T
8732< Also see |gui-toolbar|.
8733
8734 *'toolbariconsize'* *'tbis'*
8735'toolbariconsize' 'tbis' string (default "small")
8736 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008737 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008739 tiny Use tiny icons.
8740 small Use small icons (default).
8741 medium Use medium-sized icons.
8742 large Use large icons.
8743 huge Use even larger icons.
8744 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008746 the current theme. Common dimensions are giant=48x48, huge=32x32,
8747 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748
8749 If 'toolbariconsize' is empty, the global default size as determined
8750 by user preferences or the current theme is used.
8751
8752 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8753'ttybuiltin' 'tbi' boolean (default on)
8754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 When on, the builtin termcaps are searched before the external ones.
8756 When off the builtin termcaps are searched after the external ones.
8757 When this option is changed, you should set the 'term' option next for
8758 the change to take effect, for example: >
8759 :set notbi term=$TERM
8760< See also |termcap|.
8761 Rationale: The default for this option is "on", because the builtin
8762 termcap entries are generally better (many systems contain faulty
8763 xterm entries...).
8764
8765 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008766'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 Indicates a fast terminal connection. More characters will be sent to
8769 the screen for redrawing, instead of using insert/delete line
8770 commands. Improves smoothness of redrawing when there are multiple
8771 windows and the terminal does not support a scrolling region.
8772 Also enables the extra writing of characters at the end of each screen
8773 line for lines that wrap. This helps when using copy/paste with the
8774 mouse in an xterm and other terminals.
8775
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008776 The default used to be set only for some terminal names, but these
8777 days nearly all terminals are fast, therefore the default is now "on".
8778 If you have a slow connection you may want to set this option off,
8779 e.g. depending on the host name: >
8780 if hostname() =~ 'faraway'
8781 set nottyfast
8782 endif
8783<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 *'ttymouse'* *'ttym'*
8785'ttymouse' 'ttym' string (default depends on 'term')
8786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 {only in Unix and VMS, doesn't work in the GUI; not
8788 available when compiled without |+mouse|}
8789 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008790 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 *xterm-mouse*
8792 xterm xterm-like mouse handling. The mouse generates
8793 "<Esc>[Mscr", where "scr" is three bytes:
8794 "s" = button state
8795 "c" = column plus 33
8796 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008797 This only works up to 223 columns! See "dec",
8798 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 xterm2 Works like "xterm", but with the xterm reporting the
8800 mouse position while the mouse is dragged. This works
8801 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008802 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 work. See below for how Vim detects this
8804 automatically.
8805 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008806 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008808 for the row and column. No other mouse events are
8809 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 *dec-mouse*
8811 dec DEC terminal mouse handling. The mouse generates a
8812 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008813 This is also available for an Xterm, if it was
8814 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 *jsbterm-mouse*
8816 jsbterm JSB term mouse handling.
8817 *pterm-mouse*
8818 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008819 *urxvt-mouse*
8820 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008821 The mouse works only if the terminal supports this
8822 encoding style, but it does not have 223 columns limit
8823 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008824 *sgr-mouse*
8825 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008826 mouse reporting. The mouse works even in columns
8827 beyond 223. This option is backward compatible with
8828 "xterm2" because it can also decode "xterm2" style
8829 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830
8831 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008832 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8833 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8835 recognized, if enabled at compile time. DEC terminal mouse codes
8836 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008837 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8838 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008840 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8841 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8842 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008843 If the terminfo/termcap entry "XM" exists and the first number is
8844 "1006" then 'ttymouse' will be set to "sgr". This works for many
8845 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008846 Additionally, if vim is compiled with the |+termresponse| feature and
8847 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008848 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008850 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8851 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8852 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008853 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8854 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 :set t_RV=
8856<
8857 *'ttyscroll'* *'tsl'*
8858'ttyscroll' 'tsl' number (default 999)
8859 global
8860 Maximum number of lines to scroll the screen. If there are more lines
8861 to scroll the window is redrawn. For terminals where scrolling is
8862 very slow and redrawing is not slow this can be set to a small number,
8863 e.g., 3, to speed up displaying.
8864
8865 *'ttytype'* *'tty'*
8866'ttytype' 'tty' string (default from $TERM)
8867 global
8868 Alias for 'term', see above.
8869
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008870 *'undodir'* *'udir'*
8871'undodir' 'udir' string (default ".")
8872 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008873 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008874 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008875 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008876 "." means using the directory of the file. The undo file name for
8877 "file.txt" is ".file.txt.un~".
8878 For other directories the file name is the full path of the edited
8879 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008880 When writing: The first directory that exists is used. "." always
8881 works, no directories after "." will be used for writing.
8882 When reading all entries are tried to find an undo file. The first
8883 undo file that exists is used. When it cannot be read an error is
8884 given, no further entry is used.
8885 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008886 This option cannot be set from a |modeline| or in the |sandbox|, for
8887 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008888
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008889 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008890'undofile' 'udf' boolean (default off)
8891 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008892 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008893 When on, Vim automatically saves undo history to an undo file when
8894 writing a buffer to a file, and restores undo history from the same
8895 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008896 The directory where the undo file is stored is specified by 'undodir'.
8897 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008898 The undo file is not read when 'undoreload' causes the buffer from
8899 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008900 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008901 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008902
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008904'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008905 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008907 is kept in memory, higher numbers will cause more memory to be used.
8908 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8910 itself: >
8911 set ul=0
8912< But you can also get Vi compatibility by including the 'u' flag in
8913 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008914 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008915 Set to -1 for no undo at all. You might want to do this only for the
8916 current buffer: >
8917 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008919
8920 The local value is set to -123456 when the global value is to be used.
8921
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008922 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008924 *'undoreload'* *'ur'*
8925'undoreload' 'ur' number (default 10000)
8926 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008927 Save the whole buffer for undo when reloading it. This applies to the
8928 ":e!" command and reloading for when the buffer changed outside of
8929 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008930 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008931 of lines is smaller than the value of this option.
8932 Set this option to zero to disable undo for a reload.
8933
8934 When saving undo for a reload, any undo file is not read.
8935
8936 Note that this causes the whole buffer to be stored in memory. Set
8937 this option to a lower value if you run out of memory.
8938
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 *'updatecount'* *'uc'*
8940'updatecount' 'uc' number (default: 200)
8941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008942 After typing this many characters the swap file will be written to
8943 disk. When zero, no swap file will be created at all (see chapter on
8944 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8945 Vim with the "-n" option, see |startup|. When editing in readonly
8946 mode this option will be initialized to 10000.
8947 The swapfile can be disabled per buffer with |'swapfile'|.
8948 When 'updatecount' is set from zero to non-zero, swap files are
8949 created for all buffers that have 'swapfile' set. When 'updatecount'
8950 is set to zero, existing swap files are not deleted.
8951 Also see |'swapsync'|.
8952 This option has no meaning in buffers where |'buftype'| is "nofile"
8953 or "nowrite".
8954
8955 *'updatetime'* *'ut'*
8956'updatetime' 'ut' number (default 4000)
8957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 If this many milliseconds nothing is typed the swap file will be
8959 written to disk (see |crash-recovery|). Also used for the
8960 |CursorHold| autocommand event.
8961
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008962 *'varsofttabstop'* *'vsts'*
8963'varsofttabstop' 'vsts' string (default "")
8964 local to buffer
8965 {only available when compiled with the |+vartabs|
8966 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008967 A list of the number of spaces that a <Tab> counts for while editing,
8968 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8969 width <Tab>s are being inserted, while in fact a mixture of spaces
8970 and <Tab>s is used. Tab widths are separated with commas, with the
8971 final value applying to all subsequent tabs.
8972
8973 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008974 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008975 to use the following: >
8976 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008977< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8978 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008979
8980 Note that the value of |'softtabstop'| will be ignored while
8981 'varsofttabstop' is set.
8982
8983 *'vartabstop'* *'vts'*
8984'vartabstop' 'vts' string (default "")
8985 local to buffer
8986 {only available when compiled with the |+vartabs|
8987 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008988 A list of the number of spaces that a <Tab> in the file counts for,
8989 separated by commas. Each value corresponds to one tab, with the
8990 final value applying to all subsequent tabs. For example: >
8991 :set vartabstop=4,20,10,8
8992< This will make the first tab 4 spaces wide, the second 20 spaces,
8993 the third 10 spaces, and all following tabs 8 spaces.
8994
8995 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8996 is set.
8997
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 *'verbose'* *'vbs'*
8999'verbose' 'vbs' number (default 0)
9000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 When bigger than zero, Vim will give messages about what it is doing.
9002 Currently, these messages are given:
9003 >= 1 When the viminfo file is read or written.
9004 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009005 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009006 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 >= 8 Files for which a group of autocommands is executed.
9008 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009009 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 >= 12 Every executed function.
9011 >= 13 When an exception is thrown, caught, finished, or discarded.
9012 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009013 >= 15 Every executed Ex command from a script (truncated at 200
9014 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009015 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016
9017 This option can also be set with the "-V" argument. See |-V|.
9018 This option is also set by the |:verbose| command.
9019
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009020 When the 'verbosefile' option is set then the verbose messages are not
9021 displayed.
9022
9023 *'verbosefile'* *'vfile'*
9024'verbosefile' 'vfile' string (default empty)
9025 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009026 When not empty all messages are written in a file with this name.
9027 When the file exists messages are appended.
9028 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009029 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009030 Setting 'verbosefile' to a new value is like making it empty first.
9031 The difference with |:redir| is that verbose messages are not
9032 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009033 This option cannot be set from a |modeline| or in the |sandbox|, for
9034 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009035
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009037'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009038 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009039 for Unix: "$HOME/.vim/view" or
9040 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009041 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009042 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009044 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 feature}
9046 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009047 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 This option cannot be set from a |modeline| or in the |sandbox|, for
9049 security reasons.
9050
9051 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009052'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009054 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009056 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009057 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 word save and restore ~
9059 cursor cursor position in file and in window
9060 folds manually created folds, opened/closed folds and local
9061 fold options
9062 options options and mappings local to a window or buffer (not
9063 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009064 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 slash backslashes in file names replaced with forward
9066 slashes
9067 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009068 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009069 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009071 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009073 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074
9075 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009076'viminfo' 'vi' string (Vi default: "", Vim default for
9077 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009078 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9079 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009081 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 feature}
9083 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009084 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9085 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009086 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009087 consisting of a single character identifying the particular parameter,
9088 followed by a number or string which specifies the value of that
9089 parameter. If a particular character is left out, then the default
9090 value is used for that parameter. The following is a list of the
9091 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009093 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 ! When included, save and restore global variables that start
9095 with an uppercase letter, and don't contain a lowercase
9096 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009097 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009098 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009099 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009100 " Maximum number of lines saved for each register. Old name of
9101 the '<' item, with the disadvantage that you need to put a
9102 backslash before the ", otherwise it will be recognized as the
9103 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009104 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 % When included, save and restore the buffer list. If Vim is
9106 started with a file name argument, the buffer list is not
9107 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009108 buffer list is restored from the viminfo file. Quickfix
9109 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9110 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009111 When followed by a number, the number specifies the maximum
9112 number of buffers that are stored. Without a number all
9113 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009114 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 ' Maximum number of previously edited files for which the marks
9116 are remembered. This parameter must always be included when
9117 'viminfo' is non-empty.
9118 Including this item also means that the |jumplist| and the
9119 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009120 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009122 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 patterns are also saved. When not included, the value of
9124 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009125 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009127 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009128 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 < Maximum number of lines saved for each register. If zero then
9130 registers are not saved. When not included, all lines are
9131 saved. '"' is the old name for this item.
9132 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009133 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009135 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009136 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 c When included, convert the text in the viminfo file from the
9138 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009139 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009140 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 f Whether file marks need to be stored. If zero, file marks ('0
9142 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009143 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009145 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 h Disable the effect of 'hlsearch' when loading the viminfo
9147 file. When not included, it depends on whether ":nohlsearch"
9148 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009149 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009151 the 'n'. Must be at the end of the option! If the
9152 'viminfofile' option is set, that file name overrides the one
9153 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009154 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009155 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 r Removable media. The argument is a string (up to the next
9157 ','). This parameter can be given several times. Each
9158 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009159 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9161 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9162 ignored. Maximum length of each 'r' argument is 50
9163 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009164 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 s Maximum size of an item in Kbyte. If zero then registers are
9166 not saved. Currently only applies to registers. The default
9167 "s10" will exclude registers with more than 10 Kbyte of text.
9168 Also see the '<' item above: line count limit.
9169
9170 Example: >
9171 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9172<
9173 '50 Marks will be remembered for the last 50 files you
9174 edited.
9175 <1000 Contents of registers (up to 1000 lines each) will be
9176 remembered.
9177 s100 Registers with more than 100 Kbyte text are skipped.
9178 :0 Command-line history will not be saved.
9179 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9180 no / Since '/' is not specified, the default will be used,
9181 that is, save all of the search history, and also the
9182 previous search and substitute patterns.
9183 no % The buffer list will not be saved nor read back.
9184 no h 'hlsearch' highlighting will be restored.
9185
9186 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9187 load the contents of the file, this is not done automatically.
9188
9189 This option cannot be set from a |modeline| or in the |sandbox|, for
9190 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009191 NOTE: This option is set to the Vim default value when 'compatible'
9192 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009194 *'viminfofile'* *'vif'*
9195'viminfofile' 'vif' string (default: "")
9196 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009197 {not available when compiled without the |+viminfo|
9198 feature}
9199 When non-empty, overrides the file name used for viminfo.
9200 When equal to "NONE" no viminfo file will be read or written.
9201 This option can be set with the |-i| command line flag. The |--clean|
9202 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009203 This option cannot be set from a |modeline| or in the |sandbox|, for
9204 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009205
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 *'virtualedit'* *'ve'*
9207'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009208 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009209 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210 block Allow virtual editing in Visual block mode.
9211 insert Allow virtual editing in Insert mode.
9212 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009213 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009214 none When used as the local value, do not allow virtual
9215 editing even when the global value is set. When used
9216 as the global value, "none" is the same as "".
9217 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009218
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009220 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 of the line. Useful for selecting a rectangle in Visual mode and
9222 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009223 "onemore" is not the same, it will only allow moving the cursor just
9224 after the last character of the line. This makes some commands more
9225 consistent. Previously the cursor was always past the end of the line
9226 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009227 break some plugins or Vim scripts. For example because |l| can move
9228 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009229 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009230 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009231 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009232 It doesn't make sense to combine "all" with "onemore", but you will
9233 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009234 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009235 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009236
9237 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9238'visualbell' 'vb' boolean (default off)
9239 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009240 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009242 use: >
9243 :set vb t_vb=
9244< If you want a short flash, you can use this on many terminals: >
9245 :set vb t_vb=[?5h$<100>[?5l
9246< Here $<100> specifies the time, you can use a smaller or bigger value
9247 to get a shorter or longer flash.
9248
9249 Note: Vim will limit the bell to once per half a second. This avoids
9250 having to wait for the flashing to finish when there are lots of
9251 bells, e.g. on key repeat. This also happens without 'visualbell'
9252 set.
9253
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9255 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9256 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009257
9258 Note: When the GUI starts, 't_vb' is reset to its default value. You
9259 might want to set it again in your |gvimrc|.
9260
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 Does not work on the Amiga, you always get a screen flash.
9262 Also see 'errorbells'.
9263
9264 *'warn'* *'nowarn'*
9265'warn' boolean (default on)
9266 global
9267 Give a warning message when a shell command is used while the buffer
9268 has been changed.
9269
9270 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9271'weirdinvert' 'wiv' boolean (default off)
9272 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009273 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 It is provided for backwards compatibility with version 4.x.
9275 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9276 vice versa. Has no effect when the GUI is running.
9277
9278 *'whichwrap'* *'ww'*
9279'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 Allow specified keys that move the cursor left/right to move to the
9282 previous/next line when the cursor is on the first/last character in
9283 the line. Concatenate characters to allow this for these keys:
9284 char key mode ~
9285 b <BS> Normal and Visual
9286 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009287 h "h" Normal and Visual (not recommended)
9288 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 < <Left> Normal and Visual
9290 > <Right> Normal and Visual
9291 ~ "~" Normal
9292 [ <Left> Insert and Replace
9293 ] <Right> Insert and Replace
9294 For example: >
9295 :set ww=<,>,[,]
9296< allows wrap only when cursor keys are used.
9297 When the movement keys are used in combination with a delete or change
9298 operator, the <EOL> also counts for a character. This makes "3h"
9299 different from "3dh" when the cursor crosses the end of a line. This
9300 is also true for "x" and "X", because they do the same as "dl" and
9301 "dh". If you use this, you may also want to use the mapping
9302 ":map <BS> X" to make backspace delete the character in front of the
9303 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009304 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009305 line (not an empty line) then it will not move to the next line. This
9306 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307 NOTE: This option is set to the Vi default value when 'compatible' is
9308 set and to the Vim default value when 'compatible' is reset.
9309
9310 *'wildchar'* *'wc'*
9311'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 Character you have to type to start wildcard expansion in the
9314 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009315 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 The character is not recognized when used inside a macro. See
9317 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009318 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009319 <Esc> can be used, but hitting it twice in a row will still exit
9320 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009321 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009322 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009323< NOTE: This option is set to the Vi default value when 'compatible' is
9324 set and to the Vim default value when 'compatible' is reset.
9325
9326 *'wildcharm'* *'wcm'*
9327'wildcharm' 'wcm' number (default: none (0))
9328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009330 recognized when used inside a macro. You can find "spare" command-line
9331 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009332 you'll never actually type 'wildcharm', just use it in mappings that
9333 automatically invoke completion mode, e.g.: >
9334 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009335 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336< Then after typing :ss you can use CTRL-P & CTRL-N.
9337
9338 *'wildignore'* *'wig'*
9339'wildignore' 'wig' string (default "")
9340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009341 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009342 patterns is ignored when expanding |wildcards|, completing file or
9343 directory names, and influences the result of |expand()|, |glob()| and
9344 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009345 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9346 Also see 'suffixes'.
9347 Example: >
9348 :set wildignore=*.o,*.obj
9349< The use of |:set+=| and |:set-=| is preferred when adding or removing
9350 a pattern from the list. This avoids problems when a future version
9351 uses another default.
9352
h_east596a9f22023-11-21 21:24:23 +09009353 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009354'wildignorecase' 'wic' boolean (default off)
9355 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009356 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009357 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009358 Does not apply when the shell is used to expand wildcards, which
9359 happens when there are special characters.
9360
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009362'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 When 'wildmenu' is on, command-line completion operates in an enhanced
9365 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009366 the possible matches are shown.
9367 When 'wildoptions' contains "pum", then the completion matches are
9368 shown in a popup menu. Otherwise they are displayed just above the
9369 command line, with the first match highlighted (overwriting the status
9370 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009371 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009372 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9373 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9374 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009375 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376 If there are more matches than can fit in the line, a ">" is shown on
9377 the right and/or a "<" is shown on the left. The status line scrolls
9378 as needed.
9379 The "wildmenu" mode is abandoned when a key is hit that is not used
9380 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009381 While the "wildmenu" is active, the following keys have special
9382 meanings:
9383 CTRL-P - go to the previous entry
9384 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 <CR> - in menu completion, when the cursor is just after a
9386 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009387 CTRL-E - end completion, go back to what was there before
9388 selecting a match.
9389 CTRL-Y - accept the currently selected match and stop
9390 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009391
9392 When not using the popup menu for command line completion, the
9393 following keys have special meanings:
9394 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009395 <Up> - in filename/menu name completion: move up into
9396 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009397 <Down> - in filename/menu name completion: move into a
9398 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009400 When using the popup menu for command line completion, the following
9401 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009402 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009403 <PageUp> - select a match several entries back
9404 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009405 <Left> - in filename/menu name completion: move up into
9406 parent directory or parent menu.
9407 <Right> - in filename/menu name completion: move into a
9408 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009409
Bram Moolenaar071d4272004-06-13 20:20:40 +00009410 This makes the menus accessible from the console |console-menus|.
9411
9412 If you prefer the <Left> and <Right> keys to move the cursor instead
9413 of selecting a different match, use this: >
9414 :cnoremap <Left> <Space><BS><Left>
9415 :cnoremap <Right> <Space><BS><Right>
9416<
9417 The "WildMenu" highlighting is used for displaying the current match
9418 |hl-WildMenu|.
9419
9420 *'wildmode'* *'wim'*
9421'wildmode' 'wim' string (Vim default: "full")
9422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009423 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009424 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009425 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009426 first part specifies the behavior for the first use of 'wildchar',
9427 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009428
9429 Each part consists of a colon separated list consisting of the
9430 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009431 "" Complete only the first match.
9432 "full" Complete the next full match. After the last match,
9433 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009434 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009435 "longest" Complete till longest common string. If this doesn't
9436 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009437 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009438 "lastused" When completing buffer names and more than one buffer
9439 matches, sort buffers by time last used (other than
9440 the current buffer).
9441 When there is only a single match, it is fully completed in all cases.
9442
9443 Examples of useful colon-separated values:
9444 "longest:full" Like "longest", but also start 'wildmenu' if it is
9445 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009446 "list:full" When more than one match, list all matches and
9447 complete first match.
9448 "list:longest" When more than one match, list all matches and
9449 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009450 "list:lastused" When more than one buffer matches, list all matches
9451 and sort buffers by time last used (other than the
9452 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009453
9454 Examples: >
9455 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009456< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 :set wildmode=longest,full
9458< Complete longest common string, then each full match >
9459 :set wildmode=list:full
9460< List all matches and complete each full match >
9461 :set wildmode=list,full
9462< List all matches without completing, then each full match >
9463 :set wildmode=longest,list
9464< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009465 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009467 *'wildoptions'* *'wop'*
9468'wildoptions' 'wop' string (default "")
9469 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009470 A list of words that change how |cmdline-completion| is done.
9471 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009472 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009473 this value is specified, wildcard expansion will not
9474 be used for completion. The matches will be sorted by
9475 the "best match" rather than alphabetically sorted.
9476 This will find more matches than the wildcard
9477 expansion. Currently fuzzy matching based completion
9478 is not supported for file and directory names and
9479 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009480 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009481 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009482 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009483 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009484 is displayed per line. Often used tag kinds are:
9485 d #define
9486 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009487
Bram Moolenaar071d4272004-06-13 20:20:40 +00009488 *'winaltkeys'* *'wak'*
9489'winaltkeys' 'wak' string (default "menu")
9490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009491 {only used in Win32, Motif, GTK and Photon GUI}
9492 Some GUI versions allow the access to menu entries by using the ALT
9493 key in combination with a character that appears underlined in the
9494 menu. This conflicts with the use of the ALT key for mappings and
9495 entering special characters. This option tells what to do:
9496 no Don't use ALT keys for menus. ALT key combinations can be
9497 mapped, but there is no automatic handling. This can then be
9498 done with the |:simalt| command.
9499 yes ALT key handling is done by the windowing system. ALT key
9500 combinations cannot be mapped.
9501 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009502 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009503 keys can be mapped.
9504 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9505 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009506 This option is not used for <F10>; on Win32 and with GTK <F10> will
9507 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009509 *'wincolor'* *'wcr'*
9510'wincolor' 'wcr' string (default empty)
9511 local to window
9512 Highlight group name to use for this window instead of the Normal
9513 color |hl-Normal|.
9514
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009515 *'window'* *'wi'*
9516'window' 'wi' number (default screen height - 1)
9517 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009518 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9519 window and the value is smaller than 'lines' minus one. The screen
9520 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009521 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9522 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009523 When resizing the Vim window, and the value is smaller than 1 or more
9524 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009525 Note: Do not confuse this with the height of the Vim window, use
9526 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009527
Colin Kennedy21570352024-03-03 16:16:47 +01009528 *'winfixbuf'*
9529'winfixbuf' 'wfb' boolean (default off)
9530 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009531 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009532 For example, attempting to change the buffer with |:edit| will fail.
9533 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009534 also skip any window with 'winfixbuf' enabled. However if an Ex
9535 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009536
laburnumT3f7855a2023-12-05 18:37:03 +01009537 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9538'winfixheight' 'wfh' boolean (default off)
9539 local to window |local-noglobal|
9540 Keep the window height when windows are opened or closed and
9541 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9542 |preview-window| and |quickfix-window|.
9543 The height may be changed anyway when running out of room.
9544
9545 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9546'winfixwidth' 'wfw' boolean (default off)
9547 local to window |local-noglobal|
9548 Keep the window width when windows are opened or closed and
9549 'equalalways' is set. Also for |CTRL-W_=|.
9550 The width may be changed anyway when running out of room.
9551
Bram Moolenaar071d4272004-06-13 20:20:40 +00009552 *'winheight'* *'wh'* *E591*
9553'winheight' 'wh' number (default 1)
9554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009556 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009557 focus goes to a window that is smaller, its size is increased, at the
9558 cost of the height of other windows.
9559 Set 'winheight' to a small number for normal editing.
9560 Set it to 999 to make the current window fill most of the screen.
9561 Other windows will be only 'winminheight' high. This has the drawback
9562 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9563 to create only two windows, set the option after startup is done,
9564 using the |VimEnter| event: >
9565 au VimEnter * set winheight=999
9566< Minimum value is 1.
9567 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009568 height of the current window.
9569 'winheight' applies to the current window. Use 'winminheight' to set
9570 the minimal height for other windows.
9571
Bram Moolenaar071d4272004-06-13 20:20:40 +00009572 *'winminheight'* *'wmh'*
9573'winminheight' 'wmh' number (default 1)
9574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 The minimal height of a window, when it's not the current window.
9576 This is a hard minimum, windows will never become smaller.
9577 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9578 status bar) if necessary. They will return to at least one line when
9579 they become active (since the cursor has to have somewhere to go.)
9580 Use 'winheight' to set the minimal height of the current window.
9581 This option is only checked when making a window smaller. Don't use a
9582 large number, it will cause errors when opening more than a few
9583 windows. A value of 0 to 3 is reasonable.
9584
9585 *'winminwidth'* *'wmw'*
9586'winminwidth' 'wmw' number (default 1)
9587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 The minimal width of a window, when it's not the current window.
9589 This is a hard minimum, windows will never become smaller.
9590 When set to zero, windows may be "squashed" to zero columns (i.e. just
9591 a vertical separator) if necessary. They will return to at least one
9592 line when they become active (since the cursor has to have somewhere
9593 to go.)
9594 Use 'winwidth' to set the minimal width of the current window.
9595 This option is only checked when making a window smaller. Don't use a
9596 large number, it will cause errors when opening more than a few
9597 windows. A value of 0 to 12 is reasonable.
9598
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009599 *'winptydll'*
9600'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9601 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009602 {only available when compiled with the |terminal|
9603 feature on MS-Windows}
9604 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009605 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009606 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009607 a fallback.
9608 Environment variables are expanded |:set_env|.
9609 This option cannot be set from a |modeline| or in the |sandbox|, for
9610 security reasons.
9611
Bram Moolenaar071d4272004-06-13 20:20:40 +00009612 *'winwidth'* *'wiw'* *E592*
9613'winwidth' 'wiw' number (default 20)
9614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 Minimal number of columns for the current window. This is not a hard
9616 minimum, Vim will use fewer columns if there is not enough room. If
9617 the current window is smaller, its size is increased, at the cost of
9618 the width of other windows. Set it to 999 to make the current window
9619 always fill the screen. Set it to a small number for normal editing.
9620 The width is not adjusted after one of the commands to change the
9621 width of the current window.
9622 'winwidth' applies to the current window. Use 'winminwidth' to set
9623 the minimal width for other windows.
9624
9625 *'wrap'* *'nowrap'*
9626'wrap' boolean (default on)
9627 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009628 This option changes how text is displayed. It doesn't change the text
9629 in the buffer, see 'textwidth' for that.
9630 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009631 displaying continues on the next line. When off lines will not wrap
9632 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009633 moved to a part that is not shown, the screen will scroll
9634 horizontally.
9635 The line will be broken in the middle of a word if necessary. See
9636 'linebreak' to get the break at a word boundary.
9637 To make scrolling horizontally a bit more useful, try this: >
9638 :set sidescroll=5
9639 :set listchars+=precedes:<,extends:>
9640< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009641 This option can't be set from a |modeline| when the 'diff' option is
9642 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009643
9644 *'wrapmargin'* *'wm'*
9645'wrapmargin' 'wm' number (default 0)
9646 local to buffer
9647 Number of characters from the right window border where wrapping
9648 starts. When typing text beyond this limit, an <EOL> will be inserted
9649 and inserting continues on the next line.
9650 Options that add a margin, such as 'number' and 'foldcolumn', cause
9651 the text width to be further reduced. This is Vi compatible.
9652 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009653 This option is set to 0 when 'paste' is set and restored when 'paste'
9654 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009655 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009656
9657 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9658'wrapscan' 'ws' boolean (default on) *E384* *E385*
9659 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009660 Searches wrap around the end of the file. Also applies to |]s| and
9661 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009662
9663 *'write'* *'nowrite'*
9664'write' boolean (default on)
9665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009666 Allows writing files. When not set, writing a file is not allowed.
9667 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009668 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009669 argument. Filtering text is still possible, even though this requires
9670 writing a temporary file.
9671
9672 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9673'writeany' 'wa' boolean (default off)
9674 global
9675 Allows writing to any file with no need for "!" override.
9676
9677 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9678'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9679 otherwise)
9680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009681 Make a backup before overwriting a file. The backup is removed after
9682 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009683 also on.
9684 WARNING: Switching this option off means that when Vim fails to write
9685 your buffer correctly and then, for whatever reason, Vim exits, you
9686 lose both the original file and what you were writing. Only reset
9687 this option if your file system is almost full and it makes the write
9688 fail (and make sure not to exit Vim until the write was successful).
9689 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009690 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009691 Depending on 'backupcopy' the backup is a new file or the original
9692 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009693 NOTE: This option is set to the default value when 'compatible' is
9694 set.
9695
9696 *'writedelay'* *'wd'*
9697'writedelay' 'wd' number (default 0)
9698 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009699 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009700 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009701 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009702
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009703 *'xtermcodes'* *'noxtermcodes'*
9704'xtermcodes' boolean (default on)
9705 global
9706 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009707 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009708 key codes and number of colors from the terminal. This takes care of
9709 various configuration options of the terminal that cannot be obtained
9710 from the termlib/terminfo entry, see |xterm-codes|.
9711 A side effect may be that t_Co changes and Vim will redraw the
9712 display.
9713
9714
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009715 vim:tw=78:ts=8:noet:ft=help:norl: