blob: cf064e17fd73b63275247c33ad4c01dd664e3d6d [file] [log] [blame]
glepnir4ade6682025-07-03 20:41:23 +02001*options.txt* For Vim version 9.1. Last change: 2025 Jul 03
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"
Qiming zhaoab2fe652025-04-12 11:40:17 +0200215 :set tags=tags\\,file results in "tags\,file"
Yee Cheng Chin54844852023-10-09 18:12:31 +0200216 :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:
Millyd9af78b2024-09-26 15:54:43 +0200399 Command global value local value condition ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display local value is set
404 :set option? display - local value is not set
405 :setlocal option? - display
406:setglobal option? display -
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408
409Global options with a local value *global-local*
410
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000411Options are global when you mostly use one value for all buffers and windows.
412For some global options it's useful to sometimes have a different local value.
413You can set the local value with ":setlocal". That buffer or window will then
414use the local value, while other buffers and windows continue using the global
415value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416
417For example, you have two windows, both on C source code. They use the global
418'makeprg' option. If you do this in one of the two windows: >
419 :set makeprg=gmake
420then the other window will switch to the same value. There is no need to set
421the 'makeprg' option in the other C source window too.
422However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000423another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000424files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 :setlocal makeprg=perlmake
426You can switch back to using the global value by making the local value empty: >
427 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428This only works for a string option. For a number or boolean option you need
429to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100431Note that for non-boolean and non-number options using "<" copies the global
432value to the local value, it doesn't switch back to using the global value
433(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000434 :set path<
435This will make the local value of 'path' empty, so that the global value is
436used. Thus it does the same as: >
437 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000438Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439":setlocal" on a global option might work differently then.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441 *option-value-function*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
64-bitman88d41ab2025-04-06 17:20:39 +02001720 *'chistory'* *'chi'*
1721'chistory' 'chi' number (default: 10)
1722 global
1723 {only available when compiled with the |+quickfix|
1724 feature}
1725 Number of quickfix lists that should be remembered for the quickfix
1726 stack. Must be between 1 and 100. If the option is set to a value
1727 that is lower than the amount of entries in the quickfix list stack,
1728 entries will be removed starting from the oldest one. If the current
1729 quickfix list was removed, then the quickfix list at top of the stack
1730 (the most recently created) will be used in its place. For additional
1731 info, see |quickfix-stack|.
1732
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1734'cindent' 'cin' boolean (default off)
1735 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001736 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 that trigger reindenting in insert mode and 'cinoptions' to set your
1738 preferred indent style.
1739 If 'indentexpr' is not empty, it overrules 'cindent'.
1740 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1741 the "=" operator indents using this algorithm rather than calling an
1742 external program.
1743 See |C-indenting|.
1744 When you don't like the way 'cindent' works, try the 'smartindent'
1745 option or 'indentexpr'.
1746 This option is not used when 'paste' is set.
1747 NOTE: This option is reset when 'compatible' is set.
1748
1749 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001750'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 A list of keys that, when typed in Insert mode, cause reindenting of
1753 the current line. Only used if 'cindent' is on and 'indentexpr' is
1754 empty.
1755 For the format of this option see |cinkeys-format|.
1756 See |C-indenting|.
1757
1758 *'cinoptions'* *'cino'*
1759'cinoptions' 'cino' string (default "")
1760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1762 program. See |cinoptions-values| for the values of this option, and
1763 |C-indenting| for info on C indenting in general.
1764
laburnumT3f7855a2023-12-05 18:37:03 +01001765 *'cinscopedecls'* *'cinsd'*
1766'cinscopedecls' 'cinsd' string (default "public,protected,private")
1767 local to buffer
1768 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1769 Useful e.g. for working with the Qt framework that defines additional
1770 scope declarations "signals", "public slots" and "private slots": >
1771 set cinscopedecls+=signals,public\ slots,private\ slots
1772<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 *'cinwords'* *'cinw'*
1774'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 These keywords start an extra indent in the next line when
1777 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1778 an appropriate place (inside {}).
1779 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1780 matter, include the keyword both the uppercase and lowercase:
1781 "if,If,IF".
1782
laburnumT3f7855a2023-12-05 18:37:03 +01001783 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1785 for X-windows, "" otherwise)
1786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 {only in GUI versions or when the |+xterm_clipboard|
Foxe Chenb90c2392025-06-27 21:10:35 +02001788 or |+wayland_clipboard| features are included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001789 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001790 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001791 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001792 prepend, e.g.: >
1793 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001794< When using the GUI see |'go-A'|.
1795 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001797 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 unnamed When included, Vim will use the clipboard register '*'
1799 for all yank, delete, change and put operations which
1800 would normally go to the unnamed register. When a
1801 register is explicitly specified, it will always be
1802 used regardless of whether "unnamed" is in 'clipboard'
1803 or not. The clipboard register can always be
1804 explicitly accessed using the "* notation. Also see
1805 |gui-clipboard|.
1806
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001808 unnamedplus A variant of the "unnamed" flag which uses the
1809 clipboard register '+' (|quoteplus|) instead of
1810 register '*' for all yank, delete, change and put
1811 operations which would normally go to the unnamed
1812 register. When "unnamed" is also included to the
Hirohito Higashi73b96502025-06-28 18:18:21 +02001813 option, yank operations (but not delete, change or put)
1814 will additionally copy the text into register '*'. If
Hirohito Higashi651edf32025-07-01 22:07:50 +02001815 Wayland is being used and the compositor does not
Hirohito Higashi73b96502025-06-28 18:18:21 +02001816 support the primary-selection-unstable-v1 protocol,
1817 then the regular selection is used in its place. Only
1818 available with the |+X11| or |+wayland_clipboard|
1819 feature. Availability can be checked with: >
Foxe Chenb90c2392025-06-27 21:10:35 +02001820 if has('unnamedplus')
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001821<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001822 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 autoselect Works like the 'a' flag in 'guioptions': If present,
1824 then whenever Visual mode is started, or the Visual
1825 area extended, Vim tries to become the owner of the
1826 windowing system's global selection or put the
1827 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001828 register "*. See |'go-a'| and |quotestar| for details.
1829 When the GUI is active, the 'a' flag in 'guioptions'
1830 is used, when the GUI is not active, this "autoselect"
1831 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 Also applies to the modeless selection.
1833
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001834 *clipboard-autoselectplus*
1835 autoselectplus Like "autoselect" but using the + register instead of
1836 the * register. Compare to the 'P' flag in
1837 'guioptions'.
1838
1839 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 autoselectml Like "autoselect", but for the modeless selection
1841 only. Compare to the 'A' flag in 'guioptions'.
1842
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001843 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001844 html When the clipboard contains HTML, use this when
1845 pasting. When putting text on the clipboard, mark it
1846 as HTML. This works to copy rendered HTML from
1847 Firefox, paste it as raw HTML in Vim, select the HTML
1848 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001849 You probably want to add this only temporarily,
1850 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001851 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001852
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001853 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 exclude:{pattern}
1855 Defines a pattern that is matched against the name of
1856 the terminal 'term'. If there is a match, no
Hirohito Higashi651edf32025-07-01 22:07:50 +02001857 connection will be made to the X server or Wayland
Foxe Chenb90c2392025-06-27 21:10:35 +02001858 compositor. This is useful in this situation:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 - Running Vim in a console.
Foxe Chenb90c2392025-06-27 21:10:35 +02001860 - $DISPLAY/$WAYLAND_DISPLAY is set to start
Hirohito Higashi73b96502025-06-28 18:18:21 +02001861 applications on another display.
Foxe Chenb90c2392025-06-27 21:10:35 +02001862 - You do not want to connect to the X server/Wayland
1863 compositor in the console, but do want this in a
1864 terminal emulator.
1865 To never connect to the X server/Wayland compositor
1866 use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 exclude:.*
Hirohito Higashi73b96502025-06-28 18:18:21 +02001868< This has the same effect as using the |-X| or |-Y|
1869 argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 Note that when there is no connection to the X server
1871 the window title won't be restored and the clipboard
Hirohito Higashi73b96502025-06-28 18:18:21 +02001872 cannot be accessed. This is the same for Wayland,
Foxe Chenb90c2392025-06-27 21:10:35 +02001873 except there is no title restoring.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 The value of 'magic' is ignored, {pattern} is
1875 interpreted as if 'magic' was on.
1876 The rest of the option value will be used for
1877 {pattern}, this must be the last entry.
1878
Foxe Chenb90c2392025-06-27 21:10:35 +02001879 *'clipmethod'* *'cpm'*
1880'clipmethod' 'cpm' string (default for Unix: "wayland,x11",
1881 for VMS: "x11",
1882 otherwise: "")
Foxe Chenb90c2392025-06-27 21:10:35 +02001883 global
Hirohito Higashi73b96502025-06-28 18:18:21 +02001884 {only when the |+xterm_clipboard| or
1885 |+wayland_clipboard| features are included}
Foxe Chenb90c2392025-06-27 21:10:35 +02001886 Specifies which method of accessing the system clipboard is used,
1887 depending on which method works first or is available. Supported
1888 methods are:
1889 wayland Wayland selections
1890 x11 X11 selections
1891
1892 Note: This option is ignored when either the GUI is running or if Vim
Hirohito Higashi651edf32025-07-01 22:07:50 +02001893 is run on a system without Wayland or X11 support, such as Windows or
Foxe Chenb90c2392025-06-27 21:10:35 +02001894 macOS. The GUI or system way of accessing the clipboard is always
1895 used instead.
1896
Hirohito Higashi73b96502025-06-28 18:18:21 +02001897 The option value is a list of comma separated items. The list is
1898 parsed left to right in order, and the first method that Vim
1899 determines is available or is working is used as the actual method for
1900 accessing the clipboard.
Foxe Chenb90c2392025-06-27 21:10:35 +02001901
1902 The current method that is being used can be found in the |v:clipmethod|
1903 variable.
1904
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 *'cmdheight'* *'ch'*
1906'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001907 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001908 Number of screen lines to use for the command-line. A larger value
1909 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001910 The value of this option is stored with the tab page, so that each tab
1911 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912
1913 *'cmdwinheight'* *'cwh'*
1914'cmdwinheight' 'cwh' number (default 7)
1915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 Number of screen lines to use for the command-line window. |cmdwin|
1917
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001918 *'colorcolumn'* *'cc'*
1919'colorcolumn' 'cc' string (default "")
1920 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001921 {not available when compiled without the |+syntax|
1922 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001923 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001924 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1925 text. Will make screen redrawing slower.
1926 The screen column can be an absolute number, or a number preceded with
1927 '+' or '-', which is added to or subtracted from 'textwidth'. >
1928
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001929 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001930 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1931 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1932<
1933 When 'textwidth' is zero then the items with '-' and '+' are not used.
1934 A maximum of 256 columns are highlighted.
1935
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 *'columns'* *'co'* *E594*
1937'columns' 'co' number (default 80 or terminal width)
1938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001940 initialization and does not have to be set by hand. Also see
1941 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 When Vim is running in the GUI or in a resizable window, setting this
1943 option will cause the window size to be changed. When you only want
1944 to use the size for the GUI, put the command in your |gvimrc| file.
1945 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001946 number of columns of the display, the display may be messed up. For
1947 the GUI it is always possible and Vim limits the number of columns to
1948 what fits on the screen. You can use this command to get the widest
1949 window possible: >
1950 :set columns=9999
1951< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952
1953 *'comments'* *'com'* *E524* *E525*
1954'comments' 'com' string (default
1955 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1956 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001957 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 |format-comments|. See |option-backslash| about using backslashes to
1959 insert a space.
1960
1961 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001962'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 {not available when compiled without the |+folding|
1965 feature}
1966 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001967 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001968 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001969 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970
1971 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001972'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001973 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 This option has the effect of making Vim either more Vi-compatible, or
1976 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001977
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001979 other options are also changed as a side effect.
1980 NOTE: Setting or resetting this option can have a lot of unexpected
1981 effects: Mappings are interpreted in another way, undo behaves
1982 differently, etc. If you set this option in your vimrc file, you
1983 should probably put it at the very start.
1984
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 By default this option is on and the Vi defaults are used for the
1986 options. This default was chosen for those people who want to use Vim
1987 just like Vi, and don't even (want to) know about the 'compatible'
1988 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001989 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001990 this option is switched off, and all options that have not been
1991 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001992 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001993 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001994 happen for the system-wide vimrc or gvimrc file, nor for a file given
1995 with the |-u| argument). Also see |compatible-default| and
1996 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 You can also set this option with the "-C" argument, and reset it with
1998 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001999 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000
Bram Moolenaar214641f2017-03-05 17:04:09 +01002001 When this option is set, numerous other options are set to make Vim as
2002 Vi-compatible as possible. When this option is unset, various options
2003 are set to make Vim more useful. The table below lists all the
2004 options affected.
2005 The {?} column indicates when the options are affected:
2006 + Means that the option is set to the value given in {set value} when
2007 'compatible' is set.
2008 & Means that the option is set to the value given in {set value} when
2009 'compatible' is set AND is set to its Vim default value when
2010 'compatible' is unset.
2011 - Means the option is NOT changed when setting 'compatible' but IS
2012 set to its Vim default when 'compatible' is unset.
2013 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014
Bram Moolenaar036986f2017-03-16 17:41:02 +01002015 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01002016
2017 'allowrevins' + off no CTRL-_ command
2018 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00002019 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01002020 'arabicshape' + on correct character shapes
2021 'backspace' + "" normal backspace
2022 'backup' + off no backup file
2023 'backupcopy' & Unix: "yes" backup file is a copy
2024 else: "auto" copy or rename backup file
2025 'balloonexpr' + "" text to show in evaluation balloon
2026 'breakindent' + off don't indent when wrapping lines
2027 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00002028 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002029 'cindent' + off no C code indentation
2030 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
2031 'copyindent' + off don't copy indent structure
2032 'cpoptions' & (all flags) Vi-compatible flags
2033 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01002034 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002035 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01002036 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002037 'cscopeverbose' + off see |cscopeverbose|
2038 'delcombine' + off unicode: delete whole char combination
2039 'digraph' + off no digraphs
2040 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02002041 this also disables |modifyOtherKeys|
2042 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002043 'expandtab' + off tabs not expanded to spaces
2044 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002045 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002046 'formatexpr' + "" use 'formatprg' for auto-formatting
2047 'formatoptions' & "vt" Vi compatible formatting
2048 'gdefault' + off no default 'g' flag for ":s"
2049 'history' & 0 no commandline history
2050 'hkmap' + off no Hebrew keyboard mapping
2051 'hkmapp' + off no phonetic Hebrew keyboard mapping
2052 'hlsearch' + off no highlighting of search matches
2053 'incsearch' + off no incremental searching
2054 'indentexpr' + "" no indenting by expression
2055 'insertmode' + off do not start in Insert mode
2056 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002058 'joinspaces' + on insert 2 spaces after period
2059 'modeline' & off no modelines
2060 'more' & off no pauses in listings
2061 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2062 'numberwidth' & 8 min number of columns for line number
2063 'preserveindent'+ off don't preserve current indent structure
2064 when changing it
2065 'revins' + off no reverse insert
2066 'ruler' + off no ruler
2067 'scrolljump' + 1 no jump scroll
2068 'scrolloff' + 0 no scroll offset
2069 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2070 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002071 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002072 'showcmd' & off command characters not shown
2073 'showmode' & off current mode not shown
2074 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2075 'smartcase' + off no automatic ignore case switch
2076 'smartindent' + off no smart indentation
2077 'smarttab' + off no smart tab size
Damien Lejay91af4c42025-06-12 21:56:19 +02002078 'softtabstop' + 0 no soft tab stops
Bram Moolenaar214641f2017-03-05 17:04:09 +01002079 'startofline' + on goto startofline with some commands
2080 'tagcase' & "followic" 'ignorecase' when searching tags file
2081 'tagrelative' & off tag file names are not relative
2082 'termguicolors' + off don't use highlight-(guifg|guibg)
2083 'textauto' & off no automatic textmode detection
2084 'textwidth' + 0 no automatic line wrap
2085 'tildeop' + off tilde is not an operator
2086 'ttimeout' + off no terminal timeout
2087 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002088 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002089 'virtualedit' + "" cursor can only be placed on characters
2090 'whichwrap' & "" left-right movements don't wrap
2091 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002093 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094
2095 *'complete'* *'cpt'* *E535*
2096'complete' 'cpt' string (default: ".,w,b,u,t,i")
2097 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 This option specifies how keyword completion |ins-completion| works
2099 when CTRL-P or CTRL-N are used. It is also used for whole-line
2100 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002101 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002102 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 w scan buffers from other windows
2104 b scan other loaded buffers that are in the buffer list
2105 u scan the unloaded buffers that are in the buffer list
2106 U scan the buffers that are not in the buffer list
2107 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002108 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 k{dict} scan the file {dict}. Several "k" flags can be given,
2110 patterns are valid too. For example: >
2111 :set cpt=k/usr/dict/*,k~/spanish
2112< s scan the files given with the 'thesaurus' option
2113 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2114 are valid too.
2115 i scan current and included files
2116 d scan current and included files for defined name or macro
2117 |i_CTRL-X_CTRL-D|
2118 ] tag completion
2119 t same as "]"
Girish Palya14f6da52025-05-26 19:04:25 +02002120 F{func} call the function {func}. Multiple "F" flags may be specified.
Girish Palyacbe53192025-04-14 22:13:15 +02002121 Refer to |complete-functions| for details on how the function
2122 is invoked and what it should return. The value can be the
2123 name of a function or a |Funcref|. For |Funcref| values,
2124 spaces must be escaped with a backslash ('\'), and commas with
2125 double backslashes ('\\') (see |option-backslash|).
2126 If the Dict returned by the {func} includes {"refresh": "always"},
2127 the function will be invoked again whenever the leading text
2128 changes.
2129 Completion matches are always inserted at the keyword
2130 boundary, regardless of the column returned by {func} when
2131 a:findstart is 1. This ensures compatibility with other
2132 completion sources.
2133 To make further modifications to the inserted text, {func}
2134 can make use of |CompleteDonePre|.
2135 If generating matches is potentially slow, |complete_check()|
2136 should be used to avoid blocking and preserve editor
2137 responsiveness.
Girish Palya14f6da52025-05-26 19:04:25 +02002138 F equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002139 the 'completefunc' option.
Girish Palya14f6da52025-05-26 19:04:25 +02002140 o equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002141 the 'omnifunc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142
2143 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2144 not executed, this may lead to unexpected completions from some files
2145 (gzipped files for example). Unloaded buffers are not scanned for
2146 whole-line completion.
2147
2148 The default is ".,w,b,u,t,i", which means to scan:
2149 1. the current buffer
2150 2. buffers in other windows
2151 3. other loaded buffers
2152 4. unloaded buffers
2153 5. tags
2154 6. included files
2155
2156 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002157 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2158 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
Girish Palya0ac1eb32025-04-16 20:18:33 +02002160 An optional match limit can be specified for a completion source by
2161 appending a caret ("^") followed by a {count} to the source flag.
2162 For example: ".^9,w,u,t^5" limits matches from the current buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02002163 to 9 and from tags to 5. Other sources remain unlimited.
2164 Note: The match limit takes effect only during forward completion
2165 (CTRL-N) and is ignored during backward completion (CTRL-P).
Girish Palya0ac1eb32025-04-16 20:18:33 +02002166
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002167 *'completefunc'* *'cfu'*
2168'completefunc' 'cfu' string (default: empty)
2169 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002170 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002171 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002172 This option specifies a function to be used for Insert mode completion
2173 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002174 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002175 invoked and what it should return. The value can be the name of a
2176 function, a |lambda| or a |Funcref|. See |option-value-function| for
2177 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002178 This option cannot be set from a |modeline| or in the |sandbox|, for
2179 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002180
glepnirf31cfa22025-03-06 21:59:13 +01002181 *'completefuzzycollect'* *'cfc'*
2182'completefuzzycollect' 'cfc' string (default: empty)
2183 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002184 A comma-separated list of strings to enable fuzzy collection for
2185 specific |ins-completion| modes, affecting how matches are gathered
2186 during completion. For specified modes, fuzzy matching is used to
2187 find completion candidates instead of the standard prefix-based
2188 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002189
glepnir58760162025-03-13 21:39:51 +01002190 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2191 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2192 "b", "u", "U" and "k{dict}" in 'complete'
2193 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002194
glepnir58760162025-03-13 21:39:51 +01002195 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002196
glepnir58760162025-03-13 21:39:51 +01002197 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002198
Christian Brabandtf22580e2025-03-14 12:05:52 +01002199 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002200 can identify the longest common string among the best fuzzy matches
2201 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002202
glepnir6a89c942024-10-01 20:32:12 +02002203 *'completeitemalign'* *'cia'*
2204'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2205 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002206 A comma-separated list of strings that controls the alignment and
2207 display order of items in the popup menu during Insert mode
2208 completion. The supported values are "abbr", "kind", and "menu".
2209 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002210 popup menu. Note: must always contain those three values in any
2211 order.
2212
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002213 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002214'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002215 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002216 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002217 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002218
glepnira2c55592025-02-28 17:43:42 +01002219 fuzzy Enable |fuzzy-matching| for completion candidates. This
2220 allows for more flexible and intuitive matching, where
2221 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002222 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002223 does not affect the collection of candidate list, it only
2224 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002225 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002226 to gather more alternatives for your candidate list,
2227 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002228
2229 longest Only insert the longest common text of the matches. If
2230 the menu is displayed you can use CTRL-L to add more
2231 characters. Whether case is ignored depends on the kind
2232 of completion. For buffer text the 'ignorecase' option is
2233 used.
2234
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002235 menu Use a popup menu to show the possible completions. The
2236 menu is only shown when there is more than one match and
2237 sufficient colors are available. |ins-completion-menu|
2238
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002239 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002240 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002241 match, e.g., what file it comes from.
2242
Girish Palyacb3b7522025-04-18 18:52:28 +02002243 nearest Matches are listed based on their proximity to the cursor
2244 position, unlike the default behavior, which only
2245 considers proximity for matches appearing below the
2246 cursor. This applies only to matches from the current
Girish Palyab1565882025-04-15 20:16:00 +02002247 buffer. No effect if "fuzzy" is present.
2248
glepnira2c55592025-02-28 17:43:42 +01002249 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002250 a match from the menu. Only works in combination with
2251 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002252
glepnira2c55592025-02-28 17:43:42 +01002253 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002254 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002255 present, "noselect" has precedence.
2256
2257 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002258 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002259 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002260
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002261 popup Show extra information about the currently selected
2262 completion in a popup window. Only works in combination
2263 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002264 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002265 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002266
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002267 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002268 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002269 |CompleteChanged| autocommand to fetch the info and call
2270 |popup_show()| once the popup has been filled.
2271 See the example at |complete-popuphidden|.
2272 {only works when compiled with the |+textprop| feature}
2273
glepniredd4ac32025-01-29 18:53:51 +01002274 preinsert
2275 Preinsert the portion of the first candidate word that is
2276 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002277 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002278 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002279
2280 preview Show extra information about the currently selected
2281 completion in the preview window. Only works in
2282 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002283
Ilya Grigoriev053aee02025-06-11 21:07:35 +02002284 This option does not apply to |cmdline-completion|. See 'wildoptions'
2285 for that.
2286
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002287 *'completepopup'* *'cpp'*
2288'completepopup' 'cpp' string (default empty)
2289 global
2290 {not available when compiled without the |+textprop|
2291 or |+quickfix| feature}
2292 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002293 properties of the info popup when it is created. If an info popup
2294 window already exists it is closed, so that the option value is
2295 applied when it is created again.
2296 You can also use |popup_findinfo()| and then set properties for an
2297 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002298
laburnumT3f7855a2023-12-05 18:37:03 +01002299 *'completeslash'* *'csl'*
2300'completeslash' 'csl' string (default: "")
2301 local to buffer
2302 {only for MS-Windows}
2303 When this option is set it overrules 'shellslash' for completion:
2304 - When this option is set to "slash", a forward slash is used for path
2305 completion in insert mode. This is useful when editing HTML tag, or
2306 Makefile with 'noshellslash' on MS-Windows.
2307 - When this option is set to "backslash", backslash is used. This is
2308 useful when editing a batch file with 'shellslash' set on MS-Windows.
2309 - When this option is empty, same character is used as for
2310 'shellslash'.
2311 For Insert mode completion the buffer-local value is used. For
2312 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002313
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002314 *'concealcursor'* *'cocu'*
2315'concealcursor' 'cocu' string (default: "")
2316 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002317 {not available when compiled without the |+conceal|
2318 feature}
2319 Sets the modes in which text in the cursor line can also be concealed.
2320 When the current mode is listed then concealing happens just like in
2321 other lines.
2322 n Normal mode
2323 v Visual mode
2324 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002325 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002326
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002327 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002328 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002329 are moving around text is concealed, but when starting to insert text
2330 or selecting a Visual area the concealed text is displayed, so that
2331 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002332 Keep in mind that the cursor position is not always where it's
2333 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002334
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002335 *'conceallevel'* *'cole'*
2336'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002337 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002338 {not available when compiled without the |+conceal|
2339 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002340 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2341 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002342
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002343 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002344 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002345 1 Each block of concealed text is replaced with one
2346 character. If the syntax item does not have a custom
2347 replacement character defined (see |:syn-cchar|) the
2348 character defined in 'listchars' is used (default is a
2349 space).
2350 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002351 2 Concealed text is completely hidden unless it has a
2352 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002353 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002354 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002355
Bram Moolenaara7781e02010-07-19 20:13:22 +02002356 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002357 edit and copy the text. This can be changed with the 'concealcursor'
2358 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002359
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2361'confirm' 'cf' boolean (default off)
2362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 When 'confirm' is on, certain operations that would normally
2364 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2365 instead raise a |dialog| asking if you wish to save the current
2366 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2367 If 'confirm' is off you can still activate confirmation for one
2368 command only (this is most useful in mappings) with the |:confirm|
2369 command.
2370 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2371
2372 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2373'conskey' 'consk' boolean (default off)
2374 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002375 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376
2377 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2378'copyindent' 'ci' boolean (default off)
2379 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 Copy the structure of the existing lines indent when autoindenting a
2381 new line. Normally the new indent is reconstructed by a series of
2382 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2383 in which case only spaces are used). Enabling this option makes the
2384 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002385 existing line. 'expandtab' has no effect on these characters, a Tab
2386 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002388 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 Also see 'preserveindent'.
2390
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002391 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002392'cpoptions' 'cpo' string (Vim default: "aABceFsz",
glepnir4ade6682025-07-03 20:41:23 +02002393 Vi default: all flags, except "#{|&/\.~"
h-east90e1fe42024-08-12 18:26:08 +02002394 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002397 this indicates Vi-compatible behavior. This is used for things where
2398 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 'cpoptions' stands for "compatible-options".
2400 Commas can be added for readability.
2401 To avoid problems with flags that are added in the future, use the
2402 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002403
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 NOTE: This option is set to the Vi default value when 'compatible' is
2405 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002406
2407 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2408 is saved, 'cpoptions' is set to the Vim default, and the saved value
2409 is restored at the end of the script. Changes to the value of
2410 'cpoptions' will be applied to the saved value, but keep in mind that
2411 removing a flag that is not present when 'cpoptions' is changed has no
2412 effect. In the |.vimrc| file the value is not restored, thus using
2413 `vim9script` in the |.vimrc| file results in using the Vim default.
2414
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002415 NOTE: This option is set to the POSIX default value at startup when
2416 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002417 variable exists |posix|. This means Vim tries to behave like the
2418 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419
2420 contains behavior ~
2421 *cpo-a*
2422 a When included, a ":read" command with a file name
2423 argument will set the alternate file name for the
2424 current window.
2425 *cpo-A*
2426 A When included, a ":write" command with a file name
2427 argument will set the alternate file name for the
2428 current window.
2429 *cpo-b*
2430 b "\|" in a ":map" command is recognized as the end of
2431 the map command. The '\' is included in the mapping,
2432 the text after the '|' is interpreted as the next
2433 command. Use a CTRL-V instead of a backslash to
2434 include the '|' in the mapping. Applies to all
2435 mapping, abbreviation, menu and autocmd commands.
2436 See also |map_bar|.
2437 *cpo-B*
2438 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002439 abbreviations, user commands and the "to" part of the
2440 menu commands. Remove this flag to be able to use a
2441 backslash like a CTRL-V. For example, the command
2442 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 'B' included: "\^[" (^[ is a real <Esc>)
2444 'B' excluded: "<Esc>" (5 characters)
2445 ('<' excluded in both cases)
2446 *cpo-c*
2447 c Searching continues at the end of any match at the
2448 cursor position, but not further than the start of the
2449 next line. When not present searching continues
2450 one character from the cursor position. With 'c'
2451 "abababababab" only gets three matches when repeating
2452 "/abab", without 'c' there are five matches.
2453 *cpo-C*
2454 C Do not concatenate sourced lines that start with a
2455 backslash. See |line-continuation|.
2456 *cpo-d*
2457 d Using "./" in the 'tags' option doesn't mean to use
2458 the tags file relative to the current file, but the
2459 tags file in the current directory.
2460 *cpo-D*
2461 D Can't use CTRL-K to enter a digraph after Normal mode
2462 commands with a character argument, like |r|, |f| and
2463 |t|.
2464 *cpo-e*
2465 e When executing a register with ":@r", always add a
2466 <CR> to the last line, also when the register is not
2467 linewise. If this flag is not present, the register
2468 is not linewise and the last line does not end in a
2469 <CR>, then the last line is put on the command-line
2470 and can be edited before hitting <CR>.
2471 *cpo-E*
2472 E It is an error when using "y", "d", "c", "g~", "gu" or
2473 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002474 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 This makes "y0" fail in the first column.
2476 *cpo-f*
2477 f When included, a ":read" command with a file name
2478 argument will set the file name for the current buffer,
2479 if the current buffer doesn't have a file name yet.
2480 *cpo-F*
2481 F When included, a ":write" command with a file name
2482 argument will set the file name for the current
2483 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002484 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 *cpo-g*
2486 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002487 *cpo-H*
2488 H When using "I" on a line with only blanks, insert
2489 before the last blank. Without this flag insert after
2490 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 *cpo-i*
2492 i When included, interrupting the reading of a file will
2493 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002494 *cpo-I*
2495 I When moving the cursor up or down just after inserting
2496 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 *cpo-j*
2498 j When joining lines, only add two spaces after a '.',
2499 not after '!' or '?'. Also see 'joinspaces'.
2500 *cpo-J*
2501 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002502 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 white space.
2504 *cpo-k*
2505 k Disable the recognition of raw key codes in
2506 mappings, abbreviations, and the "to" part of menu
2507 commands. For example, if <Key> sends ^[OA (where ^[
2508 is <Esc>), the command ":map X ^[OA" results in X
2509 being mapped to:
2510 'k' included: "^[OA" (3 characters)
2511 'k' excluded: "<Key>" (one key code)
2512 Also see the '<' flag below.
2513 *cpo-K*
2514 K Don't wait for a key code to complete when it is
2515 halfway a mapping. This breaks mapping <F1><F1> when
2516 only part of the second <F1> has been read. It
2517 enables cancelling the mapping by typing <F1><Esc>.
2518 *cpo-l*
2519 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002520 literally, only "\]", "\^", "\-" and "\\" are special.
2521 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2523 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002524 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 *cpo-L*
2526 L When the 'list' option is set, 'wrapmargin',
2527 'textwidth', 'softtabstop' and Virtual Replace mode
2528 (see |gR|) count a <Tab> as two characters, instead of
2529 the normal behavior of a <Tab>.
2530 *cpo-m*
2531 m When included, a showmatch will always wait half a
2532 second. When not included, a showmatch will wait half
2533 a second or until a character is typed. |'showmatch'|
2534 *cpo-M*
2535 M When excluded, "%" matching will take backslashes into
2536 account. Thus in "( \( )" and "\( ( \)" the outer
2537 parenthesis match. When included "%" ignores
2538 backslashes, which is Vi compatible.
2539 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002540 n When included, the column used for 'number' and
2541 'relativenumber' will also be used for text of wrapped
2542 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 *cpo-o*
2544 o Line offset to search command is not remembered for
2545 next search.
2546 *cpo-O*
2547 O Don't complain if a file is being overwritten, even
2548 when it didn't exist when editing it. This is a
2549 protection against a file unexpectedly created by
2550 someone else. Vi didn't complain about this.
2551 *cpo-p*
2552 p Vi compatible Lisp indenting. When not present, a
2553 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002554 *cpo-P*
2555 P When included, a ":write" command that appends to a
2556 file will set the file name for the current buffer, if
2557 the current buffer doesn't have a file name yet and
2558 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002559 *cpo-q*
2560 q When joining multiple lines leave the cursor at the
2561 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 *cpo-r*
2563 r Redo ("." command) uses "/" to repeat a search
2564 command, instead of the actually used search string.
2565 *cpo-R*
2566 R Remove marks from filtered lines. Without this flag
2567 marks are kept like |:keepmarks| was used.
2568 *cpo-s*
2569 s Set buffer options when entering the buffer for the
2570 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002571 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 set when the buffer is created.
2573 *cpo-S*
2574 S Set buffer options always when entering a buffer
2575 (except 'readonly', 'fileformat', 'filetype' and
2576 'syntax'). This is the (most) Vi compatible setting.
2577 The options are set to the values in the current
2578 buffer. When you change an option and go to another
2579 buffer, the value is copied. Effectively makes the
2580 buffer options global to all buffers.
2581
2582 's' 'S' copy buffer options
2583 no no when buffer created
2584 yes no when buffer first entered (default)
2585 X yes each time when buffer entered (vi comp.)
2586 *cpo-t*
2587 t Search pattern for the tag command is remembered for
2588 "n" command. Otherwise Vim only puts the pattern in
2589 the history for search pattern, but doesn't change the
2590 last used search pattern.
2591 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002592 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 *cpo-v*
2594 v Backspaced characters remain visible on the screen in
2595 Insert mode. Without this flag the characters are
2596 erased from the screen right away. With this flag the
2597 screen newly typed text overwrites backspaced
2598 characters.
2599 *cpo-w*
2600 w When using "cw" on a blank character, only change one
2601 character and not all blanks until the start of the
2602 next word.
2603 *cpo-W*
2604 W Don't overwrite a readonly file. When omitted, ":w!"
2605 overwrites a readonly file, if possible.
2606 *cpo-x*
2607 x <Esc> on the command-line executes the command-line.
2608 The default in Vim is to abandon the command-line,
2609 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002610 *cpo-X*
2611 X When using a count with "R" the replaced text is
2612 deleted only once. Also when repeating "R" with "."
2613 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002615 y A yank command can be redone with ".". Think twice if
2616 you really want to use this, it may break some
2617 plugins, since most people expect "." to only repeat a
2618 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002619 *cpo-Z*
2620 Z When using "w!" while the 'readonly' option is set,
2621 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002622 *cpo-z*
2623 z Special casing the "cw" and "d" command (see |cw| and
2624 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 *cpo-!*
2626 ! When redoing a filter command, use the last used
2627 external command, whatever it was. Otherwise the last
2628 used -filter- command is used.
2629 *cpo-$*
2630 $ When making a change to one line, don't redisplay the
2631 line, but put a '$' at the end of the changed text.
2632 The changed text will be overwritten when you type the
2633 new text. The line is redisplayed if you type any
2634 command that moves the cursor from the insertion
2635 point.
2636 *cpo-%*
2637 % Vi-compatible matching is done for the "%" command.
2638 Does not recognize "#if", "#endif", etc.
2639 Does not recognize "/*" and "*/".
2640 Parens inside single and double quotes are also
2641 counted, causing a string that contains a paren to
2642 disturb the matching. For example, in a line like
2643 "if (strcmp("foo(", s))" the first paren does not
2644 match the last one. When this flag is not included,
2645 parens inside single and double quotes are treated
2646 specially. When matching a paren outside of quotes,
2647 everything inside quotes is ignored. When matching a
2648 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002649 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002650 This flag is also used for other features, such as
2651 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002652 *cpo--*
2653 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002654 it would go above the first line or below the last
2655 line. Without it the cursor moves to the first or
2656 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002657 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002658 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002659 *cpo-+*
2660 + When included, a ":write file" command will reset the
2661 'modified' flag of the buffer, even though the buffer
2662 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002663 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 * Use ":*" in the same way as ":@". When not included,
2665 ":*" is an alias for ":'<,'>", select the Visual area.
2666 *cpo-<*
2667 < Disable the recognition of special key codes in |<>|
2668 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002669 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 ":map X <Tab>" results in X being mapped to:
2671 '<' included: "<Tab>" (5 characters)
2672 '<' excluded: "^I" (^I is a real <Tab>)
2673 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002674 *cpo->*
2675 > When appending to a register, put a line break before
2676 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002677 *cpo-;*
2678 ; When using |,| or |;| to repeat the last |t| search
2679 and the cursor is right in front of the searched
2680 character, the cursor won't move. When not included,
2681 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002682 following occurrence.
glepnir4ade6682025-07-03 20:41:23 +02002683 *cpo-~*
2684 ~ When included, don't resolve symbolic links when
2685 changing directory with |:cd|, |:lcd|, or |:tcd|.
2686 This preserves the symbolic link path in buffer names
2687 and when displaying the current directory. When
2688 excluded (default), symbolic links are resolved to
2689 their target paths.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002690
2691 POSIX flags. These are not included in the Vi default value, except
2692 when $VIM_POSIX was set on startup. |posix|
2693
2694 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002695 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002696 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002697 *cpo-&*
2698 & When ":preserve" was used keep the swap file when
2699 exiting normally while this buffer is still loaded.
2700 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002701 *cpo-\*
2702 \ Backslash in a [] range in a search pattern is taken
2703 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002704 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2705 '\' excluded: "/[ \-]" finds <Space> and '-'
2706 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002707 *cpo-/*
2708 / When "%" is used as the replacement string in a |:s|
2709 command, use the previous replacement string. |:s%|
2710 *cpo-{*
2711 { The |{| and |}| commands also stop at a "{" character
2712 at the start of a line.
2713 *cpo-.*
2714 . The ":chdir" and ":cd" commands fail if the current
2715 buffer is modified, unless ! is used. Vim doesn't
2716 need this, since it remembers the full path of an
2717 opened file.
2718 *cpo-bar*
2719 | The value of the $LINES and $COLUMNS environment
2720 variables overrule the terminal size values obtained
2721 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002722
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002723 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002724'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002725 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002726 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002727 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002728 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002729 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002730 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002731 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002732 blowfish Blowfish method. Medium strong encryption but it has
2733 an implementation flaw. Requires Vim 7.3 or later,
2734 files can NOT be read by Vim 7.2 and older. This adds
2735 a "seed" to the file, every time you write the file
2736 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002737 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002738 *blowfish2*
2739 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002740 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002741 and older. This adds a "seed" to the file, every time
2742 you write the file the encrypted bytes will be
2743 different. The whole undo file is encrypted, not just
2744 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002745 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002746 *E1197* *E1198* *E1199* *E1200* *E1201*
2747 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002748 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002749 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002750 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002751 It adds a seed and a message authentication code (MAC)
2752 to the file. This needs at least a Vim 8.2.3022 to
2753 read the encrypted file.
2754 Encryption of swap files is not supported, therefore
2755 no swap file will be used when xchacha20 encryption is
2756 enabled.
2757 Encryption of undo files is not yet supported,
2758 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002759 CAREFUL: Files written with this method might have to
2760 be read back with the same version of Vim if the
2761 binary format changes later.
2762 Obsolete, please do no longer use.
2763 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2764 stores the key derivation parameters together with the
2765 encrypted file. Should work better in case the
2766 parameters in the libsodium library ever change.
2767 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002768 might have to be read back with the same version of
2769 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002770
Christian Brabandtaae58342023-04-23 17:50:22 +01002771 You should use "blowfish2", also to re-encrypt older files. The
2772 "xchacha20" method provides better encryption, but it does not work
2773 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002774
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002775 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002776 to the detected method of the file being read. Thus if you write it
2777 without changing 'cryptmethod' the same method will be used.
2778 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002779 explicitly write it, you don't get a warning unless there are other
2780 modifications. Also see |:X|.
2781
2782 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002783 the value "blowfish2". When setting the local value to an empty
2784 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002785
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002786 When a new encryption method is added in a later version of Vim, and
2787 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002788 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002789
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 *'cscopepathcomp'* *'cspc'*
2791'cscopepathcomp' 'cspc' number (default 0)
2792 global
2793 {not available when compiled without the |+cscope|
2794 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 Determines how many components of the path to show in a list of tags.
2796 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002797 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798
2799 *'cscopeprg'* *'csprg'*
2800'cscopeprg' 'csprg' string (default "cscope")
2801 global
2802 {not available when compiled without the |+cscope|
2803 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 Specifies the command to execute cscope. See |cscopeprg|.
2805 This option cannot be set from a |modeline| or in the |sandbox|, for
2806 security reasons.
2807
2808 *'cscopequickfix'* *'csqf'*
2809'cscopequickfix' 'csqf' string (default "")
2810 global
2811 {not available when compiled without the |+cscope|
2812 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 Specifies whether to use quickfix window to show cscope results.
2814 See |cscopequickfix|.
2815
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002816 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002817'cscoperelative' 'csre' boolean (default off)
2818 global
2819 {not available when compiled without the |+cscope|
2820 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002821 In the absence of a prefix (-P) for cscope. setting this option enables
2822 to use the basename of cscope.out path as the prefix.
2823 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002824 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002825
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2827'cscopetag' 'cst' boolean (default off)
2828 global
2829 {not available when compiled without the |+cscope|
2830 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 Use cscope for tag commands. See |cscope-options|.
2832 NOTE: This option is reset when 'compatible' is set.
2833
2834 *'cscopetagorder'* *'csto'*
2835'cscopetagorder' 'csto' number (default 0)
2836 global
2837 {not available when compiled without the |+cscope|
2838 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 Determines the order in which ":cstag" performs a search. See
2840 |cscopetagorder|.
2841 NOTE: This option is set to 0 when 'compatible' is set.
2842
2843 *'cscopeverbose'* *'csverb'*
2844 *'nocscopeverbose'* *'nocsverb'*
2845'cscopeverbose' 'csverb' boolean (default off)
2846 global
2847 {not available when compiled without the |+cscope|
2848 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 Give messages when adding a cscope database. See |cscopeverbose|.
2850 NOTE: This option is reset when 'compatible' is set.
2851
Bram Moolenaar860cae12010-06-05 23:22:07 +02002852 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2853'cursorbind' 'crb' boolean (default off)
2854 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002855 When this option is set, as the cursor in the current
2856 window moves other cursorbound windows (windows that also have
2857 this option set) move their cursors to the corresponding line and
2858 column. This option is useful for viewing the
2859 differences between two versions of a file (see 'diff'); in diff mode,
2860 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002861 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002862
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002863 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2864'cursorcolumn' 'cuc' boolean (default off)
2865 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002866 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002867 feature}
2868 Highlight the screen column of the cursor with CursorColumn
2869 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2870 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002871 If you only want the highlighting in the current window you can use
2872 these autocommands: >
2873 au WinLeave * set nocursorline nocursorcolumn
2874 au WinEnter * set cursorline cursorcolumn
2875<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002876
2877 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2878'cursorline' 'cul' boolean (default off)
2879 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002880 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002881 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002882 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2883 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002884 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002885 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002886
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002887 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002888'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002889 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002890 {not available when compiled without the |+syntax|
2891 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002892 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002893 Valid values:
2894 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002895 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002896 "screenline" Highlight only the screen line of the cursor with
2897 CursorLine |hl-CursorLine|.
2898 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002899 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002900
2901 Special value:
2902 "both" Alias for the values "line,number".
2903
2904 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002905
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 *'debug'*
2907'debug' string (default "")
2908 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002909 These values can be used:
2910 msg Error messages that would otherwise be omitted will be given
2911 anyway.
2912 throw Error messages that would otherwise be omitted will be given
2913 anyway and also throw an exception and set |v:errmsg|.
2914 beep A message will be given when otherwise only a beep would be
2915 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002916 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002917 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2918 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919
2920 *'define'* *'def'*
2921'define' 'def' string (default "^\s*#\s*define")
2922 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002923 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 pattern, just like for the "/" command. This option is used for the
2925 commands like "[i" and "[d" |include-search|. The 'isident' option is
2926 used to recognize the defined name after the match:
2927 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2928 See |option-backslash| about inserting backslashes to include a space
2929 or backslash.
2930 The default value is for C programs. For C++ this value would be
2931 useful, to include const type declarations: >
2932 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002933< You can also use "\ze" just before the name and continue the pattern
2934 to check what is following. E.g. for Javascript, if a function is
2935 defined with "func_name = function(args)": >
2936 ^\s*\ze\i\+\s*=\s*function(
2937< If the function is defined with "func_name : function() {...": >
2938 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002940 To avoid that use `:let` with a single quote string: >
2941 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002942<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
2944 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2945'delcombine' 'deco' boolean (default off)
2946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 If editing Unicode and this option is set, backspace and Normal mode
2948 "x" delete each combining character on its own. When it is off (the
2949 default) the character along with its combining characters are
2950 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002951 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
2953 This is useful for Arabic, Hebrew and many other languages where one
2954 may have combining characters overtop of base characters, and want
2955 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002956 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957
2958 *'dictionary'* *'dict'*
2959'dictionary' 'dict' string (default "")
2960 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 List of file names, separated by commas, that are used to lookup words
2962 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2963 contain a list of words. This can be one word per line, or several
2964 words per line, separated by non-keyword characters (white space is
2965 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002966
2967 When this option is empty or an entry "spell" is present, and spell
2968 checking is enabled, words in the word lists for the currently active
2969 'spelllang' are used. See |spell|.
2970
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 after a comma are ignored, otherwise spaces are included in the file
2973 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002974 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 Where to find a list of words?
2976 - On FreeBSD, there is the file "/usr/share/dict/words".
2977 - In the Simtel archive, look in the "msdos/linguist" directory.
2978 - In "miscfiles" of the GNU collection.
2979 The use of |:set+=| and |:set-=| is preferred when adding or removing
2980 directories from the list. This avoids problems when a future version
2981 uses another default.
2982 Backticks cannot be used in this option for security reasons.
2983
2984 *'diff'* *'nodiff'*
2985'diff' boolean (default off)
2986 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 {not available when compiled without the |+diff|
2988 feature}
2989 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002990 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991
2992 *'dex'* *'diffexpr'*
2993'diffexpr' 'dex' string (default "")
2994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 {not available when compiled without the |+diff|
2996 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002997 Expression which is evaluated to obtain a diff file (either ed-style
2998 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 This option cannot be set from a |modeline| or in the |sandbox|, for
3000 security reasons.
3001
3002 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003003'diffopt' 'dip' string (default
3004 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 {not available when compiled without the |+diff|
3007 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003008 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 All are optional. Items must be separated by a comma.
3010
Jonathon7c7a4e62025-01-12 09:58:00 +01003011 algorithm:{text} Use the specified diff algorithm with the
3012 internal diff engine. Currently supported
3013 algorithms are:
3014 myers the default algorithm
3015 minimal spend extra time to generate the
3016 smallest possible diff
3017 patience patience diff algorithm
3018 histogram histogram diff algorithm
3019
3020 closeoff When a window is closed where 'diff' is set
3021 and there is only one window remaining in the
3022 same tab page with 'diff' set, execute
3023 `:diffoff` in that window. This undoes a
3024 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025
3026 context:{n} Use a context of {n} lines between a change
3027 and a fold that contains unchanged lines.
3028 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01003029 When using zero the context is actually one,
3030 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02003031 for a deleted line. Set it to a very large
3032 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 See |fold-diff|.
3034
Jonathon7c7a4e62025-01-12 09:58:00 +01003035 filler Show filler lines, to keep the text
3036 synchronized with a window that has inserted
3037 lines at the same position. Mostly useful
3038 when windows are side-by-side and 'scrollbind'
3039 is set.
3040
3041 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
3042 starting diff mode. Without this 2 is used.
3043
3044 followwrap Follow the 'wrap' option and leave as it is.
3045
3046 horizontal Start diff mode with horizontal splits (unless
3047 explicitly specified otherwise).
3048
3049 hiddenoff Do not use diff mode for a buffer when it
3050 becomes hidden.
3051
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003052 iblank Ignore changes where lines are all blank. Adds
3053 the "-B" flag to the "diff" command if
3054 'diffexpr' is empty. Check the documentation
3055 of the "diff" command for what this does
3056 exactly.
3057 NOTE: the diff windows will get out of sync,
3058 because no differences between blank lines are
3059 taken into account.
3060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 icase Ignore changes in case of text. "a" and "A"
3062 are considered the same. Adds the "-i" flag
3063 to the "diff" command if 'diffexpr' is empty.
3064
Jonathon7c7a4e62025-01-12 09:58:00 +01003065 indent-heuristic
3066 Use the indent heuristic for the internal
3067 diff library.
3068
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003069 inline:{text} Highlight inline differences within a change.
3070 See |view-diffs|. Supported values are:
3071
3072 none Do not perform inline highlighting.
3073 simple Highlight from first different
3074 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003075 line. This is the default if no
3076 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003077 char Use internal diff to perform a
3078 character-wise diff and highlight the
3079 difference.
3080 word Use internal diff to perform a
3081 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003082 difference. Non-alphanumeric
3083 multi-byte characters such as emoji
3084 and CJK characters are considered
3085 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003086
Jonathon7c7a4e62025-01-12 09:58:00 +01003087 internal Use the internal diff library. This is
3088 ignored when 'diffexpr' is set. *E960*
3089 When running out of memory when writing a
3090 buffer this item will be ignored for diffs
3091 involving that buffer. Set the 'verbose'
3092 option to see when this happens.
3093
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 iwhite Ignore changes in amount of white space. Adds
3095 the "-b" flag to the "diff" command if
3096 'diffexpr' is empty. Check the documentation
3097 of the "diff" command for what this does
3098 exactly. It should ignore adding trailing
3099 white space, but not leading white space.
3100
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003101 iwhiteall Ignore all white space changes. Adds
3102 the "-w" flag to the "diff" command if
3103 'diffexpr' is empty. Check the documentation
3104 of the "diff" command for what this does
3105 exactly.
3106
3107 iwhiteeol Ignore white space changes at end of line.
3108 Adds the "-Z" flag to the "diff" command if
3109 'diffexpr' is empty. Check the documentation
3110 of the "diff" command for what this does
3111 exactly.
3112
Jonathon7c7a4e62025-01-12 09:58:00 +01003113 linematch:{n} Align and mark changes between the most
3114 similar lines between the buffers. When the
3115 total number of lines in the diff hunk exceeds
3116 {n}, the lines will not be aligned because for
3117 very large diff hunks there will be a
3118 noticeable lag. A reasonable setting is
3119 "linematch:60", as this will enable alignment
3120 for a 2 buffer diff hunk of 30 lines each,
3121 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003122
3123 vertical Start diff mode with vertical splits (unless
3124 explicitly specified otherwise).
3125
Bram Moolenaare828b762018-09-10 17:51:58 +02003126 Examples: >
3127 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003129 :set diffopt=internal,filler,foldcolumn:3
3130 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131<
3132 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3133'digraph' 'dg' boolean (default off)
3134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 {not available when compiled without the |+digraphs|
3136 feature}
3137 Enable the entering of digraphs in Insert mode with {char1} <BS>
3138 {char2}. See |digraphs|.
3139 NOTE: This option is reset when 'compatible' is set.
3140
3141 *'directory'* *'dir'*
3142'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003143 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 for Unix: ".,~/tmp,/var/tmp,/tmp")
3145 global
3146 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003147 Recommended value: ".,~/vimswap//" - this will put the swap file next
3148 to the edited file if possible, and in your personal swap directory
3149 otherwise. Make sure "~/vimswap//" is only readable for you.
3150
3151 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 - The swap file will be created in the first directory where this is
3153 possible.
3154 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003155 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 - A directory "." means to put the swap file in the same directory as
3157 the edited file. On Unix, a dot is prepended to the file name, so
3158 it doesn't show in a directory listing. On MS-Windows the "hidden"
3159 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003160 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3161 the swap file relative to where the edited file is. The leading "."
3162 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003163 - For Unix and Win32, if a directory ends in two path separators "//",
3164 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003165 with all path separators replaced by percent '%' signs (including
3166 the colon following the drive letter on Win32). This will ensure
3167 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003168 On Win32, it is also possible to end with "\\". However, When a
3169 separating comma is following, you must use "//", since "\\" will
3170 include the comma in the file name. Therefore it is recommended to
3171 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 - Spaces after the comma are ignored, other spaces are considered part
3173 of the directory name. To have a space at the start of a directory
3174 name, precede it with a backslash.
3175 - To include a comma in a directory name precede it with a backslash.
3176 - A directory name may end in an ':' or '/'.
3177 - Environment variables are expanded |:set_env|.
3178 - Careful with '\' characters, type one before a space, type two to
3179 get one in the option (see |option-backslash|), for example: >
3180 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3181< - For backwards compatibility with Vim version 3.0 a '>' at the start
3182 of the option is removed.
3183 Using "." first in the list is recommended. This means that editing
3184 the same file twice will result in a warning. Using "/tmp" on Unix is
3185 discouraged: When the system crashes you lose the swap file.
3186 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003187 choice than "/tmp". But others on the computer may be able to see the
3188 files, and it can contain a lot of files, your swap files get lost in
3189 the crowd. That is why a "tmp" directory in your home directory is
3190 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 The use of |:set+=| and |:set-=| is preferred when adding or removing
3192 directories from the list. This avoids problems when a future version
3193 uses another default.
3194 This option cannot be set from a |modeline| or in the |sandbox|, for
3195 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196
3197 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003198'display' 'dy' string (default "", set to "truncate" in
3199 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003201 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 flags:
3203 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003204 in a window will be displayed. "@@@" is put in the
3205 last columns of the last screen line to indicate the
3206 rest of the line is not displayed.
3207 truncate Like "lastline", but "@@@" is displayed in the first
3208 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 uhex Show unprintable characters hexadecimal as <xx>
3210 instead of using ^C and ~C.
3211
Bram Moolenaard0796902016-09-16 20:02:31 +02003212 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003213 doesn't fit is replaced with "@" lines.
3214
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003215 The "@" character can be changed by setting the "lastline" item in
3216 'fillchars'. The character is highlighted with |hl-NonText|.
3217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 *'eadirection'* *'ead'*
3219'eadirection' 'ead' string (default "both")
3220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 Tells when the 'equalalways' option applies:
3222 ver vertically, width of windows is not affected
3223 hor horizontally, height of windows is not affected
3224 both width and height of windows is affected
3225
3226 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3227'edcompatible' 'ed' boolean (default off)
3228 global
3229 Makes the 'g' and 'c' flags of the ":substitute" command to be
3230 toggled each time the flag is given. See |complex-change|. See
3231 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003232 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003233 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234
Bram Moolenaar03413f42016-04-12 21:07:15 +02003235 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003236'emoji' 'emo' boolean (default: on)
3237 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003238 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003239 This excludes "text emoji" characters, which are normally displayed as
3240 single width. Unfortunately there is no good specification for this
3241 and it has been determined on trial-and-error basis. Use the
3242 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003243
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003245'encoding' 'enc' string (default for MS-Windows: "utf-8",
3246 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 Sets the character encoding used inside Vim. It applies to text in
3249 the buffers, registers, Strings in expressions, text stored in the
3250 viminfo file, etc. It sets the kind of characters which Vim can work
3251 with. See |encoding-names| for the possible values.
3252
3253 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003254 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003256 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257
Bram Moolenaar865242e2010-07-14 21:12:05 +02003258 This option cannot be set from a |modeline|. It would most likely
3259 corrupt the text.
3260
Bram Moolenaar3df01732017-02-17 22:47:16 +01003261 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3262 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 'encoding', "utf-8" is the natural choice for the environment and
3264 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 versions, and to avoid changing the encoding of newly created files
3267 without your knowledge (in case 'fileencodings' is empty).
3268
3269 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 iconv() or as specified with 'charconvert'.
3272
Bram Moolenaar207f0092020-08-30 17:20:20 +02003273 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003274 can use: >
3275 if has("multi_byte_encoding")
3276<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 Normally 'encoding' will be equal to your current locale. This will
3278 be the default if Vim recognizes your environment settings. If
3279 'encoding' is not set to the current locale, 'termencoding' must be
3280 set to convert typed and displayed text. See |encoding-table|.
3281
3282 When you set this option, it fires the |EncodingChanged| autocommand
3283 event so that you can set up fonts if necessary.
3284
3285 When the option is set, the value is converted to lowercase. Thus
3286 you can set it with uppercase values too. Underscores are translated
3287 to '-' signs.
3288 When the encoding is recognized, it is changed to the standard name.
3289 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3290 "iso-8859-2" and "utf8" becomes "utf-8".
3291
3292 Note: "latin1" is also used when the encoding could not be detected.
3293 This only works when editing files in the same encoding! When the
3294 actual character set is not latin1, make sure 'fileencoding' and
3295 'fileencodings' are empty. When conversion is needed, switch to using
3296 utf-8.
3297
3298 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3299 You don't notice this while editing, but it does matter for the
3300 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3301 setting 'encoding' to one of these values instead of utf-8 only has
3302 effect for encoding used for files when 'fileencoding' is empty.
3303
Bram Moolenaar661b1822005-07-28 22:36:45 +00003304 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3305 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003307 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003308'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003310 Indicates that a CTRL-Z character was found at the end of the file
3311 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003313 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003314 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003315 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003316
3317 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3318'endofline' 'eol' boolean (default on)
3319 local to buffer
3320 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003321 is on, or 'fixeol' option is off, no <EOL> will be written for the
3322 last line in the file. This option is automatically set or reset when
3323 starting to edit a new file, depending on whether file has an <EOL>
3324 for the last line in the file. Normally you don't have to set or
3325 reset this option.
3326 When 'binary' is off and 'fixeol' is on the value is not used when
3327 writing the file. When 'binary' is on or 'fixeol' is off it is used
3328 to remember the presence of a <EOL> for the last line in the file, so
3329 that when you write the file the situation from the original file can
3330 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003331 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332
3333 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3334'equalalways' 'ea' boolean (default on)
3335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003337 splitting or closing a window. This also happens the moment the
3338 option is switched on. When off, splitting a window will reduce the
3339 size of the current window and leave the other windows the same. When
3340 closing a window the extra lines are given to the window next to it
3341 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 When mixing vertically and horizontally split windows, a minimal size
3343 is computed and some windows may be larger if there is room. The
3344 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003345 Changing the height and width of a window can be avoided by setting
3346 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003347 If a window size is specified when creating a new window sizes are
3348 currently not equalized (it's complicated, but may be implemented in
3349 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350
3351 *'equalprg'* *'ep'*
3352'equalprg' 'ep' string (default "")
3353 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003355 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003356 or 'indentexpr'. When Vim was compiled without internal formatting,
3357 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003358 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 about including spaces and backslashes.
3360 This option cannot be set from a |modeline| or in the |sandbox|, for
3361 security reasons.
3362
3363 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3364'errorbells' 'eb' boolean (default off)
3365 global
3366 Ring the bell (beep or screen flash) for error messages. This only
3367 makes a difference for error messages, the bell will be used always
3368 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003369 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003370 screen flash or do nothing. See 'belloff' to finetune when to ring the
3371 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372
3373 *'errorfile'* *'ef'*
3374'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3375 others: "errors.err")
3376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 {not available when compiled without the |+quickfix|
3378 feature}
3379 Name of the errorfile for the QuickFix mode (see |:cf|).
3380 When the "-q" command-line argument is used, 'errorfile' is set to the
3381 following argument. See |-q|.
3382 NOT used for the ":make" command. See 'makeef' for that.
3383 Environment variables are expanded |:set_env|.
3384 See |option-backslash| about including spaces and backslashes.
3385 This option cannot be set from a |modeline| or in the |sandbox|, for
3386 security reasons.
3387
3388 *'errorformat'* *'efm'*
3389'errorformat' 'efm' string (default is very long)
3390 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {not available when compiled without the |+quickfix|
3392 feature}
3393 Scanf-like description of the format for the lines in the error file
3394 (see |errorformat|).
3395
3396 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3397'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 Function keys that start with an <Esc> are recognized in Insert
3400 mode. When this option is off, the cursor and function keys cannot be
3401 used in Insert mode if they start with an <Esc>. The advantage of
3402 this is that the single <Esc> is recognized immediately, instead of
3403 after one second. Instead of resetting this option, you might want to
3404 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3405 when 'esckeys' is off, you can still map anything, but the cursor keys
3406 won't work by default.
3407 NOTE: This option is set to the Vi default value when 'compatible' is
3408 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003409 NOTE: when this option is off then the |modifyOtherKeys| and
3410 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3411 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412
3413 *'eventignore'* *'ei'*
3414'eventignore' 'ei' string (default "")
3415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003417 When set to "all" or when "all" is one of the items, all autocommand
3418 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003419 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 :set ei=WinEnter,WinLeave
3421<
Luuk van Baal8cc6d8b2025-05-31 12:10:31 +02003422 To ignore all but some events, a "-" prefix can be used: >
3423 :set ei=all,-WinLeave
3424<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003425 *'eventignorewin'* *'eiw'*
3426'eventignorewin' 'eiw' string (default "")
3427 window-local
3428 Similar to 'eventignore' but applies to a particular window and its
3429 buffers, for which window and buffer related autocommands can be
3430 ignored indefinitely without affecting the global 'eventignore'.
3431
glepnir631a50c2025-06-15 16:05:10 +02003432 Note: The following events are considered to happen outside of a
3433 window context and thus cannot be ignored by 'eventignorewin':
3434
3435 |CmdlineChanged|,
3436 |CmdlineEnter|,
3437 |CmdlineLeave|,
3438 |CmdlineLeavePre|,
3439 |CmdUndefined|,
3440 |CmdwinEnter|,
3441 |CmdwinLeave|,
3442 |ColorScheme|,
3443 |ColorSchemePre|,
3444 |CompleteChanged|,
3445 |CompleteDone|,
3446 |CompleteDonePre|,
3447 |DiffUpdated|,
3448 |DirChanged|,
3449 |DirChangedPre|,
3450 |EncodingChanged|,
3451 |ExitPre|,
3452 |FocusGained|,
3453 |FocusLost|,
3454 |FuncUndefined|,
3455 |GUIEnter|,
3456 |GUIFailed|,
3457 |KeyInputPre|,
3458 |MenuPopup|,
3459 |ModeChanged|,
3460 |OptionSet|,
3461 |QuickFixCmdPost|,
3462 |QuickFixCmdPre|,
3463 |QuitPre|,
3464 |RemoteReply|,
3465 |SafeState|,
3466 |SafeStateAgain|,
3467 |SessionLoadPost|,
3468 |SessionWritePost|,
3469 |ShellCmdPost|,
3470 |SigUSR1|,
3471 |SourceCmd|,
3472 |SourcePost|,
3473 |SourcePre|,
3474 |SpellFileMissing|,
3475 |StdinReadPost|,
3476 |StdinReadPre|,
3477 |SwapExists|,
3478 |Syntax|,
3479 |TabClosed|,
3480 |TabClosedPre|,
3481 |TabEnter|,
3482 |TabLeave|,
3483 |TabNew|,
3484 |TermChanged|,
3485 |TerminalOpen|,
3486 |TerminalWinOpen|,
3487 |TermResponse|,
3488 |TermResponseAll|,
3489 |User|,
3490 |VimEnter|,
3491 |VimLeave|,
3492 |VimLeavePre|,
3493 |VimResized|,
3494 |VimResume|,
3495 |VimSuspend|,
3496 |WinNew|,
3497 |WinNewPre|
3498
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3500'expandtab' 'et' boolean (default off)
3501 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3505 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003506 This option is reset when the 'paste' option is set and restored when
3507 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 NOTE: This option is reset when 'compatible' is set.
3509
3510 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3511'exrc' 'ex' boolean (default off)
3512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003514 directory.
3515
3516 Setting this option is a potential security leak. E.g., consider
3517 unpacking a package or fetching files from github, a .vimrc in there
3518 might be a trojan horse. BETTER NOT SET THIS OPTION!
3519 Instead, define an autocommand in your .vimrc to set options for a
3520 matching directory.
3521
3522 If you do switch this option on you should also consider setting the
3523 'secure' option (see |initialization|).
3524 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 This option cannot be set from a |modeline| or in the |sandbox|, for
3526 security reasons.
3527
3528 *'fileencoding'* *'fenc'* *E213*
3529'fileencoding' 'fenc' string (default: "")
3530 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003532
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003534 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 When 'fileencoding' is empty, the same value as 'encoding' will be
3536 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003537 No error will be given when the value is set, only when it is used,
3538 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003539 Conversion will also be done when 'encoding' and 'fileencoding' are
3540 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3541 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003543 'encoding' is "utf-8" or another Unicode encoding, conversion
3544 is most likely done in a way that the reverse conversion
3545 results in the same text. When 'encoding' is not "utf-8" some
3546 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003547
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 See 'encoding' for the possible values. Additionally, values may be
3549 specified that can be handled by the converter, see
3550 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003551
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 When reading a file 'fileencoding' will be set from 'fileencodings'.
3553 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003554 'fileencoding', use the |++enc| argument. One exception: when
3555 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003556 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003557
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3559 When the option is set, the value is converted to lowercase. Thus
3560 you can set it with uppercase values too. '_' characters are
3561 replaced with '-'. If a name is recognized from the list for
3562 'encoding', it is replaced by the standard name. For example
3563 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003564
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 When this option is set, after starting to edit a file, the 'modified'
3566 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003567
3568 Keep in mind that changing 'fenc' from a modeline happens
3569 AFTER the text has been read, thus it applies to when the file will be
3570 written. If you do set 'fenc' in a modeline, you might want to set
3571 'nomodified' to avoid not being able to ":q".
3572
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 This option can not be changed when 'modifiable' is off.
3574
3575 *'fe'*
3576 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003577 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 old short name was 'fe', which is no longer used.
3579
3580 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003581'fileencodings' 'fencs' string (default: "ucs-bom",
3582 "ucs-bom,utf-8,default,latin1" when
3583 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 This is a list of character encodings considered when starting to edit
3586 an existing file. When a file is read, Vim tries to use the first
3587 mentioned character encoding. If an error is detected, the next one
3588 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003589 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 an empty string, which means the value of 'encoding' is used.
3591 WARNING: Conversion can cause loss of information! When
3592 'encoding' is "utf-8" (or one of the other Unicode variants)
3593 conversion is most likely done in a way that the reverse
3594 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003595 "utf-8" some non-ASCII characters may be lost! You can use
3596 the |++bad| argument to specify what is done with characters
3597 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 For an empty file or a file with only ASCII characters most encodings
3599 will work and the first entry of 'fileencodings' will be used (except
3600 "ucs-bom", which requires the BOM to be present). If you prefer
3601 another encoding use an BufReadPost autocommand event to test if your
3602 preferred encoding is to be used. Example: >
3603 au BufReadPost * if search('\S', 'w') == 0 |
3604 \ set fenc=iso-2022-jp | endif
3605< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3606 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003607 When the |++enc| argument is used then the value of 'fileencodings' is
3608 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003609 Note that 'fileencodings' is not used for a new file, the global value
3610 of 'fileencoding' is used instead. You can set it with: >
3611 :setglobal fenc=iso-8859-2
3612< This means that a non-existing file may get a different encoding than
3613 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 The special value "ucs-bom" can be used to check for a Unicode BOM
3615 (Byte Order Mark) at the start of the file. It must not be preceded
3616 by "utf-8" or another Unicode encoding for this to work properly.
3617 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3618 because Vim cannot detect an error, thus the encoding is always
3619 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003620 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003621 environment. On MS-Windows this is the system encoding. Otherwise
3622 this is the default value for 'encoding'. It is useful when
3623 'encoding' is set to "utf-8" and your environment uses a non-latin1
3624 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003625 When 'encoding' is "utf-8" and a file contains an illegal byte
3626 sequence it won't be recognized as UTF-8. You can use the |8g8|
3627 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 WRONG VALUES: WHAT'S WRONG:
3629 latin1,utf-8 "latin1" will always be used
3630 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3631 file
3632 cp1250,latin1 "cp1250" will always be used
3633 If 'fileencodings' is empty, 'fileencoding' is not modified.
3634 See 'fileencoding' for the possible values.
3635 Setting this option does not have an effect until the next time a file
3636 is read.
3637
3638 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003639'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003640 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 This gives the <EOL> of the current buffer, which is used for
3643 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003644 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 unix <NL>
3646 mac <CR>
3647 When "dos" is used, CTRL-Z at the end of a file is ignored.
3648 See |file-formats| and |file-read|.
3649 For the character encoding of the file see 'fileencoding'.
3650 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003651 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 This option is set automatically when starting to edit a file and
3653 'fileformats' is not empty and 'binary' is off.
3654 When this option is set, after starting to edit a file, the 'modified'
3655 option is set, because the file would be different when written.
3656 This option can not be changed when 'modifiable' is off.
3657 For backwards compatibility: When this option is set to "dos",
3658 'textmode' is set, otherwise 'textmode' is reset.
3659
3660 *'fileformats'* *'ffs'*
3661'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003662 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003663 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 Vi Cygwin: "unix,dos",
3665 Vi others: "")
3666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 This gives the end-of-line (<EOL>) formats that will be tried when
3668 starting to edit a new buffer and when reading a file into an existing
3669 buffer:
3670 - When empty, the format defined with 'fileformat' will be used
3671 always. It is not set automatically.
3672 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 'fileformats' name will be used when a file is read into an existing
3675 buffer, no matter what 'fileformat' for that buffer is set to.
3676 - When more than one name is present, separated by commas, automatic
3677 <EOL> detection will be done when reading a file. When starting to
3678 edit a file, a check is done for the <EOL>:
3679 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3680 'fileformat' is set to "dos".
3681 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003682 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003684 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3685 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003686 This means that "mac" is only chosen when:
3687 "unix" is not present or no <NL> is found in the file, and
3688 "dos" is not present or no <CR><NL> is found in the file.
3689 Except: if "unix" was chosen, but there is a <CR> before
3690 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003691 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 4. If 'fileformat' is still not set, the first name from
3693 'fileformats' is used.
3694 When reading a file into an existing buffer, the same is done, but
3695 this happens like 'fileformat' has been set appropriately for that
3696 file only, the option is not changed.
3697 When 'binary' is set, the value of 'fileformats' is not used.
3698
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003699 When Vim starts up with an empty buffer the first item is used. You
3700 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003701
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3703 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3704 done:
3705 - When 'fileformats' is empty, there is no automatic detection. Dos
3706 format will be used.
3707 - When 'fileformats' is set to one or more names, automatic detection
3708 is done. This is based on the first <NL> in the file: If there is a
3709 <CR> in front of it, Dos format is used, otherwise Unix format is
3710 used.
3711 Also see |file-formats|.
3712 For backwards compatibility: When this option is set to an empty
3713 string or one format (no comma is included), 'textauto' is reset,
3714 otherwise 'textauto' is set.
3715 NOTE: This option is set to the Vi default value when 'compatible' is
3716 set and to the Vim default value when 'compatible' is reset.
3717
Bram Moolenaarbf884932013-04-05 22:26:15 +02003718 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3719'fileignorecase' 'fic' boolean (default on for systems where case in file
3720 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003721 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003722 When set case is ignored when using file names and directories.
3723 See 'wildignorecase' for only ignoring case when doing completion.
3724
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 *'filetype'* *'ft'*
3726'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003727 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 When this option is set, the FileType autocommand event is triggered.
3729 All autocommands that match with the value of this option will be
3730 executed. Thus the value of 'filetype' is used in place of the file
3731 name.
3732 Otherwise this option does not always reflect the current file type.
3733 This option is normally set when the file type is detected. To enable
3734 this use the ":filetype on" command. |:filetype|
3735 Setting this option to a different value is most useful in a modeline,
3736 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003737 Example, for in an IDL file:
3738 /* vim: set filetype=idl : */ ~
3739 |FileType| |filetypes|
3740 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003741 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003742 /* vim: set filetype=c.doxygen : */ ~
3743 This will use the "c" filetype first, then the "doxygen" filetype.
3744 This works both for filetype plugins and for syntax files. More than
3745 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 This option is not copied to another buffer, independent of the 's' or
3747 'S' flag in 'cpoptions'.
Christian Brabandtf0c70902025-05-26 21:18:19 +02003748 Only alphanumeric characters, '-' and '_' can be used (and a '.' is
Doug Kearnsa6172f82025-05-26 20:32:35 +02003749 allowed as delimiter when combining different filetypes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750
3751 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003752'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003753 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003754 Characters to fill the statuslines, vertical separators, special
3755 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003756 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003757 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003759 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003760 stl ' ' statusline of the current window
3761 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003762 vert '|' vertical separators |:vsplit|
3763 fold '-' filling 'foldtext'
3764 foldopen '-' mark the beginning of a fold
3765 foldclose '+' show a closed fold
3766 foldsep '|' open fold middle character
3767 diff '-' deleted lines of the 'diff' option
3768 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003769 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003770 trunc '>' truncated text in the
3771 |ins-completion-menu|.
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02003772 truncrl '<' same as "trunc" in 'rightleft' mode
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003773 tpl_vert '|' vertical separators of 'tabpanel'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003775 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776
3777 Example: >
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003778 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-,tpl_vert:\|
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003779<
Hirohito Higashi0553f2f2025-05-10 14:56:17 +02003780 All items support single-byte and multibyte characters. But
3781 double-width characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003782
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003784 item name highlight group ~
3785 stl StatusLine |hl-StatusLine|
3786 stlnc StatusLineNC |hl-StatusLineNC|
3787 vert VertSplit |hl-VertSplit|
3788 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003789 foldopen FoldColumn |hl-FoldColumn|
3790 foldclose FoldColumn |hl-FoldColumn|
3791 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003792 diff DiffDelete |hl-DiffDelete|
3793 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003794 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003795 trunc one of the many Popup menu highlighting groups like
3796 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003797 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003799 *'findfunc'* *'ffu'* *E1514*
3800'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003801 global or local to buffer |global-local|
3802 {not available when compiled without the |+eval|
3803 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003804 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003805 command. When this option is empty, the internal |file-searching|
3806 mechanism is used.
3807
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003808 The value can be the name of a function, a |lambda| or a |Funcref|.
3809 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003810
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003811 The function is called with two arguments. The first argument is a
3812 |String| and is the |:find| command argument. The second argument is
3813 a |Boolean| and is set to |v:true| when the function is called to get
3814 a List of command-line completion matches for the |:find| command.
3815 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003816
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003817 The function is called only once per |:find| command invocation.
3818 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003819
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003820 If a match is found, the function should return a |List| containing
3821 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003822 should return an empty List.
3823
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003824 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003825 empty List is used as the return value.
3826
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003827 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003828 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003829
3830 This option cannot be set from a |modeline| or in the |sandbox|, for
3831 security reasons.
3832
3833 Examples:
3834>
3835 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003836 func FindFuncGlob(cmdarg, cmdcomplete)
3837 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003838 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003839 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003840 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003841
3842 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003843 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003844 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003845 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003846 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003847 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003848<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003849 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3850'fixendofline' 'fixeol' boolean (default on)
3851 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003852 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003853 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003854 preserve the situation from the original file.
3855 When the 'binary' option is set the value of this option doesn't
3856 matter.
3857 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003858 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003859
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003861'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 {only available when compiled with the |+rightleft|
3864 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003865 This option was for using Farsi, which has been removed. See
3866 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867
3868 *'foldclose'* *'fcl'*
3869'foldclose' 'fcl' string (default "")
3870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 {not available when compiled without the |+folding|
3872 feature}
3873 When set to "all", a fold is closed when the cursor isn't in it and
3874 its level is higher than 'foldlevel'. Useful if you want folds to
3875 automatically close when moving out of them.
3876
3877 *'foldcolumn'* *'fdc'*
3878'foldcolumn' 'fdc' number (default 0)
3879 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 {not available when compiled without the |+folding|
3881 feature}
3882 When non-zero, a column with the specified width is shown at the side
3883 of the window which indicates open and closed folds. The maximum
3884 value is 12.
3885 See |folding|.
3886
3887 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3888'foldenable' 'fen' boolean (default on)
3889 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 {not available when compiled without the |+folding|
3891 feature}
3892 When off, all folds are open. This option can be used to quickly
3893 switch between showing all text unfolded and viewing the text with
3894 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 'foldenable' is off.
3897 This option is set by commands that create a new fold or close a fold.
3898 See |folding|.
3899
3900 *'foldexpr'* *'fde'*
3901'foldexpr' 'fde' string (default: "0")
3902 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003904 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003906 for each line to obtain its fold level. The context is set to the
3907 script where 'foldexpr' was set, script-local items can be accessed.
3908 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003909
Bram Moolenaar30b65812012-07-12 22:01:11 +02003910 The expression will be evaluated in the |sandbox| if set from a
3911 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003912 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003913 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003914
3915 It is not allowed to change text or jump to another window while
3916 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917
3918 *'foldignore'* *'fdi'*
3919'foldignore' 'fdi' string (default: "#")
3920 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 {not available when compiled without the |+folding|
3922 feature}
3923 Used only when 'foldmethod' is "indent". Lines starting with
3924 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003925 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 The default "#" works well for C programs. See |fold-indent|.
3927
3928 *'foldlevel'* *'fdl'*
3929'foldlevel' 'fdl' number (default: 0)
3930 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 {not available when compiled without the |+folding|
3932 feature}
3933 Sets the fold level: Folds with a higher level will be closed.
3934 Setting this option to zero will close all folds. Higher numbers will
3935 close fewer folds.
3936 This option is set by commands like |zm|, |zM| and |zR|.
3937 See |fold-foldlevel|.
3938
3939 *'foldlevelstart'* *'fdls'*
3940'foldlevelstart' 'fdls' number (default: -1)
3941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 {not available when compiled without the |+folding|
3943 feature}
3944 Sets 'foldlevel' when starting to edit another buffer in a window.
3945 Useful to always start editing with all folds closed (value zero),
3946 some folds closed (one) or no folds closed (99).
3947 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003948 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 ignores this option and closes all folds.
3950 It is also done before BufReadPre autocommands, to allow an autocmd to
3951 overrule the 'foldlevel' value for specific files.
3952 When the value is negative, it is not used.
3953
3954 *'foldmarker'* *'fmr'* *E536*
3955'foldmarker' 'fmr' string (default: "{{{,}}}")
3956 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 {not available when compiled without the |+folding|
3958 feature}
3959 The start and end marker used when 'foldmethod' is "marker". There
3960 must be one comma, which separates the start and end marker. The
3961 marker is a literal string (a regular expression would be too slow).
3962 See |fold-marker|.
3963
3964 *'foldmethod'* *'fdm'*
3965'foldmethod' 'fdm' string (default: "manual")
3966 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 {not available when compiled without the |+folding|
3968 feature}
3969 The kind of folding used for the current window. Possible values:
3970 |fold-manual| manual Folds are created manually.
3971 |fold-indent| indent Lines with equal indent form a fold.
3972 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3973 |fold-marker| marker Markers are used to specify folds.
3974 |fold-syntax| syntax Syntax highlighting items specify folds.
3975 |fold-diff| diff Fold text that is not changed.
3976
3977 *'foldminlines'* *'fml'*
3978'foldminlines' 'fml' number (default: 1)
3979 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 {not available when compiled without the |+folding|
3981 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003982 Sets the number of screen lines above which a fold can be displayed
3983 closed. Also for manually closed folds. With the default value of
3984 one a fold can only be closed if it takes up two or more screen lines.
3985 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003986 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 "zc" to close a fold, which is displayed open because it's smaller
3988 than 'foldminlines', a following "zc" may close a containing fold.
3989
3990 *'foldnestmax'* *'fdn'*
3991'foldnestmax' 'fdn' number (default: 20)
3992 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 {not available when compiled without the |+folding|
3994 feature}
3995 Sets the maximum nesting of folds for the "indent" and "syntax"
3996 methods. This avoids that too many folds will be created. Using more
3997 than 20 doesn't work, because the internal limit is 20.
3998
3999 *'foldopen'* *'fdo'*
4000'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
4001 search,tag,undo")
4002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 {not available when compiled without the |+folding|
4004 feature}
4005 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004006 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02004008 NOTE: When the command is part of a mapping this option is not used.
4009 Add the |zv| command to the mapping to get the same effect.
4010 (rationale: the mapping may want to control opening folds itself)
4011
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 item commands ~
4013 all any
4014 block "(", "{", "[[", "[{", etc.
4015 hor horizontal movements: "l", "w", "fx", etc.
4016 insert any command in Insert mode
4017 jump far jumps: "G", "gg", etc.
4018 mark jumping to a mark: "'m", CTRL-O, etc.
4019 percent "%"
4020 quickfix ":cn", ":crew", ":make", etc.
4021 search search for a pattern: "/", "n", "*", "gd", etc.
4022 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004023 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 tag jumping to a tag: ":ta", CTRL-T, etc.
4025 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 When a movement command is used for an operator (e.g., "dl" or "y%")
4027 this option is not used. This means the operator will include the
4028 whole closed fold.
4029 Note that vertical movements are not here, because it would make it
4030 very difficult to move onto a closed fold.
4031 In insert mode the folds containing the cursor will always be open
4032 when text is inserted.
4033 To close folds you can re-apply 'foldlevel' with the |zx| command or
4034 set the 'foldclose' option to "all".
4035
4036 *'foldtext'* *'fdt'*
4037'foldtext' 'fdt' string (default: "foldtext()")
4038 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 {not available when compiled without the |+folding|
4040 feature}
4041 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004042 fold. The context is set to the script where 'foldexpr' was set,
4043 script-local items can be accessed. See |fold-foldtext| for the
4044 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045
Bram Moolenaar30b65812012-07-12 22:01:11 +02004046 The expression will be evaluated in the |sandbox| if set from a
4047 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004048 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004049
4050 It is not allowed to change text or jump to another window while
4051 evaluating 'foldtext' |textlock|.
4052
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004053 *'formatexpr'* *'fex'*
4054'formatexpr' 'fex' string (default "")
4055 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004056 {not available when compiled without the |+eval|
4057 feature}
4058 Expression which is evaluated to format a range of lines for the |gq|
4059 operator or automatic formatting (see 'formatoptions'). When this
4060 option is empty 'formatprg' is used.
4061
4062 The |v:lnum| variable holds the first line to be formatted.
4063 The |v:count| variable holds the number of lines to be formatted.
4064 The |v:char| variable holds the character that is going to be
4065 inserted if the expression is being evaluated due to
4066 automatic formatting. This can be empty. Don't insert
4067 it yet!
4068
4069 Example: >
4070 :set formatexpr=mylang#Format()
4071< This will invoke the mylang#Format() function in the
4072 autoload/mylang.vim file in 'runtimepath'. |autoload|
4073
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004074 The advantage of using a function call without arguments is that it is
4075 faster, see |expr-option-function|.
4076
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004077 The expression is also evaluated when 'textwidth' is set and adding
4078 text beyond that limit. This happens under the same conditions as
4079 when internal formatting is used. Make sure the cursor is kept in the
4080 same spot relative to the text then! The |mode()| function will
4081 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004082
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004083 When the expression evaluates to non-zero Vim will fall back to using
4084 the internal format mechanism.
4085
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004086 If the expression starts with s: or |<SID>|, then it is replaced with
4087 the script ID (|local-function|). Example: >
4088 set formatexpr=s:MyFormatExpr()
4089 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004090< Otherwise, the expression is evaluated in the context of the script
4091 where the option was set, thus script-local items are available.
4092
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004093 The expression will be evaluated in the |sandbox| when set from a
4094 modeline, see |sandbox-option|. That stops the option from working,
4095 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004096 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004097 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004098
Bram Moolenaar86b68352004-12-27 21:59:20 +00004099 *'formatlistpat'* *'flp'*
4100'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
4101 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00004102 A pattern that is used to recognize a list header. This is used for
4103 the "n" flag in 'formatoptions'.
4104 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00004105 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00004106 while still checking more characters. There must be a character
4107 following the pattern, when it matches the whole line it is handled
4108 like there is no match.
4109 The default recognizes a number, followed by an optional punctuation
4110 character and white space.
4111
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004112 *'formatoptions'* *'fo'*
4113'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
4114 local to buffer
4115 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01004116 formatting is to be done.
4117 See |fo-table| for possible values and |gq| for how to format text.
4118 When the 'paste' option is on, no formatting is done (like
4119 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004120 To avoid problems with flags that are added in the future, use the
4121 "+=" and "-=" feature of ":set" |add-option-flags|.
4122 NOTE: This option is set to the Vi default value when 'compatible' is
4123 set and to the Vim default value when 'compatible' is reset.
4124
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 *'formatprg'* *'fp'*
4126'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004127 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004129 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004131 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004132 If the 'formatexpr' option is not empty it will be used instead.
4133 Otherwise, if 'formatprg' option is an empty string, the internal
4134 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004135 Environment variables are expanded |:set_env|. See |option-backslash|
4136 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004137 This option cannot be set from a |modeline| or in the |sandbox|, for
4138 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139
Bram Moolenaard94464e2015-11-02 15:28:18 +01004140 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004141'fsync' 'fs' boolean (default on)
4142 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004143 When on, the library function fsync() will be called after writing a
4144 file. This will flush a file to disk, ensuring that it is safely
4145 written even on filesystems which do metadata-only journaling. This
4146 will force the harddrive to spin up on Linux systems running in laptop
4147 mode, so it may be undesirable in some situations. Be warned that
4148 turning this off increases the chances of data loss after a crash. On
4149 systems without an fsync() implementation, this variable is always
4150 off.
4151 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004152 'fsync' also applies to |writefile()| (unless a flag is used to
4153 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004154 This option cannot be set from a |modeline| or in the |sandbox|, for
4155 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004156
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4158'gdefault' 'gd' boolean (default off)
4159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 When on, the ":substitute" flag 'g' is default on. This means that
4161 all matches in a line are substituted instead of one. When a 'g' flag
4162 is given to a ":substitute" command, this will toggle the substitution
4163 of all or one match. See |complex-change|.
4164
4165 command 'gdefault' on 'gdefault' off ~
4166 :s/// subst. all subst. one
4167 :s///g subst. one subst. all
4168 :s///gg subst. all subst. one
4169
4170 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004171 Setting this option may break plugins that rely on the default
4172 behavior of the 'g' flag. This will also make the 'g' flag have the
4173 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004174 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175
4176 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004177'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
glepnir7b9eb632025-05-16 19:49:23 +02004178 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 Format to recognize for the ":grep" command output.
4180 This is a scanf-like string that uses the same format as the
4181 'errorformat' option: see |errorformat|.
4182
4183 *'grepprg'* *'gp'*
4184'grepprg' 'gp' string (default "grep -n ",
4185 Unix: "grep -n $* /dev/null",
4186 Win32: "findstr /n" or "grep -n",
4187 VMS: "SEARCH/NUMBERS ")
4188 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004189 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 and '#' characters, which are expanded like when used in a command-
4191 line. The placeholder "$*" is allowed to specify where the arguments
4192 will be included. Environment variables are expanded |:set_env|. See
4193 |option-backslash| about including spaces and backslashes.
4194 When your "grep" accepts the "-H" argument, use this to make ":grep"
4195 also work well with a single file: >
4196 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004197< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004198 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4199 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004200 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 apply equally to 'grepprg'.
4202 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4203 otherwise it's "grep -n".
4204 This option cannot be set from a |modeline| or in the |sandbox|, for
4205 security reasons.
4206
4207 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4208'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4209 ve:ver35-Cursor,
4210 o:hor50-Cursor,
4211 i-ci:ver25-Cursor/lCursor,
4212 r-cr:hor20-Cursor/lCursor,
4213 sm:block-Cursor
4214 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004215 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 "n-v-c:block,o:hor50,i-ci:hor15,
4217 r-cr:hor30,sm:block")
4218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004220 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004222 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004223 height of the cursor can be changed. This can be done by specifying a
4224 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004225 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4226 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004228 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 mode-list and an argument-list:
4230 mode-list:argument-list,mode-list:argument-list,..
4231 The mode-list is a dash separated list of these modes:
4232 n Normal mode
4233 v Visual mode
4234 ve Visual mode with 'selection' "exclusive" (same as 'v',
4235 if not specified)
4236 o Operator-pending mode
4237 i Insert mode
4238 r Replace mode
4239 c Command-line Normal (append) mode
4240 ci Command-line Insert mode
4241 cr Command-line Replace mode
4242 sm showmatch in Insert mode
4243 a all modes
4244 The argument-list is a dash separated list of these arguments:
4245 hor{N} horizontal bar, {N} percent of the character height
4246 ver{N} vertical bar, {N} percent of the character width
4247 block block cursor, fills the whole character
4248 [only one of the above three should be present]
4249 blinkwait{N} *cursor-blinking*
4250 blinkon{N}
4251 blinkoff{N}
4252 blink times for cursor: blinkwait is the delay before
4253 the cursor starts blinking, blinkon is the time that
4254 the cursor is shown and blinkoff is the time that the
4255 cursor is not shown. The times are in msec. When one
4256 of the numbers is zero, there is no blinking. The
4257 default is: "blinkwait700-blinkon400-blinkoff250".
4258 These numbers are used for a missing entry. This
4259 means that blinking is enabled by default. To switch
4260 blinking off you can use "blinkon0". The cursor only
4261 blinks when Vim is waiting for input, not while
4262 executing a command.
4263 To make the cursor blink in an xterm, see
4264 |xterm-blink|.
4265 {group-name}
4266 a highlight group name, that sets the color and font
4267 for the cursor
4268 {group-name}/{group-name}
4269 Two highlight group names, the first is used when
4270 no language mappings are used, the other when they
4271 are. |language-mapping|
4272
4273 Examples of parts:
4274 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4275 block cursor with colors from the "nCursor"
4276 highlight group
4277 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4278 In Insert and Command-line Insert mode, use a
4279 30% vertical bar cursor with colors from the
4280 "iCursor" highlight group. Blink a bit
4281 faster.
4282
4283 The 'a' mode is different. It will set the given argument-list for
4284 all modes. It does not reset anything to defaults. This can be used
4285 to do a common setting for all modes. For example, to switch off
4286 blinking: "a:blinkon0"
4287
4288 Examples of cursor highlighting: >
4289 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4290 :highlight Cursor gui=NONE guifg=bg guibg=fg
4291<
4292 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004293 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294'guifont' 'gfn' string (default "")
4295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {only available when compiled with GUI enabled}
4297 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004298 In its simplest form the value is just one font name.
4299 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300
4301 *'guifontset'* *'gfs'*
4302 *E250* *E252* *E234* *E597* *E598*
4303'guifontset' 'gfs' string (default "")
4304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 {only available when compiled with GUI enabled and
4306 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004307 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 When not empty, specifies two (or more) fonts to be used. The first
4309 one for normal English, the second one for your special language. See
4310 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004311
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4313'guifontwide' 'gfw' string (default "")
4314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 {only available when compiled with GUI enabled}
4316 When not empty, specifies a comma-separated list of fonts to be used
4317 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004318 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004319
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 *'guiheadroom'* *'ghr'*
4321'guiheadroom' 'ghr' number (default 50)
4322 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004323 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 The number of pixels subtracted from the screen height when fitting
4325 the GUI window on the screen. Set this before the GUI is started,
4326 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004327 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 lines will be left for window decorations and other items on the
4329 screen. Set it to a negative value to allow windows taller than the
4330 screen.
4331
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004332 *'guiligatures'* *'gli'* *E1243*
4333'guiligatures' 'gli' string (default "")
4334 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004335 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004336 List of ASCII characters that, when combined together, can create more
4337 complex shapes. Each character must be a printable ASCII character
4338 with a value in the 32-127 range.
4339 Example: >
4340 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4341< Changing this option updates screen output immediately. Set it to an
4342 empty string to disable ligatures.
4343
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004345'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4346 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004347 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004348 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004351 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 sequence of letters which describes what components and options of the
4353 GUI should be used.
4354 To avoid problems with flags that are added in the future, use the
4355 "+=" and "-=" feature of ":set" |add-option-flags|.
4356
Bram Moolenaar13568252018-03-16 20:46:58 +01004357 Valid characters are as follows:
4358 *'go-!'*
4359 '!' External commands are executed in a terminal window. Without
4360 this flag the MS-Windows GUI will open a console window to
4361 execute the command. The Unix GUI will simulate a dumb
4362 terminal to list the command output.
4363 The terminal window will be positioned at the bottom, and grow
4364 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004365 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 'a' Autoselect: If present, then whenever VISUAL mode is started,
4367 or the Visual area extended, Vim tries to become the owner of
4368 the windowing system's global selection. This means that the
4369 Visually highlighted text is available for pasting into other
4370 applications as well as into Vim itself. When the Visual mode
4371 ends, possibly due to an operation on the text, or when an
4372 application wants to paste the selection, the highlighted text
4373 is automatically yanked into the "* selection register.
4374 Thus the selection is still available for pasting into other
4375 applications after the VISUAL mode has ended.
4376 If not present, then Vim won't become the owner of the
4377 windowing system's global selection unless explicitly told to
4378 by a yank or delete operation for the "* register.
4379 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004380 *'go-P'*
4381 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004382 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004383 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004384 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 applies to the modeless selection.
4386
4387 'guioptions' autoselect Visual autoselect modeless ~
4388 "" - -
4389 "a" yes yes
4390 "A" - yes
4391 "aA" yes yes
4392
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004393 When using a terminal see the 'clipboard' option.
4394
Bram Moolenaar02467872007-05-06 13:22:01 +00004395 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 'c' Use console dialogs instead of popup dialogs for simple
4397 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004398 *'go-d'*
4399 'd' Use dark theme variant if available. Currently only works for
4400 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004401 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004402 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004403 'guitablabel' can be used to change the text in the labels.
4404 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004405 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004406 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004407 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 'f' Foreground: Don't use fork() to detach the GUI from the shell
4409 where it was started. Use this for programs that wait for the
4410 editor to finish (e.g., an e-mail program). Alternatively you
4411 can use "gvim -f" or ":gui -f" to start the GUI in the
4412 foreground. |gui-fork|
4413 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004414 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004415 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4417 corner of the window. It's black&white on non-GTK, because of
4418 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004419 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004421 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004422 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004424 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004426 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004427 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 'g' Grey menu items: Make menu items that are not active grey. If
4429 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004430 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 't' Include tearoff menu items. Currently only works for Win32,
4432 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004433 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004434 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4435 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004436 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004438 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 'R' Right-hand scrollbar is present when there is a vertically
4440 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004441 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004443 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 'L' Left-hand scrollbar is present when there is a vertically
4445 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004446 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4448 the longest visible line, or on the cursor line if the 'h'
4449 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004450 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 'h' Limit horizontal scrollbar size to the length of the cursor
4452 line. Reduces computations. |gui-horiz-scroll|
4453
4454 And yes, you may even have scrollbars on the left AND the right if
4455 you really want to :-). See |gui-scrollbars| for more information.
4456
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004457 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 'v' Use a vertical button layout for dialogs. When not included,
4459 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004460 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004461 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 'p' Use Pointer callbacks for X11 GUI. This is required for some
4463 window managers. If the cursor is not blinking or hollow at
4464 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004465 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004467 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004468 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004469 *'go-k'*
4470 'k' Keep the GUI window size when adding/removing a scrollbar, or
4471 toolbar, tabline, etc. Instead, the behavior is similar to
4472 when the window is maximized and will adjust 'lines' and
4473 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004474 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004475 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004476
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 *'guipty'* *'noguipty'*
4478'guipty' boolean (default on)
4479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 {only available when compiled with GUI enabled}
4481 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4482 I/O to/from shell commands. See |gui-pty|.
4483
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004484 *'guitablabel'* *'gtl'*
4485'guitablabel' 'gtl' string (default empty)
4486 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004487 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004488 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004489 pages line. When empty and when the result is empty Vim will use a
4490 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004491
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004492 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004493 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004494 The expression will be evaluated in the |sandbox| when set from a
4495 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004496 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004497
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004498 Only used when the GUI tab pages line is displayed. 'e' must be
4499 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4500 used.
4501
Bram Moolenaar57657d82006-04-21 22:12:41 +00004502 *'guitabtooltip'* *'gtt'*
4503'guitabtooltip' 'gtt' string (default empty)
4504 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004505 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004506 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004507 pages line. When empty Vim will use a default tooltip.
4508 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004509 You can include a line break. Simplest method is to use |:let|: >
4510 :let &guitabtooltip = "line one\nline two"
4511<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004512
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004514'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 (others) "$VIMRUNTIME/doc/help.txt")
4516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 Name of the main help file. All distributed help files should be
4518 placed together in one directory. Additionally, all "doc" directories
4519 in 'runtimepath' will be used.
4520 Environment variables are expanded |:set_env|. For example:
4521 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004522 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 spaces and backslashes.
4524 This option cannot be set from a |modeline| or in the |sandbox|, for
4525 security reasons.
4526
4527 *'helpheight'* *'hh'*
4528'helpheight' 'hh' number (default 20)
4529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 Minimal initial height of the help window when it is opened with the
4531 ":help" command. The initial height of the help window is half of the
4532 current window, or (when the 'ea' option is on) the same as other
4533 windows. When the height is less than 'helpheight', the height is
4534 set to 'helpheight'. Set to zero to disable.
4535
4536 *'helplang'* *'hlg'*
4537'helplang' 'hlg' string (default: messages language or empty)
4538 global
4539 {only available when compiled with the |+multi_lang|
4540 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004541 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 for which the desired help can be found. The English help will always
4543 be used as a last resort. You can add "en" to prefer English over
4544 another language, but that will only find tags that exist in that
4545 language and not in the English help.
4546 Example: >
4547 :set helplang=de,it
4548< This will first search German, then Italian and finally English help
4549 files.
4550 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4551 try to find the tag in the current language before using this option.
4552 See |help-translated|.
4553
4554 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4555'hidden' 'hid' boolean (default off)
4556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 When off a buffer is unloaded when it is |abandon|ed. When on a
4558 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4559 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004560
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004562 hidden even if the 'hidden' option is off when these three are true:
4563 - the buffer is modified
4564 - 'autowrite' is off or writing is not possible
4565 - the '!' flag was used
4566 Also see |windows.txt|.
4567
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004568 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 This option is set for one command with ":hide {command}" |:hide|.
4570 WARNING: It's easy to forget that you have changes in hidden buffers.
4571 Think twice when using ":q!" or ":qa!".
4572
4573 *'highlight'* *'hl'*
4574'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004575 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4576 d:Directory,e:ErrorMsg,i:IncSearch,
4577 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004578 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004579 N:CursorLineNr,r:Question,s:StatusLine,
4580 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004581 v:Visual,V:VisualNOS,w:WarningMsg,
4582 W:WildMenu,f:Folded,F:FoldColumn,
4583 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004584 T:DiffText,E:DiffTextAdd,>:SignColumn,
4585 -:Conceal,B:SpellBad,P:SpellCap,
4586 R:SpellRare, L:SpellLocal,+:Pmenu,
4587 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004588 [:PmenuKind,]:PmenuKindSel,
4589 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004590 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4591 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004592 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004593 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004594 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004597 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004599 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004601 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4602 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 characters from 'showbreak'
4604 |hl-Directory| d directories in CTRL-D listing and other special
4605 things in listings
4606 |hl-ErrorMsg| e error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004608 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4610 |hl-MoreMsg| m |more-prompt|
4611 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004612 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004613 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004614 |hl-LineNr| n line number for ":number" and ":#" commands, and
4615 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004616 |hl-LineNrAbove| a line number above the cursor for when the
4617 'relativenumber' option is set.
4618 |hl-LineNrBelow| b line number below the cursor for when the
4619 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004620 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4621 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 |hl-Question| r |hit-enter| prompt and yes/no questions
4623 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004624 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4626 |hl-VertSplit| c column used to separate vertically split windows
4627 |hl-Visual| v Visual mode
Foxe Chenb90c2392025-06-27 21:10:35 +02004628 |hl-VisualNOS| V Visual mode when Vim is "Not Owning the
4629 Selection" Only X11 Gui's |gui-x11|,
4630 |xterm-clipboard| and |wayland-selections|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 |hl-WarningMsg| w warning messages
4632 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4633 |hl-Folded| f line used for closed folds
4634 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004635 |hl-DiffAdd| A added line in diff mode
4636 |hl-DiffChange| C changed line in diff mode
4637 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004638 |hl-DiffText| T changed text in diff mode
4639 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004641 |hl-Conceal| - the placeholders used for concealed characters
4642 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004643 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004644 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004645 |hl-SpellRare| R rare word |spell|
4646 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004647 |hl-Pmenu| + popup menu normal line
4648 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004649 |hl-PmenuKind| [ popup menu "kind" normal line
4650 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004651 |hl-PmenuExtra| { popup menu "extra" normal line
4652 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004653 |hl-PmenuSbar| x popup menu scrollbar
4654 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004655 |hl-PmenuMatch| k popup menu matched text
4656 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 The display modes are:
4659 r reverse (termcap entry "mr" and "me")
4660 i italic (termcap entry "ZH" and "ZR")
4661 b bold (termcap entry "md" and "me")
4662 s standout (termcap entry "so" and "se")
4663 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004664 c undercurl (termcap entry "Us" and "Ce")
4665 2 double underline (termcap entry "Ds" and "Ce")
4666 d dotted underline (termcap entry "ds" and "Ce")
4667 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004668 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 n no highlighting
4670 - no highlighting
4671 : use a highlight group
4672 The default is used for occasions that are not included.
4673 If you want to change what the display modes do, see |dos-colors|
4674 for an example.
4675 When using the ':' display mode, this must be followed by the name of
4676 a highlight group. A highlight group can be used to define any type
4677 of highlighting, including using color. See |:highlight| on how to
4678 define one. The default uses a different group for each occasion.
4679 See |highlight-default| for the default highlight groups.
4680
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004682'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004685 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004686 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004687 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004688 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 NOTE: This option is set to the Vi default value when 'compatible' is
4690 set and to the Vim default value when 'compatible' is reset.
4691
4692 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4693'hkmap' 'hk' boolean (default off)
4694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 {only available when compiled with the |+rightleft|
4696 feature}
4697 When on, the keyboard is mapped for the Hebrew character set.
4698 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4699 toggle this option. See |rileft.txt|.
4700 NOTE: This option is reset when 'compatible' is set.
4701
4702 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4703'hkmapp' 'hkp' boolean (default off)
4704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 {only available when compiled with the |+rightleft|
4706 feature}
4707 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4708 This is useful if you have a non-Hebrew keyboard.
4709 See |rileft.txt|.
4710 NOTE: This option is reset when 'compatible' is set.
4711
Bram Moolenaar036986f2017-03-16 17:41:02 +01004712 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4713'hlsearch' 'hls' boolean (default off)
4714 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004715 {not available when compiled without the
4716 |+extra_search| feature}
4717 When there is a previous search pattern, highlight all its matches.
4718 The type of highlighting used can be set with the 'l' occasion in the
4719 'highlight' option. This uses the "Search" highlight group by
4720 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004721 are not applied. If the "CurSearch" highlight group is set then the
4722 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004723 See also: 'incsearch' and |:match|.
4724 When you get bored looking at the highlighted matches, you can turn it
4725 off with |:nohlsearch|. This does not change the option value, as
4726 soon as you use a search command, the highlighting comes back.
4727 'redrawtime' specifies the maximum time spent on finding matches.
4728 When the search pattern can match an end-of-line, Vim will try to
4729 highlight all of the matched text. However, this depends on where the
4730 search starts. This will be the first line in the window or the first
4731 line below a closed fold. A match in a previous line which is not
4732 drawn may not continue in a newly drawn line.
4733 You can specify whether the highlight status is restored on startup
4734 with the 'h' flag in 'viminfo' |viminfo-h|.
4735 NOTE: This option is reset when 'compatible' is set.
4736
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 *'icon'* *'noicon'*
4738'icon' boolean (default off, on when title can be restored)
4739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 When on, the icon text of the window will be set to the value of
4741 'iconstring' (if it is not empty), or to the name of the file
4742 currently being edited. Only the last part of the name is used.
4743 Overridden by the 'iconstring' option.
4744 Only works if the terminal supports setting window icons (currently
4745 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4746 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4747 builtin termcap).
4748 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004749 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004751 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
4753 *'iconstring'*
4754'iconstring' string (default "")
4755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 When this option is not empty, it will be used for the icon text of
4757 the window. This happens only when the 'icon' option is on.
4758 Only works if the terminal supports setting window icon text
4759 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004760 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 When Vim was compiled with HAVE_X11 defined, the original icon will be
4762 restored if possible |X11|.
4763 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004764 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004766 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 {not available when compiled without the |+statusline| feature}
4768
4769 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4770'ignorecase' 'ic' boolean (default off)
4771 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004772 Ignore case in search patterns, |cmdline-completion|, when
glepnir05460682025-05-26 18:23:27 +02004773 searching in the tags file, non-|Vim9| |expr-==| and for Insert-mode
4774 completion |ins-completion|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004775 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 Can be overruled by using "\c" or "\C" in the pattern, see
4777 |/ignorecase|.
4778
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004779 *'imactivatefunc'* *'imaf'*
4780'imactivatefunc' 'imaf' string (default "")
4781 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004782 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004783 activate or deactivate the Input Method. The value can be the name of
4784 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4785 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004786 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004787 The expression will be evaluated in the |sandbox| when set from a
4788 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004789
4790 Example: >
4791 function ImActivateFunc(active)
4792 if a:active
4793 ... do something
4794 else
4795 ... do something
4796 endif
4797 " return value is not used
4798 endfunction
4799 set imactivatefunc=ImActivateFunc
4800<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 *'imactivatekey'* *'imak'*
4802'imactivatekey' 'imak' string (default "")
4803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004805 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 Specifies the key that your Input Method in X-Windows uses for
4807 activation. When this is specified correctly, vim can fully control
4808 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4809 You can't use this option to change the activation key, the option
4810 tells Vim what the key is.
4811 Format:
4812 [MODIFIER_FLAG-]KEY_STRING
4813
4814 These characters can be used for MODIFIER_FLAG (case is ignored):
4815 S Shift key
4816 L Lock key
4817 C Control key
4818 1 Mod1 key
4819 2 Mod2 key
4820 3 Mod3 key
4821 4 Mod4 key
4822 5 Mod5 key
4823 Combinations are allowed, for example "S-C-space" or "SC-space" are
4824 both shift+ctrl+space.
4825 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4826
4827 Example: >
4828 :set imactivatekey=S-space
4829< "S-space" means shift+space. This is the activation key for kinput2 +
4830 canna (Japanese), and ami (Korean).
4831
4832 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4833'imcmdline' 'imc' boolean (default off)
4834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 When set the Input Method is always on when starting to edit a command
4836 line, unless entering a search pattern (see 'imsearch' for that).
4837 Setting this option is useful when your input method allows entering
4838 English characters directly, e.g., when it's used to type accented
4839 characters with dead keys.
4840
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004841 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 When set the Input Method is never used. This is useful to disable
4845 the IM when it doesn't work properly.
4846 Currently this option is on by default for SGI/IRIX machines. This
4847 may change in later releases.
4848
4849 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004850'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 Specifies whether :lmap or an Input Method (IM) is to be used in
4853 Insert mode. Valid values:
4854 0 :lmap is off and IM is off
4855 1 :lmap is ON and IM is off
4856 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 To always reset the option to zero when leaving Insert mode with <Esc>
4858 this can be used: >
4859 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4860< This makes :lmap and IM turn off automatically when leaving Insert
4861 mode.
4862 Note that this option changes when using CTRL-^ in Insert mode
4863 |i_CTRL-^|.
4864 The value is set to 1 when setting 'keymap' to a valid keymap name.
4865 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004866 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 methods. Use 'imdisable' to disable XIM then.
4868
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004869 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004870 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004871 |+multi_byte_ime| or |global-ime|.
4872
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004874'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 Specifies whether :lmap or an Input Method (IM) is to be used when
4877 entering a search pattern. Valid values:
4878 -1 the value of 'iminsert' is used, makes it look like
4879 'iminsert' is also used when typing a search pattern
4880 0 :lmap is off and IM is off
4881 1 :lmap is ON and IM is off
4882 2 :lmap is off and IM is ON
4883 Note that this option changes when using CTRL-^ in Command-line mode
4884 |c_CTRL-^|.
4885 The value is set to 1 when it is not -1 and setting the 'keymap'
4886 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004887 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 methods. Use 'imdisable' to disable XIM then.
4889
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004890 *'imstatusfunc'* *'imsf'*
4891'imstatusfunc' 'imsf' string (default "")
4892 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004893 This option specifies a function that is called to obtain the status
4894 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004895 The value can be the name of a function, a |lambda| or a |Funcref|.
4896 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004897 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004898
4899 Example: >
4900 function ImStatusFunc()
4901 let is_active = ...do something
4902 return is_active ? 1 : 0
4903 endfunction
4904 set imstatusfunc=ImStatusFunc
4905<
4906 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004907 The expression will be evaluated in the |sandbox| when set from a
4908 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004909
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004910 *'imstyle'* *'imst'*
4911'imstyle' 'imst' number (default 1)
4912 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004913 {only available when compiled with |+xim| and
4914 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004915 This option specifies the input style of Input Method:
4916 0 use on-the-spot style
4917 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004918 See: |xim-input-style|
4919
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004920 For a long time on-the-spot style had been used in the GTK version of
4921 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004922 |single-repeat|, etc. Therefore over-the-spot style becomes the
4923 default now. This should work fine for most people, however if you
4924 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004925 The expression will be evaluated in the |sandbox| when set from a
4926 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004927
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 *'include'* *'inc'*
4929'include' 'inc' string (default "^\s*#\s*include")
4930 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 {not available when compiled without the
4932 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004933 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 pattern, just like for the "/" command (See |pattern|). The default
4935 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004936 "]I", "[d", etc.
4937 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004938 comes after the matched pattern. But if "\zs" appears in the pattern
4939 then the text matched from "\zs" to the end, or until "\ze" if it
4940 appears, is used as the file name. Use this to include characters
4941 that are not in 'isfname', such as a space. You can then use
4942 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004943 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944
4945 *'includeexpr'* *'inex'*
4946'includeexpr' 'inex' string (default "")
4947 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004949 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004951 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004952 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004954 Note the double backslash: the `:set` command first halves them, then
4955 one remains it the value, where "\." matches a dot literally. For
4956 simple character replacements `tr()` avoids the need for escaping: >
4957 :setlocal includeexpr=tr(v:fname,'.','/')
4958<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004960 found. Allows doing "gf" on the name after an 'include' statement.
Christian Brabandt23984602025-04-19 11:54:08 +02004961 Note: Not used for |<cfile>|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004963 If the expression starts with s: or |<SID>|, then it is replaced with
4964 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004965 setlocal includeexpr=s:MyIncludeExpr()
4966 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004967< Otherwise, the expression is evaluated in the context of the script
4968 where the option was set, thus script-local items are available.
4969
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004970 It is more efficient if the value is just a function call without
4971 arguments, see |expr-option-function|.
4972
Bram Moolenaar30b65812012-07-12 22:01:11 +02004973 The expression will be evaluated in the |sandbox| when set from a
4974 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004975 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004976
4977 It is not allowed to change text or jump to another window while
4978 evaluating 'includeexpr' |textlock|.
4979
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004981'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004982 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004985 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004986 While typing a search command, show where the pattern, as it was typed
4987 so far, matches. The matched string is highlighted. If the pattern
4988 is invalid or not found, nothing is shown. The screen will be updated
4989 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004990 Also applies to the pattern in commands: >
4991 :global
4992 :lvimgrep
4993 :lvimgrepadd
4994 :smagic
4995 :snomagic
4996 :sort
4997 :substitute
4998 :vglobal
4999 :vimgrep
5000 :vimgrepadd
5001< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00005002 original position when no match is found and when pressing <Esc>. You
5003 still need to finish the search command with <Enter> to move the
5004 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02005005 You can use the CTRL-G and CTRL-T keys to move to the next and
5006 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005007 When compiled with the |+reltime| feature Vim only searches for about
5008 half a second. With a complicated pattern and/or a lot of text the
5009 match may not be found. This is to avoid that Vim hangs while you
5010 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00005011 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01005012 When 'hlsearch' is on, all matched strings are highlighted too while
5013 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02005014 If you don't want to turn 'hlsearch' on, but want to highlight all
5015 matches while searching, you can turn on and off 'hlsearch' with
5016 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005017 augroup vimrc-incsearch-highlight
5018 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01005019 autocmd CmdlineEnter /,\? :set hlsearch
5020 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005021 augroup END
5022<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005023 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02005024 to the command line. If 'ignorecase' and 'smartcase' are set and the
5025 command line has no uppercase characters, the added character is
5026 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005027 CTRL-R CTRL-W can be used to add the word at the end of the current
5028 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 NOTE: This option is reset when 'compatible' is set.
5030
5031 *'indentexpr'* *'inde'*
5032'indentexpr' 'inde' string (default "")
5033 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005034 {not available when compiled without the |+eval|
5035 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 Expression which is evaluated to obtain the proper indent for a line.
5037 It is used when a new line is created, for the |=| operator and
5038 in Insert mode as specified with the 'indentkeys' option.
5039 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02005040 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02005041 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 When 'paste' is set this option is not used for indenting.
5043 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005044 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005046
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00005047 If the expression starts with s: or |<SID>|, then it is replaced with
5048 the script ID (|local-function|). Example: >
5049 set indentexpr=s:MyIndentExpr()
5050 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005051< Otherwise, the expression is evaluated in the context of the script
5052 where the option was set, thus script-local items are available.
5053
Bram Moolenaara4e0b972022-10-01 19:43:52 +01005054 The advantage of using a function call without arguments is that it is
5055 faster, see |expr-option-function|.
5056
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 The expression must return the number of spaces worth of indent. It
5058 can return "-1" to keep the current indent (this means 'autoindent' is
5059 used for the indent).
5060 Functions useful for computing the indent are |indent()|, |cindent()|
5061 and |lispindent()|.
5062 The evaluation of the expression must not have side effects! It must
5063 not change the text, jump to another window, etc. Afterwards the
5064 cursor position is always restored, thus the cursor may be moved.
5065 Normally this option would be set to call a function: >
5066 :set indentexpr=GetMyIndent()
5067< Error messages will be suppressed, unless the 'debug' option contains
5068 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005069 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005070 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071
Bram Moolenaar30b65812012-07-12 22:01:11 +02005072 The expression will be evaluated in the |sandbox| when set from a
5073 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005074 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005075
5076 It is not allowed to change text or jump to another window while
5077 evaluating 'indentexpr' |textlock|.
5078
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01005080'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 A list of keys that, when typed in Insert mode, cause reindenting of
5083 the current line. Only happens if 'indentexpr' isn't empty.
5084 The format is identical to 'cinkeys', see |indentkeys-format|.
5085 See |C-indenting| and |indent-expression|.
5086
5087 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
5088'infercase' 'inf' boolean (default off)
5089 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00005091 'ignorecase' is also on, the case of the match is adjusted depending
5092 on the typed text. If the typed text contains a lowercase letter
5093 where the match has an upper case letter, the completed part is made
5094 lowercase. If the typed text has no lowercase letters and the match
5095 has a lowercase letter where the typed text has an uppercase letter,
5096 and there is a letter before it, the completed part is made uppercase.
5097 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098
glepnirbcd59952025-04-24 21:48:35 +02005099 *'isexpand'* *'ise'*
5100'isexpand' 'ise' string (default: "")
5101 local to buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02005102 Defines characters and patterns for completion in insert mode. Used
5103 by the |complete_match()| function to determine the starting position
5104 for completion. This is a comma-separated list of triggers. Each
5105 trigger can be:
glepnirbcd59952025-04-24 21:48:35 +02005106 - A single character like "." or "/"
5107 - A sequence of characters like "->", "/*", or "/**"
5108
5109 Note: Use "\\," to add a literal comma as trigger character, see
5110 |option-backslash|.
5111
glepnirffc89e42025-04-27 14:59:17 +02005112 Examples: >
5113 set isexpand=.,->,/*,\\,
5114<
5115
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
5117'insertmode' 'im' boolean (default off)
5118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 Makes Vim work in a way that Insert mode is the default mode. Useful
5120 if you want to use Vim as a modeless editor. Used for |evim|.
5121 These Insert mode commands will be useful:
5122 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005123 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 this is a mapping, it is executed as if 'insertmode' was off.
5125 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00005127 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
5128 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
5130 These items change when 'insertmode' is set:
5131 - when starting to edit of a file, Vim goes to Insert mode.
5132 - <Esc> in Insert mode is a no-op and beeps.
5133 - <Esc> in Normal mode makes Vim go to Insert mode.
5134 - CTRL-L in Insert mode is a command, it is not inserted.
5135 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
5136 However, when <Esc> is used inside a mapping, it behaves like
5137 'insertmode' was not set. This was done to be able to use the same
5138 mappings with 'insertmode' set or not set.
5139 When executing commands with |:normal| 'insertmode' is not used.
5140
5141 NOTE: This option is reset when 'compatible' is set.
5142
5143 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005144'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5146 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5147 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5148 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5149 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 The characters specified by this option are included in file names and
5152 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005153 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 Multi-byte characters 256 and above are always included, only the
5155 characters up to 255 are specified with this option.
5156 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005157 Think twice before adding white space to this option. Although a
5158 space may appear inside a file name, the effect will be that Vim
5159 doesn't know where a file name starts or ends when doing completion.
5160 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
5162 Note that on systems using a backslash as path separator, Vim tries to
5163 do its best to make it work as you would expect. That is a bit
5164 tricky, since Vi originally used the backslash to escape special
5165 characters. Vim will not remove a backslash in front of a normal file
5166 name character on these systems, but it will on Unix and alikes. The
5167 '&' and '^' are not included by default, because these are special for
5168 cmd.exe.
5169
5170 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005171 Each part can be a single character number or a range. A range is two
5172 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 decimal number between 0 and 255 or the ASCII character itself (does
5174 not work for digits). Example:
5175 "_,-,128-140,#-43" (include '_' and '-' and the range
5176 128 to 140 and '#' to 43)
5177 If a part starts with '^', the following character number or range
5178 will be excluded from the option. The option is interpreted from left
5179 to right. Put the excluded character after the range where it is
5180 included. To include '^' itself use it as the last character of the
5181 option or the end of a range. Example:
5182 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5183 If the character is '@', all characters where isalpha() returns TRUE
5184 are included. Normally these are the characters a to z and A to Z,
5185 plus accented characters. To include '@' itself use "@-@". Examples:
5186 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005187 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 "a-z,A-Z,@-@" All letters plus the '@' character.
5189 A comma can be included by using it where a character number is
5190 expected. Example:
5191 "48-57,,,_" Digits, comma and underscore.
5192 A comma can be excluded by prepending a '^'. Example:
5193 " -~,^,,9" All characters from space to '~', excluding
5194 comma, plus <Tab>.
5195 See |option-backslash| about including spaces and backslashes.
5196
5197 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005198'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 "@,48-57,_,128-167,224-235"
5200 otherwise: "@,48-57,_,192-255")
5201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 The characters given by this option are included in identifiers.
5203 Identifiers are used in recognizing environment variables and after a
5204 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005205 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005206 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005208 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5210
5211 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005212'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 "@,48-57,_,128-167,224-235"
5214 otherwise: "@,48-57,_,192-255"
5215 Vi default: "@,48-57,_")
5216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005218 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005219 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005220 characters above 255 check the "word" character class (any character
5221 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005222 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 For a help file it is set to all non-blank printable characters except
5224 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5225 command).
5226 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005227 This option also influences syntax highlighting, unless the syntax
5228 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 NOTE: This option is set to the Vi default value when 'compatible' is
5230 set and to the Vim default value when 'compatible' is reset.
5231
5232 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005233'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 "@,~-255"; otherwise: "@,161-255")
5235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 The characters given by this option are displayed directly on the
5237 screen. It is also used for "\p" in a |pattern|. The characters from
5238 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5239 even when they are not included in 'isprint' or excluded. See
5240 'isfname' for a description of the format of this option.
5241
5242 Non-printable characters are displayed with two characters:
5243 0 - 31 "^@" - "^_"
5244 32 - 126 always single characters
5245 127 "^?"
5246 128 - 159 "~@" - "~_"
5247 160 - 254 "| " - "|~"
5248 255 "~?"
5249 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5250 displayed as <xx>, with the hexadecimal value of the byte.
5251 When 'display' contains "uhex" all unprintable characters are
5252 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005253 The SpecialKey highlighting will be used for unprintable characters.
5254 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255
5256 Multi-byte characters 256 and above are always included, only the
5257 characters up to 255 are specified with this option. When a character
5258 is printable but it is not available in the current font, a
5259 replacement character will be shown.
5260 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5261 There is no option to specify these characters.
5262
5263 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5264'joinspaces' 'js' boolean (default on)
5265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 Insert two spaces after a '.', '?' and '!' with a join command.
5267 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5268 Otherwise only one space is inserted.
5269 NOTE: This option is set when 'compatible' is set.
5270
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005271 *'jumpoptions'* *'jop'*
5272'jumpoptions' 'jop' string (default "")
5273 global
5274 List of words that change the behavior of the |jumplist|.
5275 stack Make the jumplist behave like the tagstack.
5276 Relative location of entries in the jumplist is
5277 preserved at the cost of discarding subsequent entries
5278 when navigating backwards in the jumplist and then
5279 jumping to a location. |jumplist-stack|
5280
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 *'key'*
5282'key' string (default "")
5283 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005284 {only available when compiled with the |+cryptv|
5285 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005287 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 Careful: Do not set the key value by hand, someone might see the typed
5289 key. Use the |:X| command. But you can make 'key' empty: >
5290 :set key=
5291< It is not possible to get the value of this option with ":set key" or
5292 "echo &key". This is to avoid showing it to someone who shouldn't
5293 know. It also means you cannot see it yourself once you have set it,
5294 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005295 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5296 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005297 You can use "&key" in an expression to detect whether encryption is
5298 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299
5300 *'keymap'* *'kmp'* *E544*
5301'keymap' 'kmp' string (default "")
5302 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 {only available when compiled with the |+keymap|
5304 feature}
5305 Name of a keyboard mapping. See |mbyte-keymap|.
5306 Setting this option to a valid keymap name has the side effect of
5307 setting 'iminsert' to one, so that the keymap becomes effective.
5308 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005309 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310
5311 *'keymodel'* *'km'*
5312'keymodel' 'km' string (default "")
5313 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005314 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 can do. These values can be used:
5316 startsel Using a shifted special key starts selection (either
5317 Select mode or Visual mode, depending on "key" being
5318 present in 'selectmode').
5319 stopsel Using a not-shifted special key stops selection.
5320 Special keys in this context are the cursor keys, <End>, <Home>,
5321 <PageUp> and <PageDown>.
5322 The 'keymodel' option is set by the |:behave| command.
5323
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005324 *'keyprotocol'* *'kpc'*
5325'keyprotocol' 'kpc' string (default: see below)
5326 global
5327 Specifies what keyboard protocol to use depending on the value of
5328 'term'. The supported keyboard protocols names are:
5329 none whatever the terminal uses
5330 mok2 modifyOtherKeys level 2, as supported by xterm
5331 kitty Kitty keyboard protocol, as supported by Kitty
5332
Bram Moolenaara87749e2022-11-30 10:23:17 +00005333 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005334 a pattern that is matched against the 'term' option, a colon and the
5335 protocol name to be used. To illustrate this, the default value would
5336 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005337 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5338 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005339
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005340< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005341 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5342 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005343
5344 The first match is used, thus if you want to have "kitty" use the
5345 kitty protocol, but "badkitty" not, then you should match "badkitty"
5346 first and use the "none" value: >
5347 set keyprotocol=badkitty:none,kitty:kitty
5348<
5349 The option is used after 'term' has been changed. First the termcap
5350 entries are set, possibly using the builtin list, see |builtin-terms|.
5351 Then this option is inspected and if there is a match and a protocol
5352 is specified the following happens:
5353 none Nothing, the regular t_TE and t_TI values remain
5354
5355 mok2 The t_TE value is changed to:
5356 CSI >4;m disables modifyOtherKeys
5357 The t_TI value is changed to:
5358 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005359 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005360
5361 kitty The t_TE value is changed to:
5362 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005363 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005364 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005365 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005366 CSI ?u request kitty keyboard protocol state
5367 CSI >c request the termresponse
5368
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005369 If you notice problems, such as characters being displayed that
5370 disappear after `CTRL-L`, you might want to try making this option
5371 empty. Then set the 'term' option to have it take effect: >
5372 set keyprotocol=
5373 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005374<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005375
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 *'keywordprg'* *'kp'*
5377'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005378 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 Program to use for the |K| command. Environment variables are
5381 expanded |:set_env|. ":help" may be used to access the Vim internal
5382 help. (Note that previously setting the global option to the empty
5383 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005384 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005385 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005386 When "man", "man -s" or an Ex command is used, Vim will automatically
5387 translate a count for the "K" command and pass it as the first
5388 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 See |option-backslash| about including spaces and backslashes.
5390 Example: >
5391 :set keywordprg=man\ -s
5392< This option cannot be set from a |modeline| or in the |sandbox|, for
5393 security reasons.
5394
5395 *'langmap'* *'lmap'* *E357* *E358*
5396'langmap' 'lmap' string (default "")
5397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 {only available when compiled with the |+langmap|
5399 feature}
5400 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005401 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005402 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 care of translating these special characters to the original meaning
5404 of the key. This means you don't have to change the keyboard mode to
5405 be able to execute Normal mode commands.
5406 This is the opposite of the 'keymap' option, where characters are
5407 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005408 Also consider setting 'langremap' to off, to prevent 'langmap' from
5409 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005410 This option cannot be set from a |modeline| or in the |sandbox|, for
5411 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005413 Example (for Greek, in UTF-8): *greek* >
5414 :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 +00005415< Example (exchanges meaning of z and y for commands): >
5416 :set langmap=zy,yz,ZY,YZ
5417<
5418 The 'langmap' option is a list of parts, separated with commas. Each
5419 part can be in one of two forms:
5420 1. A list of pairs. Each pair is a "from" character immediately
5421 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005422 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 characters. Example: "abc;ABC"
5424 Example: "aA,fgh;FGH,cCdDeE"
5425 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005426 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427
5428 This will allow you to activate vim actions without having to switch
5429 back and forth between the languages. Your language characters will
5430 be understood as normal vim English characters (according to the
5431 langmap mappings) in the following cases:
5432 o Normal/Visual mode (commands, buffer/register names, user mappings)
5433 o Insert/Replace Mode: Register names after CTRL-R
5434 o Insert/Replace Mode: Mappings
5435 Characters entered in Command-line mode will NOT be affected by
5436 this option. Note that this option can be changed at any time
5437 allowing to switch between mappings for different languages/encodings.
5438 Use a mapping to avoid having to type it each time!
5439
5440 *'langmenu'* *'lm'*
5441'langmenu' 'lm' string (default "")
5442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 {only available when compiled with the |+menu| and
5444 |+multi_lang| features}
5445 Language to use for menu translation. Tells which file is loaded
5446 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005447 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448< (without the spaces). For example, to always use the Dutch menus, no
5449 matter what $LANG is set to: >
5450 :set langmenu=nl_NL.ISO_8859-1
5451< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005452 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 If your $LANG is set to a non-English language but you do want to use
5454 the English menus: >
5455 :set langmenu=none
5456< This option must be set before loading menus, switching on filetype
5457 detection or syntax highlighting. Once the menus are defined setting
5458 this option has no effect. But you could do this: >
5459 :source $VIMRUNTIME/delmenu.vim
5460 :set langmenu=de_DE.ISO_8859-1
5461 :source $VIMRUNTIME/menu.vim
5462< Warning: This deletes all menus that you defined yourself!
5463
Bram Moolenaard94464e2015-11-02 15:28:18 +01005464 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005465'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005466 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005467 {only available when compiled with the |+langmap|
5468 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005469 This is just like 'langremap' but with the value inverted. It only
5470 exists for backwards compatibility. When setting 'langremap' then
5471 'langnoremap' is set to the inverted value, and the other way around.
5472
5473 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005474'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005475 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005476 {only available when compiled with the |+langmap|
5477 feature}
5478 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005479 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005480 'langmap' disables some of your mappings, try resetting this option.
5481 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005482 that works for you to avoid mappings to break.
5483
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 *'laststatus'* *'ls'*
5485'laststatus' 'ls' number (default 1)
5486 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 The value of this option influences when the last window will have a
5488 status line:
5489 0: never
5490 1: only if there are at least two windows
5491 2: always
5492 The screen looks nicer with a status line if you have several
5493 windows, but it takes another screen line. |status-line|
5494
5495 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5496'lazyredraw' 'lz' boolean (default off)
5497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 When this option is set, the screen will not be redrawn while
5499 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005500 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005502 This may occasionally cause display errors. It is only meant to be set
5503 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005504 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505
64-bitman88d41ab2025-04-06 17:20:39 +02005506 *'lhistory'* *'lhi'*
5507'lhistory' 'lhi' number (default: 10)
5508 local to window
5509 {only available when compiled with the |+quickfix|
5510 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005511 Like 'chistory', but for the location list stack associated with a
5512 window. If the option is changed in either the location list window
5513 itself or the window that is associated with the location list stack,
5514 the new value will also be applied to the other one. This means this
5515 value will always be the same for a given location list window and its
5516 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005517
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5519'linebreak' 'lbr' boolean (default off)
5520 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005521 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005523 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 than at the last character that fits on the screen. Unlike
5525 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005526 it only affects the way the file is displayed, not its contents.
5527 If 'breakindent' is set, line is visually indented. Then, the value
5528 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005529 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 Note that <Tab> characters after an <EOL> are mostly not displayed
5531 with the right amount of white space.
5532
5533 *'lines'* *E593*
5534'lines' number (default 24 or terminal height)
5535 global
5536 Number of lines of the Vim window.
5537 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005538 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 When Vim is running in the GUI or in a resizable window, setting this
5540 option will cause the window size to be changed. When you only want
5541 to use the size for the GUI, put the command in your |gvimrc| file.
5542 Vim limits the number of lines to what fits on the screen. You can
5543 use this command to get the tallest window possible: >
5544 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005545< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005546 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 When you set this option and Vim is unable to change the physical
5548 number of lines of the display, the display may be messed up.
5549
5550 *'linespace'* *'lsp'*
5551'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 {only in the GUI}
5554 Number of pixel lines inserted between characters. Useful if the font
5555 uses the full character cell height, making lines touch each other.
5556 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005557 With some fonts there can be too much room between lines (to have
5558 space for ascents and descents). Then it makes sense to set
5559 'linespace' to a negative value. This may cause display problems
5560 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561
5562 *'lisp'* *'nolisp'*
5563'lisp' boolean (default off)
5564 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 Lisp mode: When <Enter> is typed in insert mode set the indent for
5566 the next line to Lisp standards (well, sort of). Also happens with
5567 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5568 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5569 better. Also see 'lispwords'.
5570 The '-' character is included in keyword characters. Redefines the
5571 "=" operator to use this same indentation algorithm rather than
5572 calling an external program if 'equalprg' is empty.
5573 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005575 *'lispoptions'* *'lop'*
5576'lispoptions' 'lop' string (default "")
5577 local to buffer
5578 Comma-separated list of items that influence the Lisp indenting when
5579 enabled with the |'lisp'| option. Currently only one item is
5580 supported:
5581 expr:1 use 'indentexpr' for Lisp indenting when it is set
5582 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5583 Note that when using 'indentexpr' the `=` operator indents all the
5584 lines, otherwise the first line is not indented (Vi-compatible).
5585
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 *'lispwords'* *'lw'*
5587'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005588 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005589 Comma-separated list of words that influence the Lisp indenting when
5590 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591
5592 *'list'* *'nolist'*
5593'list' boolean (default off)
5594 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005595 List mode: By default show tabs as CTRL-I is displayed, display $
5596 after end of line. Useful to see the difference between tabs and
5597 spaces and for trailing blanks. Further changed by the 'listchars'
5598 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005599
5600 The cursor is displayed at the start of the space a Tab character
5601 occupies, not at the end as usual in Normal mode. To get this cursor
5602 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005603 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005604<
5605 Note that list mode will also affect formatting (set with 'textwidth'
5606 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 changing the way tabs are displayed.
5608
5609 *'listchars'* *'lcs'*
5610'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005611 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005612 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005613 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005614 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 eol:c Character to show at the end of each line. When
5616 omitted, there is no extra character at the end of the
5617 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005618 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005619 tab:xy[z] Two or three characters to be used to show a tab.
5620 The third character is optional.
5621
5622 tab:xy The 'x' is always used, then 'y' as many times as will
5623 fit. Thus "tab:>-" displays:
5624 >
5625 >-
5626 >--
5627 etc.
5628
5629 tab:xyz The 'z' is always used, then 'x' is prepended, and
5630 then 'y' is used as many times as will fit. Thus
5631 "tab:<->" displays:
5632 >
5633 <>
5634 <->
5635 <-->
5636 etc.
5637
5638 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005639 *lcs-space*
5640 space:c Character to show for a space. When omitted, spaces
5641 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005642 *lcs-multispace*
5643 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005644 One or more characters to use cyclically to show for
5645 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005646 setting, except for single spaces. When omitted, the
5647 "space" setting is used. For example,
5648 `:set listchars=multispace:---+` shows ten consecutive
5649 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005650 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005651 *lcs-lead*
5652 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005653 leading spaces are blank. Overrides the "space" and
5654 "multispace" settings for leading spaces. You can
5655 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005656 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005657< *lcs-leadmultispace*
5658 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005659 Like the |lcs-multispace| value, but for leading
5660 spaces only. Also overrides |lcs-lead| for leading
5661 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005662 `:set listchars=leadmultispace:---+` shows ten
5663 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005664 ---+---+--XXX ~
5665 Where "XXX" denotes the first non-blank characters in
5666 the line.
5667 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005668 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005669 trailing spaces are blank. Overrides the "space" and
5670 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005671 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 extends:c Character to show in the last column, when 'wrap' is
5673 off and the line continues beyond the right of the
5674 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005675 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005676 precedes:c Character to show in the first visible column of the
5677 physical line, when there is text preceding the
5678 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005679 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005680 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005681 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005682 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005683 nbsp:c Character to show for a non-breakable space character
5684 (0xA0 (160 decimal) and U+202F). Left blank when
5685 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005689 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005691 Each character can be specified as hex: >
5692 set listchars=eol:\\x24
5693 set listchars=eol:\\u21b5
5694 set listchars=eol:\\U000021b5
5695< Note that a double backslash is used. The number of hex characters
5696 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 Examples: >
5699 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005700 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 :set lcs=extends:>,precedes:<
5702< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005703 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5704 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005705 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706
5707 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5708'loadplugins' 'lpl' boolean (default on)
5709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 When on the plugin scripts are loaded when starting up |load-plugins|.
5711 This option can be reset in your |vimrc| file to disable the loading
5712 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005713 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5714 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715
Bram Moolenaard94464e2015-11-02 15:28:18 +01005716 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005717'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005718 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005719 {only available when compiled with the |+lua/dyn|
5720 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005721 Specifies the name of the Lua shared library. The default is
5722 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005723 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005724 This option cannot be set from a |modeline| or in the |sandbox|, for
5725 security reasons.
5726
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005727 *'macatsui'* *'nomacatsui'*
5728'macatsui' boolean (default on)
5729 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005730 {not supported}
5731 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005732
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 *'magic'* *'nomagic'*
5734'magic' boolean (default on)
5735 global
5736 Changes the special characters that can be used in search patterns.
5737 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005738 WARNING: Switching this option off most likely breaks plugins! That
5739 is because many patterns assume it's on and will fail when it's off.
5740 Only switch it off when working with old Vi scripts. In any other
5741 situation write patterns that work when 'magic' is on. Include "\M"
5742 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005743 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5744 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745
5746 *'makeef'* *'mef'*
5747'makeef' 'mef' string (default: "")
5748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 {not available when compiled without the |+quickfix|
5750 feature}
5751 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5752 and the |:grep| command.
5753 When it is empty, an internally generated temp file will be used.
5754 When "##" is included, it is replaced by a number to make the name
5755 unique. This makes sure that the ":make" command doesn't overwrite an
5756 existing file.
5757 NOT used for the ":cf" command. See 'errorfile' for that.
5758 Environment variables are expanded |:set_env|.
5759 See |option-backslash| about including spaces and backslashes.
5760 This option cannot be set from a |modeline| or in the |sandbox|, for
5761 security reasons.
5762
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005763 *'makeencoding'* *'menc'*
5764'makeencoding' 'menc' string (default "")
5765 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005766 Encoding used for reading the output of external commands. When empty,
5767 encoding is not converted.
5768 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5769 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5770 and `:laddfile`.
5771
5772 This would be mostly useful when you use MS-Windows and set 'encoding'
5773 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5774 'makeencoding' to "char" has the same effect as setting to the system
5775 locale encoding. Example: >
5776 :set encoding=utf-8
5777 :set makeencoding=char " system locale is used
5778<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 *'makeprg'* *'mp'*
5780'makeprg' 'mp' string (default "make", VMS: "MMS")
5781 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005782 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005783 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5784 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005785 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005786 Environment variables are expanded |:set_env|. See |option-backslash|
5787 about including spaces and backslashes.
5788 Note that a '|' must be escaped twice: once for ":set" and once for
5789 the interpretation of a command. When you use a filter called
5790 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 :set makeprg=gmake\ \\\|\ myfilter
5792< The placeholder "$*" can be given (even multiple times) to specify
5793 where the arguments will be included, for example: >
5794 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5795< This option cannot be set from a |modeline| or in the |sandbox|, for
5796 security reasons.
5797
5798 *'matchpairs'* *'mps'*
5799'matchpairs' 'mps' string (default "(:),{:},[:]")
5800 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005802 other.
5803 Only character pairs are allowed that are different, thus you cannot
5804 jump between two double quotes.
5805 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005806 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005807 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 :set mps+=<:>
5809
5810< A more exotic example, to jump between the '=' and ';' in an
5811 assignment, useful for languages like C and Java: >
5812 :au FileType c,cpp,java set mps+==:;
5813
5814< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005815 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816
5817 *'matchtime'* *'mat'*
5818'matchtime' 'mat' number (default 5)
5819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 Tenths of a second to show the matching paren, when 'showmatch' is
5821 set. Note that this is not in milliseconds, like other options that
5822 set a time. This is to be compatible with Nvi.
5823
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005824 *'maxcombine'* *'mco'*
5825'maxcombine' 'mco' number (default 2)
5826 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005827 The maximum number of combining characters supported for displaying.
5828 Only used when 'encoding' is "utf-8".
5829 The default is OK for most languages. Hebrew may require 4.
5830 Maximum value is 6.
5831 Even when this option is set to 2 you can still edit text with more
5832 combining characters, you just can't see them. Use |g8| or |ga|.
Christian Brabandt6b2c1ad2025-05-30 17:43:42 +02005833 When set to 0, you will not be able to see any combining characters.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005834 See |mbyte-combining|.
5835
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 *'maxfuncdepth'* *'mfd'*
5837'maxfuncdepth' 'mfd' number (default 100)
5838 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005839 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005840 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 Maximum depth of function calls for user functions. This normally
5842 catches endless recursion. When using a recursive function with
5843 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5844 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005845 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005846 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005848 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849
5850 *'maxmapdepth'* *'mmd'* *E223*
5851'maxmapdepth' 'mmd' number (default 1000)
5852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 Maximum number of times a mapping is done without resulting in a
5854 character to be used. This normally catches endless mappings, like
5855 ":map x y" with ":map y x". It still does not catch ":map g wg",
5856 because the 'w' is used before the next mapping is done. See also
5857 |key-mapping|.
5858
5859 *'maxmem'* *'mm'*
5860'maxmem' 'mm' number (default between 256 to 5120 (system
5861 dependent) or half the amount of memory
5862 available)
5863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5865 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005866 other memory to be freed.
5867 The maximum usable value is about 2000000. Use this to work without a
5868 limit.
5869 The value is ignored when 'swapfile' is off.
5870 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005872 *'maxmempattern'* *'mmp'*
5873'maxmempattern' 'mmp' number (default 1000)
5874 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005875 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005876 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005877 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005878 When Vim runs into the limit it gives an error message and mostly
5879 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005880 Running into the limit often means that the pattern is very
5881 inefficient or too complex. This may already happen with the pattern
5882 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005883 Might also happen on redraw, when syntax rules try to match a complex
5884 text structure.
5885 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5886 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005887
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 *'maxmemtot'* *'mmt'*
5889'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5890 dependent) or half the amount of memory
5891 available)
5892 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005893 Maximum amount of memory in Kbyte to use for all buffers together.
5894 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005895 without a limit.
5896 On 64 bit machines higher values might work. But hey, do you really
5897 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005898 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005899 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005900 Buffers with 'swapfile' off still count to the total amount of memory
5901 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005902 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903
5904 *'menuitems'* *'mis'*
5905'menuitems' 'mis' number (default 25)
5906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 {not available when compiled without the |+menu|
5908 feature}
5909 Maximum number of items to use in a menu. Used for menus that are
5910 generated from a list of items, e.g., the Buffers menu. Changing this
5911 option has no direct effect, the menu must be refreshed first.
5912
Christian Brabandt51d4d842024-12-06 17:26:25 +01005913 *'messagesopt'* *'mopt'*
5914'messagesopt' 'mopt' string (default "hit-enter,history:500")
5915 global
5916
zeertzjq8cc43da2024-12-07 16:09:08 +01005917 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005918 following items. Items must be separated by a comma.
5919
zeertzjq8cc43da2024-12-07 16:09:08 +01005920 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005921 'cmdheight' size.
5922
zeertzjq8cc43da2024-12-07 16:09:08 +01005923 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5924 {n} milliseconds so that the user has a chance to read
5925 the message. The maximum value of {n} is 10000. Use
5926 0 to disable the wait (but then the user may miss an
5927 important message).
5928 This item is ignored when "hit-enter" is present, but
5929 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005930
5931 history:{n} Determines how many entries are remembered in the
5932 |:messages| history. The maximum value is 10000.
5933 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005934 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005935
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005936 *'mkspellmem'* *'msm'*
5937'mkspellmem' 'msm' string (default "460000,2000,500")
5938 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005939 {not available when compiled without the |+syntax|
5940 feature}
5941 Parameters for |:mkspell|. This tunes when to start compressing the
5942 word tree. Compression can be slow when there are many words, but
5943 it's needed to avoid running out of memory. The amount of memory used
5944 per word depends very much on how similar the words are, that's why
5945 this tuning is complicated.
5946
5947 There are three numbers, separated by commas:
5948 {start},{inc},{added}
5949
5950 For most languages the uncompressed word tree fits in memory. {start}
5951 gives the amount of memory in Kbyte that can be used before any
5952 compression is done. It should be a bit smaller than the amount of
5953 memory that is available to Vim.
5954
5955 When going over the {start} limit the {inc} number specifies the
5956 amount of memory in Kbyte that can be allocated before another
5957 compression is done. A low number means compression is done after
5958 less words are added, which is slow. A high number means more memory
5959 will be allocated.
5960
5961 After doing compression, {added} times 1024 words can be added before
5962 the {inc} limit is ignored and compression is done when any extra
5963 amount of memory is needed. A low number means there is a smaller
5964 chance of hitting the {inc} limit, less memory is used but it's
5965 slower.
5966
5967 The languages for which these numbers are important are Italian and
5968 Hungarian. The default works for when you have about 512 Mbyte. If
5969 you have 1 Gbyte you could use: >
5970 :set mkspellmem=900000,3000,800
5971< If you have less than 512 Mbyte |:mkspell| may fail for some
5972 languages, no matter what you set 'mkspellmem' to.
5973
dkearns8ebdbc92023-10-29 06:26:19 +11005974 This option cannot be set from a |modeline| or in the |sandbox|, for
5975 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005976
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005978'modeline' 'ml' boolean (Vim default: on (off for root),
5979 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005981 If 'modeline' is on 'modelines' gives the number of lines that is
5982 checked for set commands. If 'modeline' is off or 'modelines' is zero
5983 no lines are checked. See |modeline|.
5984
5985 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5986'modelineexpr' 'mle' boolean (default: off)
5987 global
5988 When on allow some options that are an expression to be set in the
5989 modeline. Check the option for whether it is affected by
5990 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005991 This option cannot be set from a |modeline| or in the |sandbox|, for
5992 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005993
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 *'modelines'* *'mls'*
5995'modelines' 'mls' number (default 5)
5996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 If 'modeline' is on 'modelines' gives the number of lines that is
5998 checked for set commands. If 'modeline' is off or 'modelines' is zero
5999 no lines are checked. See |modeline|.
6000 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
6001 set and to the Vim default value when 'compatible' is reset.
6002
6003 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02006004 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005'modifiable' 'ma' boolean (default on)
6006 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 When off the buffer contents cannot be changed. The 'fileformat' and
6008 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006009 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010
6011 *'modified'* *'mod'* *'nomodified'* *'nomod'*
6012'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006013 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 When on, the buffer is considered to be modified. This option is set
6015 when:
6016 1. A change was made to the text since it was last written. Using the
6017 |undo| command to go back to the original text will reset the
6018 option. But undoing changes that were made before writing the
6019 buffer will set the option again, since the text is different from
6020 when it was written.
6021 2. 'fileformat' or 'fileencoding' is different from its original
6022 value. The original value is set when the buffer is read or
6023 written. A ":set nomodified" command also resets the original
6024 values to the current values and the 'modified' option will be
6025 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01006026 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006027 This option is not set when a change is made to the buffer as the
6028 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
6029 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
6030 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 When 'buftype' is "nowrite" or "nofile" this option may be set, but
6032 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006033 Note that the text may actually be the same, e.g. 'modified' is set
6034 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035
6036 *'more'* *'nomore'*
6037'more' boolean (Vim default: on, Vi default: off)
6038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 When on, listings pause when the whole screen is filled. You will get
6040 the |more-prompt|. When this option is off there are no pauses, the
6041 listing continues until finished.
6042 NOTE: This option is set to the Vi default value when 'compatible' is
6043 set and to the Vim default value when 'compatible' is reset.
6044
Bram Moolenaar98a29d02021-01-18 19:55:44 +01006045 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006046'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01006047 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006049 Enable the use of the mouse. Works for most terminals (xterm, Win32
6050 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
6051 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
6052 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01006053 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 v Visual mode
6055 i Insert mode
6056 c Command-line mode
6057 h all previous modes when editing a help file
6058 a all previous modes
6059 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006060 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01006062< If your terminal can't overrule the mouse events going to the
6063 application, use: >
6064 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02006065< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01006066 back to Vim using the mouse events.
6067 In |defaults.vim| "nvi" is used if the 'term' option is not matching
6068 "xterm".
6069
6070 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 modeless selection. This doesn't move the text cursor.
6072
6073 See |mouse-using|. Also see |'clipboard'|.
6074
6075 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006076 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 the mouse buttons can still be used by keeping the shift key pressed.
6078 Also see the 'clipboard' option.
6079
6080 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
6081'mousefocus' 'mousef' boolean (default off)
6082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 {only works in the GUI}
6084 The window that the mouse pointer is on is automatically activated.
6085 When changing the window layout or window focus in another way, the
6086 mouse pointer is moved to the window with keyboard focus. Off is the
6087 default because it makes using the pull down menus a little goofy, as
6088 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006089 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01006090 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091
6092 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
6093'mousehide' 'mh' boolean (default on)
6094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 {only works in the GUI}
6096 When on, the mouse pointer is hidden when characters are typed.
6097 The mouse pointer is restored when the mouse is moved.
6098
6099 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006100'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 Sets the model to use for the mouse. The name mostly specifies what
6103 the right mouse button is used for:
6104 extend Right mouse button extends a selection. This works
6105 like in an xterm.
6106 popup Right mouse button pops up a menu. The shifted left
6107 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00006108 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 popup_setpos Like "popup", but the cursor will be moved to the
6110 position where the mouse was clicked, and thus the
6111 selected operation will act upon the clicked object.
6112 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00006113 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 course, that right clicking outside a selection will
6115 end Visual mode.
6116 Overview of what button does what for each model:
6117 mouse extend popup(_setpos) ~
6118 left click place cursor place cursor
6119 left drag start selection start selection
6120 shift-left search word extend selection
6121 right click extend selection popup menu (place cursor)
6122 right drag extend selection -
6123 middle click paste paste
6124
6125 In the "popup" model the right mouse button produces a pop-up menu.
6126 You need to define this first, see |popup-menu|.
6127
6128 Note that you can further refine the meaning of buttons with mappings.
6129 See |gui-mouse-mapping|. But mappings are NOT used for modeless
6130 selection (because that's handled in the GUI code directly).
6131
6132 The 'mousemodel' option is set by the |:behave| command.
6133
h_east59858792023-10-25 22:47:05 +09006134 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01006135'mousemoveevent' 'mousemev' boolean (default off)
6136 global
6137 {only works in the GUI}
6138 When on, mouse move events are delivered to the input queue and are
6139 available for mapping. The default, off, avoids the mouse movement
6140 overhead except when needed. See |gui-mouse-mapping|.
6141 Warning: Setting this option can make pending mappings to be aborted
6142 when the mouse is moved.
6143 Currently only works in the GUI, may be made to work in a terminal
6144 later.
6145
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006147'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6148 vs:leftright,vd:lrsizing,m:no,
6149 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 {only available when compiled with the |+mouseshape|
6152 feature}
6153 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006154 different modes. The option is a comma-separated list of parts, much
Drew Vogel48b19b22025-05-07 21:32:03 +02006155 like used for 'guicursor'. Each part consists of a mode/location-list
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 and an argument-list:
6157 mode-list:shape,mode-list:shape,..
6158 The mode-list is a dash separated list of these modes/locations:
6159 In a normal window: ~
6160 n Normal mode
6161 v Visual mode
6162 ve Visual mode with 'selection' "exclusive" (same as 'v',
6163 if not specified)
6164 o Operator-pending mode
6165 i Insert mode
6166 r Replace mode
6167
6168 Others: ~
6169 c appending to the command-line
6170 ci inserting in the command-line
6171 cr replacing in the command-line
6172 m at the 'Hit ENTER' or 'More' prompts
6173 ml idem, but cursor in the last line
6174 e any mode, pointer below last window
6175 s any mode, pointer on a status line
6176 sd any mode, while dragging a status line
6177 vs any mode, pointer on a vertical separator line
6178 vd any mode, while dragging a vertical separator line
6179 a everywhere
6180
6181 The shape is one of the following:
6182 avail name looks like ~
Drew Vogel48b19b22025-05-07 21:32:03 +02006183 w x g arrow Normal mouse pointer
6184 w x blank no pointer at all (use with care!)
6185 w x g beam I-beam
6186 w x g updown up-down sizing arrows
6187 w x g leftright left-right sizing arrows
6188 w x g busy The system's usual busy pointer
6189 w x g no The system's usual 'no input' pointer
6190 x g udsizing indicates up-down resizing
6191 x g lrsizing indicates left-right resizing
6192 x g crosshair like a big thin +
6193 x g hand1 black hand
6194 x g hand2 white hand
6195 x pencil what you write with
6196 x g question big ?
6197 x rightup-arrow arrow pointing right-up
6198 w x up-arrow arrow pointing up
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 x <number> any X11 pointer number (see X11/cursorfont.h)
6200
6201 The "avail" column contains a 'w' if the shape is available for Win32,
Drew Vogel48b19b22025-05-07 21:32:03 +02006202 x for X11 (including GTK+ 2), g for GTK+ 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 Any modes not specified or shapes not available use the normal mouse
6204 pointer.
6205
6206 Example: >
6207 :set mouseshape=s:udsizing,m:no
6208< will make the mouse turn to a sizing arrow over the status lines and
6209 indicate no input when the hit-enter prompt is displayed (since
6210 clicking the mouse has no effect in this state.)
6211
6212 *'mousetime'* *'mouset'*
6213'mousetime' 'mouset' number (default 500)
6214 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006215 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 time in msec between two mouse clicks for the second click to be
6217 recognized as a multi click.
6218
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006219
laburnumT3f7855a2023-12-05 18:37:03 +01006220 *'mzquantum'* *'mzq'*
6221'mzquantum' 'mzq' number (default 100)
6222 global
6223 {not available when compiled without the |+mzscheme|
6224 feature}
6225 The number of milliseconds between polls for MzScheme threads.
6226 Negative or zero value means no thread scheduling.
6227 NOTE: This option is set to the Vim default value when 'compatible'
6228 is reset.
6229
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006230 *'mzschemedll'*
6231'mzschemedll' string (default depends on the build)
6232 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006233 {only available when compiled with the |+mzscheme/dyn|
6234 feature}
6235 Specifies the name of the MzScheme shared library. The default is
6236 DYNAMIC_MZSCH_DLL which was specified at compile time.
6237 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006238 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006239 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006240 This option cannot be set from a |modeline| or in the |sandbox|, for
6241 security reasons.
6242
6243 *'mzschemegcdll'*
6244'mzschemegcdll' string (default depends on the build)
6245 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006246 {only available when compiled with the |+mzscheme/dyn|
6247 feature}
6248 Specifies the name of the MzScheme GC shared library. The default is
6249 DYNAMIC_MZGC_DLL which was specified at compile time.
6250 The value can be equal to 'mzschemedll' if it includes the GC code.
6251 Environment variables are expanded |:set_env|.
6252 This option cannot be set from a |modeline| or in the |sandbox|, for
6253 security reasons.
6254
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006256'nrformats' 'nf' string (default "bin,octal,hex",
6257 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 This defines what bases Vim will consider for numbers when using the
6260 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6261 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006262 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006264 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006265 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006267 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 considered to be hexadecimal. Example: Using CTRL-X on
6269 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006270 bin If included, numbers starting with "0b" or "0B" will be
6271 considered to be binary. Example: Using CTRL-X on
6272 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006273 unsigned If included, numbers are recognized as unsigned. Thus a
6274 leading dash or negative sign won't be considered as part of
6275 the number. Examples:
6276 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6277 (without "unsigned" it would become "9-2021").
6278 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6279 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006280 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6281 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006282 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006283 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006284 dash immediately preceded by a non-whitespace character (i.e.,
6285 not a tab or a " "), the negative sign won't be considered as
6286 part of the number. For example:
6287 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6288 (without "blank" it would become "Carbon-13").
6289 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006290 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006291 set, it would result in "Carbon -7").
6292 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006293 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006294 included, "unsigned" will take precedence.
6295
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 Numbers which simply begin with a digit in the range 1-9 are always
6297 considered decimal. This also happens for numbers that are not
6298 recognized as octal or hex.
6299
6300 *'number'* *'nu'* *'nonumber'* *'nonu'*
6301'number' 'nu' boolean (default off)
6302 local to window
6303 Print the line number in front of each line. When the 'n' option is
6304 excluded from 'cpoptions' a wrapped line will not use the column of
6305 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006306 The 'numberwidth' option can be used to set the room used for the line
6307 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 When a long, wrapped line doesn't start with the first character, '-'
6309 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006310 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6311 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006312 *number_relativenumber*
6313 The 'relativenumber' option changes the displayed number to be
6314 relative to the cursor. Together with 'number' there are these
6315 four combinations (cursor in line 3):
6316
Bram Moolenaar3848e002016-03-19 18:42:29 +01006317 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006318 'nornu' 'nornu' 'rnu' 'rnu'
6319
6320 |apple | 1 apple | 2 apple | 2 apple
6321 |pear | 2 pear | 1 pear | 1 pear
6322 |nobody | 3 nobody | 0 nobody |3 nobody
6323 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006325 *'numberwidth'* *'nuw'*
6326'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6327 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006328 {only available when compiled with the |+linebreak|
6329 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006330 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006331 when the 'number' or 'relativenumber' option is set or printing lines
6332 with a line number. Since one space is always between the number and
6333 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006334 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006335 fit the highest line number in the buffer respectively the number of
6336 rows in the window, depending on whether 'number' or 'relativenumber'
6337 is set. Thus with the Vim default of 4 there is room for a line number
6338 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006339 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006340 NOTE: This option is set to the Vi default value when 'compatible' is
6341 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006342
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006343 *'omnifunc'* *'ofu'*
6344'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006345 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006346 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006347 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006348 This option specifies a function to be used for Insert mode omni
6349 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006350 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006351 invoked and what it should return. The value can be the name of a
6352 function, a |lambda| or a |Funcref|. See |option-value-function| for
6353 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006354 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006355 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006356 This option cannot be set from a |modeline| or in the |sandbox|, for
6357 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006358
Bram Moolenaar02467872007-05-06 13:22:01 +00006359 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006360'opendevice' 'odev' boolean (default off)
6361 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006362 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006363 Enable reading and writing from devices. This may get Vim stuck on a
6364 device that can be opened but doesn't actually do the I/O. Therefore
6365 it is off by default.
6366 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6367 result in editing a device.
6368
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006369 *'operatorfunc'* *'opfunc'*
6370'operatorfunc' 'opfunc' string (default: empty)
6371 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006372 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006373 See |:map-operator| for more info and an example. The value can be
6374 the name of a function, a |lambda| or a |Funcref|. See
6375 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006376
6377 This option cannot be set from a |modeline| or in the |sandbox|, for
6378 security reasons.
6379
Bram Moolenaar251e1912011-06-19 05:09:16 +02006380 *'osfiletype'* *'oft'*
6381'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006383 This option was supported on RISC OS, which has been removed.
6384
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006385 *'packpath'* *'pp'*
6386'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006387 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006388 This option cannot be set from a |modeline| or in the |sandbox|, for
6389 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006390
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006392'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 global
6394 Specifies the nroff macros that separate paragraphs. These are pairs
6395 of two letters (see |object-motions|).
6396
6397 *'paste'* *'nopaste'*
6398'paste' boolean (default off)
6399 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006400 Put Vim in Paste mode. This is useful if you want to cut or copy
6401 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 unexpected effects.
6403 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006404 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 knows about pasting and will mostly do the right thing without 'paste'
6406 being set. The same is true for a terminal where Vim handles the
6407 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006408 This option is reset when starting the GUI. Thus if you set it in
6409 your .vimrc it will work in a terminal, but not in the GUI. Setting
6410 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6411 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 When the 'paste' option is switched on (also when it was already on):
6413 - mapping in Insert mode and Command-line mode is disabled
6414 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006416 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006417 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 - 'revins' is reset
6419 - 'ruler' is reset
6420 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006421 - 'smarttab' is reset
6422 - 'softtabstop' is set to 0
6423 - 'textwidth' is set to 0
6424 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006425 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006428 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006429 - 'indentexpr'
6430 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006431 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 NOTE: When you start editing another file while the 'paste' option is
6433 on, settings from the modelines or autocommands may change the
6434 settings again, causing trouble when pasting text. You might want to
6435 set the 'paste' option again.
6436 When the 'paste' option is reset the mentioned options are restored to
6437 the value before the moment 'paste' was switched from off to on.
6438 Resetting 'paste' before ever setting it does not have any effect.
6439 Since mapping doesn't work while 'paste' is active, you need to use
6440 the 'pastetoggle' option to toggle the 'paste' option with some key.
6441
6442 *'pastetoggle'* *'pt'*
6443'pastetoggle' 'pt' string (default "")
6444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 When non-empty, specifies the key sequence that toggles the 'paste'
6446 option. This is like specifying a mapping: >
6447 :map {keys} :set invpaste<CR>
6448< Where {keys} is the value of 'pastetoggle'.
6449 The difference is that it will work even when 'paste' is set.
6450 'pastetoggle' works in Insert mode and Normal mode, but not in
6451 Command-line mode.
6452 Mappings are checked first, thus overrule 'pastetoggle'. However,
6453 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6454 this: >
6455 :map <F10> :set paste<CR>
6456 :map <F11> :set nopaste<CR>
6457 :imap <F10> <C-O>:set paste<CR>
6458 :imap <F11> <nop>
6459 :set pastetoggle=<F11>
6460< This will make <F10> start paste mode and <F11> stop paste mode.
6461 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6462 mode everything is inserted literally, except the 'pastetoggle' key
6463 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006464 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465
6466 *'pex'* *'patchexpr'*
6467'patchexpr' 'pex' string (default "")
6468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 {not available when compiled without the |+diff|
6470 feature}
6471 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006472 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006473 This option cannot be set from a |modeline| or in the |sandbox|, for
6474 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475
Bram Moolenaardbc28022014-07-26 13:40:44 +02006476 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477'patchmode' 'pm' string (default "")
6478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 When non-empty the oldest version of a file is kept. This can be used
6480 to keep the original version of a file if you are changing files in a
6481 source distribution. Only the first time that a file is written a
6482 copy of the original file will be kept. The name of the copy is the
6483 name of the original file with the string in the 'patchmode' option
6484 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006485 ".orig" or ".org". 'backupdir' must not be empty for this to work
6486 (Detail: The backup file is renamed to the patchmode file after the
6487 new file has been successfully written, that's why it must be possible
6488 to write a backup file). If there was no file to be backed up, an
6489 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 When the 'backupskip' pattern matches, a patchmode file is not made.
6491 Using 'patchmode' for compressed files appends the extension at the
6492 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6493 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006494 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006496 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 other systems: ".,,")
6499 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006501 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6502 provided that the file being searched for has a relative path (not
6503 starting with "/", "./" or "../"). The directories in the 'path'
6504 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 - Use commas to separate directory names: >
6506 :set path=.,/usr/local/include,/usr/include
6507< - Spaces can also be used to separate directory names (for backwards
6508 compatibility with version 3.0). To have a space in a directory
6509 name, precede it with an extra backslash, and escape the space: >
6510 :set path=.,/dir/with\\\ space
6511< - To include a comma in a directory name precede it with an extra
6512 backslash: >
6513 :set path=.,/dir/with\\,comma
6514< - To search relative to the directory of the current file, use: >
6515 :set path=.
6516< - To search in the current directory use an empty string between two
6517 commas: >
6518 :set path=,,
6519< - A directory name may end in a ':' or '/'.
6520 - Environment variables are expanded |:set_env|.
6521 - When using |netrw.vim| URLs can be used. For example, adding
6522 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006523 - Search upwards and downwards in a directory tree using "*", "**" and
6524 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 - Careful with '\' characters, type two to get one in the option: >
6526 :set path=.,c:\\include
6527< Or just use '/' instead: >
6528 :set path=.,c:/include
6529< Don't forget "." or files won't even be found in the same directory as
6530 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006531 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 it is something like 256 or 1024 characters.
6533 You can check if all the include files are found, using the value of
6534 'path', see |:checkpath|.
6535 The use of |:set+=| and |:set-=| is preferred when adding or removing
6536 directories from the list. This avoids problems when a future version
6537 uses another default. To remove the current directory use: >
6538 :set path-=
6539< To add the current directory use: >
6540 :set path+=
6541< To use an environment variable, you probably need to replace the
6542 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006543 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006544 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545< Replace the ';' with a ':' or whatever separator is used. Note that
6546 this doesn't work when $INCL contains a comma or white space.
6547
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006548 *'perldll'*
6549'perldll' string (default depends on the build)
6550 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006551 {only available when compiled with the |+perl/dyn|
6552 feature}
6553 Specifies the name of the Perl shared library. The default is
6554 DYNAMIC_PERL_DLL, which was specified at compile time.
6555 Environment variables are expanded |:set_env|.
6556 This option cannot be set from a |modeline| or in the |sandbox|, for
6557 security reasons.
6558
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6560'preserveindent' 'pi' boolean (default off)
6561 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 When changing the indent of the current line, preserve as much of the
6563 indent structure as possible. Normally the indent is replaced by a
6564 series of tabs followed by spaces as required (unless |'expandtab'| is
6565 enabled, in which case only spaces are used). Enabling this option
6566 means the indent will preserve as many existing characters as possible
6567 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006568 'expandtab' does not apply to the preserved white space, a Tab remains
6569 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 NOTE: When using ">>" multiple times the resulting indent is a mix of
6571 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006572 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 Also see 'copyindent'.
6574 Use |:retab| to clean up white space.
6575
6576 *'previewheight'* *'pvh'*
6577'previewheight' 'pvh' number (default 12)
6578 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006579 {not available when compiled without the |+quickfix|
6580 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006582 commands. Used for |CTRL-W_}| when no count is given. Not used when
6583 'previewpopup' is set.
6584
6585 *'previewpopup'* *'pvp'*
6586'previewpopup' 'pvp' string (default empty)
6587 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006588 {not available when compiled without the |+textprop|
6589 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006590 When not empty a popup window is used for commands that would open a
6591 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006592 Not used for the insert completion info, add "popup" to
6593 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594
6595 *'previewwindow'* *'nopreviewwindow'*
6596 *'pvw'* *'nopvw'* *E590*
6597'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006598 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006599 {not available when compiled without the |+quickfix|
6600 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006601 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 set. It's normally not set directly, but by using one of the commands
6603 |:ptag|, |:pedit|, etc.
6604
6605 *'printdevice'* *'pdev'*
6606'printdevice' 'pdev' string (default empty)
6607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 {only available when compiled with the |+printer|
6609 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006610 The name of the printer to be used for |:hardcopy|.
6611 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006612 This option cannot be set from a |modeline| or in the |sandbox|, for
6613 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614
Bram Moolenaar8299df92004-07-10 09:47:34 +00006615 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006616'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 {only available when compiled with the |+printer|
6619 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006620 Sets the character encoding used when printing.
6621 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622
6623 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006624'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 {only available when compiled with the |+printer|
6627 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006628 Expression used to print the PostScript produced with |:hardcopy|.
6629 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006630 This option cannot be set from a |modeline| or in the |sandbox|, for
6631 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632
Bram Moolenaar8299df92004-07-10 09:47:34 +00006633 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634'printfont' 'pfn' string (default "courier")
6635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 {only available when compiled with the |+printer|
6637 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006638 The name of the font that will be used for |:hardcopy|.
6639 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640
6641 *'printheader'* *'pheader'*
6642'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 {only available when compiled with the |+printer|
6645 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006646 The format of the header produced in |:hardcopy| output.
6647 See |pheader-option|.
6648
6649 *'printmbcharset'* *'pmbcs'*
6650'printmbcharset' 'pmbcs' string (default "")
6651 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006652 {only available when compiled with the |+printer|
6653 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006654 The CJK character set to be used for CJK output from |:hardcopy|.
6655 See |pmbcs-option|.
6656
6657 *'printmbfont'* *'pmbfn'*
6658'printmbfont' 'pmbfn' string (default "")
6659 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006660 {only available when compiled with the |+printer|
6661 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006662 List of font names to be used for CJK output from |:hardcopy|.
6663 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664
6665 *'printoptions'* *'popt'*
6666'printoptions' 'popt' string (default "")
6667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006669 List of items that control the format of the output of |:hardcopy|.
6670 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006672 *'prompt'* *'noprompt'*
6673'prompt' boolean (default on)
6674 global
6675 When on a ":" prompt is used in Ex mode.
6676
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006677 *'pumheight'* *'ph'*
6678'pumheight' 'ph' number (default 0)
6679 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006680 Determines the maximum number of items to show in the popup menu for
6681 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006682 |ins-completion-menu|.
6683
glepnir88d75932025-03-27 20:09:07 +01006684 *'pummaxwidth'* *'pmw'*
6685'pummaxwidth' 'pmw' number (default 0)
6686 global
6687 Determines the maximum width to use for the popup menu for completion.
6688 When zero, there is no maximum width limit, otherwise the popup menu
6689 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006690 by "trunc" value of 'fillchars' option.
6691
6692 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006693 |ins-completion-menu|.
6694
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006695 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006696'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006697 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006698 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006699 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006700
Bram Moolenaard94464e2015-11-02 15:28:18 +01006701 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006702'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006703 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006704 {only available when compiled with the |+python/dyn|
6705 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006706 Specifies the name of the Python 2.x shared library. The default is
6707 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006708 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006709 This option cannot be set from a |modeline| or in the |sandbox|, for
6710 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006711
Bram Moolenaar94073162018-01-31 21:49:05 +01006712 *'pythonhome'*
6713'pythonhome' string (default "")
6714 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006715 {only available when compiled with the |+python/dyn|
6716 feature}
6717 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6718 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6719 which was specified at compile time, will be used for the Python 2.x
6720 home directory.
6721 Environment variables are expanded |:set_env|.
6722 This option cannot be set from a |modeline| or in the |sandbox|, for
6723 security reasons.
6724
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006725 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006726'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006727 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006728 {only available when compiled with the |+python3/dyn|
6729 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006730 Specifies the name of the Python 3 shared library. The default is
6731 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006732 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006733 This option cannot be set from a |modeline| or in the |sandbox|, for
6734 security reasons.
6735
Bram Moolenaar94073162018-01-31 21:49:05 +01006736 *'pythonthreehome'*
6737'pythonthreehome' string (default "")
6738 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006739 {only available when compiled with the |+python3/dyn|
6740 feature}
6741 Specifies the name of the Python 3 home directory. When
6742 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6743 PYTHON3_HOME, which was specified at compile time, will be used for
6744 the Python 3 home directory.
6745 Environment variables are expanded |:set_env|.
6746 This option cannot be set from a |modeline| or in the |sandbox|, for
6747 security reasons.
6748
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006749 *'pyxversion'* *'pyx'*
6750'pyxversion' 'pyx' number (default depends on the build)
6751 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006752 {only available when compiled with the |+python| or
6753 the |+python3| feature}
6754 Specifies the python version used for pyx* functions and commands
6755 |python_x|. The default value is as follows:
6756
6757 Compiled with Default ~
6758 |+python| and |+python3| 0
6759 only |+python| 2
6760 only |+python3| 3
6761
6762 Available values are 0, 2 and 3.
6763 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6764 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6765 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6766 to 2 if Python 2 is available.
6767 See also: |has-pythonx|
6768
6769 If Vim is compiled with only |+python| or |+python3| setting
6770 'pyxversion' has no effect. The pyx* functions and commands are
6771 always the same as the compiled version.
6772
6773 This option cannot be set from a |modeline| or in the |sandbox|, for
6774 security reasons.
6775
Bram Moolenaar858ba062020-05-31 23:11:59 +02006776 *'quickfixtextfunc'* *'qftf'*
6777'quickfixtextfunc' 'qftf' string (default "")
6778 global
6779 {only available when compiled with the |+quickfix|
6780 feature}
6781 This option specifies a function to be used to get the text to display
6782 in the quickfix and location list windows. This can be used to
6783 customize the information displayed in the quickfix or location window
6784 for each entry in the corresponding quickfix or location list. See
6785 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006786 function and an example. The value can be the name of a function, a
6787 |lambda| or a |Funcref|. See |option-value-function| for more
6788 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006789
6790 This option cannot be set from a |modeline| or in the |sandbox|, for
6791 security reasons.
6792
Bram Moolenaar677ee682005-01-27 14:41:15 +00006793 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006794'quoteescape' 'qe' string (default "\")
6795 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006796 The characters that are used to escape quotes in a string. Used for
6797 objects like a', a" and a` |a'|.
6798 When one of the characters in this option is found inside a string,
6799 the following character will be skipped. The default value makes the
6800 text "foo\"bar\\" considered to be one string.
6801
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6803'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006804 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 If on, writes fail unless you use a '!'. Protects you from
6806 accidentally overwriting a file. Default on when Vim is started
6807 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006808 When using ":w!" the 'readonly' option is reset for the current
6809 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006810 When using the ":view" command the 'readonly' option is set for the
6811 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006812 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006814 *'redrawtime'* *'rdt'*
6815'redrawtime' 'rdt' number (default 2000)
6816 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006817 {only available when compiled with the |+reltime|
6818 feature}
6819 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006820 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006821 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006822 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006823 matches will be highlighted.
6824 For syntax highlighting the time applies per window. When over the
6825 limit syntax highlighting is disabled until |CTRL-L| is used.
6826 This is used to avoid that Vim hangs when using a very complicated
6827 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006828
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006829 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006830'regexpengine' 're' number (default 0)
6831 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006832 This selects the default regexp engine. |two-engines|
6833 The possible values are:
6834 0 automatic selection
6835 1 old engine
6836 2 NFA engine
6837 Note that when using the NFA engine and the pattern contains something
6838 that is not supported the pattern will not match. This is only useful
6839 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006840 Using automatic selection enables Vim to switch the engine, if the
6841 default engine becomes too costly. E.g., when the NFA engine uses too
6842 many states. This should prevent Vim from hanging on a combination of
6843 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006844
Bram Moolenaar64486672010-05-16 15:46:46 +02006845 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6846'relativenumber' 'rnu' boolean (default off)
6847 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006848 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006849 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006850 precede some vertical motion commands (e.g. j k + -) with, without
6851 having to calculate it yourself. Especially useful in combination with
6852 other commands (e.g. y d c < > gq gw =).
6853 When the 'n' option is excluded from 'cpoptions' a wrapped
6854 line will not use the column of line numbers (this is the default when
6855 'compatible' isn't set).
6856 The 'numberwidth' option can be used to set the room used for the line
6857 number.
6858 When a long, wrapped line doesn't start with the first character, '-'
6859 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006860 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6861 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006862
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006863 The number in front of the cursor line also depends on the value of
6864 'number', see |number_relativenumber| for all combinations of the two
6865 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006866
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 *'remap'* *'noremap'*
6868'remap' boolean (default on)
6869 global
6870 Allows for mappings to work recursively. If you do not want this for
6871 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006872 NOTE: To avoid portability problems with Vim scripts, always keep
6873 this option at the default "on". Only switch it off when working with
6874 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875
zeertzjqd086b8f2024-02-25 15:42:52 +08006876 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006877'renderoptions' 'rop' string (default: empty)
6878 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006879 {only available when compiled with GUI and DIRECTX on
6880 MS-Windows}
6881 Select a text renderer and set its options. The options depend on the
6882 renderer.
6883
6884 Syntax: >
6885 set rop=type:{renderer}(,{name}:{value})*
6886<
6887 Currently, only one optional renderer is available.
6888
6889 render behavior ~
6890 directx Vim will draw text using DirectX (DirectWrite). It makes
6891 drawn glyphs more beautiful than default GDI.
6892 It requires 'encoding' is "utf-8", and only works on
6893 MS-Windows Vista or newer version.
6894
6895 Options:
6896 name meaning type value ~
6897 gamma gamma float 1.0 - 2.2 (maybe)
6898 contrast enhancedContrast float (unknown)
6899 level clearTypeLevel float (unknown)
6900 geom pixelGeometry int 0 - 2 (see below)
6901 renmode renderingMode int 0 - 6 (see below)
6902 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006903 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006904
Bram Moolenaar92467d32017-12-05 13:22:16 +01006905 See this URL for detail (except for scrlines):
6906 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006907
6908 For geom: structure of a device pixel.
6909 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6910 1 - DWRITE_PIXEL_GEOMETRY_RGB
6911 2 - DWRITE_PIXEL_GEOMETRY_BGR
6912
6913 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006914 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006915
6916 For renmode: method of rendering glyphs.
6917 0 - DWRITE_RENDERING_MODE_DEFAULT
6918 1 - DWRITE_RENDERING_MODE_ALIASED
6919 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6920 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6921 4 - DWRITE_RENDERING_MODE_NATURAL
6922 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6923 6 - DWRITE_RENDERING_MODE_OUTLINE
6924
6925 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006926 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006927
6928 For taamode: antialiasing mode used for drawing text.
6929 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6930 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6931 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6932 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6933
6934 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006935 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6936
Bram Moolenaara338adc2018-01-31 20:51:47 +01006937 For scrlines:
6938 This was used for optimizing scrolling behavior, however this
6939 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006940
6941 Example: >
6942 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006943 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006944 set rop=type:directx
6945<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006946 If select a raster font (Courier, Terminal or FixedSys which
6947 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006948 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006949
6950 NOTE: It is known that some fonts and options combination
6951 causes trouble on drawing glyphs.
6952
Bram Moolenaar92467d32017-12-05 13:22:16 +01006953 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006954 special made fonts (True-Type fonts which includes only
6955 bitmap glyphs).
6956 - 'taamode:3' will not work with some vector fonts.
6957
6958 NOTE: With this option, you can display colored emoji
6959 (emoticon) in Windows 8.1 or later. To display colored emoji,
6960 there are some conditions which you should notice.
6961
6962 - If your font includes non-colored emoji already, it will
6963 be used.
6964 - If your font doesn't have emoji, the system chooses an
6965 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6966 will be used.
6967 - When this alternative font didn't have fixed width glyph,
6968 emoji might be rendered beyond the bounding box of drawing
6969 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006970
6971 Other render types are currently not supported.
6972
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 *'report'*
6974'report' number (default 2)
6975 global
6976 Threshold for reporting number of lines changed. When the number of
6977 changed lines is more than 'report' a message will be given for most
6978 ":" commands. If you want it always, set 'report' to 0.
6979 For the ":substitute" command the number of substitutions is used
6980 instead of the number of lines.
6981
6982 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6983'restorescreen' 'rs' boolean (default on)
6984 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006985 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 When set, the screen contents is restored when exiting Vim. This also
6987 happens when executing external commands.
6988
6989 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6990 options in your .vimrc. To disable restoring:
6991 set t_ti= t_te=
6992 To enable restoring (for an xterm):
6993 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6994 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6995
6996 *'revins'* *'ri'* *'norevins'* *'nori'*
6997'revins' 'ri' boolean (default off)
6998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 {only available when compiled with the |+rightleft|
7000 feature}
7001 Inserting characters in Insert mode will work backwards. See "typing
7002 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
7003 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007004 NOTE: This option is reset when 'compatible' is set.
7005 This option is reset when 'paste' is set and restored when 'paste' is
7006 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007
7008 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
7009'rightleft' 'rl' boolean (default off)
7010 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 {only available when compiled with the |+rightleft|
7012 feature}
7013 When on, display orientation becomes right-to-left, i.e., characters
7014 that are stored in the file appear from the right to the left.
7015 Using this option, it is possible to edit files for languages that
7016 are written from the right to the left such as Hebrew and Arabic.
7017 This option is per window, so it is possible to edit mixed files
7018 simultaneously, or to view the same file in both ways (this is
7019 useful whenever you have a mixed text file with both right-to-left
7020 and left-to-right strings so that both sets are displayed properly
7021 in different windows). Also see |rileft.txt|.
7022
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02007023 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024'rightleftcmd' 'rlc' string (default "search")
7025 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 {only available when compiled with the |+rightleft|
7027 feature}
7028 Each word in this option enables the command line editing to work in
7029 right-to-left mode for a group of commands:
7030
7031 search "/" and "?" commands
7032
7033 This is useful for languages such as Hebrew, Arabic and Farsi.
7034 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
7035
Bram Moolenaard94464e2015-11-02 15:28:18 +01007036 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007037'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01007038 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01007039 {only available when compiled with the |+ruby/dyn|
7040 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01007041 Specifies the name of the Ruby shared library. The default is
7042 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007043 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01007044 This option cannot be set from a |modeline| or in the |sandbox|, for
7045 security reasons.
7046
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007048'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007051 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 text in the file is shown on the far right:
7053 Top first line is visible
7054 Bot last line is visible
7055 All first and last line are visible
7056 45% relative position in the file
7057 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007058 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01007059 ruler is shown there. Otherwise it is shown in the last line of the
7060 screen. If the statusline is given by 'statusline' (i.e. not empty),
7061 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02007063 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 the text column (byte number) and the screen column are shown,
7065 separated with a dash.
7066 For an empty line "0-1" is shown.
7067 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02007068 This option is reset when 'paste' is set and restored when 'paste' is
7069 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 If you don't want to see the ruler all the time but want to know where
7071 you are, use "g CTRL-G" |g_CTRL-G|.
7072 NOTE: This option is reset when 'compatible' is set.
7073
7074 *'rulerformat'* *'ruf'*
7075'rulerformat' 'ruf' string (default empty)
7076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 {not available when compiled without the |+statusline|
7078 feature}
7079 When this option is not empty, it determines the content of the ruler
7080 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00007081 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007082 This option cannot be set in a modeline when 'modelineexpr' is off.
7083
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 The default ruler width is 17 characters. To make the ruler 15
7085 characters wide, put "%15(" at the start and "%)" at the end.
7086 Example: >
7087 :set rulerformat=%15(%c%V\ %p%%%)
7088<
7089 *'runtimepath'* *'rtp'* *vimfiles*
7090'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007091 Unix: "$HOME/.vim or
7092 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 $VIM/vimfiles,
7094 $VIMRUNTIME,
7095 $VIM/vimfiles/after,
7096 $HOME/.vim/after"
7097 Amiga: "home:vimfiles,
7098 $VIM/vimfiles,
7099 $VIMRUNTIME,
7100 $VIM/vimfiles/after,
7101 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01007102 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 $VIM/vimfiles,
7104 $VIMRUNTIME,
7105 $VIM/vimfiles/after,
7106 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007107 Haiku: "$BE_USER_SETTINGS/vim,
7108 $VIM/vimfiles,
7109 $VIMRUNTIME,
7110 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01007111 $BE_USER_SETTINGS/vim/after"
7112 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 $VIM/vimfiles,
7114 $VIMRUNTIME,
7115 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00007116 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 This is a list of directories which will be searched for runtime
7119 files:
7120 filetype.vim filetypes by file name |new-filetype|
7121 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007122 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 colors/ color scheme files |:colorscheme|
7124 compiler/ compiler files |:compiler|
7125 doc/ documentation |write-local-help|
7126 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007127 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 indent/ indent scripts |indent-expression|
7129 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02007130 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02007132 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 plugin/ plugin scripts |write-plugin|
7134 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007135 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 syntax/ syntax files |mysyntaxfile|
7137 tutor/ files for vimtutor |tutor|
7138
7139 And any other file searched for with the |:runtime| command.
7140
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007141 For $XDG_CONFIG_HOME see |xdg-base-dir|.
7142
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 The defaults for most systems are setup to search five locations:
7144 1. In your home directory, for your personal preferences.
7145 2. In a system-wide Vim directory, for preferences from the system
7146 administrator.
7147 3. In $VIMRUNTIME, for files distributed with Vim.
7148 *after-directory*
7149 4. In the "after" directory in the system-wide Vim directory. This is
7150 for the system administrator to overrule or add to the distributed
7151 defaults (rarely needed)
7152 5. In the "after" directory in your home directory. This is for
7153 personal preferences to overrule or add to the distributed defaults
7154 or system-wide settings (rarely needed).
7155
Bram Moolenaard0796902016-09-16 20:02:31 +02007156 More entries are added when using |packages|. If it gets very long
7157 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7158 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007159
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7161 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007162 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 wildcards.
7164 See |:runtime|.
7165 Example: >
7166 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7167< This will use the directory "~/vimruntime" first (containing your
7168 personal Vim runtime files), then "/mygroup/vim" (shared between a
7169 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7170 files).
7171 You probably should always include $VIMRUNTIME somewhere, to use the
7172 distributed runtime files. You can put a directory before $VIMRUNTIME
7173 to find files which replace a distributed runtime files. You can put
7174 a directory after $VIMRUNTIME to find files which add to distributed
7175 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007176 When Vim is started with |--clean| the home directory entries are not
7177 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 This option cannot be set from a |modeline| or in the |sandbox|, for
7179 security reasons.
7180
7181 *'scroll'* *'scr'*
7182'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007183 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7185 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007186 changes. This may happen when enabling the |status-line| or
7187 'tabline' option after setting the 'scroll' option.
7188 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007189 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007190 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191
7192 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7193'scrollbind' 'scb' boolean (default off)
7194 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007195 See also |scroll-binding|. When this option is set, scrolling the
7196 current window also scrolls other scrollbind windows (windows that
7197 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 differences between two versions of a file, see 'diff'.
7199 See |'scrollopt'| for options that determine how this option should be
7200 interpreted.
7201 This option is mostly reset when splitting a window to edit another
7202 file. This means that ":split | edit file" results in two windows
7203 with scroll-binding, but ":split file" does not.
7204
Bram Moolenaarae20f342019-11-05 21:09:23 +01007205 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7206'scrollfocus' 'scf' boolean (default off)
7207 global
7208 {only for MS-Windows GUI}
7209 When using the scroll wheel and this option is set, the window under
7210 the mouse pointer is scrolled. With this option off the current
7211 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007212 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007213
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 *'scrolljump'* *'sj'*
7215'scrolljump' 'sj' number (default 1)
7216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 Minimal number of lines to scroll when the cursor gets off the
7218 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7219 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007220 When set to a negative number from -1 to -100 this is used as the
7221 percentage of the window height. Thus -50 scrolls half the window
7222 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 NOTE: This option is set to 1 when 'compatible' is set.
7224
7225 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007226'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007227 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 Minimal number of screen lines to keep above and below the cursor.
7229 This will make some context visible around where you are working. If
7230 you set it to a very large value (999) the cursor line will always be
7231 in the middle of the window (except at the start or end of the file or
7232 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007233 After using the local value, go back the global value with one of
7234 these two: >
7235 setlocal scrolloff<
7236 setlocal scrolloff=-1
7237< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 NOTE: This option is set to 0 when 'compatible' is set.
7239
7240 *'scrollopt'* *'sbo'*
7241'scrollopt' 'sbo' string (default "ver,jump")
7242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007244 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7245 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 The following words are available:
7247 ver Bind vertical scrolling for 'scrollbind' windows
7248 hor Bind horizontal scrolling for 'scrollbind' windows
7249 jump Applies to the offset between two windows for vertical
7250 scrolling. This offset is the difference in the first
7251 displayed line of the bound windows. When moving
7252 around in a window, another 'scrollbind' window may
7253 reach a position before the start or after the end of
7254 the buffer. The offset is not changed though, when
7255 moving back the 'scrollbind' window will try to scroll
7256 to the desired position when possible.
7257 When now making that window the current one, two
7258 things can be done with the relative offset:
7259 1. When "jump" is not included, the relative offset is
7260 adjusted for the scroll position in the new current
7261 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007262 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 2. When "jump" is included, the other windows are
7264 scrolled to keep the same relative offset. When
7265 going back to the other window, it still uses the
7266 same relative offset.
7267 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007268 When 'diff' mode is active there always is vertical scroll binding,
7269 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270
7271 *'sections'* *'sect'*
7272'sections' 'sect' string (default "SHNHH HUnhsh")
7273 global
7274 Specifies the nroff macros that separate sections. These are pairs of
7275 two letters (See |object-motions|). The default makes a section start
7276 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7277
7278 *'secure'* *'nosecure'* *E523*
7279'secure' boolean (default off)
7280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 When on, ":autocmd", shell and write commands are not allowed in
7282 ".vimrc" and ".exrc" in the current directory and map commands are
7283 displayed. Switch it off only if you know that you will not run into
7284 problems, or when the 'exrc' option is off. On Unix this option is
7285 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007286 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 'secure' at the end of your ~/.vimrc then.
7288 This option cannot be set from a |modeline| or in the |sandbox|, for
7289 security reasons.
7290
7291 *'selection'* *'sel'*
7292'selection' 'sel' string (default "inclusive")
7293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 This option defines the behavior of the selection. It is only used
7295 in Visual and Select mode.
7296 Possible values:
7297 value past line inclusive ~
7298 old no yes
7299 inclusive yes yes
7300 exclusive yes no
7301 "past line" means that the cursor is allowed to be positioned one
7302 character past the line.
7303 "inclusive" means that the last character of the selection is included
7304 in an operation. For example, when "x" is used to delete the
7305 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007306 When "old" is used and 'virtualedit' allows the cursor to move past
7307 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007308 When "exclusive" is used, cursor position in visual mode will be
7309 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Christian Brabandtbfeefc42025-06-02 19:56:57 +02007310
7311 Note:
7312 - When "exclusive" is used and selecting from the end backwards, you
7313 cannot include the last character of a line, when starting in Normal
7314 mode and 'virtualedit' empty.
7315 - when "exclusive" is used with a single character visual selection,
7316 Vim will behave as if the 'selection' is inclusive (in other words,
7317 you cannot visually select an empty region).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318
7319 The 'selection' option is set by the |:behave| command.
7320
7321 *'selectmode'* *'slm'*
7322'selectmode' 'slm' string (default "")
7323 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007324 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 Select mode instead of Visual mode, when a selection is started.
7326 Possible values:
7327 mouse when using the mouse
7328 key when using shifted special keys
7329 cmd when using "v", "V" or CTRL-V
7330 See |Select-mode|.
7331 The 'selectmode' option is set by the |:behave| command.
7332
7333 *'sessionoptions'* *'ssop'*
7334'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007335 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007337 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 feature}
7339 Changes the effect of the |:mksession| command. It is a comma
7340 separated list of words. Each word enables saving and restoring
7341 something:
7342 word save and restore ~
7343 blank empty windows
7344 buffers hidden and unloaded buffers, not just those in windows
7345 curdir the current directory
7346 folds manually created folds, opened/closed folds and local
7347 fold options
7348 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007349 and contain at least one lowercase letter. Only
7350 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 help the help window
7352 localoptions options and mappings local to a window or buffer (not
7353 global values for local options)
7354 options all options and mappings (also global values for local
7355 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007356 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 resize size of the Vim window: 'lines' and 'columns'
7358 sesdir the directory in which the session file is located
7359 will become the current directory (useful with
7360 projects accessed over a network from different
7361 systems)
7362 slash backslashes in file names replaced with forward
7363 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007364 tabpages all tab pages; without this only the current tab page
7365 is restored, so that you can make a session for each
7366 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007367 terminal include terminal windows where the command can be
7368 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 unix with Unix end-of-line format (single <NL>), even when
7370 on Windows or DOS
7371 winpos position of the whole Vim window
7372 winsize window sizes
7373
7374 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007375 When neither "curdir" nor "sesdir" is included, file names are stored
7376 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007377 If you leave out "options" many things won't work well after restoring
7378 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 "slash" and "unix" are useful on Windows when sharing session files
7380 with Unix. The Unix version of Vim cannot source dos format scripts,
7381 but the Windows version of Vim can source unix format scripts.
7382
7383 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007384'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 global
7386 Name of the shell to use for ! and :! commands. When changing the
7387 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7388 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007389 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 See |option-backslash| about including spaces and backslashes.
7391 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007392
Bram Moolenaara2baa732022-02-04 16:09:54 +00007393 In |restricted-mode| shell commands will not be possible. This mode
7394 is used if the value of $SHELL ends in "false" or "nologin".
7395
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007396 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007397 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7399< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007400 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007402 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007404 Example with escaped space (Vim will do this when initializing the
7405 option from $SHELL): >
7406 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007407< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007408 backslashes are consumed by `:set`.
7409
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 Under MS-Windows, when the executable ends in ".com" it must be
7411 included. Thus setting the shell to "command.com" or "4dos.com"
7412 works, but "command" and "4dos" do not work for all commands (e.g.,
7413 filtering).
7414 For unknown reasons, when using "4dos.com" the current directory is
7415 changed to "C:\". To avoid this set 'shell' like this: >
7416 :set shell=command.com\ /c\ 4dos
7417< This option cannot be set from a |modeline| or in the |sandbox|, for
7418 security reasons.
7419
7420 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007421'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007422 Win32, when 'shell' contains "powershell":
7423 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007424 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007427 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7428 For MS-Windows, the default is set according to the value of 'shell',
7429 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007430 On Unix it can have more than one flag. Each white space separated
7431 part is passed as an argument to the shell command.
7432 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007433 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 This option cannot be set from a |modeline| or in the |sandbox|, for
7435 security reasons.
7436
7437 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007438'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7439 "2>&1| tee", or
7440 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 {not available when compiled without the |+quickfix|
7443 feature}
7444 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007445 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 including spaces and backslashes.
7447 The name of the temporary file can be represented by "%s" if necessary
7448 (the file name is appended automatically if no %s appears in the value
7449 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007450 For the Amiga the default is ">". For MS-Windows using powershell the
7451 default is "2>&1 | Out-File -Encoding default", otherwise the default
7452 is ">%s 2>&1". The output is directly saved in a file and not echoed
7453 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007454 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 in a file and echoed to the screen. If the 'shell' option is "csh" or
7456 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007457 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007458 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7459 means that stderr is also included. Before using the 'shell' option a
7460 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007461 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7462 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 The initialization of this option is done after reading the ".vimrc"
7464 and the other initializations, so that when the 'shell' option is set
7465 there, the 'shellpipe' option changes automatically, unless it was
7466 explicitly set before.
7467 When 'shellpipe' is set to an empty string, no redirection of the
7468 ":make" output will be done. This is useful if you use a 'makeprg'
7469 that writes to 'makeef' by itself. If you want no piping, but do
7470 want to include the 'makeef', set 'shellpipe' to a single space.
7471 Don't forget to precede the space with a backslash: ":set sp=\ ".
7472 In the future pipes may be used for filtering and this option will
7473 become obsolete (at least for Unix).
7474 This option cannot be set from a |modeline| or in the |sandbox|, for
7475 security reasons.
7476
7477 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007478'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 Quoting character(s), put around the command passed to the shell, for
7481 the "!" and ":!" commands. The redirection is kept outside of the
7482 quoting. See 'shellxquote' to include the redirection. It's
7483 probably not useful to set both options.
7484 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007485 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007486 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 This option cannot be set from a |modeline| or in the |sandbox|, for
7488 security reasons.
7489
7490 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007491'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7492 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 String to be used to put the output of a filter command in a temporary
7495 file. See also |:!|. See |option-backslash| about including spaces
7496 and backslashes.
7497 The name of the temporary file can be represented by "%s" if necessary
7498 (the file name is appended automatically if no %s appears in the value
7499 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007500 The default is ">". For Unix, if the 'shell' option is "csh" or
7501 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007502 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007503 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7504 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007505 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7506 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007507 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7508 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 The initialization of this option is done after reading the ".vimrc"
7510 and the other initializations, so that when the 'shell' option is set
7511 there, the 'shellredir' option changes automatically unless it was
7512 explicitly set before.
7513 In the future pipes may be used for filtering and this option will
7514 become obsolete (at least for Unix).
7515 This option cannot be set from a |modeline| or in the |sandbox|, for
7516 security reasons.
7517
7518 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7519'shellslash' 'ssl' boolean (default off)
7520 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007521 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007523 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007524 powershell.exe. Backward slashes can still be typed, but they are
7525 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 Note that setting or resetting this option has no effect for some
7527 existing file names, thus this option needs to be set before opening
7528 any file for best results. This might change in the future.
7529 'shellslash' only works when a backslash can be used as a path
7530 separator. To test if this is so use: >
7531 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007532< Also see 'completeslash'.
7533
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007534 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7535'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7536 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007537 When on, use temp files for shell commands. When off use a pipe.
7538 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007539 Currently a pipe is only supported on Unix and MS-Windows 2K and
7540 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007541 :if has("filterpipe")
7542< The advantage of using a pipe is that nobody can read the temp file
7543 and the 'shell' command does not need to support redirection.
7544 The advantage of using a temp file is that the file type and encoding
7545 can be detected.
7546 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7547 |FilterWritePost| autocommands event are not triggered when
7548 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007549 The `system()` function does not respect this option and always uses
7550 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007551 NOTE: This option is set to the Vim default value when 'compatible'
7552 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007553
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 *'shelltype'* *'st'*
7555'shelltype' 'st' number (default 0)
7556 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007557 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 On the Amiga this option influences the way how the commands work
7559 which use a shell.
7560 0 and 1: always use the shell
7561 2 and 3: use the shell only to filter lines
7562 4 and 5: use shell only for ':sh' command
7563 When not using the shell, the command is executed directly.
7564
7565 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7566 1 and 3: use "shell cmd" to start external commands
7567
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007568 *'shellxescape'* *'sxe'*
7569'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007570 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007571 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007572 When 'shellxquote' is set to "(" then the characters listed in this
7573 option will be escaped with a '^' character. This makes it possible
7574 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007575 This option cannot be set from a |modeline| or in the |sandbox|, for
7576 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007577
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 *'shellxquote'* *'sxq'*
7579'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007580 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007581 for Win32, when 'shell' is
7582 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007583 for Win32, when 'shell' contains "sh"
7584 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 for Unix, when using system(): "\"")
7586 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 Quoting character(s), put around the command passed to the shell, for
7588 the "!" and ":!" commands. Includes the redirection. See
7589 'shellquote' to exclude the redirection. It's probably not useful
7590 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007591 When the value is '(' then ')' is appended. When the value is '"('
7592 then ')"' is appended.
7593 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007594 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007595 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7596 pwsh.exe which automatically strips off the first and last quote on a
7597 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7598 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007599 'shell', to reduce the need to set this option by the user. See
7600 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 This option cannot be set from a |modeline| or in the |sandbox|, for
7602 security reasons.
7603
7604 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7605'shiftround' 'sr' boolean (default off)
7606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 Round indent to multiple of 'shiftwidth'. Applies to > and <
7608 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7609 a multiple of 'shiftwidth' (this is Vi compatible).
7610 NOTE: This option is reset when 'compatible' is set.
7611
7612 *'shiftwidth'* *'sw'*
7613'shiftwidth' 'sw' number (default 8)
7614 local to buffer
Damien Lejay95ea0b02025-06-01 19:10:36 +02007615 Number of columns that make up one level of (auto)indentation. Used
7616 by |'cindent'|, |<<|, |>>|, etc.
7617 If set to 0, Vim uses the current 'tabstop' value. Use |shiftwidth()|
7618 to obtain the effective value in scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619
7620 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007621'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7622 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007623 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007625 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 It is a list of flags:
7627 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007628 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7629 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7630 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7631 m use "[+]" instead of "[Modified]" *shm-m*
7632 n use "[New]" instead of "[New File]" *shm-n*
7633 r use "[RO]" instead of "[readonly]" *shm-r*
7634 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007636 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7637 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007638 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007639 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007641 o overwrite message for writing a file with subsequent *shm-o*
7642 message for reading a file (useful for ":wn" or when
7643 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007644 O message for reading a file overwrites any previous *shm-O*
7645 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007646 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7647 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007648 the search count do not show "W" before the count message
7649 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007650 t truncate file message at the start if it is too long *shm-t*
7651 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007652 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007653 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007654 long to fit on the command line; "..." will appear in the
7655 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007656 W don't give "written" or "[w]" when writing a file *shm-W*
7657 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007658 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007659 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007660 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007661 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007662 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7663 match", "Pattern not found", "Back at original", etc.
7664 C don't give messages while scanning for ins-completion *shm-C*
7665 items, for instance "scanning tags"
7666 q use "recording" instead of "recording @a" *shm-q*
7667 F don't give the file info when editing a file, like *shm-F*
7668 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007669 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007670 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007671 "[1/5]". When the "S" flag is not present (e.g. search count
7672 is shown), the "search hit BOTTOM, continuing at TOP" and
7673 "search hit TOP, continuing at BOTTOM" messages are only
7674 indicated by a "W" (Mnemonic: Wrapped) letter before the
7675 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676
7677 This gives you the opportunity to avoid that a change between buffers
7678 requires you to hit <Enter>, but still gives as useful a message as
7679 possible for the space available. To get the whole message that you
7680 would have got with 'shm' empty, use ":file!"
7681 Useful values:
7682 shm= No abbreviation of message.
7683 shm=a Abbreviation, but no loss of information.
7684 shm=at Abbreviation, and truncate message when necessary.
7685
7686 NOTE: This option is set to the Vi default value when 'compatible' is
7687 set and to the Vim default value when 'compatible' is reset.
7688
7689 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7690'shortname' 'sn' boolean (default off)
7691 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 Filenames are assumed to be 8 characters plus one extension of 3
7693 characters. Multiple dots in file names are not allowed. When this
7694 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007695 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007697 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698
7699 *'showbreak'* *'sbr'* *E595*
7700'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007701 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007702 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 feature}
7704 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007705 values are "> " or "+++ ": >
7706 :set showbreak=>\
7707< Note the backslash to escape the trailing space. It's easier like
7708 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007709 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007710< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 comma (in a future version the comma might be used to separate the
7712 part that is shown at the end and at the start of a line).
7713 The characters are highlighted according to the '@' flag in
7714 'highlight'.
7715 Note that tabs after the showbreak will be displayed differently.
7716 If you want the 'showbreak' to appear in between line numbers, add the
7717 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007718 A window-local value overrules a global value. If the global value is
7719 set and you want no value in the current window use NONE: >
7720 :setlocal showbreak=NONE
7721<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007723'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7724 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007726 Show (partial) command in the last line of the screen. Set this
7727 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 In Visual mode the size of the selected area is shown:
7729 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007730 If the number of bytes is different it is also displayed: "2-6"
7731 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007733 - When selecting a block, the size in screen characters:
7734 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007735 This information can be displayed in an alternative location using the
7736 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 NOTE: This option is set to the Vi default value when 'compatible' is
7738 set and to the Vim default value when 'compatible' is reset.
7739
Luuk van Baalba936f62022-12-15 13:15:39 +00007740 *'showcmdloc'* *'sloc'*
7741'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007742 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007743 This option can be used to display the (partially) entered command in
7744 another location. Possible values are:
7745 last Last line of the screen (default).
7746 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007747 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007748 Setting this option to "statusline" or "tabline" means that these will
7749 be redrawn whenever the command changes, which can be on every key
7750 pressed.
7751 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7752 place the text. Without a custom 'statusline' or 'tabline' it will be
7753 displayed in a convenient location.
7754
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7756'showfulltag' 'sft' boolean (default off)
7757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 When completing a word in insert mode (see |ins-completion|) from the
7759 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007760 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 matched a C function, you can see a template for what arguments are
7762 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007763 Note that this doesn't work well together with having "longest" in
7764 'completeopt', because the completion from the search pattern may not
7765 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766
7767 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7768'showmatch' 'sm' boolean (default off)
7769 global
7770 When a bracket is inserted, briefly jump to the matching one. The
7771 jump is only done if the match can be seen on the screen. The time to
7772 show the match can be set with 'matchtime'.
7773 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007774 seen or not).
7775 This option is reset when 'paste' is set and restored when 'paste' is
7776 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 When the 'm' flag is not included in 'cpoptions', typing a character
7778 will immediately move the cursor back to where it belongs.
7779 See the "sm" field in 'guicursor' for setting the cursor shape and
7780 blinking when showing the match.
7781 The 'matchpairs' option can be used to specify the characters to show
7782 matches for. 'rightleft' and 'revins' are used to look for opposite
7783 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007784 Also see the matchparen plugin for highlighting the match when moving
7785 around |pi_paren.txt|.
7786 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787
7788 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7789'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7790 global
7791 If in Insert, Replace or Visual mode put a message on the last line.
7792 Use the 'M' flag in 'highlight' to set the type of highlighting for
7793 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007794 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 doesn't mean XIM is really active, especially when 'imactivatekey' is
7796 not set.
7797 NOTE: This option is set to the Vi default value when 'compatible' is
7798 set and to the Vim default value when 'compatible' is reset.
7799
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007800 *'showtabline'* *'stal'*
7801'showtabline' 'stal' number (default 1)
7802 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007803 The value of this option specifies when the line with tab page labels
7804 will be displayed:
7805 0: never
7806 1: only if there are at least two tab pages
7807 2: always
7808 This is both for the GUI and non-GUI implementation of the tab pages
7809 line.
7810 See |tab-page| for more information about tab pages.
7811
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007812 *'showtabpanel'* *'stpl'*
7813'showtabpanel' 'stpl' number (default 0)
7814 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007815 {not available when compiled without the |+tabpanel|
7816 feature}
7817 The value of this option specifies when the |tabpanel| with tab page
7818 labels will be displayed:
7819 0: never
7820 1: only if there are at least two tab pages
7821 2: always
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007822 See |tab-page| for more information about tab page labels.
7823
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 *'sidescroll'* *'ss'*
7825'sidescroll' 'ss' number (default 0)
7826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 The minimal number of columns to scroll horizontally. Used only when
7828 the 'wrap' option is off and the cursor is moved off of the screen.
7829 When it is zero the cursor will be put in the middle of the screen.
7830 When using a slow terminal set it to a large number or 0. When using
7831 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7832 commands.
7833
7834 *'sidescrolloff'* *'siso'*
7835'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007836 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007838 right of the cursor if 'nowrap' is set. Setting this option to a
7839 value greater than 0 while having |'sidescroll'| also at a non-zero
7840 value makes some context visible in the line you are scrolling in
7841 horizontally (except at beginning of the line). Setting this option
7842 to a large value (like 999) has the effect of keeping the cursor
7843 horizontally centered in the window, as long as one does not come too
7844 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007845 After using the local value, go back the global value with one of
7846 these two: >
7847 setlocal sidescrolloff<
7848 setlocal sidescrolloff=-1
7849< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850
7851 Example: Try this together with 'sidescroll' and 'listchars' as
7852 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007853 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854
7855 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7856 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007857<
7858 *'signcolumn'* *'scl'*
7859'signcolumn' 'scl' string (default "auto")
7860 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007861 {not available when compiled without the |+signs|
7862 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007863 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007864 "auto" only when there is a sign to display
7865 "no" never
7866 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007867 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007868 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7871'smartcase' 'scs' boolean (default off)
7872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 Override the 'ignorecase' option if the search pattern contains upper
7874 case characters. Only used when the search pattern is typed and
7875 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Girish Palyadc314052025-05-08 23:28:52 +02007876 ":g" and ":s" and when filtering matches for the completion menu
7877 |compl-states|.
7878 Not used for "*", "#", "gd", tag search, etc. After "*" and "#" you
7879 can make 'smartcase' used by doing a "/" command, recalling the search
7880 pattern from history and hitting <Enter>.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 NOTE: This option is reset when 'compatible' is set.
7882
7883 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7884'smartindent' 'si' boolean (default off)
7885 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 Do smart autoindenting when starting a new line. Works for C-like
7887 programs, but can also be used for other languages. 'cindent' does
7888 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007889 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007890 setting 'si' has no effect. 'indentexpr' is a more advanced
7891 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 Normally 'autoindent' should also be on when using 'smartindent'.
7893 An indent is automatically inserted:
7894 - After a line ending in '{'.
7895 - After a line starting with a keyword from 'cinwords'.
7896 - Before a line starting with '}' (only with the "O" command).
7897 When typing '}' as the first character in a new line, that line is
7898 given the same indent as the matching '{'.
7899 When typing '#' as the first character in a new line, the indent for
7900 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007901 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7903 When using the ">>" command, lines starting with '#' are not shifted
7904 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007905 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007906 This option is reset when 'paste' is set and restored when 'paste' is
7907 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908
7909 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7910'smarttab' 'sta' boolean (default off)
7911 global
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007912 When enabled, the <Tab> key will indent by 'shiftwidth' if the cursor
7913 is in leading whitespace. The <BS> key has the opposite effect.
Damien Lejaybfa16362025-06-10 21:12:31 +02007914 In leading whitespace, this has the same effect as setting
7915 'softtabstop' to the value of 'shiftwidth'.
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007916 This option is reset when 'compatible' is set; it is temporarily
7917 disabled when 'paste' is enabled, and restored when 'paste' is turned
7918 off.
Damien Lejaybfa16362025-06-10 21:12:31 +02007919 NOTE: in most cases, using 'softtabstop' is a better option. Have a
7920 look at section |30.5| of the user guide for detailed
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007921 explanations on how Vim works with tabs and spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007923 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7924'smoothscroll' 'sms' boolean (default off)
7925 local to window
7926 Scrolling works with screen lines. When 'wrap' is set and the first
7927 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007928 above the window. "<<<" is displayed at the start of the first line,
7929 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007930 You may also want to add "lastline" to the 'display' option to show as
7931 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007932 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007933
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 *'softtabstop'* *'sts'*
7935'softtabstop' 'sts' number (default 0)
7936 local to buffer
Damien Lejay91af4c42025-06-12 21:56:19 +02007937 Create soft tab stops, separated by 'softtabstop' number of columns.
7938 In Insert mode, pressing the <Tab> key will move the cursor to the
7939 next soft tab stop, instead of inserting a literal tab. <BS> behaves
7940 similarly in reverse. Vim inserts a minimal mix of tab and space
7941 characters to produce the visual effect.
7942
7943 This setting does not affect the display of existing tab characters.
7944
7945 A value of 0 disables this behaviour. A negative value makes Vim use
7946 'shiftwidth'. If you plan to use 'sts' and 'shiftwidth' with
7947 different values, you might consider setting 'smarttab'.
7948
7949 'softtabstop' is temporarily set to 0 when 'paste' is on and reset
7950 when it is turned off. It is also reset when 'compatible' is set.
7951
7952 The 'L' flag in 'cpoptions' alters tab behavior when 'list' is
7953 enabled. See also |ins-expandtab| ans user manual section |30.5| for
7954 in-depth explanations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007956 If Vim is compiled with the |+vartabs| feature then the value of
7957 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7958 anything other than an empty string.
7959
Bram Moolenaar217ad922005-03-20 22:37:15 +00007960 *'spell'* *'nospell'*
7961'spell' boolean (default off)
7962 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007963 {not available when compiled without the |+syntax|
7964 feature}
7965 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007966 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007967
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007968 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007969'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007970 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007971 {not available when compiled without the |+syntax|
7972 feature}
7973 Pattern to locate the end of a sentence. The following word will be
7974 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007975 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007976 When this check is not wanted make this option empty.
7977 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007978 Be careful with special characters, see |option-backslash| about
7979 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007980 To set this option automatically depending on the language, see
7981 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007982
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007983 *'spellfile'* *'spf'*
7984'spellfile' 'spf' string (default empty)
7985 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007986 {not available when compiled without the |+syntax|
7987 feature}
7988 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007989 commands. It must end in ".{encoding}.add". You need to include the
7990 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007991 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007992 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007993 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007994 |zg| and |zw| commands can be used to access each. This allows using
7995 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007996 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007997 you: Using the first directory in 'runtimepath' that is writable. If
7998 there is no "spell" directory yet it will be created. For the file
7999 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00008000 ignoring the region.
8001 The resulting ".spl" file will be used for spell checking, it does not
8002 have to appear in 'spelllang'.
8003 Normally one file is used for all regions, but you can add the region
8004 name if you want to. However, it will then only be used when
8005 'spellfile' is set to it, for entries in 'spelllang' only files
8006 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00008007 This option cannot be set from a |modeline| or in the |sandbox|, for
8008 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008009
Bram Moolenaar217ad922005-03-20 22:37:15 +00008010 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008011'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00008012 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00008013 {not available when compiled without the |+syntax|
8014 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008015 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008016 on spellchecking will be done for these languages. Example: >
8017 set spelllang=en_us,nl,medical
8018< This means US English, Dutch and medical words are recognized. Words
8019 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02008020 The word list name must consist of alphanumeric characters, a dash or
8021 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008022 recommended to separate the two letter language name from a
8023 specification. Thus "en-rare" is used for rare English words.
8024 A region name must come last and have the form "_xx", where "xx" is
8025 the two-letter, lower case region name. You can use more than one
8026 region by listing them: "en_us,en_ca" supports both US and Canadian
8027 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01008028 Britain. (Note: currently en_au and en_nz dictionaries are older than
8029 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01008030 If the name "cjk" is included East Asian characters are excluded from
8031 spell checking. This is useful when editing text that also has Asian
8032 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02008033 Note that the "medical" dictionary does not exist, it is just an
8034 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008035 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008036 As a special case the name of a .spl file can be given as-is. The
8037 first "_xx" in the name is removed and used as the region name
8038 (_xx is an underscore, two letters and followed by a non-letter).
8039 This is mainly for testing purposes. You must make sure the correct
8040 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008041 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008042 idea to set 'spelllang' after setting 'encoding' to avoid loading the
8043 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00008044 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00008045
Bram Moolenaar98692072006-02-04 00:57:42 +00008046 If the |spellfile.vim| plugin is active and you use a language name
8047 for which Vim cannot find the .spl file in 'runtimepath' the plugin
8048 will ask you if you want to download the file.
8049
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008050 After this option has been set successfully, Vim will source the files
8051 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01008052 up to the first character that is not an ASCII letter or number and
8053 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008054
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008055 *'spelloptions'* *'spo'*
8056'spelloptions' 'spo' string (default "")
8057 local to buffer
8058 {not available when compiled without the |+syntax|
8059 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008060 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008061 camel When a word is CamelCased, assume "Cased" is a
8062 separate word: every upper-case character in a word
8063 that comes after a lower case character indicates the
8064 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008065
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008066 *'spellsuggest'* *'sps'*
8067'spellsuggest' 'sps' string (default "best")
8068 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008069 {not available when compiled without the |+syntax|
8070 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008071 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008072 the |spellsuggest()| function. This is a comma-separated list of
8073 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008074
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008075 best Internal method that works best for English. Finds
8076 changes like "fast" and uses a bit of sound-a-like
8077 scoring to improve the ordering.
8078
8079 double Internal method that uses two methods and mixes the
8080 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008081 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008082 word. That only works when the language specifies
8083 sound folding. Can be slow and doesn't always give
8084 better results.
8085
8086 fast Internal method that only checks for simple changes:
8087 character inserts/deletes/swaps. Works well for
8088 simple typing mistakes.
8089
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008090 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008091 Not used for |spellsuggest()|. The number of
8092 suggestions is never more than the value of 'lines'
8093 minus two.
8094
Bram Moolenaar585ee072022-01-29 11:22:17 +00008095 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02008096 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00008097 methods. When omitted the limit is 5000. When
8098 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01008099 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00008100
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008101 file:{filename} Read file {filename}, which must have two columns,
8102 separated by a slash. The first column contains the
8103 bad word, the second column the suggested good word.
8104 Example:
8105 theribal/terrible ~
8106 Use this for common mistakes that do not appear at the
8107 top of the suggestion list with the internal methods.
8108 Lines without a slash are ignored, use this for
8109 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008110 The word in the second column must be correct,
8111 otherwise it will not be used. Add the word to an
8112 ".add" file if it is currently flagged as a spelling
8113 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008114 The file is used for all languages.
8115
8116 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01008117 trouble with spaces. Best is to call a function
8118 without arguments, see |expr-option-function|.
8119 |v:val| holds the badly spelled word. The expression
8120 must evaluate to a List of Lists, each with a
8121 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008122 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01008123 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008124 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008125 internal methods use. A lower score is better.
8126 This may invoke |spellsuggest()| if you temporarily
8127 set 'spellsuggest' to exclude the "expr:" part.
8128 Errors are silently ignored, unless you set the
8129 'verbose' option to a non-zero value.
8130
8131 Only one of "best", "double" or "fast" may be used. The others may
8132 appear several times in any order. Example: >
8133 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
8134<
8135 This option cannot be set from a |modeline| or in the |sandbox|, for
8136 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008137
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
8139'splitbelow' 'sb' boolean (default off)
8140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 When on, splitting a window will put the new window below the current
8142 one. |:split|
8143
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008144 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008145'splitkeep' 'spk' string (default "cursor")
8146 global
8147 The value of this option determines the scroll behavior when opening,
8148 closing or resizing horizontal splits.
8149
8150 Possible values are:
8151 cursor Keep the same relative cursor position.
8152 screen Keep the text on the same screen line.
8153 topline Keep the topline the same.
8154
8155 For the "screen" and "topline" values, the cursor position will be
8156 changed when necessary. In this case, the jumplist will be populated
8157 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008158 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008159
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
8161'splitright' 'spr' boolean (default off)
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 When on, splitting a window will put the new window right of the
8164 current one. |:vsplit|
8165
8166 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8167'startofline' 'sol' boolean (default on)
8168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008170 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008171 (if possible). This applies to the commands:
8172 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008173 - "d", "<<", "==" and ">>" with a linewise operator
8174 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008175 - "%" with a count
8176 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8177 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 In case of buffer changing commands the cursor is placed at the column
8179 where it was the last time the buffer was edited.
8180 NOTE: This option is set when 'compatible' is set.
8181
Bram Moolenaar00654022011-02-25 14:42:19 +01008182 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008184 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 {not available when compiled without the |+statusline|
8186 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008187 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 Also see |status-line|.
8189
8190 The option consists of printf style '%' items interspersed with
8191 normal text. Each status line item is of the form:
8192 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008193 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008194 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008196 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008197 When the option starts with "%!" then it is used as an expression,
8198 evaluated and the result is used as the option value. Example: >
8199 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008200< The *g:statusline_winid* variable will be set to the |window-ID| of the
8201 window that the status line belongs to.
8202 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008203 Note that the "%!" expression is evaluated in the context of the
8204 current window and buffer, while %{} items are evaluated in the
8205 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008206
8207 When there is error while evaluating the option then it will be made
8208 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008209 When the result contains unprintable characters the result is
8210 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008211
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 Note that the only effect of 'ruler' when this option is set (and
8213 'laststatus' is 2) is controlling the output of |CTRL-G|.
8214
8215 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008216 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008218 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 minwid Minimum width of the item, padding as set by '-' & '0'.
8220 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008221 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 on the left for text items. Numeric items will be
8223 shifted down to maxwid-2 digits followed by '>'number
8224 where number is the amount of missing digits, much like
8225 an exponential notation.
8226 item A one letter code as described below.
8227
8228 Following is a description of the possible statusline items. The
8229 second character in "item" is the type:
8230 N for number
8231 S for string
8232 F for flags as described below
8233 - not applicable
8234
8235 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008236 f S Path to the file in the buffer, as typed or relative to current
8237 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 F S Full path to the file in the buffer.
8239 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008240 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008242 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008244 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008246 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008248 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008250 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8252 being used: "<keymap>"
8253 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008254 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 B N As above, in hexadecimal.
8256 o N Byte number in file of byte under cursor, first byte is 1.
8257 Mnemonic: Offset from start of file (with one added)
8258 {not available when compiled without |+byte_offset| feature}
8259 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008260 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 l N Line number.
8262 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008263 c N Column number (byte index).
8264 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008265 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 p N Percentage through file in lines as in |CTRL-G|.
8267 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008268 percentage described for 'ruler'. Always 3 in length, unless
8269 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008270 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008271 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008273 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008274 Note that there is no '%' before the closing '}'. The
8275 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008276 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008277 {% - This is almost same as { except the result of the expression is
8278 re-evaluated as a statusline format string. Thus if the
8279 return value of expr contains % items they will get expanded.
8280 The expression can contain the } character, the end of
8281 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008282 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008283 func! Stl_filename() abort
8284 return "%t"
8285 endfunc
8286< `stl=%{Stl_filename()}` results in `"%t"`
8287 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008288 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 ( - Start of item group. Can be used for setting the width and
8290 alignment of a section. Must be followed by %) somewhere.
8291 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008292 T N For 'tabline': start of tab page N label. Use %T after the last
8293 label. This information is used for mouse clicks.
8294 X N For 'tabline': start of close tab N label. Use %X after the
8295 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8296 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 < - Where to truncate line if too long. Default is at the start.
8298 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008299 = - Separation point between alignment sections. Each section will
8300 be separated by an equal number of spaces. With one %= what
8301 comes after it will be right-aligned. With two %= there is a
8302 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008304 # - Set highlight group. The name must follow and then a # again.
8305 Thus use %#HLname# for highlight group HLname. The same
8306 highlighting is used, also for the statusline of non-current
8307 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008309 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008310 The difference between User{N} and StatusLine will be applied to
8311 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 The number N must be between 1 and 9. See |hl-User1..9|
8313
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008314 When displaying a flag, Vim removes the leading comma, if any, when
8315 that flag comes right after plaintext. This will make a nice display
8316 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317
Bram Moolenaar582fd852005-03-28 20:58:01 +00008318 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 not set) and a minwid is not set for the group, the whole group will
8320 become empty. This will make a group like the following disappear
8321 completely from the statusline when none of the flags are set. >
8322 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008323< Beware that an expression is evaluated each and every time the status
8324 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008325 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008326 While evaluating %{} the current buffer and current window will be set
8327 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008328 currently being drawn. The expression will evaluate in this context.
8329 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8330 real current buffer and "g:actual_curwin" to the |window-ID| of the
8331 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008332
Bram Moolenaar30b65812012-07-12 22:01:11 +02008333 The 'statusline' option will be evaluated in the |sandbox| if set from
8334 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008335 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008336
8337 It is not allowed to change text or jump to another window while
8338 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339
8340 If the statusline is not updated when you want it (e.g., after setting
8341 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008342 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008344 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 Otherwise the result is taken as flag text and applied to the rules
8346 described above.
8347
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008348 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008350 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351
8352 Examples:
8353 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008354 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355< Similar, but add ASCII value of char under the cursor (like "ga") >
8356 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8357< Display byte count and byte value, modified flag in red. >
8358 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8359 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8360< Display a ,GZ flag if a compressed file is loaded >
8361 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8362< In the |:autocmd|'s: >
8363 :let b:gzflag = 1
8364< And: >
8365 :unlet b:gzflag
8366< And define this function: >
8367 :function VarExists(var, val)
8368 : if exists(a:var) | return a:val | else | return '' | endif
8369 :endfunction
8370<
8371 *'suffixes'* *'su'*
8372'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 Files with these suffixes get a lower priority when multiple files
8375 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008376 suffixes. Spaces after the comma are ignored. A dot is also seen as
8377 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 separator, precede it with a backslash (see |option-backslash| about
8379 including spaces and backslashes).
8380 See 'wildignore' for completely ignoring files.
8381 The use of |:set+=| and |:set-=| is preferred when adding or removing
8382 suffixes from the list. This avoids problems when a future version
8383 uses another default.
8384
8385 *'suffixesadd'* *'sua'*
8386'suffixesadd' 'sua' string (default "")
8387 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008388 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 file for the "gf", "[I", etc. commands. Example: >
8390 :set suffixesadd=.java
8391<
8392 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8393'swapfile' 'swf' boolean (default on)
8394 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008395 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 swapfile is not wanted for a specific buffer. For example, with
8397 confidential information that even root must not be able to access.
8398 Careful: All text will be in memory:
8399 - Don't use this for big files.
8400 - Recovery will be impossible!
8401 A swapfile will only be present when |'updatecount'| is non-zero and
8402 'swapfile' is set.
8403 When 'swapfile' is reset, the swap file for the current buffer is
8404 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8405 non-zero, a swap file is immediately created.
8406 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008407 If you want to open a new buffer without creating a swap file for it,
8408 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008409 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410
8411 This option is used together with 'bufhidden' and 'buftype' to
8412 specify special kinds of buffers. See |special-buffers|.
8413
8414 *'swapsync'* *'sws'*
8415'swapsync' 'sws' string (default "fsync")
8416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008418 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 When this option is empty parts of the swap file may be in memory and
8420 not written to disk. When the system crashes you may lose more work.
8421 On Unix the system does a sync now and then without Vim asking for it,
8422 so the disadvantage of setting this option off is small. On some
8423 systems the swap file will not be written at all. For a unix system
8424 setting it to "sync" will use the sync() call instead of the default
8425 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008426 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427
8428 *'switchbuf'* *'swb'*
8429'switchbuf' 'swb' string (default "")
8430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008432 This option is checked, when
8433 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008434 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008435 - jumping to a tag using the |:stag| command.
8436 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8437 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8438 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008439 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008440 useopen If included, jump to the first open window in the
8441 current tab page that contains the specified buffer
8442 (if there is one). Otherwise: Do not examine other
8443 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008444 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008445 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008447 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008448 Otherwise: do not split, use current window (when used
8449 in the quickfix window: the previously used window or
8450 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008451 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008452 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008453 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008454 uselast If included, jump to the previously used window when
8455 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008456 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8457 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008459 *'synmaxcol'* *'smc'*
8460'synmaxcol' 'smc' number (default 3000)
8461 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008462 {not available when compiled without the |+syntax|
8463 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008464 Maximum column in which to search for syntax items. In long lines the
8465 text after this column is not highlighted and following lines may not
8466 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008467 This helps to avoid very slow redrawing for an XML file that is one
8468 long line.
8469 Set to zero to remove the limit.
8470
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 *'syntax'* *'syn'*
8472'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008473 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 {not available when compiled without the |+syntax|
8475 feature}
8476 When this option is set, the syntax with this name is loaded, unless
8477 syntax highlighting has been switched off with ":syntax off".
8478 Otherwise this option does not always reflect the current syntax (the
8479 b:current_syntax variable does).
8480 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008481 not automatically recognized. Example, in an IDL file:
8482 /* vim: set syntax=idl : */ ~
8483 When a dot appears in the value then this separates two filetype
8484 names. Example:
8485 /* vim: set syntax=c.doxygen : */ ~
8486 This will use the "c" syntax first, then the "doxygen" syntax.
8487 Note that the second one must be prepared to be loaded as an addition,
8488 otherwise it will be skipped. More than one dot may appear.
8489 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 :set syntax=OFF
8491< To switch syntax highlighting on according to the current value of the
8492 'filetype' option: >
8493 :set syntax=ON
8494< What actually happens when setting the 'syntax' option is that the
8495 Syntax autocommand event is triggered with the value as argument.
8496 This option is not copied to another buffer, independent of the 's' or
8497 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008498 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499
LemonBoy5247b0b2024-07-12 19:30:58 +02008500 *'tabclose'* *'tcl'*
8501'tabclose' 'tcl' string (default "")
8502 global
8503 This option controls the behavior when closing tab pages (e.g., using
8504 |:tabclose|). When empty Vim goes to the next (right) tab page.
8505
8506 Possible values (comma-separated list):
8507 left If included, go to the previous tab page instead of
8508 the next one.
8509 uselast If included, go to the previously used tab page if
8510 possible. This option takes precedence over the
8511 others.
8512
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008513 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008514'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008515 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008516 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008517 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008518 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008519
8520 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008521 option and only when there is no GUI tab line. When 'e' is in
8522 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008523 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008524
8525 The value is evaluated like with 'statusline'. You can use
8526 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008527 the text to be displayed. Use "%1T" for the first label, "%2T" for
8528 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008529
Bram Moolenaare12bab32019-01-08 22:02:56 +01008530 When changing something that is used in 'tabline' that does not
8531 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008532 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008533
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008534 Keep in mind that only one of the tab pages is the current one, others
8535 are invisible and you can't jump to their windows.
8536
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008537 *'tabpagemax'* *'tpm'*
8538'tabpagemax' 'tpm' number (default 10)
8539 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008540 Maximum number of tab pages to be opened by the |-p| command line
8541 argument or the ":tab all" command. |tabpage|
8542
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008543 *'tabpanel'* *'tpl'* *g:actual_curtabpage*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008544'tabpanel' 'tpl' string (default empty)
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008545 global
Christ van Willegend65cdad2025-05-30 16:05:58 +02008546 When non-empty, this option determines the content of the |tabpanel|.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008547 The option consists of printf style '%' items interspersed with
8548 normal text, similar to the 'statusline' or 'tabline'.
8549
8550 When changing something that is used in 'tabpanel' that does not
8551 trigger it to be updated, use |:redrawtabpanel|.
8552 This option cannot be set in a modeline when 'modelineexpr' is off.
8553
8554 You can use |g:actual_curtabpage| within a function assigned to
8555 tabpanel. |g:actual_curtabpage| represents current tab's label number.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008556 The option value can contain line breaks: >
8557
8558 set tabpanel=%!TabPanel()
8559 function! TabPanel() abort
8560 return printf("(%2d)\n %%f", g:actual_curtabpage)
8561 endfunction
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008562<
8563 The result is:
8564>
8565 +-----------+---------------------------------
8566 |(1) |
8567 | ~/aaa.txt|
8568 |(2) |
8569 | ~/.vimrc |
8570 | |
8571 | |
8572 | |
8573<
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008574 *'tabpanelopt'* *'tplo'*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008575'tabpanelopt' 'tplo' string (default "")
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008576 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008577 Optional settings for the |tabpanel|, It can consist of the following
8578 items. Items must be separated by a comma.
8579
Christ van Willegend65cdad2025-05-30 16:05:58 +02008580 align:{text} Specifies the position of the tabpanel.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008581 Currently supported positions are:
8582
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008583 left left-side
8584 right right-side
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008585
8586 (default "left")
8587
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008588 columns:{n} Number of columns of the tabpanel.
8589 If this value is 0 or less than 'columns', the
8590 tab panel will not be displayed.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008591 (default 20)
8592
8593 vert Use a vertical separator for tabpanel.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008594 The vertical separator character is taken from
8595 "tpl_vert" in 'fillchars'.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008596 (default off)
8597
8598 Examples: >
8599 :set tabpanelopt=columns:16,align:right
8600 :set tabpanelopt=
8601 :set tabpanelopt=vert,align:right
8602 :set tabpanelopt=columns:16
8603<
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008604 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605'tabstop' 'ts' number (default 8)
8606 local to buffer
Damien Lejaya4a3f712025-05-30 17:36:37 +02008607 Defines the column multiple used to display the Horizontal Tab
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008608 character (ASCII 9); a Horizontal Tab always advances to the next tab
8609 stop.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008610 The value must be at least 1 and at most 9999.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008611 If Vim was compiled with |+vartabs| and |'vartabstop'| is set, this
8612 option is ignored.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008613 Leave it at 8 unless you have a strong reason (see usr |30.5|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008615
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8617'tagbsearch' 'tbs' boolean (default on)
8618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008620 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 searching makes searching for a tag a LOT faster, but a linear search
8622 will find more tags if the tags file wasn't properly sorted.
8623 Vim normally assumes that your tags files are sorted, or indicate that
8624 they are not sorted. Only when this is not the case does the
8625 'tagbsearch' option need to be switched off.
8626
8627 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008628 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 certain files, or retry all files with a linear search. When
8630 'tagbsearch' is off, only a linear search is done.
8631
8632 Linear searching is done anyway, for one file, when Vim finds a line
8633 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008634 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635< [The whitespace before and after the '0' must be a single <Tab>]
8636
8637 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008638 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 instead of a normal tag name, a retry is done with a linear search.
8640 Tags in unsorted tags files, and matches with different case will only
8641 be found in the retry.
8642
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008643 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008644 linear search can be avoided when case is ignored. Use a value of '2'
8645 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8646 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008647 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8648 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8649 used for this as well. Note that case must be folded to uppercase for
8650 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008651
8652 By default, tag searches are case-sensitive. Case is ignored when
8653 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8654 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008655 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8656 'tagcase' is "smart", and the pattern contains only lowercase
8657 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658
8659 When 'tagbsearch' is off, tags searching is slower when a full match
8660 exists, but faster when no full match exists. Tags in unsorted tags
8661 files may only be found with 'tagbsearch' off.
8662 When the tags file is not sorted, or sorted in a wrong way (not on
8663 ASCII byte value), 'tagbsearch' should be off, or the line given above
8664 must be included in the tags file.
8665 This option doesn't affect commands that find all matching tags (e.g.,
8666 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008668 *'tagcase'* *'tc'*
8669'tagcase' 'tc' string (default "followic")
8670 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008671 This option specifies how case is handled when searching the tags
8672 file:
8673 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008674 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008675 ignore Ignore case
8676 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008677 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008678 NOTE: This option is set to the Vi default value when 'compatible' is
8679 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008680
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008681 *'tagfunc'* *'tfu'*
8682'tagfunc' 'tfu' string (default: empty)
8683 local to buffer
8684 {not available when compiled without the |+eval|
8685 feature}
Christian Brabandtfb081922025-04-30 19:31:58 +02008686 This option specifies a function to be used to perform tag searches
8687 (including |taglist()|).
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008688 The function gets the tag pattern and should return a List of matching
8689 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008690 function and an example. The value can be the name of a function, a
8691 |lambda| or a |Funcref|. See |option-value-function| for more
8692 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008693 This option cannot be set from a |modeline| or in the |sandbox|, for
8694 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008695
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 *'taglength'* *'tl'*
8697'taglength' 'tl' number (default 0)
8698 global
8699 If non-zero, tags are significant up to this number of characters.
8700
8701 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8702'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8703 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008704 If on and using a tags file in another directory, file names in that
8705 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 NOTE: This option is set to the Vi default value when 'compatible' is
8707 set and to the Vim default value when 'compatible' is reset.
8708
8709 *'tags'* *'tag'* *E433*
8710'tags' 'tag' string (default "./tags,tags", when compiled with
8711 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8712 global or local to buffer |global-local|
8713 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008714 include a space or comma in a file name, precede it with backslashes
8715 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 When a file name starts with "./", the '.' is replaced with the path
8717 of the current file. But only when the 'd' flag is not included in
8718 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8719 |tags-option|.
8720 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008721 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8722 find all files named "tags" below "/lib". The filename itself cannot
8723 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008724 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008725 The |tagfiles()| function can be used to get a list of the file names
8726 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8728 files are also supported. They are automatically recognized. The
8729 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8730 differences are ignored (MS-Windows). |emacs-tags|
8731 The use of |:set+=| and |:set-=| is preferred when adding or removing
8732 file names from the list. This avoids problems when a future version
8733 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734
8735 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8736'tagstack' 'tgst' boolean (default on)
8737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 When on, the |tagstack| is used normally. When off, a ":tag" or
8739 ":tselect" command with an argument will not push the tag onto the
8740 tagstack. A following ":tag" without an argument, a ":pop" command or
8741 any other command that uses the tagstack will use the unmodified
8742 tagstack, but does change the pointer to the active entry.
8743 Resetting this option is useful when using a ":tag" command in a
8744 mapping which should not change the tagstack.
8745
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008746 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008747'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008748 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008749 {only available when compiled with the |+tcl/dyn|
8750 feature}
8751 Specifies the name of the Tcl shared library. The default is
8752 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008753 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008754 This option cannot be set from a |modeline| or in the |sandbox|, for
8755 security reasons.
8756
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 *'term'* *E529* *E530* *E531*
8758'term' string (default is $TERM, if that fails:
8759 in the GUI: "builtin_gui"
8760 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008761 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 on Unix: "ansi"
8764 on VMS: "ansi"
8765 on Win 32: "win32")
8766 global
8767 Name of the terminal. Used for choosing the terminal control
8768 characters. Environment variables are expanded |:set_env|.
8769 For example: >
8770 :set term=$TERM
8771< See |termcap|.
8772
8773 *'termbidi'* *'tbidi'*
8774 *'notermbidi'* *'notbidi'*
8775'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 {only available when compiled with the |+arabic|
8778 feature}
8779 The terminal is in charge of Bi-directionality of text (as specified
8780 by Unicode). The terminal is also expected to do the required shaping
8781 that some languages (such as Arabic) require.
8782 Setting this option implies that 'rightleft' will not be set when
8783 'arabic' is set and the value of 'arabicshape' will be ignored.
8784 Note that setting 'termbidi' has the immediate effect that
8785 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8786 This option is reset when the GUI is started.
8787 For further details see |arabic.txt|.
8788
8789 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008790'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 Encoding used for the terminal. This specifies what character
8793 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008794 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008795 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008796 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008797 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8799 Any attempts to set a different value will be rejected, and an error
8800 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008801 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 because the Win32 system always passes Unicode characters.
8803 When empty, the same encoding is used as for the 'encoding' option.
8804 This is the normal value.
8805 Not all combinations for 'termencoding' and 'encoding' are valid. See
8806 |encoding-table|.
8807 The value for this option must be supported by internal conversions or
8808 iconv(). When this is not possible no conversion will be done and you
8809 will probably experience problems with non-ASCII characters.
8810 Example: You are working with the locale set to euc-jp (Japanese) and
8811 want to edit a UTF-8 file: >
8812 :let &termencoding = &encoding
8813 :set encoding=utf-8
8814< You need to do this when your system has no locale support for UTF-8.
8815
Bram Moolenaar938ae282023-02-20 20:44:55 +00008816 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008817'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8818 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008819 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008820 {not available when compiled without the
8821 |+termguicolors| feature}
8822 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008823 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008824
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008825 Requires a ISO-8613-3 compatible terminal. If setting this option
8826 does not work (produces a colorless UI) reading |xterm-true-color|
8827 might help.
8828
8829 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8830 is required. Use this check to find out: >
8831 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008832< This requires Vim to be built with the |+vtp| feature.
8833
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008834 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008835
8836 When using Vim with Windows Terminal, the background of Windows
8837 Terminal is normally filled with the Vim background color. Setting
8838 'termguicolors' and the guibg of the Normal highlight group to NONE
8839 will make the background transparent: >
8840 :hi Normal guibg=NONE
8841<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008842 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008843
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008844 *'termwinkey'* *'twk'*
8845'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008846 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008847 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008848 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008849 The key can be specified as a single character, a |key-notation| (e.g.
8850 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8851 :set twk=X
8852 :set twk=^I
8853 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008854< The string must be one key stroke but can be multiple bytes.
8855 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008856 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008857 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008858
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008859 *'termwinscroll'* *'twsl'*
8860'termwinscroll' 'twsl' number (default 10000)
8861 local to buffer
8862 {not available when compiled without the
8863 |+terminal| feature}
8864 Number of scrollback lines to keep. When going over this limit the
8865 first 10% of the scrollback lines are deleted. This is just to reduce
8866 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008867 Also used as a limit for text sent to the terminal in one write,
8868 multiplied by the number of columns times 3 (average number of bytes
8869 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008870
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008871 *'termwinsize'* *'tws'*
8872'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008873 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008874 Size used when opening the |terminal| window. Format:
8875 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008876 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008877 - When set with a "x" (e.g., "24x80") the terminal size is not
8878 adjusted to the window size. If the window is smaller only the
8879 top-left part is displayed.
8880 - When set with a "*" (e.g., "10*50") the terminal size follows the
8881 window size, but will not be smaller than the specified rows and/or
8882 columns.
8883 - When rows is zero then use the height of the window.
8884 - When columns is zero then use the width of the window.
8885 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008886 - Can be overruled in the |term_start()| options with "term_rows" and
8887 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008888
8889 Examples:
8890 "30x0" uses 30 rows and the current window width.
8891 "20*0" uses at least 20 rows and the current window width.
8892 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008893 Note that the command running in the terminal window may still change
8894 the size of the terminal. In that case the Vim window will be
8895 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008896
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008897 *'termwintype'* *'twt'*
8898'termwintype' 'twt' string (default "")
8899 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008900 {only available when compiled with the |terminal|
8901 feature on MS-Windows}
8902 Specify the virtual console (pty) used when opening the terminal
8903 window.
8904
8905 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008906 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008907 "winpty" use winpty, fail if not supported
8908 "conpty" use |ConPTY|, fail if not supported
8909
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008910 |ConPTY| support depends on the platform. Windows 10 October 2018
8911 Update is the first version that supports ConPTY, however it is still
8912 considered unstable. ConPTY might become stable in the next release
8913 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008914 supported then you cannot open a terminal window.
8915
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 *'terse'* *'noterse'*
8917'terse' boolean (default off)
8918 global
8919 When set: Add 's' flag to 'shortmess' option (this makes the message
8920 for a search that hits the start or end of the file not being
8921 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8922 shortens a lot of messages}
8923
8924 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8925'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927 This option is obsolete. Use 'fileformats'.
8928 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8929 set to the default value for the current system. When 'textauto' is
8930 reset, 'fileformats' is made empty.
8931 NOTE: This option is set to the Vi default value when 'compatible' is
8932 set and to the Vim default value when 'compatible' is reset.
8933
8934 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008935'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 others: default off)
8937 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 This option is obsolete. Use 'fileformat'.
8939 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8940 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8941 "unix".
8942
8943 *'textwidth'* *'tw'*
8944'textwidth' 'tw' number (default 0)
8945 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 Maximum width of text that is being inserted. A longer line will be
8947 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008948 this.
8949 'textwidth' is set to 0 when the 'paste' option is set and restored
8950 when 'paste' is reset.
8951 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008953 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 NOTE: This option is set to 0 when 'compatible' is set.
8955
8956 *'thesaurus'* *'tsr'*
8957'thesaurus' 'tsr' string (default "")
8958 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008960 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8961 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008962
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008963 This option is not used if 'thesaurusfunc' is set, either for the
8964 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008965
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008966 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008968 name. See |option-backslash| about using backslashes. The use of
8969 |:set+=| and |:set-=| is preferred when adding or removing directories
8970 from the list. This avoids problems when a future version uses
8971 another default. Backticks cannot be used in this option for security
8972 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008974 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008975'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008976 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008977 {not available when compiled without the |+eval|
8978 feature}
8979 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008980 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008981 The value can be the name of a function, a |lambda| or a |Funcref|.
8982 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008983
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008984 This option cannot be set from a |modeline| or in the |sandbox|, for
8985 security reasons.
8986
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8988'tildeop' 'top' boolean (default off)
8989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 When on: The tilde command "~" behaves like an operator.
8991 NOTE: This option is reset when 'compatible' is set.
8992
8993 *'timeout'* *'to'* *'notimeout'* *'noto'*
8994'timeout' 'to' boolean (default on)
8995 global
laburnumT3f7855a2023-12-05 18:37:03 +01008996
Bram Moolenaar071d4272004-06-13 20:20:40 +00008997 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008998'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 These two options together determine the behavior when part of a
9001 mapped key sequence or keyboard code has been received:
9002
9003 'timeout' 'ttimeout' action ~
9004 off off do not time out
9005 on on or off time out on :mappings and key codes
9006 off on time out on key codes
9007
9008 If both options are off, Vim will wait until either the complete
9009 mapping or key sequence has been received, or it is clear that there
9010 is no mapping or key sequence for the received characters. For
9011 example: if you have mapped "vl" and Vim has received 'v', the next
9012 character is needed to see if the 'v' is followed by an 'l'.
9013 When one of the options is on, Vim will wait for about 1 second for
9014 the next character to arrive. After that the already received
9015 characters are interpreted as single characters. The waiting time can
9016 be changed with the 'timeoutlen' option.
9017 On slow terminals or very busy systems timing out may cause
9018 malfunctioning cursor keys. If both options are off, Vim waits
9019 forever after an entered <Esc> if there are key codes that start
9020 with <Esc>. You will have to type <Esc> twice. If you do not have
9021 problems with key codes, but would like to have :mapped key
9022 sequences not timing out in 1 second, set the 'ttimeout' option and
9023 reset the 'timeout' option.
9024
9025 NOTE: 'ttimeout' is reset when 'compatible' is set.
9026
9027 *'timeoutlen'* *'tm'*
9028'timeoutlen' 'tm' number (default 1000)
9029 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009030
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02009032'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 The time in milliseconds that is waited for a key code or mapped key
9035 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
9036 when part of a command has been typed.
9037 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
9038 different timeout value for key codes is desired set 'ttimeoutlen' to
9039 a non-negative number.
9040
9041 ttimeoutlen mapping delay key code delay ~
9042 < 0 'timeoutlen' 'timeoutlen'
9043 >= 0 'timeoutlen' 'ttimeoutlen'
9044
9045 The timeout only happens when the 'timeout' and 'ttimeout' options
9046 tell so. A useful setting would be >
9047 :set timeout timeoutlen=3000 ttimeoutlen=100
9048< (time out on mapping after three seconds, time out on key codes after
9049 a tenth of a second).
9050
9051 *'title'* *'notitle'*
9052'title' boolean (default off, on when title can be restored)
9053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 When on, the title of the window will be set to the value of
9055 'titlestring' (if it is not empty), or to:
9056 filename [+=-] (path) - VIM
9057 Where:
9058 filename the name of the file being edited
9059 - indicates the file cannot be modified, 'ma' off
9060 + indicates the file was modified
9061 = indicates the file is read-only
9062 =+ indicates the file is read-only and modified
9063 (path) is the path of the file being edited
9064 - VIM the server name |v:servername| or "VIM"
9065 Only works if the terminal supports setting window titles
9066 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02009067 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
9069 *X11*
9070 When Vim was compiled with HAVE_X11 defined, the original title will
9071 be restored if possible. The output of ":version" will include "+X11"
9072 when HAVE_X11 was defined, otherwise it will be "-X11". This also
9073 works for the icon name |'icon'|.
9074 But: When Vim was started with the |-X| argument, restoring the title
9075 will not work (except in the GUI).
9076 If the title cannot be restored, it is set to the value of 'titleold'.
9077 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009078 When using an xterm from a remote machine you can use this command: >
9079
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009081 ssh -X machine_name xterm &
9082<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 then the WINDOWID environment variable should be inherited and the
9084 title of the window should change back to what it should be after
9085 exiting Vim.
9086
9087 *'titlelen'*
9088'titlelen' number (default 85)
9089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009091 title. When the title is longer, only the end of the path name is
9092 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 Using a percentage makes this adapt to the width of the window. But
9094 it won't work perfectly, because the actual number of characters
9095 available also depends on the font used and other things in the title
9096 bar. When 'titlelen' is zero the full path is used. Otherwise,
9097 values from 1 to 30000 percent can be used.
9098 'titlelen' is also used for the 'titlestring' option.
9099
9100 *'titleold'*
9101'titleold' string (default "Thanks for flying Vim")
9102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 This option will be used for the window title when exiting Vim if the
9104 original title cannot be restored. Only happens if 'title' is on or
9105 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009106 This option cannot be set from a |modeline| or in the |sandbox|, for
9107 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 *'titlestring'*
9109'titlestring' string (default "")
9110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111 When this option is not empty, it will be used for the title of the
9112 window. This happens only when the 'title' option is on.
9113 Only works if the terminal supports setting window titles (currently
9114 Amiga console, Win32 console, all GUI versions and terminals with a
9115 non-empty 't_ts' option).
9116 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01009117 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009118
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02009120 expanded according to the rules used for 'statusline'. If it contains
9121 an invalid '%' format, the value is used as-is and no error or warning
9122 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009123 This option cannot be set in a modeline when 'modelineexpr' is off.
9124
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009126 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
9128< The value of 'titlelen' is used to align items in the middle or right
9129 of the available space.
9130 Some people prefer to have the file name first: >
9131 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
9132< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009133 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134 separating space only when needed.
9135 NOTE: Use of special characters in 'titlestring' may cause the display
9136 to be garbled (e.g., when it contains a CR or NL character).
9137 {not available when compiled without the |+statusline| feature}
9138
9139 *'toolbar'* *'tb'*
9140'toolbar' 'tb' string (default "icons,tooltips")
9141 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009142 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009143 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 possible values are:
9145 icons Toolbar buttons are shown with icons.
9146 text Toolbar buttons shown with text.
9147 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009148 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 tooltips Tooltips are active for toolbar buttons.
9150 Tooltips refer to the popup help text which appears after the mouse
9151 cursor is placed over a toolbar button for a brief moment.
9152
9153 If you want the toolbar to be shown with icons as well as text, do the
9154 following: >
9155 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009156< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 will show icons if both are requested.
9158
9159 If none of the strings specified in 'toolbar' are valid or if
9160 'toolbar' is empty, this option is ignored. If you want to disable
9161 the toolbar, you need to set the 'guioptions' option. For example: >
9162 :set guioptions-=T
9163< Also see |gui-toolbar|.
9164
9165 *'toolbariconsize'* *'tbis'*
9166'toolbariconsize' 'tbis' string (default "small")
9167 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01009168 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009170 tiny Use tiny icons.
9171 small Use small icons (default).
9172 medium Use medium-sized icons.
9173 large Use large icons.
9174 huge Use even larger icons.
9175 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009177 the current theme. Common dimensions are giant=48x48, huge=32x32,
9178 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009179
9180 If 'toolbariconsize' is empty, the global default size as determined
9181 by user preferences or the current theme is used.
9182
9183 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
9184'ttybuiltin' 'tbi' boolean (default on)
9185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 When on, the builtin termcaps are searched before the external ones.
9187 When off the builtin termcaps are searched after the external ones.
9188 When this option is changed, you should set the 'term' option next for
9189 the change to take effect, for example: >
9190 :set notbi term=$TERM
9191< See also |termcap|.
9192 Rationale: The default for this option is "on", because the builtin
9193 termcap entries are generally better (many systems contain faulty
9194 xterm entries...).
9195
9196 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009197'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 Indicates a fast terminal connection. More characters will be sent to
9200 the screen for redrawing, instead of using insert/delete line
9201 commands. Improves smoothness of redrawing when there are multiple
9202 windows and the terminal does not support a scrolling region.
9203 Also enables the extra writing of characters at the end of each screen
9204 line for lines that wrap. This helps when using copy/paste with the
9205 mouse in an xterm and other terminals.
9206
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009207 The default used to be set only for some terminal names, but these
9208 days nearly all terminals are fast, therefore the default is now "on".
9209 If you have a slow connection you may want to set this option off,
9210 e.g. depending on the host name: >
9211 if hostname() =~ 'faraway'
9212 set nottyfast
9213 endif
9214<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 *'ttymouse'* *'ttym'*
9216'ttymouse' 'ttym' string (default depends on 'term')
9217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009218 {only in Unix and VMS, doesn't work in the GUI; not
9219 available when compiled without |+mouse|}
9220 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009221 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 *xterm-mouse*
9223 xterm xterm-like mouse handling. The mouse generates
9224 "<Esc>[Mscr", where "scr" is three bytes:
9225 "s" = button state
9226 "c" = column plus 33
9227 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009228 This only works up to 223 columns! See "dec",
9229 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 xterm2 Works like "xterm", but with the xterm reporting the
9231 mouse position while the mouse is dragged. This works
9232 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009233 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 work. See below for how Vim detects this
9235 automatically.
9236 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009237 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009239 for the row and column. No other mouse events are
9240 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 *dec-mouse*
9242 dec DEC terminal mouse handling. The mouse generates a
9243 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009244 This is also available for an Xterm, if it was
9245 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246 *jsbterm-mouse*
9247 jsbterm JSB term mouse handling.
9248 *pterm-mouse*
9249 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009250 *urxvt-mouse*
9251 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009252 The mouse works only if the terminal supports this
9253 encoding style, but it does not have 223 columns limit
9254 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009255 *sgr-mouse*
9256 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009257 mouse reporting. The mouse works even in columns
9258 beyond 223. This option is backward compatible with
9259 "xterm2" because it can also decode "xterm2" style
9260 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261
9262 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009263 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9264 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9266 recognized, if enabled at compile time. DEC terminal mouse codes
9267 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009268 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9269 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009271 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9272 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9273 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009274 If the terminfo/termcap entry "XM" exists and the first number is
9275 "1006" then 'ttymouse' will be set to "sgr". This works for many
9276 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009277 Additionally, if vim is compiled with the |+termresponse| feature and
9278 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009279 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009281 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9282 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9283 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009284 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9285 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009286 :set t_RV=
9287<
9288 *'ttyscroll'* *'tsl'*
9289'ttyscroll' 'tsl' number (default 999)
9290 global
9291 Maximum number of lines to scroll the screen. If there are more lines
9292 to scroll the window is redrawn. For terminals where scrolling is
9293 very slow and redrawing is not slow this can be set to a small number,
9294 e.g., 3, to speed up displaying.
9295
9296 *'ttytype'* *'tty'*
9297'ttytype' 'tty' string (default from $TERM)
9298 global
9299 Alias for 'term', see above.
9300
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009301 *'undodir'* *'udir'*
9302'undodir' 'udir' string (default ".")
9303 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009304 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009305 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009306 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009307 "." means using the directory of the file. The undo file name for
9308 "file.txt" is ".file.txt.un~".
9309 For other directories the file name is the full path of the edited
9310 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009311 When writing: The first directory that exists is used. "." always
9312 works, no directories after "." will be used for writing.
9313 When reading all entries are tried to find an undo file. The first
9314 undo file that exists is used. When it cannot be read an error is
9315 given, no further entry is used.
9316 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009317 This option cannot be set from a |modeline| or in the |sandbox|, for
9318 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009319
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009320 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009321'undofile' 'udf' boolean (default off)
9322 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009323 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009324 When on, Vim automatically saves undo history to an undo file when
9325 writing a buffer to a file, and restores undo history from the same
9326 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009327 The directory where the undo file is stored is specified by 'undodir'.
9328 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009329 The undo file is not read when 'undoreload' causes the buffer from
9330 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009331 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009332 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009333
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009335'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009336 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009337 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009338 is kept in memory, higher numbers will cause more memory to be used.
9339 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9341 itself: >
9342 set ul=0
9343< But you can also get Vi compatibility by including the 'u' flag in
9344 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009345 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009346 Set to -1 for no undo at all. You might want to do this only for the
9347 current buffer: >
9348 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009350
9351 The local value is set to -123456 when the global value is to be used.
9352
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009353 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009355 *'undoreload'* *'ur'*
9356'undoreload' 'ur' number (default 10000)
9357 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009358 Save the whole buffer for undo when reloading it. This applies to the
9359 ":e!" command and reloading for when the buffer changed outside of
9360 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009361 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009362 of lines is smaller than the value of this option.
9363 Set this option to zero to disable undo for a reload.
9364
9365 When saving undo for a reload, any undo file is not read.
9366
9367 Note that this causes the whole buffer to be stored in memory. Set
9368 this option to a lower value if you run out of memory.
9369
Bram Moolenaar071d4272004-06-13 20:20:40 +00009370 *'updatecount'* *'uc'*
9371'updatecount' 'uc' number (default: 200)
9372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009373 After typing this many characters the swap file will be written to
9374 disk. When zero, no swap file will be created at all (see chapter on
9375 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9376 Vim with the "-n" option, see |startup|. When editing in readonly
9377 mode this option will be initialized to 10000.
9378 The swapfile can be disabled per buffer with |'swapfile'|.
9379 When 'updatecount' is set from zero to non-zero, swap files are
9380 created for all buffers that have 'swapfile' set. When 'updatecount'
9381 is set to zero, existing swap files are not deleted.
9382 Also see |'swapsync'|.
9383 This option has no meaning in buffers where |'buftype'| is "nofile"
9384 or "nowrite".
9385
9386 *'updatetime'* *'ut'*
9387'updatetime' 'ut' number (default 4000)
9388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009389 If this many milliseconds nothing is typed the swap file will be
9390 written to disk (see |crash-recovery|). Also used for the
9391 |CursorHold| autocommand event.
9392
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009393 *'varsofttabstop'* *'vsts'*
9394'varsofttabstop' 'vsts' string (default "")
9395 local to buffer
9396 {only available when compiled with the |+vartabs|
9397 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009398 Defines variable-width soft tab stops. The value is a comma-separated
9399 list of widths in columns. Each width defines the number of columns
9400 before the next soft tab stop. The last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009401
9402 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009403 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009404 to use the following: >
9405 :set varsofttabstop=8,32,8
Damien Lejay91af4c42025-06-12 21:56:19 +02009406< This sets soft tab stops at column 8, then at column 40 (8 + 32), and
9407 every 8 columns thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009408
Damien Lejay91af4c42025-06-12 21:56:19 +02009409 Note: this setting overrides 'softtabstop'.
9410 See section |30.5| of the user manual for detailed explanations on how
9411 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009412
9413 *'vartabstop'* *'vts'*
9414'vartabstop' 'vts' string (default "")
9415 local to buffer
9416 {only available when compiled with the |+vartabs|
9417 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009418 Defines variable-width tab stops. The value is a comma-separated list
9419 of widths in columns. Each width defines the number of columns
9420 before the next tab stop; the last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009421
Damien Lejay91af4c42025-06-12 21:56:19 +02009422 For example: >
9423 :set vartabstop=4,8
9424< This places the first tab stop 4 columns from the start of the line
9425 and each subsequent tab stop 8 columns apart.
9426
9427 Note: this setting overrides 'tabstop'.
9428 On UNIX, it is recommended to keep the default tabstop value of 8.
9429 Consider setting 'varsofttabstop' instead.
9430 See section |30.5| of the user manual for detailed explanations on how
9431 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009432
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 *'verbose'* *'vbs'*
9434'verbose' 'vbs' number (default 0)
9435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436 When bigger than zero, Vim will give messages about what it is doing.
9437 Currently, these messages are given:
9438 >= 1 When the viminfo file is read or written.
9439 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009440 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009441 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009442 >= 8 Files for which a group of autocommands is executed.
9443 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009444 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009445 >= 12 Every executed function.
9446 >= 13 When an exception is thrown, caught, finished, or discarded.
9447 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009448 >= 15 Every executed Ex command from a script (truncated at 200
9449 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009450 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009451
9452 This option can also be set with the "-V" argument. See |-V|.
9453 This option is also set by the |:verbose| command.
9454
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009455 When the 'verbosefile' option is set then the verbose messages are not
9456 displayed.
9457
9458 *'verbosefile'* *'vfile'*
9459'verbosefile' 'vfile' string (default empty)
9460 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009461 When not empty all messages are written in a file with this name.
9462 When the file exists messages are appended.
9463 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009464 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009465 Setting 'verbosefile' to a new value is like making it empty first.
9466 The difference with |:redir| is that verbose messages are not
9467 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009468 This option cannot be set from a |modeline| or in the |sandbox|, for
9469 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009470
Bram Moolenaar071d4272004-06-13 20:20:40 +00009471 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009472'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009473 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009474 for Unix: "$HOME/.vim/view" or
9475 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009476 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009478 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009479 feature}
9480 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009481 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009482 This option cannot be set from a |modeline| or in the |sandbox|, for
9483 security reasons.
9484
9485 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009486'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009487 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009488 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009489 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009490 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009491 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009492 word save and restore ~
9493 cursor cursor position in file and in window
9494 folds manually created folds, opened/closed folds and local
9495 fold options
9496 options options and mappings local to a window or buffer (not
9497 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009498 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009499 slash backslashes in file names replaced with forward
9500 slashes
9501 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009502 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009503 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009504
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009505 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009506 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009507 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508
9509 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009510'viminfo' 'vi' string (Vi default: "", Vim default for
9511 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009512 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9513 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009514 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009515 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009516 feature}
9517 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009518 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9519 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009520 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009521 consisting of a single character identifying the particular parameter,
9522 followed by a number or string which specifies the value of that
9523 parameter. If a particular character is left out, then the default
9524 value is used for that parameter. The following is a list of the
9525 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009527 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009528 ! When included, save and restore global variables that start
9529 with an uppercase letter, and don't contain a lowercase
9530 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009531 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009532 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009533 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009534 " Maximum number of lines saved for each register. Old name of
9535 the '<' item, with the disadvantage that you need to put a
9536 backslash before the ", otherwise it will be recognized as the
9537 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009538 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009539 % When included, save and restore the buffer list. If Vim is
9540 started with a file name argument, the buffer list is not
9541 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009542 buffer list is restored from the viminfo file. Quickfix
9543 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9544 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009545 When followed by a number, the number specifies the maximum
9546 number of buffers that are stored. Without a number all
9547 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009548 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009549 ' Maximum number of previously edited files for which the marks
9550 are remembered. This parameter must always be included when
9551 'viminfo' is non-empty.
9552 Including this item also means that the |jumplist| and the
9553 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009554 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009556 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 patterns are also saved. When not included, the value of
9558 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009559 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009560 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009561 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009562 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009563 < Maximum number of lines saved for each register. If zero then
9564 registers are not saved. When not included, all lines are
9565 saved. '"' is the old name for this item.
9566 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009567 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009568 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009569 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009570 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009571 c When included, convert the text in the viminfo file from the
9572 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009573 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009574 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 f Whether file marks need to be stored. If zero, file marks ('0
9576 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009577 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009579 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009580 h Disable the effect of 'hlsearch' when loading the viminfo
9581 file. When not included, it depends on whether ":nohlsearch"
9582 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009583 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009584 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009585 the 'n'. Must be at the end of the option! If the
9586 'viminfofile' option is set, that file name overrides the one
9587 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009588 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009589 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009590 r Removable media. The argument is a string (up to the next
9591 ','). This parameter can be given several times. Each
9592 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009593 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009594 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9595 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9596 ignored. Maximum length of each 'r' argument is 50
9597 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009598 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009599 s Maximum size of an item in Kbyte. If zero then registers are
9600 not saved. Currently only applies to registers. The default
9601 "s10" will exclude registers with more than 10 Kbyte of text.
9602 Also see the '<' item above: line count limit.
9603
9604 Example: >
9605 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9606<
9607 '50 Marks will be remembered for the last 50 files you
9608 edited.
9609 <1000 Contents of registers (up to 1000 lines each) will be
9610 remembered.
9611 s100 Registers with more than 100 Kbyte text are skipped.
9612 :0 Command-line history will not be saved.
9613 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9614 no / Since '/' is not specified, the default will be used,
9615 that is, save all of the search history, and also the
9616 previous search and substitute patterns.
9617 no % The buffer list will not be saved nor read back.
9618 no h 'hlsearch' highlighting will be restored.
9619
9620 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9621 load the contents of the file, this is not done automatically.
9622
9623 This option cannot be set from a |modeline| or in the |sandbox|, for
9624 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009625 NOTE: This option is set to the Vim default value when 'compatible'
9626 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009627
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009628 *'viminfofile'* *'vif'*
9629'viminfofile' 'vif' string (default: "")
9630 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009631 {not available when compiled without the |+viminfo|
9632 feature}
9633 When non-empty, overrides the file name used for viminfo.
9634 When equal to "NONE" no viminfo file will be read or written.
9635 This option can be set with the |-i| command line flag. The |--clean|
9636 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009637 This option cannot be set from a |modeline| or in the |sandbox|, for
9638 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009639
Bram Moolenaar071d4272004-06-13 20:20:40 +00009640 *'virtualedit'* *'ve'*
9641'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009642 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009643 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009644 block Allow virtual editing in Visual block mode.
9645 insert Allow virtual editing in Insert mode.
9646 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009647 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009648 none When used as the local value, do not allow virtual
9649 editing even when the global value is set. When used
9650 as the global value, "none" is the same as "".
9651 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009652
Bram Moolenaar071d4272004-06-13 20:20:40 +00009653 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009654 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009655 of the line. Useful for selecting a rectangle in Visual mode and
9656 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009657 "onemore" is not the same, it will only allow moving the cursor just
9658 after the last character of the line. This makes some commands more
9659 consistent. Previously the cursor was always past the end of the line
9660 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009661 break some plugins or Vim scripts. For example because |l| can move
9662 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009663 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009664 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009665 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009666 It doesn't make sense to combine "all" with "onemore", but you will
9667 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009668 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009669 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009670
9671 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9672'visualbell' 'vb' boolean (default off)
9673 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009674 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009675 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009676 use: >
9677 :set vb t_vb=
9678< If you want a short flash, you can use this on many terminals: >
9679 :set vb t_vb=[?5h$<100>[?5l
9680< Here $<100> specifies the time, you can use a smaller or bigger value
9681 to get a shorter or longer flash.
9682
9683 Note: Vim will limit the bell to once per half a second. This avoids
9684 having to wait for the flashing to finish when there are lots of
9685 bells, e.g. on key repeat. This also happens without 'visualbell'
9686 set.
9687
Bram Moolenaar071d4272004-06-13 20:20:40 +00009688 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9689 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9690 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009691
9692 Note: When the GUI starts, 't_vb' is reset to its default value. You
9693 might want to set it again in your |gvimrc|.
9694
Bram Moolenaar071d4272004-06-13 20:20:40 +00009695 Does not work on the Amiga, you always get a screen flash.
9696 Also see 'errorbells'.
9697
9698 *'warn'* *'nowarn'*
9699'warn' boolean (default on)
9700 global
9701 Give a warning message when a shell command is used while the buffer
9702 has been changed.
9703
9704 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9705'weirdinvert' 'wiv' boolean (default off)
9706 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009707 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009708 It is provided for backwards compatibility with version 4.x.
9709 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9710 vice versa. Has no effect when the GUI is running.
9711
9712 *'whichwrap'* *'ww'*
9713'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009715 Allow specified keys that move the cursor left/right to move to the
9716 previous/next line when the cursor is on the first/last character in
9717 the line. Concatenate characters to allow this for these keys:
9718 char key mode ~
9719 b <BS> Normal and Visual
9720 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009721 h "h" Normal and Visual (not recommended)
9722 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009723 < <Left> Normal and Visual
9724 > <Right> Normal and Visual
9725 ~ "~" Normal
9726 [ <Left> Insert and Replace
9727 ] <Right> Insert and Replace
9728 For example: >
9729 :set ww=<,>,[,]
9730< allows wrap only when cursor keys are used.
9731 When the movement keys are used in combination with a delete or change
9732 operator, the <EOL> also counts for a character. This makes "3h"
9733 different from "3dh" when the cursor crosses the end of a line. This
9734 is also true for "x" and "X", because they do the same as "dl" and
9735 "dh". If you use this, you may also want to use the mapping
9736 ":map <BS> X" to make backspace delete the character in front of the
9737 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009738 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009739 line (not an empty line) then it will not move to the next line. This
9740 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009741 NOTE: This option is set to the Vi default value when 'compatible' is
9742 set and to the Vim default value when 'compatible' is reset.
9743
9744 *'wildchar'* *'wc'*
9745'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009747 Character you have to type to start wildcard expansion in the
9748 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009749 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009750 The character is not recognized when used inside a macro. See
9751 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009752 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009753 <Esc> can be used, but hitting it twice in a row will still exit
9754 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009755 Although 'wc' is a number option, it can be specified as a number, a
9756 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9757 preceded with a caret (e.g. `^F` is CTRL-F): >
9758 :set wc=27
9759 :set wc=X
9760 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009761 :set wc=<Tab>
Girish Palya6b49fba2025-06-28 19:47:34 +02009762< 'wildchar' also enables completion in search pattern contexts such as
9763 |/|, |?|, |:s|, |:g|, |:v|, and |:vim|. To insert a literal <Tab>
9764 instead of triggering completion, type <C-V><Tab> or "\t".
9765 NOTE: This option is set to the Vi default value when 'compatible' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009766 set and to the Vim default value when 'compatible' is reset.
9767
9768 *'wildcharm'* *'wcm'*
9769'wildcharm' 'wcm' number (default: none (0))
9770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009771 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009772 recognized when used inside a macro. You can find "spare" command-line
9773 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009774 you'll never actually type 'wildcharm', just use it in mappings that
9775 automatically invoke completion mode, e.g.: >
9776 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009777 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009778< Then after typing :ss you can use CTRL-P & CTRL-N.
9779
9780 *'wildignore'* *'wig'*
9781'wildignore' 'wig' string (default "")
9782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009783 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009784 patterns is ignored when expanding |wildcards|, completing file or
9785 directory names, and influences the result of |expand()|, |glob()| and
9786 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009787 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9788 Also see 'suffixes'.
9789 Example: >
9790 :set wildignore=*.o,*.obj
9791< The use of |:set+=| and |:set-=| is preferred when adding or removing
9792 a pattern from the list. This avoids problems when a future version
9793 uses another default.
9794
h_east596a9f22023-11-21 21:24:23 +09009795 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009796'wildignorecase' 'wic' boolean (default off)
9797 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009798 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009799 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009800 Does not apply when the shell is used to expand wildcards, which
9801 happens when there are special characters.
9802
Bram Moolenaar071d4272004-06-13 20:20:40 +00009803 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009804'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009806 When 'wildmenu' is on, command-line completion operates in an enhanced
9807 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009808 the possible matches are shown.
9809 When 'wildoptions' contains "pum", then the completion matches are
9810 shown in a popup menu. Otherwise they are displayed just above the
9811 command line, with the first match highlighted (overwriting the status
9812 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009813 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009814 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9815 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9816 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009817 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009818 If there are more matches than can fit in the line, a ">" is shown on
9819 the right and/or a "<" is shown on the left. The status line scrolls
9820 as needed.
9821 The "wildmenu" mode is abandoned when a key is hit that is not used
9822 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009823 While the "wildmenu" is active, the following keys have special
9824 meanings:
9825 CTRL-P - go to the previous entry
9826 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009827 <CR> - in menu completion, when the cursor is just after a
9828 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009829 CTRL-E - end completion, go back to what was there before
9830 selecting a match.
9831 CTRL-Y - accept the currently selected match and stop
9832 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009833
9834 When not using the popup menu for command line completion, the
9835 following keys have special meanings:
9836 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009837 <Up> - in filename/menu name completion: move up into
9838 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009839 <Down> - in filename/menu name completion: move into a
9840 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009841
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009842 When using the popup menu for command line completion, the following
9843 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009844 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009845 <PageUp> - select a match several entries back
9846 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009847 <Left> - in filename/menu name completion: move up into
9848 parent directory or parent menu.
9849 <Right> - in filename/menu name completion: move into a
9850 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009851
Bram Moolenaar071d4272004-06-13 20:20:40 +00009852 This makes the menus accessible from the console |console-menus|.
9853
9854 If you prefer the <Left> and <Right> keys to move the cursor instead
9855 of selecting a different match, use this: >
9856 :cnoremap <Left> <Space><BS><Left>
9857 :cnoremap <Right> <Space><BS><Right>
9858<
9859 The "WildMenu" highlighting is used for displaying the current match
9860 |hl-WildMenu|.
9861
9862 *'wildmode'* *'wim'*
9863'wildmode' 'wim' string (Vim default: "full")
9864 global
Girish Palyaeded3362025-04-12 18:03:32 +02009865 Completion mode used for the character specified with 'wildchar'.
9866 This option is a comma-separated list of up to four parts,
9867 corresponding to the first, second, third, and fourth presses of
9868 'wildchar'. Each part is a colon-separated list of completion
9869 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009870
Girish Palyaeded3362025-04-12 18:03:32 +02009871 The possible behavior values are:
9872 "" Only complete (insert) the first match. No further
9873 matches are cycled or listed.
9874 "full" Complete the next full match. Cycles through all
9875 matches, returning to the original input after the
9876 last match. If 'wildmenu' is enabled, it will be
9877 shown.
9878 "longest" Complete to the longest common substring. If this
9879 doesn't extend the input, the next 'wildmode' part is
9880 used.
9881 "list" If multiple matches are found, list all of them.
9882 "lastused" When completing buffer names, sort them by most
9883 recently used (excluding the current buffer). Only
9884 applies to buffer name completion.
9885 "noselect" If 'wildmenu' is enabled, show the menu but do not
9886 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009887 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009888 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009889
Girish Palyaeded3362025-04-12 18:03:32 +02009890 Some useful combinations of colon-separated values:
9891 "longest:full" Start with the longest common string and show
9892 'wildmenu' (if enabled). Does not cycle
9893 through full matches.
9894 "list:full" List all matches and complete first match.
9895 "list:longest" List all matches and complete till the longest
9896 common prefix.
9897 "list:lastused" List all matches. When completing buffers,
9898 sort them by most recently used (excluding the
9899 current buffer).
9900 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9901 if it is active. When completing buffers,
9902 sort them by most recently used (excluding the
9903 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009904
9905 Examples: >
9906 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009907< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009908 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009909< First press: longest common substring
9910 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009911 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009912< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009913 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009914< First press: list matches only
9915 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009916 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009917< First press: longest common substring
9918 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009919 :set wildmode=noselect:full
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02009920< First press: show 'wildmenu' without completing or selecting
9921 Second press: cycle full matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009922 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009923< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009924 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009925
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009926 *'wildoptions'* *'wop'*
9927'wildoptions' 'wop' string (default "")
9928 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009929 A list of words that change how |cmdline-completion| is done.
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009930
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009931 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009932 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009933 this value is specified, wildcard expansion will not
9934 be used for completion. The matches will be sorted by
9935 the "best match" rather than alphabetically sorted.
9936 This will find more matches than the wildcard
9937 expansion. Currently fuzzy matching based completion
9938 is not supported for file and directory names and
9939 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009940 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009941 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009942 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009943 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009944 is displayed per line. Often used tag kinds are:
9945 d #define
9946 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009947
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009948 This option does not apply to |ins-completion|. See 'completeopt' for
9949 that.
9950
Bram Moolenaar071d4272004-06-13 20:20:40 +00009951 *'winaltkeys'* *'wak'*
9952'winaltkeys' 'wak' string (default "menu")
9953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009954 {only used in Win32, Motif, GTK and Photon GUI}
9955 Some GUI versions allow the access to menu entries by using the ALT
9956 key in combination with a character that appears underlined in the
9957 menu. This conflicts with the use of the ALT key for mappings and
9958 entering special characters. This option tells what to do:
9959 no Don't use ALT keys for menus. ALT key combinations can be
9960 mapped, but there is no automatic handling. This can then be
9961 done with the |:simalt| command.
9962 yes ALT key handling is done by the windowing system. ALT key
9963 combinations cannot be mapped.
9964 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009965 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009966 keys can be mapped.
9967 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9968 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009969 This option is not used for <F10>; on Win32 and with GTK <F10> will
9970 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009971
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009972 *'wincolor'* *'wcr'*
9973'wincolor' 'wcr' string (default empty)
9974 local to window
9975 Highlight group name to use for this window instead of the Normal
9976 color |hl-Normal|.
9977
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009978 *'window'* *'wi'*
9979'window' 'wi' number (default screen height - 1)
9980 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009981 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9982 window and the value is smaller than 'lines' minus one. The screen
9983 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009984 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9985 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009986 When resizing the Vim window, and the value is smaller than 1 or more
9987 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009988 Note: Do not confuse this with the height of the Vim window, use
9989 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009990
Doug Kearns002548b2025-06-05 21:18:09 +02009991 *'winfixbuf'* *'wfb'*
Colin Kennedy21570352024-03-03 16:16:47 +01009992'winfixbuf' 'wfb' boolean (default off)
9993 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009994 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009995 For example, attempting to change the buffer with |:edit| will fail.
9996 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009997 also skip any window with 'winfixbuf' enabled. However if an Ex
9998 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009999
laburnumT3f7855a2023-12-05 18:37:03 +010010000 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
10001'winfixheight' 'wfh' boolean (default off)
10002 local to window |local-noglobal|
10003 Keep the window height when windows are opened or closed and
10004 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
10005 |preview-window| and |quickfix-window|.
10006 The height may be changed anyway when running out of room.
10007
10008 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
10009'winfixwidth' 'wfw' boolean (default off)
10010 local to window |local-noglobal|
10011 Keep the window width when windows are opened or closed and
10012 'equalalways' is set. Also for |CTRL-W_=|.
10013 The width may be changed anyway when running out of room.
10014
Bram Moolenaar071d4272004-06-13 20:20:40 +000010015 *'winheight'* *'wh'* *E591*
10016'winheight' 'wh' number (default 1)
10017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010018 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010019 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +000010020 focus goes to a window that is smaller, its size is increased, at the
10021 cost of the height of other windows.
10022 Set 'winheight' to a small number for normal editing.
10023 Set it to 999 to make the current window fill most of the screen.
10024 Other windows will be only 'winminheight' high. This has the drawback
10025 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
10026 to create only two windows, set the option after startup is done,
10027 using the |VimEnter| event: >
10028 au VimEnter * set winheight=999
10029< Minimum value is 1.
10030 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010031 height of the current window.
10032 'winheight' applies to the current window. Use 'winminheight' to set
10033 the minimal height for other windows.
10034
Bram Moolenaar071d4272004-06-13 20:20:40 +000010035 *'winminheight'* *'wmh'*
10036'winminheight' 'wmh' number (default 1)
10037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010038 The minimal height of a window, when it's not the current window.
10039 This is a hard minimum, windows will never become smaller.
10040 When set to zero, windows may be "squashed" to zero lines (i.e. just a
10041 status bar) if necessary. They will return to at least one line when
10042 they become active (since the cursor has to have somewhere to go.)
10043 Use 'winheight' to set the minimal height of the current window.
10044 This option is only checked when making a window smaller. Don't use a
10045 large number, it will cause errors when opening more than a few
10046 windows. A value of 0 to 3 is reasonable.
10047
10048 *'winminwidth'* *'wmw'*
10049'winminwidth' 'wmw' number (default 1)
10050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010051 The minimal width of a window, when it's not the current window.
10052 This is a hard minimum, windows will never become smaller.
10053 When set to zero, windows may be "squashed" to zero columns (i.e. just
10054 a vertical separator) if necessary. They will return to at least one
10055 line when they become active (since the cursor has to have somewhere
10056 to go.)
10057 Use 'winwidth' to set the minimal width of the current window.
10058 This option is only checked when making a window smaller. Don't use a
10059 large number, it will cause errors when opening more than a few
10060 windows. A value of 0 to 12 is reasonable.
10061
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010062 *'winptydll'*
10063'winptydll' string (default "winpty32.dll" or "winpty64.dll")
10064 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010065 {only available when compiled with the |terminal|
10066 feature on MS-Windows}
10067 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +020010068 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +020010069 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010070 a fallback.
10071 Environment variables are expanded |:set_env|.
10072 This option cannot be set from a |modeline| or in the |sandbox|, for
10073 security reasons.
10074
Bram Moolenaar071d4272004-06-13 20:20:40 +000010075 *'winwidth'* *'wiw'* *E592*
10076'winwidth' 'wiw' number (default 20)
10077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010078 Minimal number of columns for the current window. This is not a hard
10079 minimum, Vim will use fewer columns if there is not enough room. If
10080 the current window is smaller, its size is increased, at the cost of
10081 the width of other windows. Set it to 999 to make the current window
10082 always fill the screen. Set it to a small number for normal editing.
10083 The width is not adjusted after one of the commands to change the
10084 width of the current window.
10085 'winwidth' applies to the current window. Use 'winminwidth' to set
10086 the minimal width for other windows.
10087
Foxe Chenb90c2392025-06-27 21:10:35 +020010088 *'wlseat'* *'wse'*
10089'wlseat' 'wse' string (default "")
10090 global
10091 {only when the |+wayland| feature is included}
10092 Specifies the Wayland seat to use for Wayland functionality,
Hirohito Higashi73b96502025-06-28 18:18:21 +020010093 specifically the clipboard. If the seat does not exist, then the
Foxe Chenb90c2392025-06-27 21:10:35 +020010094 option will still be set to the new value, with the Wayland clipboard
Hirohito Higashi73b96502025-06-28 18:18:21 +020010095 being unavailable as a result. If an empty value is passed then Vim
Foxe Chen7a4cf4b2025-06-29 18:00:46 +020010096 will attempt to use the first seat found available. Updating this
Foxe Chenb90c2392025-06-27 21:10:35 +020010097 option will also update |v:clipmethod|.
10098
Hirohito Higashi73b96502025-06-28 18:18:21 +020010099 *'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
Foxe Chenb90c2392025-06-27 21:10:35 +020010100'wlsteal' 'wst' boolean (default off)
10101 global
10102 {only when the |+wayland_clipboard| feature is included}
10103 When enabled, then allow Vim to steal focus by creating a temporary
Hirohito Higashi73b96502025-06-28 18:18:21 +020010104 surface, in order to access the clipboard. For more information see
Foxe Chenb90c2392025-06-27 21:10:35 +020010105 |wayland-focus-steal|.
10106
10107 *'wltimeoutlen'* *'wtm'*
10108'wltimeoutlen' 'wtm' number (default 500)
10109 global
10110 {only when the |+wayland| feature is included}
10111 The timeout in milliseconds before Vim gives up on waiting for the
10112 Wayland compositor. While Vim waits on the compositor, it is
10113 unresponsive to input and does not update the screen. Therefore
10114 setting this to a lower value may make Vim feel more responsive in
10115 some cases. On the other hand, it may also mean you receive errors
10116 when the compositor takes more time to respond than usual.
10117
10118 Additionally, this option is also used as the maximum timeout when
10119 waiting for a surface to gain focus, see |wayland-focus-steal|.
10120
Bram Moolenaar071d4272004-06-13 20:20:40 +000010121 *'wrap'* *'nowrap'*
10122'wrap' boolean (default on)
10123 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +000010124 This option changes how text is displayed. It doesn't change the text
10125 in the buffer, see 'textwidth' for that.
10126 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010127 displaying continues on the next line. When off lines will not wrap
10128 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +000010129 moved to a part that is not shown, the screen will scroll
10130 horizontally.
10131 The line will be broken in the middle of a word if necessary. See
10132 'linebreak' to get the break at a word boundary.
10133 To make scrolling horizontally a bit more useful, try this: >
10134 :set sidescroll=5
10135 :set listchars+=precedes:<,extends:>
10136< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010137 This option can't be set from a |modeline| when the 'diff' option is
10138 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010139
10140 *'wrapmargin'* *'wm'*
10141'wrapmargin' 'wm' number (default 0)
10142 local to buffer
10143 Number of characters from the right window border where wrapping
10144 starts. When typing text beyond this limit, an <EOL> will be inserted
10145 and inserting continues on the next line.
10146 Options that add a margin, such as 'number' and 'foldcolumn', cause
10147 the text width to be further reduced. This is Vi compatible.
10148 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +020010149 This option is set to 0 when 'paste' is set and restored when 'paste'
10150 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +020010151 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010152
10153 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
10154'wrapscan' 'ws' boolean (default on) *E384* *E385*
10155 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +000010156 Searches wrap around the end of the file. Also applies to |]s| and
10157 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010158
10159 *'write'* *'nowrite'*
10160'write' boolean (default on)
10161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010162 Allows writing files. When not set, writing a file is not allowed.
10163 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010164 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +000010165 argument. Filtering text is still possible, even though this requires
10166 writing a temporary file.
10167
10168 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
10169'writeany' 'wa' boolean (default off)
10170 global
10171 Allows writing to any file with no need for "!" override.
10172
10173 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
10174'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
10175 otherwise)
10176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010177 Make a backup before overwriting a file. The backup is removed after
10178 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +020010179 also on.
10180 WARNING: Switching this option off means that when Vim fails to write
10181 your buffer correctly and then, for whatever reason, Vim exits, you
10182 lose both the original file and what you were writing. Only reset
10183 this option if your file system is almost full and it makes the write
10184 fail (and make sure not to exit Vim until the write was successful).
10185 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010186 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +010010187 Depending on 'backupcopy' the backup is a new file or the original
10188 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010189 NOTE: This option is set to the default value when 'compatible' is
10190 set.
10191
10192 *'writedelay'* *'wd'*
10193'writedelay' 'wd' number (default 0)
10194 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +020010195 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010196 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010010197 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010198
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010199 *'xtermcodes'* *'noxtermcodes'*
10200'xtermcodes' boolean (default on)
10201 global
10202 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +000010203 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010204 key codes and number of colors from the terminal. This takes care of
10205 various configuration options of the terminal that cannot be obtained
10206 from the termlib/terminfo entry, see |xterm-codes|.
10207 A side effect may be that t_Co changes and Vim will redraw the
10208 display.
10209
10210
Bram Moolenaar91f84f62018-07-29 15:07:52 +020010211 vim:tw=78:ts=8:noet:ft=help:norl: