blob: e71f0d635fb838fabb64611e2ee597096d49989e [file] [log] [blame]
Girish Palya93c2d5b2025-07-08 21:29:02 +02001*options.txt* For Vim version 9.1. Last change: 2025 Jul 08
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|).
Girish Palyaba11e782025-07-05 16:11:44 +02002126 Unlike other sources, functions can provide completions starting
2127 from a non-keyword character before the cursor, and their
2128 start position for replacing text may differ from other sources.
Girish Palyacbe53192025-04-14 22:13:15 +02002129 If the Dict returned by the {func} includes {"refresh": "always"},
2130 the function will be invoked again whenever the leading text
2131 changes.
Girish Palyacbe53192025-04-14 22:13:15 +02002132 If generating matches is potentially slow, |complete_check()|
2133 should be used to avoid blocking and preserve editor
2134 responsiveness.
Girish Palya14f6da52025-05-26 19:04:25 +02002135 F equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002136 the 'completefunc' option.
Girish Palya14f6da52025-05-26 19:04:25 +02002137 o equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002138 the 'omnifunc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139
2140 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2141 not executed, this may lead to unexpected completions from some files
2142 (gzipped files for example). Unloaded buffers are not scanned for
2143 whole-line completion.
2144
2145 The default is ".,w,b,u,t,i", which means to scan:
2146 1. the current buffer
2147 2. buffers in other windows
2148 3. other loaded buffers
2149 4. unloaded buffers
2150 5. tags
2151 6. included files
2152
2153 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002154 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2155 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156
Girish Palya0ac1eb32025-04-16 20:18:33 +02002157 An optional match limit can be specified for a completion source by
2158 appending a caret ("^") followed by a {count} to the source flag.
2159 For example: ".^9,w,u,t^5" limits matches from the current buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02002160 to 9 and from tags to 5. Other sources remain unlimited.
2161 Note: The match limit takes effect only during forward completion
2162 (CTRL-N) and is ignored during backward completion (CTRL-P).
Girish Palya0ac1eb32025-04-16 20:18:33 +02002163
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002164 *'completefunc'* *'cfu'*
2165'completefunc' 'cfu' string (default: empty)
2166 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002167 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002168 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002169 This option specifies a function to be used for Insert mode completion
2170 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002171 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002172 invoked and what it should return. The value can be the name of a
2173 function, a |lambda| or a |Funcref|. See |option-value-function| for
2174 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002175 This option cannot be set from a |modeline| or in the |sandbox|, for
2176 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002177
glepnirf31cfa22025-03-06 21:59:13 +01002178 *'completefuzzycollect'* *'cfc'*
2179'completefuzzycollect' 'cfc' string (default: empty)
2180 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002181 A comma-separated list of strings to enable fuzzy collection for
2182 specific |ins-completion| modes, affecting how matches are gathered
2183 during completion. For specified modes, fuzzy matching is used to
2184 find completion candidates instead of the standard prefix-based
2185 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002186
glepnir58760162025-03-13 21:39:51 +01002187 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2188 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2189 "b", "u", "U" and "k{dict}" in 'complete'
2190 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002191
glepnir58760162025-03-13 21:39:51 +01002192 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002193
glepnir58760162025-03-13 21:39:51 +01002194 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002195
Christian Brabandtf22580e2025-03-14 12:05:52 +01002196 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002197 can identify the longest common string among the best fuzzy matches
2198 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002199
glepnir6a89c942024-10-01 20:32:12 +02002200 *'completeitemalign'* *'cia'*
2201'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2202 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002203 A comma-separated list of strings that controls the alignment and
2204 display order of items in the popup menu during Insert mode
2205 completion. The supported values are "abbr", "kind", and "menu".
2206 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002207 popup menu. Note: must always contain those three values in any
2208 order.
2209
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002210 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002211'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002212 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002213 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002214 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002215
glepnira2c55592025-02-28 17:43:42 +01002216 fuzzy Enable |fuzzy-matching| for completion candidates. This
2217 allows for more flexible and intuitive matching, where
2218 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002219 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002220 does not affect the collection of candidate list, it only
2221 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002222 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002223 to gather more alternatives for your candidate list,
2224 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002225
2226 longest Only insert the longest common text of the matches. If
2227 the menu is displayed you can use CTRL-L to add more
2228 characters. Whether case is ignored depends on the kind
2229 of completion. For buffer text the 'ignorecase' option is
2230 used.
2231
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002232 menu Use a popup menu to show the possible completions. The
2233 menu is only shown when there is more than one match and
2234 sufficient colors are available. |ins-completion-menu|
2235
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002236 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002237 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002238 match, e.g., what file it comes from.
2239
Girish Palyacb3b7522025-04-18 18:52:28 +02002240 nearest Matches are listed based on their proximity to the cursor
2241 position, unlike the default behavior, which only
2242 considers proximity for matches appearing below the
2243 cursor. This applies only to matches from the current
Girish Palyab1565882025-04-15 20:16:00 +02002244 buffer. No effect if "fuzzy" is present.
2245
glepnira2c55592025-02-28 17:43:42 +01002246 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002247 a match from the menu. Only works in combination with
2248 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002249
glepnira2c55592025-02-28 17:43:42 +01002250 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002251 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002252 present, "noselect" has precedence.
2253
2254 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002255 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002256 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002257
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002258 popup Show extra information about the currently selected
2259 completion in a popup window. Only works in combination
2260 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002261 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002262 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002263
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002264 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002265 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002266 |CompleteChanged| autocommand to fetch the info and call
2267 |popup_show()| once the popup has been filled.
2268 See the example at |complete-popuphidden|.
2269 {only works when compiled with the |+textprop| feature}
2270
glepniredd4ac32025-01-29 18:53:51 +01002271 preinsert
2272 Preinsert the portion of the first candidate word that is
2273 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002274 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002275 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002276
2277 preview Show extra information about the currently selected
2278 completion in the preview window. Only works in
2279 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002280
Ilya Grigoriev053aee02025-06-11 21:07:35 +02002281 This option does not apply to |cmdline-completion|. See 'wildoptions'
2282 for that.
2283
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002284 *'completepopup'* *'cpp'*
2285'completepopup' 'cpp' string (default empty)
2286 global
2287 {not available when compiled without the |+textprop|
2288 or |+quickfix| feature}
2289 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002290 properties of the info popup when it is created. If an info popup
2291 window already exists it is closed, so that the option value is
2292 applied when it is created again.
2293 You can also use |popup_findinfo()| and then set properties for an
2294 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002295
laburnumT3f7855a2023-12-05 18:37:03 +01002296 *'completeslash'* *'csl'*
2297'completeslash' 'csl' string (default: "")
2298 local to buffer
2299 {only for MS-Windows}
2300 When this option is set it overrules 'shellslash' for completion:
2301 - When this option is set to "slash", a forward slash is used for path
2302 completion in insert mode. This is useful when editing HTML tag, or
2303 Makefile with 'noshellslash' on MS-Windows.
2304 - When this option is set to "backslash", backslash is used. This is
2305 useful when editing a batch file with 'shellslash' set on MS-Windows.
2306 - When this option is empty, same character is used as for
2307 'shellslash'.
2308 For Insert mode completion the buffer-local value is used. For
2309 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002310
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002311 *'concealcursor'* *'cocu'*
2312'concealcursor' 'cocu' string (default: "")
2313 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002314 {not available when compiled without the |+conceal|
2315 feature}
2316 Sets the modes in which text in the cursor line can also be concealed.
2317 When the current mode is listed then concealing happens just like in
2318 other lines.
2319 n Normal mode
2320 v Visual mode
2321 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002322 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002323
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002324 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002325 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002326 are moving around text is concealed, but when starting to insert text
2327 or selecting a Visual area the concealed text is displayed, so that
2328 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002329 Keep in mind that the cursor position is not always where it's
2330 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002331
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002332 *'conceallevel'* *'cole'*
2333'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002334 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002335 {not available when compiled without the |+conceal|
2336 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002337 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2338 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002339
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002340 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002341 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002342 1 Each block of concealed text is replaced with one
2343 character. If the syntax item does not have a custom
2344 replacement character defined (see |:syn-cchar|) the
2345 character defined in 'listchars' is used (default is a
2346 space).
2347 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002348 2 Concealed text is completely hidden unless it has a
2349 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002350 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002351 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002352
Bram Moolenaara7781e02010-07-19 20:13:22 +02002353 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002354 edit and copy the text. This can be changed with the 'concealcursor'
2355 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002356
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2358'confirm' 'cf' boolean (default off)
2359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 When 'confirm' is on, certain operations that would normally
2361 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2362 instead raise a |dialog| asking if you wish to save the current
2363 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2364 If 'confirm' is off you can still activate confirmation for one
2365 command only (this is most useful in mappings) with the |:confirm|
2366 command.
2367 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2368
2369 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2370'conskey' 'consk' boolean (default off)
2371 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002372 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373
2374 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2375'copyindent' 'ci' boolean (default off)
2376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 Copy the structure of the existing lines indent when autoindenting a
2378 new line. Normally the new indent is reconstructed by a series of
2379 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2380 in which case only spaces are used). Enabling this option makes the
2381 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002382 existing line. 'expandtab' has no effect on these characters, a Tab
2383 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002385 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 Also see 'preserveindent'.
2387
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002388 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002389'cpoptions' 'cpo' string (Vim default: "aABceFsz",
glepnir4ade6682025-07-03 20:41:23 +02002390 Vi default: all flags, except "#{|&/\.~"
h-east90e1fe42024-08-12 18:26:08 +02002391 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002394 this indicates Vi-compatible behavior. This is used for things where
2395 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 'cpoptions' stands for "compatible-options".
2397 Commas can be added for readability.
2398 To avoid problems with flags that are added in the future, use the
2399 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002400
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 NOTE: This option is set to the Vi default value when 'compatible' is
2402 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002403
2404 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2405 is saved, 'cpoptions' is set to the Vim default, and the saved value
2406 is restored at the end of the script. Changes to the value of
2407 'cpoptions' will be applied to the saved value, but keep in mind that
2408 removing a flag that is not present when 'cpoptions' is changed has no
2409 effect. In the |.vimrc| file the value is not restored, thus using
2410 `vim9script` in the |.vimrc| file results in using the Vim default.
2411
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002412 NOTE: This option is set to the POSIX default value at startup when
2413 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002414 variable exists |posix|. This means Vim tries to behave like the
2415 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416
2417 contains behavior ~
2418 *cpo-a*
2419 a When included, a ":read" command with a file name
2420 argument will set the alternate file name for the
2421 current window.
2422 *cpo-A*
2423 A When included, a ":write" command with a file name
2424 argument will set the alternate file name for the
2425 current window.
2426 *cpo-b*
2427 b "\|" in a ":map" command is recognized as the end of
2428 the map command. The '\' is included in the mapping,
2429 the text after the '|' is interpreted as the next
2430 command. Use a CTRL-V instead of a backslash to
2431 include the '|' in the mapping. Applies to all
2432 mapping, abbreviation, menu and autocmd commands.
2433 See also |map_bar|.
2434 *cpo-B*
2435 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002436 abbreviations, user commands and the "to" part of the
2437 menu commands. Remove this flag to be able to use a
2438 backslash like a CTRL-V. For example, the command
2439 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 'B' included: "\^[" (^[ is a real <Esc>)
2441 'B' excluded: "<Esc>" (5 characters)
2442 ('<' excluded in both cases)
2443 *cpo-c*
2444 c Searching continues at the end of any match at the
2445 cursor position, but not further than the start of the
2446 next line. When not present searching continues
2447 one character from the cursor position. With 'c'
2448 "abababababab" only gets three matches when repeating
2449 "/abab", without 'c' there are five matches.
2450 *cpo-C*
2451 C Do not concatenate sourced lines that start with a
2452 backslash. See |line-continuation|.
2453 *cpo-d*
2454 d Using "./" in the 'tags' option doesn't mean to use
2455 the tags file relative to the current file, but the
2456 tags file in the current directory.
2457 *cpo-D*
2458 D Can't use CTRL-K to enter a digraph after Normal mode
2459 commands with a character argument, like |r|, |f| and
2460 |t|.
2461 *cpo-e*
2462 e When executing a register with ":@r", always add a
2463 <CR> to the last line, also when the register is not
2464 linewise. If this flag is not present, the register
2465 is not linewise and the last line does not end in a
2466 <CR>, then the last line is put on the command-line
2467 and can be edited before hitting <CR>.
2468 *cpo-E*
2469 E It is an error when using "y", "d", "c", "g~", "gu" or
2470 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002471 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 This makes "y0" fail in the first column.
2473 *cpo-f*
2474 f When included, a ":read" command with a file name
2475 argument will set the file name for the current buffer,
2476 if the current buffer doesn't have a file name yet.
2477 *cpo-F*
2478 F When included, a ":write" command with a file name
2479 argument will set the file name for the current
2480 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002481 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 *cpo-g*
2483 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002484 *cpo-H*
2485 H When using "I" on a line with only blanks, insert
2486 before the last blank. Without this flag insert after
2487 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 *cpo-i*
2489 i When included, interrupting the reading of a file will
2490 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002491 *cpo-I*
2492 I When moving the cursor up or down just after inserting
2493 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 *cpo-j*
2495 j When joining lines, only add two spaces after a '.',
2496 not after '!' or '?'. Also see 'joinspaces'.
2497 *cpo-J*
2498 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002499 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 white space.
2501 *cpo-k*
2502 k Disable the recognition of raw key codes in
2503 mappings, abbreviations, and the "to" part of menu
2504 commands. For example, if <Key> sends ^[OA (where ^[
2505 is <Esc>), the command ":map X ^[OA" results in X
2506 being mapped to:
2507 'k' included: "^[OA" (3 characters)
2508 'k' excluded: "<Key>" (one key code)
2509 Also see the '<' flag below.
2510 *cpo-K*
2511 K Don't wait for a key code to complete when it is
2512 halfway a mapping. This breaks mapping <F1><F1> when
2513 only part of the second <F1> has been read. It
2514 enables cancelling the mapping by typing <F1><Esc>.
2515 *cpo-l*
2516 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002517 literally, only "\]", "\^", "\-" and "\\" are special.
2518 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2520 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002521 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 *cpo-L*
2523 L When the 'list' option is set, 'wrapmargin',
2524 'textwidth', 'softtabstop' and Virtual Replace mode
2525 (see |gR|) count a <Tab> as two characters, instead of
2526 the normal behavior of a <Tab>.
2527 *cpo-m*
2528 m When included, a showmatch will always wait half a
2529 second. When not included, a showmatch will wait half
2530 a second or until a character is typed. |'showmatch'|
2531 *cpo-M*
2532 M When excluded, "%" matching will take backslashes into
2533 account. Thus in "( \( )" and "\( ( \)" the outer
2534 parenthesis match. When included "%" ignores
2535 backslashes, which is Vi compatible.
2536 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002537 n When included, the column used for 'number' and
2538 'relativenumber' will also be used for text of wrapped
2539 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 *cpo-o*
2541 o Line offset to search command is not remembered for
2542 next search.
2543 *cpo-O*
2544 O Don't complain if a file is being overwritten, even
2545 when it didn't exist when editing it. This is a
2546 protection against a file unexpectedly created by
2547 someone else. Vi didn't complain about this.
2548 *cpo-p*
2549 p Vi compatible Lisp indenting. When not present, a
2550 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002551 *cpo-P*
2552 P When included, a ":write" command that appends to a
2553 file will set the file name for the current buffer, if
2554 the current buffer doesn't have a file name yet and
2555 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002556 *cpo-q*
2557 q When joining multiple lines leave the cursor at the
2558 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 *cpo-r*
2560 r Redo ("." command) uses "/" to repeat a search
2561 command, instead of the actually used search string.
2562 *cpo-R*
2563 R Remove marks from filtered lines. Without this flag
2564 marks are kept like |:keepmarks| was used.
2565 *cpo-s*
2566 s Set buffer options when entering the buffer for the
2567 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 set when the buffer is created.
2570 *cpo-S*
2571 S Set buffer options always when entering a buffer
2572 (except 'readonly', 'fileformat', 'filetype' and
2573 'syntax'). This is the (most) Vi compatible setting.
2574 The options are set to the values in the current
2575 buffer. When you change an option and go to another
2576 buffer, the value is copied. Effectively makes the
2577 buffer options global to all buffers.
2578
2579 's' 'S' copy buffer options
2580 no no when buffer created
2581 yes no when buffer first entered (default)
2582 X yes each time when buffer entered (vi comp.)
2583 *cpo-t*
2584 t Search pattern for the tag command is remembered for
2585 "n" command. Otherwise Vim only puts the pattern in
2586 the history for search pattern, but doesn't change the
2587 last used search pattern.
2588 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002589 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 *cpo-v*
2591 v Backspaced characters remain visible on the screen in
2592 Insert mode. Without this flag the characters are
2593 erased from the screen right away. With this flag the
2594 screen newly typed text overwrites backspaced
2595 characters.
2596 *cpo-w*
2597 w When using "cw" on a blank character, only change one
2598 character and not all blanks until the start of the
2599 next word.
2600 *cpo-W*
2601 W Don't overwrite a readonly file. When omitted, ":w!"
2602 overwrites a readonly file, if possible.
2603 *cpo-x*
2604 x <Esc> on the command-line executes the command-line.
2605 The default in Vim is to abandon the command-line,
2606 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002607 *cpo-X*
2608 X When using a count with "R" the replaced text is
2609 deleted only once. Also when repeating "R" with "."
2610 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002612 y A yank command can be redone with ".". Think twice if
2613 you really want to use this, it may break some
2614 plugins, since most people expect "." to only repeat a
2615 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002616 *cpo-Z*
2617 Z When using "w!" while the 'readonly' option is set,
2618 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002619 *cpo-z*
2620 z Special casing the "cw" and "d" command (see |cw| and
2621 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 *cpo-!*
2623 ! When redoing a filter command, use the last used
2624 external command, whatever it was. Otherwise the last
2625 used -filter- command is used.
2626 *cpo-$*
2627 $ When making a change to one line, don't redisplay the
2628 line, but put a '$' at the end of the changed text.
2629 The changed text will be overwritten when you type the
2630 new text. The line is redisplayed if you type any
2631 command that moves the cursor from the insertion
2632 point.
2633 *cpo-%*
2634 % Vi-compatible matching is done for the "%" command.
2635 Does not recognize "#if", "#endif", etc.
2636 Does not recognize "/*" and "*/".
2637 Parens inside single and double quotes are also
2638 counted, causing a string that contains a paren to
2639 disturb the matching. For example, in a line like
2640 "if (strcmp("foo(", s))" the first paren does not
2641 match the last one. When this flag is not included,
2642 parens inside single and double quotes are treated
2643 specially. When matching a paren outside of quotes,
2644 everything inside quotes is ignored. When matching a
2645 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002646 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002647 This flag is also used for other features, such as
2648 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002649 *cpo--*
2650 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002651 it would go above the first line or below the last
2652 line. Without it the cursor moves to the first or
2653 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002654 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002655 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002656 *cpo-+*
2657 + When included, a ":write file" command will reset the
2658 'modified' flag of the buffer, even though the buffer
2659 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002660 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 * Use ":*" in the same way as ":@". When not included,
2662 ":*" is an alias for ":'<,'>", select the Visual area.
2663 *cpo-<*
2664 < Disable the recognition of special key codes in |<>|
2665 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002666 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 ":map X <Tab>" results in X being mapped to:
2668 '<' included: "<Tab>" (5 characters)
2669 '<' excluded: "^I" (^I is a real <Tab>)
2670 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002671 *cpo->*
2672 > When appending to a register, put a line break before
2673 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002674 *cpo-;*
2675 ; When using |,| or |;| to repeat the last |t| search
2676 and the cursor is right in front of the searched
2677 character, the cursor won't move. When not included,
2678 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002679 following occurrence.
glepnir4ade6682025-07-03 20:41:23 +02002680 *cpo-~*
2681 ~ When included, don't resolve symbolic links when
2682 changing directory with |:cd|, |:lcd|, or |:tcd|.
2683 This preserves the symbolic link path in buffer names
2684 and when displaying the current directory. When
2685 excluded (default), symbolic links are resolved to
2686 their target paths.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002687
2688 POSIX flags. These are not included in the Vi default value, except
2689 when $VIM_POSIX was set on startup. |posix|
2690
2691 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002692 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002693 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002694 *cpo-&*
2695 & When ":preserve" was used keep the swap file when
2696 exiting normally while this buffer is still loaded.
2697 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002698 *cpo-\*
2699 \ Backslash in a [] range in a search pattern is taken
2700 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002701 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2702 '\' excluded: "/[ \-]" finds <Space> and '-'
2703 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002704 *cpo-/*
2705 / When "%" is used as the replacement string in a |:s|
2706 command, use the previous replacement string. |:s%|
2707 *cpo-{*
2708 { The |{| and |}| commands also stop at a "{" character
2709 at the start of a line.
2710 *cpo-.*
2711 . The ":chdir" and ":cd" commands fail if the current
2712 buffer is modified, unless ! is used. Vim doesn't
2713 need this, since it remembers the full path of an
2714 opened file.
2715 *cpo-bar*
2716 | The value of the $LINES and $COLUMNS environment
2717 variables overrule the terminal size values obtained
2718 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002719
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002720 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002721'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002722 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002723 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002724 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002725 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002726 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002727 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002728 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002729 blowfish Blowfish method. Medium strong encryption but it has
2730 an implementation flaw. Requires Vim 7.3 or later,
2731 files can NOT be read by Vim 7.2 and older. This adds
2732 a "seed" to the file, every time you write the file
2733 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002734 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002735 *blowfish2*
2736 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002737 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002738 and older. This adds a "seed" to the file, every time
2739 you write the file the encrypted bytes will be
2740 different. The whole undo file is encrypted, not just
2741 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002742 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002743 *E1197* *E1198* *E1199* *E1200* *E1201*
2744 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002745 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002746 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002747 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002748 It adds a seed and a message authentication code (MAC)
2749 to the file. This needs at least a Vim 8.2.3022 to
2750 read the encrypted file.
2751 Encryption of swap files is not supported, therefore
2752 no swap file will be used when xchacha20 encryption is
2753 enabled.
2754 Encryption of undo files is not yet supported,
2755 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002756 CAREFUL: Files written with this method might have to
2757 be read back with the same version of Vim if the
2758 binary format changes later.
2759 Obsolete, please do no longer use.
2760 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2761 stores the key derivation parameters together with the
2762 encrypted file. Should work better in case the
2763 parameters in the libsodium library ever change.
2764 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002765 might have to be read back with the same version of
2766 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002767
Christian Brabandtaae58342023-04-23 17:50:22 +01002768 You should use "blowfish2", also to re-encrypt older files. The
2769 "xchacha20" method provides better encryption, but it does not work
2770 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002771
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002772 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002773 to the detected method of the file being read. Thus if you write it
2774 without changing 'cryptmethod' the same method will be used.
2775 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002776 explicitly write it, you don't get a warning unless there are other
2777 modifications. Also see |:X|.
2778
2779 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002780 the value "blowfish2". When setting the local value to an empty
2781 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002782
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002783 When a new encryption method is added in a later version of Vim, and
2784 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002785 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002786
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 *'cscopepathcomp'* *'cspc'*
2788'cscopepathcomp' 'cspc' number (default 0)
2789 global
2790 {not available when compiled without the |+cscope|
2791 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 Determines how many components of the path to show in a list of tags.
2793 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002794 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
2796 *'cscopeprg'* *'csprg'*
2797'cscopeprg' 'csprg' string (default "cscope")
2798 global
2799 {not available when compiled without the |+cscope|
2800 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 Specifies the command to execute cscope. See |cscopeprg|.
2802 This option cannot be set from a |modeline| or in the |sandbox|, for
2803 security reasons.
2804
2805 *'cscopequickfix'* *'csqf'*
2806'cscopequickfix' 'csqf' string (default "")
2807 global
2808 {not available when compiled without the |+cscope|
2809 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 Specifies whether to use quickfix window to show cscope results.
2811 See |cscopequickfix|.
2812
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002813 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002814'cscoperelative' 'csre' boolean (default off)
2815 global
2816 {not available when compiled without the |+cscope|
2817 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002818 In the absence of a prefix (-P) for cscope. setting this option enables
2819 to use the basename of cscope.out path as the prefix.
2820 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002821 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002822
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2824'cscopetag' 'cst' boolean (default off)
2825 global
2826 {not available when compiled without the |+cscope|
2827 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Use cscope for tag commands. See |cscope-options|.
2829 NOTE: This option is reset when 'compatible' is set.
2830
2831 *'cscopetagorder'* *'csto'*
2832'cscopetagorder' 'csto' number (default 0)
2833 global
2834 {not available when compiled without the |+cscope|
2835 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 Determines the order in which ":cstag" performs a search. See
2837 |cscopetagorder|.
2838 NOTE: This option is set to 0 when 'compatible' is set.
2839
2840 *'cscopeverbose'* *'csverb'*
2841 *'nocscopeverbose'* *'nocsverb'*
2842'cscopeverbose' 'csverb' boolean (default off)
2843 global
2844 {not available when compiled without the |+cscope|
2845 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 Give messages when adding a cscope database. See |cscopeverbose|.
2847 NOTE: This option is reset when 'compatible' is set.
2848
Bram Moolenaar860cae12010-06-05 23:22:07 +02002849 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2850'cursorbind' 'crb' boolean (default off)
2851 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002852 When this option is set, as the cursor in the current
2853 window moves other cursorbound windows (windows that also have
2854 this option set) move their cursors to the corresponding line and
2855 column. This option is useful for viewing the
2856 differences between two versions of a file (see 'diff'); in diff mode,
2857 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002858 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002859
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002860 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2861'cursorcolumn' 'cuc' boolean (default off)
2862 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002863 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002864 feature}
2865 Highlight the screen column of the cursor with CursorColumn
2866 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2867 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002868 If you only want the highlighting in the current window you can use
2869 these autocommands: >
2870 au WinLeave * set nocursorline nocursorcolumn
2871 au WinEnter * set cursorline cursorcolumn
2872<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002873
2874 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2875'cursorline' 'cul' boolean (default off)
2876 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002877 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002878 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002879 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2880 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002881 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002882 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002883
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002884 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002885'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002886 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002887 {not available when compiled without the |+syntax|
2888 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002889 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002890 Valid values:
2891 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002892 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002893 "screenline" Highlight only the screen line of the cursor with
2894 CursorLine |hl-CursorLine|.
2895 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002896 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002897
2898 Special value:
2899 "both" Alias for the values "line,number".
2900
2901 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002902
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 *'debug'*
2904'debug' string (default "")
2905 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002906 These values can be used:
2907 msg Error messages that would otherwise be omitted will be given
2908 anyway.
2909 throw Error messages that would otherwise be omitted will be given
2910 anyway and also throw an exception and set |v:errmsg|.
2911 beep A message will be given when otherwise only a beep would be
2912 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002913 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002914 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2915 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916
2917 *'define'* *'def'*
2918'define' 'def' string (default "^\s*#\s*define")
2919 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 pattern, just like for the "/" command. This option is used for the
2922 commands like "[i" and "[d" |include-search|. The 'isident' option is
2923 used to recognize the defined name after the match:
2924 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2925 See |option-backslash| about inserting backslashes to include a space
2926 or backslash.
2927 The default value is for C programs. For C++ this value would be
2928 useful, to include const type declarations: >
2929 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002930< You can also use "\ze" just before the name and continue the pattern
2931 to check what is following. E.g. for Javascript, if a function is
2932 defined with "func_name = function(args)": >
2933 ^\s*\ze\i\+\s*=\s*function(
2934< If the function is defined with "func_name : function() {...": >
2935 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002937 To avoid that use `:let` with a single quote string: >
2938 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002939<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
2941 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2942'delcombine' 'deco' boolean (default off)
2943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 If editing Unicode and this option is set, backspace and Normal mode
2945 "x" delete each combining character on its own. When it is off (the
2946 default) the character along with its combining characters are
2947 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002948 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
2950 This is useful for Arabic, Hebrew and many other languages where one
2951 may have combining characters overtop of base characters, and want
2952 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002953 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
2955 *'dictionary'* *'dict'*
2956'dictionary' 'dict' string (default "")
2957 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 List of file names, separated by commas, that are used to lookup words
2959 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2960 contain a list of words. This can be one word per line, or several
2961 words per line, separated by non-keyword characters (white space is
2962 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002963
2964 When this option is empty or an entry "spell" is present, and spell
2965 checking is enabled, words in the word lists for the currently active
2966 'spelllang' are used. See |spell|.
2967
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002968 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 after a comma are ignored, otherwise spaces are included in the file
2970 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002971 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 Where to find a list of words?
2973 - On FreeBSD, there is the file "/usr/share/dict/words".
2974 - In the Simtel archive, look in the "msdos/linguist" directory.
2975 - In "miscfiles" of the GNU collection.
2976 The use of |:set+=| and |:set-=| is preferred when adding or removing
2977 directories from the list. This avoids problems when a future version
2978 uses another default.
2979 Backticks cannot be used in this option for security reasons.
2980
2981 *'diff'* *'nodiff'*
2982'diff' boolean (default off)
2983 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 {not available when compiled without the |+diff|
2985 feature}
2986 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002987 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988
2989 *'dex'* *'diffexpr'*
2990'diffexpr' 'dex' string (default "")
2991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 {not available when compiled without the |+diff|
2993 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002994 Expression which is evaluated to obtain a diff file (either ed-style
2995 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 This option cannot be set from a |modeline| or in the |sandbox|, for
2997 security reasons.
2998
2999 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003000'diffopt' 'dip' string (default
3001 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 {not available when compiled without the |+diff|
3004 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003005 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 All are optional. Items must be separated by a comma.
3007
Jonathon7c7a4e62025-01-12 09:58:00 +01003008 algorithm:{text} Use the specified diff algorithm with the
3009 internal diff engine. Currently supported
3010 algorithms are:
3011 myers the default algorithm
3012 minimal spend extra time to generate the
3013 smallest possible diff
3014 patience patience diff algorithm
3015 histogram histogram diff algorithm
3016
3017 closeoff When a window is closed where 'diff' is set
3018 and there is only one window remaining in the
3019 same tab page with 'diff' set, execute
3020 `:diffoff` in that window. This undoes a
3021 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022
3023 context:{n} Use a context of {n} lines between a change
3024 and a fold that contains unchanged lines.
3025 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01003026 When using zero the context is actually one,
3027 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02003028 for a deleted line. Set it to a very large
3029 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 See |fold-diff|.
3031
Jonathon7c7a4e62025-01-12 09:58:00 +01003032 filler Show filler lines, to keep the text
3033 synchronized with a window that has inserted
3034 lines at the same position. Mostly useful
3035 when windows are side-by-side and 'scrollbind'
3036 is set.
3037
3038 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
3039 starting diff mode. Without this 2 is used.
3040
3041 followwrap Follow the 'wrap' option and leave as it is.
3042
3043 horizontal Start diff mode with horizontal splits (unless
3044 explicitly specified otherwise).
3045
3046 hiddenoff Do not use diff mode for a buffer when it
3047 becomes hidden.
3048
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003049 iblank Ignore changes where lines are all blank. Adds
3050 the "-B" flag to the "diff" command if
3051 'diffexpr' is empty. Check the documentation
3052 of the "diff" command for what this does
3053 exactly.
3054 NOTE: the diff windows will get out of sync,
3055 because no differences between blank lines are
3056 taken into account.
3057
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 icase Ignore changes in case of text. "a" and "A"
3059 are considered the same. Adds the "-i" flag
3060 to the "diff" command if 'diffexpr' is empty.
3061
Jonathon7c7a4e62025-01-12 09:58:00 +01003062 indent-heuristic
3063 Use the indent heuristic for the internal
3064 diff library.
3065
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003066 inline:{text} Highlight inline differences within a change.
3067 See |view-diffs|. Supported values are:
3068
3069 none Do not perform inline highlighting.
3070 simple Highlight from first different
3071 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003072 line. This is the default if no
3073 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003074 char Use internal diff to perform a
3075 character-wise diff and highlight the
3076 difference.
3077 word Use internal diff to perform a
3078 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003079 difference. Non-alphanumeric
3080 multi-byte characters such as emoji
3081 and CJK characters are considered
3082 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003083
Jonathon7c7a4e62025-01-12 09:58:00 +01003084 internal Use the internal diff library. This is
3085 ignored when 'diffexpr' is set. *E960*
3086 When running out of memory when writing a
3087 buffer this item will be ignored for diffs
3088 involving that buffer. Set the 'verbose'
3089 option to see when this happens.
3090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 iwhite Ignore changes in amount of white space. Adds
3092 the "-b" flag to the "diff" command if
3093 'diffexpr' is empty. Check the documentation
3094 of the "diff" command for what this does
3095 exactly. It should ignore adding trailing
3096 white space, but not leading white space.
3097
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003098 iwhiteall Ignore all white space changes. Adds
3099 the "-w" flag to the "diff" command if
3100 'diffexpr' is empty. Check the documentation
3101 of the "diff" command for what this does
3102 exactly.
3103
3104 iwhiteeol Ignore white space changes at end of line.
3105 Adds the "-Z" flag to the "diff" command if
3106 'diffexpr' is empty. Check the documentation
3107 of the "diff" command for what this does
3108 exactly.
3109
Jonathon7c7a4e62025-01-12 09:58:00 +01003110 linematch:{n} Align and mark changes between the most
3111 similar lines between the buffers. When the
3112 total number of lines in the diff hunk exceeds
3113 {n}, the lines will not be aligned because for
3114 very large diff hunks there will be a
3115 noticeable lag. A reasonable setting is
3116 "linematch:60", as this will enable alignment
3117 for a 2 buffer diff hunk of 30 lines each,
3118 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003119
3120 vertical Start diff mode with vertical splits (unless
3121 explicitly specified otherwise).
3122
Bram Moolenaare828b762018-09-10 17:51:58 +02003123 Examples: >
3124 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003126 :set diffopt=internal,filler,foldcolumn:3
3127 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128<
3129 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3130'digraph' 'dg' boolean (default off)
3131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 {not available when compiled without the |+digraphs|
3133 feature}
3134 Enable the entering of digraphs in Insert mode with {char1} <BS>
3135 {char2}. See |digraphs|.
3136 NOTE: This option is reset when 'compatible' is set.
3137
3138 *'directory'* *'dir'*
3139'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003140 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 for Unix: ".,~/tmp,/var/tmp,/tmp")
3142 global
3143 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003144 Recommended value: ".,~/vimswap//" - this will put the swap file next
3145 to the edited file if possible, and in your personal swap directory
3146 otherwise. Make sure "~/vimswap//" is only readable for you.
3147
3148 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 - The swap file will be created in the first directory where this is
3150 possible.
3151 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003152 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 - A directory "." means to put the swap file in the same directory as
3154 the edited file. On Unix, a dot is prepended to the file name, so
3155 it doesn't show in a directory listing. On MS-Windows the "hidden"
3156 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003157 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3158 the swap file relative to where the edited file is. The leading "."
3159 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003160 - For Unix and Win32, if a directory ends in two path separators "//",
3161 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003162 with all path separators replaced by percent '%' signs (including
3163 the colon following the drive letter on Win32). This will ensure
3164 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003165 On Win32, it is also possible to end with "\\". However, When a
3166 separating comma is following, you must use "//", since "\\" will
3167 include the comma in the file name. Therefore it is recommended to
3168 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 - Spaces after the comma are ignored, other spaces are considered part
3170 of the directory name. To have a space at the start of a directory
3171 name, precede it with a backslash.
3172 - To include a comma in a directory name precede it with a backslash.
3173 - A directory name may end in an ':' or '/'.
3174 - Environment variables are expanded |:set_env|.
3175 - Careful with '\' characters, type one before a space, type two to
3176 get one in the option (see |option-backslash|), for example: >
3177 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3178< - For backwards compatibility with Vim version 3.0 a '>' at the start
3179 of the option is removed.
3180 Using "." first in the list is recommended. This means that editing
3181 the same file twice will result in a warning. Using "/tmp" on Unix is
3182 discouraged: When the system crashes you lose the swap file.
3183 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003184 choice than "/tmp". But others on the computer may be able to see the
3185 files, and it can contain a lot of files, your swap files get lost in
3186 the crowd. That is why a "tmp" directory in your home directory is
3187 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 The use of |:set+=| and |:set-=| is preferred when adding or removing
3189 directories from the list. This avoids problems when a future version
3190 uses another default.
3191 This option cannot be set from a |modeline| or in the |sandbox|, for
3192 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193
3194 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003195'display' 'dy' string (default "", set to "truncate" in
3196 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003198 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 flags:
3200 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003201 in a window will be displayed. "@@@" is put in the
3202 last columns of the last screen line to indicate the
3203 rest of the line is not displayed.
3204 truncate Like "lastline", but "@@@" is displayed in the first
3205 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 uhex Show unprintable characters hexadecimal as <xx>
3207 instead of using ^C and ~C.
3208
Bram Moolenaard0796902016-09-16 20:02:31 +02003209 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003210 doesn't fit is replaced with "@" lines.
3211
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003212 The "@" character can be changed by setting the "lastline" item in
3213 'fillchars'. The character is highlighted with |hl-NonText|.
3214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 *'eadirection'* *'ead'*
3216'eadirection' 'ead' string (default "both")
3217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 Tells when the 'equalalways' option applies:
3219 ver vertically, width of windows is not affected
3220 hor horizontally, height of windows is not affected
3221 both width and height of windows is affected
3222
3223 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3224'edcompatible' 'ed' boolean (default off)
3225 global
3226 Makes the 'g' and 'c' flags of the ":substitute" command to be
3227 toggled each time the flag is given. See |complex-change|. See
3228 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003229 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003230 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
Bram Moolenaar03413f42016-04-12 21:07:15 +02003232 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003233'emoji' 'emo' boolean (default: on)
3234 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003235 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003236 This excludes "text emoji" characters, which are normally displayed as
3237 single width. Unfortunately there is no good specification for this
3238 and it has been determined on trial-and-error basis. Use the
3239 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003240
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003242'encoding' 'enc' string (default for MS-Windows: "utf-8",
3243 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 Sets the character encoding used inside Vim. It applies to text in
3246 the buffers, registers, Strings in expressions, text stored in the
3247 viminfo file, etc. It sets the kind of characters which Vim can work
3248 with. See |encoding-names| for the possible values.
3249
3250 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003251 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003253 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254
Bram Moolenaar865242e2010-07-14 21:12:05 +02003255 This option cannot be set from a |modeline|. It would most likely
3256 corrupt the text.
3257
Bram Moolenaar3df01732017-02-17 22:47:16 +01003258 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3259 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 'encoding', "utf-8" is the natural choice for the environment and
3261 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 versions, and to avoid changing the encoding of newly created files
3264 without your knowledge (in case 'fileencodings' is empty).
3265
3266 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 iconv() or as specified with 'charconvert'.
3269
Bram Moolenaar207f0092020-08-30 17:20:20 +02003270 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003271 can use: >
3272 if has("multi_byte_encoding")
3273<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 Normally 'encoding' will be equal to your current locale. This will
3275 be the default if Vim recognizes your environment settings. If
3276 'encoding' is not set to the current locale, 'termencoding' must be
3277 set to convert typed and displayed text. See |encoding-table|.
3278
3279 When you set this option, it fires the |EncodingChanged| autocommand
3280 event so that you can set up fonts if necessary.
3281
3282 When the option is set, the value is converted to lowercase. Thus
3283 you can set it with uppercase values too. Underscores are translated
3284 to '-' signs.
3285 When the encoding is recognized, it is changed to the standard name.
3286 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3287 "iso-8859-2" and "utf8" becomes "utf-8".
3288
3289 Note: "latin1" is also used when the encoding could not be detected.
3290 This only works when editing files in the same encoding! When the
3291 actual character set is not latin1, make sure 'fileencoding' and
3292 'fileencodings' are empty. When conversion is needed, switch to using
3293 utf-8.
3294
3295 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3296 You don't notice this while editing, but it does matter for the
3297 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3298 setting 'encoding' to one of these values instead of utf-8 only has
3299 effect for encoding used for files when 'fileencoding' is empty.
3300
Bram Moolenaar661b1822005-07-28 22:36:45 +00003301 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3302 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003304 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003305'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003307 Indicates that a CTRL-Z character was found at the end of the file
3308 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003310 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003311 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003312 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003313
3314 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3315'endofline' 'eol' boolean (default on)
3316 local to buffer
3317 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003318 is on, or 'fixeol' option is off, no <EOL> will be written for the
3319 last line in the file. This option is automatically set or reset when
3320 starting to edit a new file, depending on whether file has an <EOL>
3321 for the last line in the file. Normally you don't have to set or
3322 reset this option.
3323 When 'binary' is off and 'fixeol' is on the value is not used when
3324 writing the file. When 'binary' is on or 'fixeol' is off it is used
3325 to remember the presence of a <EOL> for the last line in the file, so
3326 that when you write the file the situation from the original file can
3327 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003328 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329
3330 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3331'equalalways' 'ea' boolean (default on)
3332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003334 splitting or closing a window. This also happens the moment the
3335 option is switched on. When off, splitting a window will reduce the
3336 size of the current window and leave the other windows the same. When
3337 closing a window the extra lines are given to the window next to it
3338 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 When mixing vertically and horizontally split windows, a minimal size
3340 is computed and some windows may be larger if there is room. The
3341 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003342 Changing the height and width of a window can be avoided by setting
3343 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003344 If a window size is specified when creating a new window sizes are
3345 currently not equalized (it's complicated, but may be implemented in
3346 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347
3348 *'equalprg'* *'ep'*
3349'equalprg' 'ep' string (default "")
3350 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003352 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003353 or 'indentexpr'. When Vim was compiled without internal formatting,
3354 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 about including spaces and backslashes.
3357 This option cannot be set from a |modeline| or in the |sandbox|, for
3358 security reasons.
3359
3360 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3361'errorbells' 'eb' boolean (default off)
3362 global
3363 Ring the bell (beep or screen flash) for error messages. This only
3364 makes a difference for error messages, the bell will be used always
3365 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003367 screen flash or do nothing. See 'belloff' to finetune when to ring the
3368 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369
3370 *'errorfile'* *'ef'*
3371'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3372 others: "errors.err")
3373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 {not available when compiled without the |+quickfix|
3375 feature}
3376 Name of the errorfile for the QuickFix mode (see |:cf|).
3377 When the "-q" command-line argument is used, 'errorfile' is set to the
3378 following argument. See |-q|.
3379 NOT used for the ":make" command. See 'makeef' for that.
3380 Environment variables are expanded |:set_env|.
3381 See |option-backslash| about including spaces and backslashes.
3382 This option cannot be set from a |modeline| or in the |sandbox|, for
3383 security reasons.
3384
3385 *'errorformat'* *'efm'*
3386'errorformat' 'efm' string (default is very long)
3387 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 {not available when compiled without the |+quickfix|
3389 feature}
3390 Scanf-like description of the format for the lines in the error file
3391 (see |errorformat|).
3392
3393 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3394'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 Function keys that start with an <Esc> are recognized in Insert
3397 mode. When this option is off, the cursor and function keys cannot be
3398 used in Insert mode if they start with an <Esc>. The advantage of
3399 this is that the single <Esc> is recognized immediately, instead of
3400 after one second. Instead of resetting this option, you might want to
3401 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3402 when 'esckeys' is off, you can still map anything, but the cursor keys
3403 won't work by default.
3404 NOTE: This option is set to the Vi default value when 'compatible' is
3405 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003406 NOTE: when this option is off then the |modifyOtherKeys| and
3407 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3408 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409
3410 *'eventignore'* *'ei'*
3411'eventignore' 'ei' string (default "")
3412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003414 When set to "all" or when "all" is one of the items, all autocommand
3415 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003416 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 :set ei=WinEnter,WinLeave
3418<
Luuk van Baal8cc6d8b2025-05-31 12:10:31 +02003419 To ignore all but some events, a "-" prefix can be used: >
3420 :set ei=all,-WinLeave
3421<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003422 *'eventignorewin'* *'eiw'*
3423'eventignorewin' 'eiw' string (default "")
3424 window-local
3425 Similar to 'eventignore' but applies to a particular window and its
3426 buffers, for which window and buffer related autocommands can be
3427 ignored indefinitely without affecting the global 'eventignore'.
3428
glepnir631a50c2025-06-15 16:05:10 +02003429 Note: The following events are considered to happen outside of a
3430 window context and thus cannot be ignored by 'eventignorewin':
3431
3432 |CmdlineChanged|,
3433 |CmdlineEnter|,
3434 |CmdlineLeave|,
3435 |CmdlineLeavePre|,
3436 |CmdUndefined|,
3437 |CmdwinEnter|,
3438 |CmdwinLeave|,
3439 |ColorScheme|,
3440 |ColorSchemePre|,
3441 |CompleteChanged|,
3442 |CompleteDone|,
3443 |CompleteDonePre|,
3444 |DiffUpdated|,
3445 |DirChanged|,
3446 |DirChangedPre|,
3447 |EncodingChanged|,
3448 |ExitPre|,
3449 |FocusGained|,
3450 |FocusLost|,
3451 |FuncUndefined|,
3452 |GUIEnter|,
3453 |GUIFailed|,
3454 |KeyInputPre|,
3455 |MenuPopup|,
3456 |ModeChanged|,
3457 |OptionSet|,
3458 |QuickFixCmdPost|,
3459 |QuickFixCmdPre|,
3460 |QuitPre|,
3461 |RemoteReply|,
3462 |SafeState|,
3463 |SafeStateAgain|,
3464 |SessionLoadPost|,
3465 |SessionWritePost|,
3466 |ShellCmdPost|,
3467 |SigUSR1|,
3468 |SourceCmd|,
3469 |SourcePost|,
3470 |SourcePre|,
3471 |SpellFileMissing|,
3472 |StdinReadPost|,
3473 |StdinReadPre|,
3474 |SwapExists|,
3475 |Syntax|,
3476 |TabClosed|,
3477 |TabClosedPre|,
3478 |TabEnter|,
3479 |TabLeave|,
3480 |TabNew|,
3481 |TermChanged|,
3482 |TerminalOpen|,
3483 |TerminalWinOpen|,
3484 |TermResponse|,
3485 |TermResponseAll|,
3486 |User|,
3487 |VimEnter|,
3488 |VimLeave|,
3489 |VimLeavePre|,
3490 |VimResized|,
3491 |VimResume|,
3492 |VimSuspend|,
3493 |WinNew|,
3494 |WinNewPre|
3495
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3497'expandtab' 'et' boolean (default off)
3498 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003500 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3502 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003503 This option is reset when the 'paste' option is set and restored when
3504 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 NOTE: This option is reset when 'compatible' is set.
3506
3507 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3508'exrc' 'ex' boolean (default off)
3509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003511 directory.
3512
3513 Setting this option is a potential security leak. E.g., consider
3514 unpacking a package or fetching files from github, a .vimrc in there
3515 might be a trojan horse. BETTER NOT SET THIS OPTION!
3516 Instead, define an autocommand in your .vimrc to set options for a
3517 matching directory.
3518
3519 If you do switch this option on you should also consider setting the
3520 'secure' option (see |initialization|).
3521 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 This option cannot be set from a |modeline| or in the |sandbox|, for
3523 security reasons.
3524
3525 *'fileencoding'* *'fenc'* *E213*
3526'fileencoding' 'fenc' string (default: "")
3527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003529
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003531 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 When 'fileencoding' is empty, the same value as 'encoding' will be
3533 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003534 No error will be given when the value is set, only when it is used,
3535 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003536 Conversion will also be done when 'encoding' and 'fileencoding' are
3537 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3538 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003540 'encoding' is "utf-8" or another Unicode encoding, conversion
3541 is most likely done in a way that the reverse conversion
3542 results in the same text. When 'encoding' is not "utf-8" some
3543 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003544
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 See 'encoding' for the possible values. Additionally, values may be
3546 specified that can be handled by the converter, see
3547 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003548
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 When reading a file 'fileencoding' will be set from 'fileencodings'.
3550 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003551 'fileencoding', use the |++enc| argument. One exception: when
3552 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003553 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003554
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3556 When the option is set, the value is converted to lowercase. Thus
3557 you can set it with uppercase values too. '_' characters are
3558 replaced with '-'. If a name is recognized from the list for
3559 'encoding', it is replaced by the standard name. For example
3560 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003561
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 When this option is set, after starting to edit a file, the 'modified'
3563 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003564
3565 Keep in mind that changing 'fenc' from a modeline happens
3566 AFTER the text has been read, thus it applies to when the file will be
3567 written. If you do set 'fenc' in a modeline, you might want to set
3568 'nomodified' to avoid not being able to ":q".
3569
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 This option can not be changed when 'modifiable' is off.
3571
3572 *'fe'*
3573 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003574 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 old short name was 'fe', which is no longer used.
3576
3577 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003578'fileencodings' 'fencs' string (default: "ucs-bom",
3579 "ucs-bom,utf-8,default,latin1" when
3580 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 This is a list of character encodings considered when starting to edit
3583 an existing file. When a file is read, Vim tries to use the first
3584 mentioned character encoding. If an error is detected, the next one
3585 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 an empty string, which means the value of 'encoding' is used.
3588 WARNING: Conversion can cause loss of information! When
3589 'encoding' is "utf-8" (or one of the other Unicode variants)
3590 conversion is most likely done in a way that the reverse
3591 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003592 "utf-8" some non-ASCII characters may be lost! You can use
3593 the |++bad| argument to specify what is done with characters
3594 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 For an empty file or a file with only ASCII characters most encodings
3596 will work and the first entry of 'fileencodings' will be used (except
3597 "ucs-bom", which requires the BOM to be present). If you prefer
3598 another encoding use an BufReadPost autocommand event to test if your
3599 preferred encoding is to be used. Example: >
3600 au BufReadPost * if search('\S', 'w') == 0 |
3601 \ set fenc=iso-2022-jp | endif
3602< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3603 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003604 When the |++enc| argument is used then the value of 'fileencodings' is
3605 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003606 Note that 'fileencodings' is not used for a new file, the global value
3607 of 'fileencoding' is used instead. You can set it with: >
3608 :setglobal fenc=iso-8859-2
3609< This means that a non-existing file may get a different encoding than
3610 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 The special value "ucs-bom" can be used to check for a Unicode BOM
3612 (Byte Order Mark) at the start of the file. It must not be preceded
3613 by "utf-8" or another Unicode encoding for this to work properly.
3614 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3615 because Vim cannot detect an error, thus the encoding is always
3616 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003617 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003618 environment. On MS-Windows this is the system encoding. Otherwise
3619 this is the default value for 'encoding'. It is useful when
3620 'encoding' is set to "utf-8" and your environment uses a non-latin1
3621 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003622 When 'encoding' is "utf-8" and a file contains an illegal byte
3623 sequence it won't be recognized as UTF-8. You can use the |8g8|
3624 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 WRONG VALUES: WHAT'S WRONG:
3626 latin1,utf-8 "latin1" will always be used
3627 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3628 file
3629 cp1250,latin1 "cp1250" will always be used
3630 If 'fileencodings' is empty, 'fileencoding' is not modified.
3631 See 'fileencoding' for the possible values.
3632 Setting this option does not have an effect until the next time a file
3633 is read.
3634
3635 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003636'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003637 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 This gives the <EOL> of the current buffer, which is used for
3640 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003641 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 unix <NL>
3643 mac <CR>
3644 When "dos" is used, CTRL-Z at the end of a file is ignored.
3645 See |file-formats| and |file-read|.
3646 For the character encoding of the file see 'fileencoding'.
3647 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003648 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 This option is set automatically when starting to edit a file and
3650 'fileformats' is not empty and 'binary' is off.
3651 When this option is set, after starting to edit a file, the 'modified'
3652 option is set, because the file would be different when written.
3653 This option can not be changed when 'modifiable' is off.
3654 For backwards compatibility: When this option is set to "dos",
3655 'textmode' is set, otherwise 'textmode' is reset.
3656
3657 *'fileformats'* *'ffs'*
3658'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003659 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003660 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 Vi Cygwin: "unix,dos",
3662 Vi others: "")
3663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 This gives the end-of-line (<EOL>) formats that will be tried when
3665 starting to edit a new buffer and when reading a file into an existing
3666 buffer:
3667 - When empty, the format defined with 'fileformat' will be used
3668 always. It is not set automatically.
3669 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003670 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 'fileformats' name will be used when a file is read into an existing
3672 buffer, no matter what 'fileformat' for that buffer is set to.
3673 - When more than one name is present, separated by commas, automatic
3674 <EOL> detection will be done when reading a file. When starting to
3675 edit a file, a check is done for the <EOL>:
3676 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3677 'fileformat' is set to "dos".
3678 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003679 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003681 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3682 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003683 This means that "mac" is only chosen when:
3684 "unix" is not present or no <NL> is found in the file, and
3685 "dos" is not present or no <CR><NL> is found in the file.
3686 Except: if "unix" was chosen, but there is a <CR> before
3687 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003688 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 4. If 'fileformat' is still not set, the first name from
3690 'fileformats' is used.
3691 When reading a file into an existing buffer, the same is done, but
3692 this happens like 'fileformat' has been set appropriately for that
3693 file only, the option is not changed.
3694 When 'binary' is set, the value of 'fileformats' is not used.
3695
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003696 When Vim starts up with an empty buffer the first item is used. You
3697 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003698
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3700 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3701 done:
3702 - When 'fileformats' is empty, there is no automatic detection. Dos
3703 format will be used.
3704 - When 'fileformats' is set to one or more names, automatic detection
3705 is done. This is based on the first <NL> in the file: If there is a
3706 <CR> in front of it, Dos format is used, otherwise Unix format is
3707 used.
3708 Also see |file-formats|.
3709 For backwards compatibility: When this option is set to an empty
3710 string or one format (no comma is included), 'textauto' is reset,
3711 otherwise 'textauto' is set.
3712 NOTE: This option is set to the Vi default value when 'compatible' is
3713 set and to the Vim default value when 'compatible' is reset.
3714
Bram Moolenaarbf884932013-04-05 22:26:15 +02003715 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3716'fileignorecase' 'fic' boolean (default on for systems where case in file
3717 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003718 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003719 When set case is ignored when using file names and directories.
3720 See 'wildignorecase' for only ignoring case when doing completion.
3721
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 *'filetype'* *'ft'*
3723'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003724 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 When this option is set, the FileType autocommand event is triggered.
3726 All autocommands that match with the value of this option will be
3727 executed. Thus the value of 'filetype' is used in place of the file
3728 name.
3729 Otherwise this option does not always reflect the current file type.
3730 This option is normally set when the file type is detected. To enable
3731 this use the ":filetype on" command. |:filetype|
3732 Setting this option to a different value is most useful in a modeline,
3733 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003734 Example, for in an IDL file:
3735 /* vim: set filetype=idl : */ ~
3736 |FileType| |filetypes|
3737 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003738 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003739 /* vim: set filetype=c.doxygen : */ ~
3740 This will use the "c" filetype first, then the "doxygen" filetype.
3741 This works both for filetype plugins and for syntax files. More than
3742 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 This option is not copied to another buffer, independent of the 's' or
3744 'S' flag in 'cpoptions'.
Christian Brabandtf0c70902025-05-26 21:18:19 +02003745 Only alphanumeric characters, '-' and '_' can be used (and a '.' is
Doug Kearnsa6172f82025-05-26 20:32:35 +02003746 allowed as delimiter when combining different filetypes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747
3748 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003749'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003750 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003751 Characters to fill the statuslines, vertical separators, special
3752 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003753 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003754 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003756 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003757 stl ' ' statusline of the current window
3758 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003759 vert '|' vertical separators |:vsplit|
3760 fold '-' filling 'foldtext'
3761 foldopen '-' mark the beginning of a fold
3762 foldclose '+' show a closed fold
3763 foldsep '|' open fold middle character
3764 diff '-' deleted lines of the 'diff' option
3765 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003766 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003767 trunc '>' truncated text in the
3768 |ins-completion-menu|.
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02003769 truncrl '<' same as "trunc" in 'rightleft' mode
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003770 tpl_vert '|' vertical separators of 'tabpanel'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003772 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773
3774 Example: >
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003775 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-,tpl_vert:\|
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003776<
Hirohito Higashi0553f2f2025-05-10 14:56:17 +02003777 All items support single-byte and multibyte characters. But
3778 double-width characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003779
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003781 item name highlight group ~
3782 stl StatusLine |hl-StatusLine|
3783 stlnc StatusLineNC |hl-StatusLineNC|
3784 vert VertSplit |hl-VertSplit|
3785 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003786 foldopen FoldColumn |hl-FoldColumn|
3787 foldclose FoldColumn |hl-FoldColumn|
3788 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003789 diff DiffDelete |hl-DiffDelete|
3790 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003791 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003792 trunc one of the many Popup menu highlighting groups like
3793 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003794 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003796 *'findfunc'* *'ffu'* *E1514*
3797'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003798 global or local to buffer |global-local|
3799 {not available when compiled without the |+eval|
3800 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003801 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003802 command. When this option is empty, the internal |file-searching|
3803 mechanism is used.
3804
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003805 The value can be the name of a function, a |lambda| or a |Funcref|.
3806 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003807
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003808 The function is called with two arguments. The first argument is a
3809 |String| and is the |:find| command argument. The second argument is
3810 a |Boolean| and is set to |v:true| when the function is called to get
3811 a List of command-line completion matches for the |:find| command.
3812 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003813
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003814 The function is called only once per |:find| command invocation.
3815 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003816
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003817 If a match is found, the function should return a |List| containing
3818 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003819 should return an empty List.
3820
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003821 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003822 empty List is used as the return value.
3823
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003824 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003825 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003826
3827 This option cannot be set from a |modeline| or in the |sandbox|, for
3828 security reasons.
3829
3830 Examples:
3831>
3832 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003833 func FindFuncGlob(cmdarg, cmdcomplete)
3834 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003835 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003836 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003837 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003838
3839 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003840 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003841 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003842 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003843 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003844 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003845<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003846 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3847'fixendofline' 'fixeol' boolean (default on)
3848 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003849 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003850 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003851 preserve the situation from the original file.
3852 When the 'binary' option is set the value of this option doesn't
3853 matter.
3854 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003855 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003856
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003858'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 {only available when compiled with the |+rightleft|
3861 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003862 This option was for using Farsi, which has been removed. See
3863 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864
3865 *'foldclose'* *'fcl'*
3866'foldclose' 'fcl' string (default "")
3867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 {not available when compiled without the |+folding|
3869 feature}
3870 When set to "all", a fold is closed when the cursor isn't in it and
3871 its level is higher than 'foldlevel'. Useful if you want folds to
3872 automatically close when moving out of them.
3873
3874 *'foldcolumn'* *'fdc'*
3875'foldcolumn' 'fdc' number (default 0)
3876 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 {not available when compiled without the |+folding|
3878 feature}
3879 When non-zero, a column with the specified width is shown at the side
3880 of the window which indicates open and closed folds. The maximum
3881 value is 12.
3882 See |folding|.
3883
3884 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3885'foldenable' 'fen' boolean (default on)
3886 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 {not available when compiled without the |+folding|
3888 feature}
3889 When off, all folds are open. This option can be used to quickly
3890 switch between showing all text unfolded and viewing the text with
3891 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003892 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 'foldenable' is off.
3894 This option is set by commands that create a new fold or close a fold.
3895 See |folding|.
3896
3897 *'foldexpr'* *'fde'*
3898'foldexpr' 'fde' string (default: "0")
3899 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003901 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003903 for each line to obtain its fold level. The context is set to the
3904 script where 'foldexpr' was set, script-local items can be accessed.
3905 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003906
Bram Moolenaar30b65812012-07-12 22:01:11 +02003907 The expression will be evaluated in the |sandbox| if set from a
3908 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003909 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003910 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003911
3912 It is not allowed to change text or jump to another window while
3913 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914
3915 *'foldignore'* *'fdi'*
3916'foldignore' 'fdi' string (default: "#")
3917 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 {not available when compiled without the |+folding|
3919 feature}
3920 Used only when 'foldmethod' is "indent". Lines starting with
3921 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003922 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 The default "#" works well for C programs. See |fold-indent|.
3924
3925 *'foldlevel'* *'fdl'*
3926'foldlevel' 'fdl' number (default: 0)
3927 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 {not available when compiled without the |+folding|
3929 feature}
3930 Sets the fold level: Folds with a higher level will be closed.
3931 Setting this option to zero will close all folds. Higher numbers will
3932 close fewer folds.
3933 This option is set by commands like |zm|, |zM| and |zR|.
3934 See |fold-foldlevel|.
3935
3936 *'foldlevelstart'* *'fdls'*
3937'foldlevelstart' 'fdls' number (default: -1)
3938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 {not available when compiled without the |+folding|
3940 feature}
3941 Sets 'foldlevel' when starting to edit another buffer in a window.
3942 Useful to always start editing with all folds closed (value zero),
3943 some folds closed (one) or no folds closed (99).
3944 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003945 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 ignores this option and closes all folds.
3947 It is also done before BufReadPre autocommands, to allow an autocmd to
3948 overrule the 'foldlevel' value for specific files.
3949 When the value is negative, it is not used.
3950
3951 *'foldmarker'* *'fmr'* *E536*
3952'foldmarker' 'fmr' string (default: "{{{,}}}")
3953 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 {not available when compiled without the |+folding|
3955 feature}
3956 The start and end marker used when 'foldmethod' is "marker". There
3957 must be one comma, which separates the start and end marker. The
3958 marker is a literal string (a regular expression would be too slow).
3959 See |fold-marker|.
3960
3961 *'foldmethod'* *'fdm'*
3962'foldmethod' 'fdm' string (default: "manual")
3963 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 {not available when compiled without the |+folding|
3965 feature}
3966 The kind of folding used for the current window. Possible values:
3967 |fold-manual| manual Folds are created manually.
3968 |fold-indent| indent Lines with equal indent form a fold.
3969 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3970 |fold-marker| marker Markers are used to specify folds.
3971 |fold-syntax| syntax Syntax highlighting items specify folds.
3972 |fold-diff| diff Fold text that is not changed.
3973
3974 *'foldminlines'* *'fml'*
3975'foldminlines' 'fml' number (default: 1)
3976 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 {not available when compiled without the |+folding|
3978 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003979 Sets the number of screen lines above which a fold can be displayed
3980 closed. Also for manually closed folds. With the default value of
3981 one a fold can only be closed if it takes up two or more screen lines.
3982 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003983 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 "zc" to close a fold, which is displayed open because it's smaller
3985 than 'foldminlines', a following "zc" may close a containing fold.
3986
3987 *'foldnestmax'* *'fdn'*
3988'foldnestmax' 'fdn' number (default: 20)
3989 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 {not available when compiled without the |+folding|
3991 feature}
3992 Sets the maximum nesting of folds for the "indent" and "syntax"
3993 methods. This avoids that too many folds will be created. Using more
3994 than 20 doesn't work, because the internal limit is 20.
3995
3996 *'foldopen'* *'fdo'*
3997'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3998 search,tag,undo")
3999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 {not available when compiled without the |+folding|
4001 feature}
4002 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004003 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02004005 NOTE: When the command is part of a mapping this option is not used.
4006 Add the |zv| command to the mapping to get the same effect.
4007 (rationale: the mapping may want to control opening folds itself)
4008
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 item commands ~
4010 all any
4011 block "(", "{", "[[", "[{", etc.
4012 hor horizontal movements: "l", "w", "fx", etc.
4013 insert any command in Insert mode
4014 jump far jumps: "G", "gg", etc.
4015 mark jumping to a mark: "'m", CTRL-O, etc.
4016 percent "%"
4017 quickfix ":cn", ":crew", ":make", etc.
4018 search search for a pattern: "/", "n", "*", "gd", etc.
4019 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004020 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 tag jumping to a tag: ":ta", CTRL-T, etc.
4022 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 When a movement command is used for an operator (e.g., "dl" or "y%")
4024 this option is not used. This means the operator will include the
4025 whole closed fold.
4026 Note that vertical movements are not here, because it would make it
4027 very difficult to move onto a closed fold.
4028 In insert mode the folds containing the cursor will always be open
4029 when text is inserted.
4030 To close folds you can re-apply 'foldlevel' with the |zx| command or
4031 set the 'foldclose' option to "all".
4032
4033 *'foldtext'* *'fdt'*
4034'foldtext' 'fdt' string (default: "foldtext()")
4035 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 {not available when compiled without the |+folding|
4037 feature}
4038 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004039 fold. The context is set to the script where 'foldexpr' was set,
4040 script-local items can be accessed. See |fold-foldtext| for the
4041 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042
Bram Moolenaar30b65812012-07-12 22:01:11 +02004043 The expression will be evaluated in the |sandbox| if set from a
4044 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004045 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004046
4047 It is not allowed to change text or jump to another window while
4048 evaluating 'foldtext' |textlock|.
4049
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004050 *'formatexpr'* *'fex'*
4051'formatexpr' 'fex' string (default "")
4052 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004053 {not available when compiled without the |+eval|
4054 feature}
4055 Expression which is evaluated to format a range of lines for the |gq|
4056 operator or automatic formatting (see 'formatoptions'). When this
4057 option is empty 'formatprg' is used.
4058
4059 The |v:lnum| variable holds the first line to be formatted.
4060 The |v:count| variable holds the number of lines to be formatted.
4061 The |v:char| variable holds the character that is going to be
4062 inserted if the expression is being evaluated due to
4063 automatic formatting. This can be empty. Don't insert
4064 it yet!
4065
4066 Example: >
4067 :set formatexpr=mylang#Format()
4068< This will invoke the mylang#Format() function in the
4069 autoload/mylang.vim file in 'runtimepath'. |autoload|
4070
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004071 The advantage of using a function call without arguments is that it is
4072 faster, see |expr-option-function|.
4073
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004074 The expression is also evaluated when 'textwidth' is set and adding
4075 text beyond that limit. This happens under the same conditions as
4076 when internal formatting is used. Make sure the cursor is kept in the
4077 same spot relative to the text then! The |mode()| function will
4078 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004079
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004080 When the expression evaluates to non-zero Vim will fall back to using
4081 the internal format mechanism.
4082
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004083 If the expression starts with s: or |<SID>|, then it is replaced with
4084 the script ID (|local-function|). Example: >
4085 set formatexpr=s:MyFormatExpr()
4086 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004087< Otherwise, the expression is evaluated in the context of the script
4088 where the option was set, thus script-local items are available.
4089
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004090 The expression will be evaluated in the |sandbox| when set from a
4091 modeline, see |sandbox-option|. That stops the option from working,
4092 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004093 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004094 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004095
Bram Moolenaar86b68352004-12-27 21:59:20 +00004096 *'formatlistpat'* *'flp'*
4097'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
4098 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00004099 A pattern that is used to recognize a list header. This is used for
4100 the "n" flag in 'formatoptions'.
4101 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00004102 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00004103 while still checking more characters. There must be a character
4104 following the pattern, when it matches the whole line it is handled
4105 like there is no match.
4106 The default recognizes a number, followed by an optional punctuation
4107 character and white space.
4108
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004109 *'formatoptions'* *'fo'*
4110'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
4111 local to buffer
4112 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01004113 formatting is to be done.
4114 See |fo-table| for possible values and |gq| for how to format text.
4115 When the 'paste' option is on, no formatting is done (like
4116 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004117 To avoid problems with flags that are added in the future, use the
4118 "+=" and "-=" feature of ":set" |add-option-flags|.
4119 NOTE: This option is set to the Vi default value when 'compatible' is
4120 set and to the Vim default value when 'compatible' is reset.
4121
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 *'formatprg'* *'fp'*
4123'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004124 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004126 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004128 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004129 If the 'formatexpr' option is not empty it will be used instead.
4130 Otherwise, if 'formatprg' option is an empty string, the internal
4131 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004132 Environment variables are expanded |:set_env|. See |option-backslash|
4133 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004134 This option cannot be set from a |modeline| or in the |sandbox|, for
4135 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
Bram Moolenaard94464e2015-11-02 15:28:18 +01004137 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004138'fsync' 'fs' boolean (default on)
4139 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004140 When on, the library function fsync() will be called after writing a
4141 file. This will flush a file to disk, ensuring that it is safely
4142 written even on filesystems which do metadata-only journaling. This
4143 will force the harddrive to spin up on Linux systems running in laptop
4144 mode, so it may be undesirable in some situations. Be warned that
4145 turning this off increases the chances of data loss after a crash. On
4146 systems without an fsync() implementation, this variable is always
4147 off.
4148 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004149 'fsync' also applies to |writefile()| (unless a flag is used to
4150 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004151 This option cannot be set from a |modeline| or in the |sandbox|, for
4152 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004153
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4155'gdefault' 'gd' boolean (default off)
4156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 When on, the ":substitute" flag 'g' is default on. This means that
4158 all matches in a line are substituted instead of one. When a 'g' flag
4159 is given to a ":substitute" command, this will toggle the substitution
4160 of all or one match. See |complex-change|.
4161
4162 command 'gdefault' on 'gdefault' off ~
4163 :s/// subst. all subst. one
4164 :s///g subst. one subst. all
4165 :s///gg subst. all subst. one
4166
4167 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004168 Setting this option may break plugins that rely on the default
4169 behavior of the 'g' flag. This will also make the 'g' flag have the
4170 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004171 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172
4173 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004174'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
glepnir7b9eb632025-05-16 19:49:23 +02004175 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 Format to recognize for the ":grep" command output.
4177 This is a scanf-like string that uses the same format as the
4178 'errorformat' option: see |errorformat|.
4179
4180 *'grepprg'* *'gp'*
4181'grepprg' 'gp' string (default "grep -n ",
4182 Unix: "grep -n $* /dev/null",
4183 Win32: "findstr /n" or "grep -n",
4184 VMS: "SEARCH/NUMBERS ")
4185 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004186 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 and '#' characters, which are expanded like when used in a command-
4188 line. The placeholder "$*" is allowed to specify where the arguments
4189 will be included. Environment variables are expanded |:set_env|. See
4190 |option-backslash| about including spaces and backslashes.
4191 When your "grep" accepts the "-H" argument, use this to make ":grep"
4192 also work well with a single file: >
4193 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004194< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004195 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4196 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004197 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 apply equally to 'grepprg'.
4199 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4200 otherwise it's "grep -n".
4201 This option cannot be set from a |modeline| or in the |sandbox|, for
4202 security reasons.
4203
4204 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4205'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4206 ve:ver35-Cursor,
4207 o:hor50-Cursor,
4208 i-ci:ver25-Cursor/lCursor,
4209 r-cr:hor20-Cursor/lCursor,
4210 sm:block-Cursor
4211 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004212 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 "n-v-c:block,o:hor50,i-ci:hor15,
4214 r-cr:hor30,sm:block")
4215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004217 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004219 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004220 height of the cursor can be changed. This can be done by specifying a
4221 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004222 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4223 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004225 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 mode-list and an argument-list:
4227 mode-list:argument-list,mode-list:argument-list,..
4228 The mode-list is a dash separated list of these modes:
4229 n Normal mode
4230 v Visual mode
4231 ve Visual mode with 'selection' "exclusive" (same as 'v',
4232 if not specified)
4233 o Operator-pending mode
4234 i Insert mode
4235 r Replace mode
4236 c Command-line Normal (append) mode
4237 ci Command-line Insert mode
4238 cr Command-line Replace mode
4239 sm showmatch in Insert mode
4240 a all modes
4241 The argument-list is a dash separated list of these arguments:
4242 hor{N} horizontal bar, {N} percent of the character height
4243 ver{N} vertical bar, {N} percent of the character width
4244 block block cursor, fills the whole character
4245 [only one of the above three should be present]
4246 blinkwait{N} *cursor-blinking*
4247 blinkon{N}
4248 blinkoff{N}
4249 blink times for cursor: blinkwait is the delay before
4250 the cursor starts blinking, blinkon is the time that
4251 the cursor is shown and blinkoff is the time that the
4252 cursor is not shown. The times are in msec. When one
4253 of the numbers is zero, there is no blinking. The
4254 default is: "blinkwait700-blinkon400-blinkoff250".
4255 These numbers are used for a missing entry. This
4256 means that blinking is enabled by default. To switch
4257 blinking off you can use "blinkon0". The cursor only
4258 blinks when Vim is waiting for input, not while
4259 executing a command.
4260 To make the cursor blink in an xterm, see
4261 |xterm-blink|.
4262 {group-name}
4263 a highlight group name, that sets the color and font
4264 for the cursor
4265 {group-name}/{group-name}
4266 Two highlight group names, the first is used when
4267 no language mappings are used, the other when they
4268 are. |language-mapping|
4269
4270 Examples of parts:
4271 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4272 block cursor with colors from the "nCursor"
4273 highlight group
4274 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4275 In Insert and Command-line Insert mode, use a
4276 30% vertical bar cursor with colors from the
4277 "iCursor" highlight group. Blink a bit
4278 faster.
4279
4280 The 'a' mode is different. It will set the given argument-list for
4281 all modes. It does not reset anything to defaults. This can be used
4282 to do a common setting for all modes. For example, to switch off
4283 blinking: "a:blinkon0"
4284
4285 Examples of cursor highlighting: >
4286 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4287 :highlight Cursor gui=NONE guifg=bg guibg=fg
4288<
4289 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004290 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291'guifont' 'gfn' string (default "")
4292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 {only available when compiled with GUI enabled}
4294 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004295 In its simplest form the value is just one font name.
4296 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
4298 *'guifontset'* *'gfs'*
4299 *E250* *E252* *E234* *E597* *E598*
4300'guifontset' 'gfs' string (default "")
4301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 {only available when compiled with GUI enabled and
4303 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004304 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 When not empty, specifies two (or more) fonts to be used. The first
4306 one for normal English, the second one for your special language. See
4307 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004308
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4310'guifontwide' 'gfw' string (default "")
4311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 {only available when compiled with GUI enabled}
4313 When not empty, specifies a comma-separated list of fonts to be used
4314 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004315 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004316
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 *'guiheadroom'* *'ghr'*
4318'guiheadroom' 'ghr' number (default 50)
4319 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004320 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 The number of pixels subtracted from the screen height when fitting
4322 the GUI window on the screen. Set this before the GUI is started,
4323 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004324 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 lines will be left for window decorations and other items on the
4326 screen. Set it to a negative value to allow windows taller than the
4327 screen.
4328
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004329 *'guiligatures'* *'gli'* *E1243*
4330'guiligatures' 'gli' string (default "")
4331 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004332 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004333 List of ASCII characters that, when combined together, can create more
4334 complex shapes. Each character must be a printable ASCII character
4335 with a value in the 32-127 range.
4336 Example: >
4337 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4338< Changing this option updates screen output immediately. Set it to an
4339 empty string to disable ligatures.
4340
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004342'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4343 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004344 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004345 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004348 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 sequence of letters which describes what components and options of the
4350 GUI should be used.
4351 To avoid problems with flags that are added in the future, use the
4352 "+=" and "-=" feature of ":set" |add-option-flags|.
4353
Bram Moolenaar13568252018-03-16 20:46:58 +01004354 Valid characters are as follows:
4355 *'go-!'*
4356 '!' External commands are executed in a terminal window. Without
4357 this flag the MS-Windows GUI will open a console window to
4358 execute the command. The Unix GUI will simulate a dumb
4359 terminal to list the command output.
4360 The terminal window will be positioned at the bottom, and grow
4361 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004362 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 'a' Autoselect: If present, then whenever VISUAL mode is started,
4364 or the Visual area extended, Vim tries to become the owner of
4365 the windowing system's global selection. This means that the
4366 Visually highlighted text is available for pasting into other
4367 applications as well as into Vim itself. When the Visual mode
4368 ends, possibly due to an operation on the text, or when an
4369 application wants to paste the selection, the highlighted text
4370 is automatically yanked into the "* selection register.
4371 Thus the selection is still available for pasting into other
4372 applications after the VISUAL mode has ended.
4373 If not present, then Vim won't become the owner of the
4374 windowing system's global selection unless explicitly told to
4375 by a yank or delete operation for the "* register.
4376 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004377 *'go-P'*
4378 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004379 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004380 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004381 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 applies to the modeless selection.
4383
4384 'guioptions' autoselect Visual autoselect modeless ~
4385 "" - -
4386 "a" yes yes
4387 "A" - yes
4388 "aA" yes yes
4389
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004390 When using a terminal see the 'clipboard' option.
4391
Bram Moolenaar02467872007-05-06 13:22:01 +00004392 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 'c' Use console dialogs instead of popup dialogs for simple
4394 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004395 *'go-d'*
4396 'd' Use dark theme variant if available. Currently only works for
4397 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004398 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004399 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004400 'guitablabel' can be used to change the text in the labels.
4401 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004402 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004403 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004404 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 'f' Foreground: Don't use fork() to detach the GUI from the shell
4406 where it was started. Use this for programs that wait for the
4407 editor to finish (e.g., an e-mail program). Alternatively you
4408 can use "gvim -f" or ":gui -f" to start the GUI in the
4409 foreground. |gui-fork|
4410 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004411 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004412 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4414 corner of the window. It's black&white on non-GTK, because of
4415 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004416 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004418 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004419 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004421 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004423 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004424 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 'g' Grey menu items: Make menu items that are not active grey. If
4426 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004427 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 't' Include tearoff menu items. Currently only works for Win32,
4429 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004430 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004431 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4432 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004433 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004435 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 'R' Right-hand scrollbar is present when there is a vertically
4437 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004438 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004440 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 'L' Left-hand scrollbar is present when there is a vertically
4442 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004443 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4445 the longest visible line, or on the cursor line if the 'h'
4446 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004447 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 'h' Limit horizontal scrollbar size to the length of the cursor
4449 line. Reduces computations. |gui-horiz-scroll|
4450
4451 And yes, you may even have scrollbars on the left AND the right if
4452 you really want to :-). See |gui-scrollbars| for more information.
4453
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004454 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 'v' Use a vertical button layout for dialogs. When not included,
4456 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004457 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004458 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 'p' Use Pointer callbacks for X11 GUI. This is required for some
4460 window managers. If the cursor is not blinking or hollow at
4461 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004462 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004464 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004465 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004466 *'go-k'*
4467 'k' Keep the GUI window size when adding/removing a scrollbar, or
4468 toolbar, tabline, etc. Instead, the behavior is similar to
4469 when the window is maximized and will adjust 'lines' and
4470 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004471 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004472 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 *'guipty'* *'noguipty'*
4475'guipty' boolean (default on)
4476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 {only available when compiled with GUI enabled}
4478 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4479 I/O to/from shell commands. See |gui-pty|.
4480
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004481 *'guitablabel'* *'gtl'*
4482'guitablabel' 'gtl' string (default empty)
4483 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004484 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004485 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004486 pages line. When empty and when the result is empty Vim will use a
4487 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004488
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004489 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004490 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004491 The expression will be evaluated in the |sandbox| when set from a
4492 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004493 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004494
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004495 Only used when the GUI tab pages line is displayed. 'e' must be
4496 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4497 used.
4498
Bram Moolenaar57657d82006-04-21 22:12:41 +00004499 *'guitabtooltip'* *'gtt'*
4500'guitabtooltip' 'gtt' string (default empty)
4501 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004502 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004503 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004504 pages line. When empty Vim will use a default tooltip.
4505 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004506 You can include a line break. Simplest method is to use |:let|: >
4507 :let &guitabtooltip = "line one\nline two"
4508<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004509
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004511'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 (others) "$VIMRUNTIME/doc/help.txt")
4513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 Name of the main help file. All distributed help files should be
4515 placed together in one directory. Additionally, all "doc" directories
4516 in 'runtimepath' will be used.
4517 Environment variables are expanded |:set_env|. For example:
4518 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 spaces and backslashes.
4521 This option cannot be set from a |modeline| or in the |sandbox|, for
4522 security reasons.
4523
4524 *'helpheight'* *'hh'*
4525'helpheight' 'hh' number (default 20)
4526 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 Minimal initial height of the help window when it is opened with the
4528 ":help" command. The initial height of the help window is half of the
4529 current window, or (when the 'ea' option is on) the same as other
4530 windows. When the height is less than 'helpheight', the height is
4531 set to 'helpheight'. Set to zero to disable.
4532
4533 *'helplang'* *'hlg'*
4534'helplang' 'hlg' string (default: messages language or empty)
4535 global
4536 {only available when compiled with the |+multi_lang|
4537 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004538 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 for which the desired help can be found. The English help will always
4540 be used as a last resort. You can add "en" to prefer English over
4541 another language, but that will only find tags that exist in that
4542 language and not in the English help.
4543 Example: >
4544 :set helplang=de,it
4545< This will first search German, then Italian and finally English help
4546 files.
4547 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4548 try to find the tag in the current language before using this option.
4549 See |help-translated|.
4550
4551 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4552'hidden' 'hid' boolean (default off)
4553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 When off a buffer is unloaded when it is |abandon|ed. When on a
4555 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4556 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004557
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004559 hidden even if the 'hidden' option is off when these three are true:
4560 - the buffer is modified
4561 - 'autowrite' is off or writing is not possible
4562 - the '!' flag was used
4563 Also see |windows.txt|.
4564
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004565 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 This option is set for one command with ":hide {command}" |:hide|.
4567 WARNING: It's easy to forget that you have changes in hidden buffers.
4568 Think twice when using ":q!" or ":qa!".
4569
4570 *'highlight'* *'hl'*
4571'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004572 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4573 d:Directory,e:ErrorMsg,i:IncSearch,
4574 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004575 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004576 N:CursorLineNr,r:Question,s:StatusLine,
4577 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004578 v:Visual,V:VisualNOS,w:WarningMsg,
4579 W:WildMenu,f:Folded,F:FoldColumn,
4580 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004581 T:DiffText,E:DiffTextAdd,>:SignColumn,
4582 -:Conceal,B:SpellBad,P:SpellCap,
4583 R:SpellRare, L:SpellLocal,+:Pmenu,
4584 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004585 [:PmenuKind,]:PmenuKindSel,
4586 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004587 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4588 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004589 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004590 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004591 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004594 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004596 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004598 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4599 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 characters from 'showbreak'
4601 |hl-Directory| d directories in CTRL-D listing and other special
4602 things in listings
4603 |hl-ErrorMsg| e error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004605 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4607 |hl-MoreMsg| m |more-prompt|
4608 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004609 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004610 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004611 |hl-LineNr| n line number for ":number" and ":#" commands, and
4612 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004613 |hl-LineNrAbove| a line number above the cursor for when the
4614 'relativenumber' option is set.
4615 |hl-LineNrBelow| b line number below the cursor for when the
4616 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004617 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4618 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 |hl-Question| r |hit-enter| prompt and yes/no questions
4620 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004621 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4623 |hl-VertSplit| c column used to separate vertically split windows
4624 |hl-Visual| v Visual mode
Foxe Chenb90c2392025-06-27 21:10:35 +02004625 |hl-VisualNOS| V Visual mode when Vim is "Not Owning the
4626 Selection" Only X11 Gui's |gui-x11|,
4627 |xterm-clipboard| and |wayland-selections|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 |hl-WarningMsg| w warning messages
4629 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4630 |hl-Folded| f line used for closed folds
4631 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004632 |hl-DiffAdd| A added line in diff mode
4633 |hl-DiffChange| C changed line in diff mode
4634 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004635 |hl-DiffText| T changed text in diff mode
4636 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004638 |hl-Conceal| - the placeholders used for concealed characters
4639 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004640 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004641 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004642 |hl-SpellRare| R rare word |spell|
4643 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004644 |hl-Pmenu| + popup menu normal line
4645 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004646 |hl-PmenuKind| [ popup menu "kind" normal line
4647 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004648 |hl-PmenuExtra| { popup menu "extra" normal line
4649 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004650 |hl-PmenuSbar| x popup menu scrollbar
4651 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004652 |hl-PmenuMatch| k popup menu matched text
4653 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654
4655 The display modes are:
4656 r reverse (termcap entry "mr" and "me")
4657 i italic (termcap entry "ZH" and "ZR")
4658 b bold (termcap entry "md" and "me")
4659 s standout (termcap entry "so" and "se")
4660 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004661 c undercurl (termcap entry "Us" and "Ce")
4662 2 double underline (termcap entry "Ds" and "Ce")
4663 d dotted underline (termcap entry "ds" and "Ce")
4664 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004665 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 n no highlighting
4667 - no highlighting
4668 : use a highlight group
4669 The default is used for occasions that are not included.
4670 If you want to change what the display modes do, see |dos-colors|
4671 for an example.
4672 When using the ':' display mode, this must be followed by the name of
4673 a highlight group. A highlight group can be used to define any type
4674 of highlighting, including using color. See |:highlight| on how to
4675 define one. The default uses a different group for each occasion.
4676 See |highlight-default| for the default highlight groups.
4677
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004679'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004682 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004683 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004684 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004685 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 NOTE: This option is set to the Vi default value when 'compatible' is
4687 set and to the Vim default value when 'compatible' is reset.
4688
4689 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4690'hkmap' 'hk' boolean (default off)
4691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 {only available when compiled with the |+rightleft|
4693 feature}
4694 When on, the keyboard is mapped for the Hebrew character set.
4695 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4696 toggle this option. See |rileft.txt|.
4697 NOTE: This option is reset when 'compatible' is set.
4698
4699 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4700'hkmapp' 'hkp' boolean (default off)
4701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 {only available when compiled with the |+rightleft|
4703 feature}
4704 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4705 This is useful if you have a non-Hebrew keyboard.
4706 See |rileft.txt|.
4707 NOTE: This option is reset when 'compatible' is set.
4708
Bram Moolenaar036986f2017-03-16 17:41:02 +01004709 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4710'hlsearch' 'hls' boolean (default off)
4711 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004712 {not available when compiled without the
4713 |+extra_search| feature}
4714 When there is a previous search pattern, highlight all its matches.
4715 The type of highlighting used can be set with the 'l' occasion in the
4716 'highlight' option. This uses the "Search" highlight group by
4717 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004718 are not applied. If the "CurSearch" highlight group is set then the
4719 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004720 See also: 'incsearch' and |:match|.
4721 When you get bored looking at the highlighted matches, you can turn it
4722 off with |:nohlsearch|. This does not change the option value, as
4723 soon as you use a search command, the highlighting comes back.
4724 'redrawtime' specifies the maximum time spent on finding matches.
4725 When the search pattern can match an end-of-line, Vim will try to
4726 highlight all of the matched text. However, this depends on where the
4727 search starts. This will be the first line in the window or the first
4728 line below a closed fold. A match in a previous line which is not
4729 drawn may not continue in a newly drawn line.
4730 You can specify whether the highlight status is restored on startup
4731 with the 'h' flag in 'viminfo' |viminfo-h|.
4732 NOTE: This option is reset when 'compatible' is set.
4733
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 *'icon'* *'noicon'*
4735'icon' boolean (default off, on when title can be restored)
4736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 When on, the icon text of the window will be set to the value of
4738 'iconstring' (if it is not empty), or to the name of the file
4739 currently being edited. Only the last part of the name is used.
4740 Overridden by the 'iconstring' option.
4741 Only works if the terminal supports setting window icons (currently
4742 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4743 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4744 builtin termcap).
4745 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004746 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004748 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749
4750 *'iconstring'*
4751'iconstring' string (default "")
4752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 When this option is not empty, it will be used for the icon text of
4754 the window. This happens only when the 'icon' option is on.
4755 Only works if the terminal supports setting window icon text
4756 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004757 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 When Vim was compiled with HAVE_X11 defined, the original icon will be
4759 restored if possible |X11|.
4760 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004761 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004763 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 {not available when compiled without the |+statusline| feature}
4765
4766 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4767'ignorecase' 'ic' boolean (default off)
4768 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004769 Ignore case in search patterns, |cmdline-completion|, when
glepnir05460682025-05-26 18:23:27 +02004770 searching in the tags file, non-|Vim9| |expr-==| and for Insert-mode
4771 completion |ins-completion|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004772 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 Can be overruled by using "\c" or "\C" in the pattern, see
4774 |/ignorecase|.
4775
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004776 *'imactivatefunc'* *'imaf'*
4777'imactivatefunc' 'imaf' string (default "")
4778 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004779 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004780 activate or deactivate the Input Method. The value can be the name of
4781 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4782 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004783 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004784 The expression will be evaluated in the |sandbox| when set from a
4785 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004786
4787 Example: >
4788 function ImActivateFunc(active)
4789 if a:active
4790 ... do something
4791 else
4792 ... do something
4793 endif
4794 " return value is not used
4795 endfunction
4796 set imactivatefunc=ImActivateFunc
4797<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 *'imactivatekey'* *'imak'*
4799'imactivatekey' 'imak' string (default "")
4800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004802 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 Specifies the key that your Input Method in X-Windows uses for
4804 activation. When this is specified correctly, vim can fully control
4805 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4806 You can't use this option to change the activation key, the option
4807 tells Vim what the key is.
4808 Format:
4809 [MODIFIER_FLAG-]KEY_STRING
4810
4811 These characters can be used for MODIFIER_FLAG (case is ignored):
4812 S Shift key
4813 L Lock key
4814 C Control key
4815 1 Mod1 key
4816 2 Mod2 key
4817 3 Mod3 key
4818 4 Mod4 key
4819 5 Mod5 key
4820 Combinations are allowed, for example "S-C-space" or "SC-space" are
4821 both shift+ctrl+space.
4822 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4823
4824 Example: >
4825 :set imactivatekey=S-space
4826< "S-space" means shift+space. This is the activation key for kinput2 +
4827 canna (Japanese), and ami (Korean).
4828
4829 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4830'imcmdline' 'imc' boolean (default off)
4831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 When set the Input Method is always on when starting to edit a command
4833 line, unless entering a search pattern (see 'imsearch' for that).
4834 Setting this option is useful when your input method allows entering
4835 English characters directly, e.g., when it's used to type accented
4836 characters with dead keys.
4837
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004838 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 When set the Input Method is never used. This is useful to disable
4842 the IM when it doesn't work properly.
4843 Currently this option is on by default for SGI/IRIX machines. This
4844 may change in later releases.
4845
4846 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004847'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 Specifies whether :lmap or an Input Method (IM) is to be used in
4850 Insert mode. Valid values:
4851 0 :lmap is off and IM is off
4852 1 :lmap is ON and IM is off
4853 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 To always reset the option to zero when leaving Insert mode with <Esc>
4855 this can be used: >
4856 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4857< This makes :lmap and IM turn off automatically when leaving Insert
4858 mode.
4859 Note that this option changes when using CTRL-^ in Insert mode
4860 |i_CTRL-^|.
4861 The value is set to 1 when setting 'keymap' to a valid keymap name.
4862 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004863 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 methods. Use 'imdisable' to disable XIM then.
4865
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004866 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004867 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004868 |+multi_byte_ime| or |global-ime|.
4869
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004871'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 Specifies whether :lmap or an Input Method (IM) is to be used when
4874 entering a search pattern. Valid values:
4875 -1 the value of 'iminsert' is used, makes it look like
4876 'iminsert' is also used when typing a search pattern
4877 0 :lmap is off and IM is off
4878 1 :lmap is ON and IM is off
4879 2 :lmap is off and IM is ON
4880 Note that this option changes when using CTRL-^ in Command-line mode
4881 |c_CTRL-^|.
4882 The value is set to 1 when it is not -1 and setting the 'keymap'
4883 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004884 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 methods. Use 'imdisable' to disable XIM then.
4886
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004887 *'imstatusfunc'* *'imsf'*
4888'imstatusfunc' 'imsf' string (default "")
4889 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004890 This option specifies a function that is called to obtain the status
4891 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004892 The value can be the name of a function, a |lambda| or a |Funcref|.
4893 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004894 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004895
4896 Example: >
4897 function ImStatusFunc()
4898 let is_active = ...do something
4899 return is_active ? 1 : 0
4900 endfunction
4901 set imstatusfunc=ImStatusFunc
4902<
4903 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004904 The expression will be evaluated in the |sandbox| when set from a
4905 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004906
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004907 *'imstyle'* *'imst'*
4908'imstyle' 'imst' number (default 1)
4909 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004910 {only available when compiled with |+xim| and
4911 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004912 This option specifies the input style of Input Method:
4913 0 use on-the-spot style
4914 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004915 See: |xim-input-style|
4916
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004917 For a long time on-the-spot style had been used in the GTK version of
4918 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004919 |single-repeat|, etc. Therefore over-the-spot style becomes the
4920 default now. This should work fine for most people, however if you
4921 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004922 The expression will be evaluated in the |sandbox| when set from a
4923 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004924
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 *'include'* *'inc'*
4926'include' 'inc' string (default "^\s*#\s*include")
4927 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 {not available when compiled without the
4929 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004930 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 pattern, just like for the "/" command (See |pattern|). The default
4932 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004933 "]I", "[d", etc.
4934 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004935 comes after the matched pattern. But if "\zs" appears in the pattern
4936 then the text matched from "\zs" to the end, or until "\ze" if it
4937 appears, is used as the file name. Use this to include characters
4938 that are not in 'isfname', such as a space. You can then use
4939 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004940 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941
4942 *'includeexpr'* *'inex'*
4943'includeexpr' 'inex' string (default "")
4944 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004946 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004948 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004949 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004951 Note the double backslash: the `:set` command first halves them, then
4952 one remains it the value, where "\." matches a dot literally. For
4953 simple character replacements `tr()` avoids the need for escaping: >
4954 :setlocal includeexpr=tr(v:fname,'.','/')
4955<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004957 found. Allows doing "gf" on the name after an 'include' statement.
Christian Brabandt23984602025-04-19 11:54:08 +02004958 Note: Not used for |<cfile>|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004960 If the expression starts with s: or |<SID>|, then it is replaced with
4961 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004962 setlocal includeexpr=s:MyIncludeExpr()
4963 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004964< Otherwise, the expression is evaluated in the context of the script
4965 where the option was set, thus script-local items are available.
4966
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004967 It is more efficient if the value is just a function call without
4968 arguments, see |expr-option-function|.
4969
Bram Moolenaar30b65812012-07-12 22:01:11 +02004970 The expression will be evaluated in the |sandbox| when set from a
4971 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004972 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004973
4974 It is not allowed to change text or jump to another window while
4975 evaluating 'includeexpr' |textlock|.
4976
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004978'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004979 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004982 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004983 While typing a search command, show where the pattern, as it was typed
4984 so far, matches. The matched string is highlighted. If the pattern
4985 is invalid or not found, nothing is shown. The screen will be updated
4986 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004987 Also applies to the pattern in commands: >
4988 :global
4989 :lvimgrep
4990 :lvimgrepadd
4991 :smagic
4992 :snomagic
4993 :sort
4994 :substitute
4995 :vglobal
4996 :vimgrep
4997 :vimgrepadd
4998< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004999 original position when no match is found and when pressing <Esc>. You
5000 still need to finish the search command with <Enter> to move the
5001 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02005002 You can use the CTRL-G and CTRL-T keys to move to the next and
5003 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005004 When compiled with the |+reltime| feature Vim only searches for about
5005 half a second. With a complicated pattern and/or a lot of text the
5006 match may not be found. This is to avoid that Vim hangs while you
5007 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00005008 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01005009 When 'hlsearch' is on, all matched strings are highlighted too while
5010 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02005011 If you don't want to turn 'hlsearch' on, but want to highlight all
5012 matches while searching, you can turn on and off 'hlsearch' with
5013 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005014 augroup vimrc-incsearch-highlight
5015 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01005016 autocmd CmdlineEnter /,\? :set hlsearch
5017 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005018 augroup END
5019<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005020 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02005021 to the command line. If 'ignorecase' and 'smartcase' are set and the
5022 command line has no uppercase characters, the added character is
5023 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005024 CTRL-R CTRL-W can be used to add the word at the end of the current
5025 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 NOTE: This option is reset when 'compatible' is set.
5027
5028 *'indentexpr'* *'inde'*
5029'indentexpr' 'inde' string (default "")
5030 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005031 {not available when compiled without the |+eval|
5032 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 Expression which is evaluated to obtain the proper indent for a line.
5034 It is used when a new line is created, for the |=| operator and
5035 in Insert mode as specified with the 'indentkeys' option.
5036 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02005037 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02005038 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 When 'paste' is set this option is not used for indenting.
5040 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005041 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005043
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00005044 If the expression starts with s: or |<SID>|, then it is replaced with
5045 the script ID (|local-function|). Example: >
5046 set indentexpr=s:MyIndentExpr()
5047 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005048< Otherwise, the expression is evaluated in the context of the script
5049 where the option was set, thus script-local items are available.
5050
Bram Moolenaara4e0b972022-10-01 19:43:52 +01005051 The advantage of using a function call without arguments is that it is
5052 faster, see |expr-option-function|.
5053
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 The expression must return the number of spaces worth of indent. It
5055 can return "-1" to keep the current indent (this means 'autoindent' is
5056 used for the indent).
5057 Functions useful for computing the indent are |indent()|, |cindent()|
5058 and |lispindent()|.
5059 The evaluation of the expression must not have side effects! It must
5060 not change the text, jump to another window, etc. Afterwards the
5061 cursor position is always restored, thus the cursor may be moved.
5062 Normally this option would be set to call a function: >
5063 :set indentexpr=GetMyIndent()
5064< Error messages will be suppressed, unless the 'debug' option contains
5065 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005066 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005067 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
Bram Moolenaar30b65812012-07-12 22:01:11 +02005069 The expression will be evaluated in the |sandbox| when set from a
5070 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005071 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005072
5073 It is not allowed to change text or jump to another window while
5074 evaluating 'indentexpr' |textlock|.
5075
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01005077'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 A list of keys that, when typed in Insert mode, cause reindenting of
5080 the current line. Only happens if 'indentexpr' isn't empty.
5081 The format is identical to 'cinkeys', see |indentkeys-format|.
5082 See |C-indenting| and |indent-expression|.
5083
5084 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
5085'infercase' 'inf' boolean (default off)
5086 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00005088 'ignorecase' is also on, the case of the match is adjusted depending
5089 on the typed text. If the typed text contains a lowercase letter
5090 where the match has an upper case letter, the completed part is made
5091 lowercase. If the typed text has no lowercase letters and the match
5092 has a lowercase letter where the typed text has an uppercase letter,
5093 and there is a letter before it, the completed part is made uppercase.
5094 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095
glepnirbcd59952025-04-24 21:48:35 +02005096 *'isexpand'* *'ise'*
5097'isexpand' 'ise' string (default: "")
5098 local to buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02005099 Defines characters and patterns for completion in insert mode. Used
5100 by the |complete_match()| function to determine the starting position
5101 for completion. This is a comma-separated list of triggers. Each
5102 trigger can be:
glepnirbcd59952025-04-24 21:48:35 +02005103 - A single character like "." or "/"
5104 - A sequence of characters like "->", "/*", or "/**"
5105
5106 Note: Use "\\," to add a literal comma as trigger character, see
5107 |option-backslash|.
5108
glepnirffc89e42025-04-27 14:59:17 +02005109 Examples: >
5110 set isexpand=.,->,/*,\\,
5111<
5112
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
5114'insertmode' 'im' boolean (default off)
5115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 Makes Vim work in a way that Insert mode is the default mode. Useful
5117 if you want to use Vim as a modeless editor. Used for |evim|.
5118 These Insert mode commands will be useful:
5119 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005120 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 this is a mapping, it is executed as if 'insertmode' was off.
5122 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00005124 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
5125 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
5127 These items change when 'insertmode' is set:
5128 - when starting to edit of a file, Vim goes to Insert mode.
5129 - <Esc> in Insert mode is a no-op and beeps.
5130 - <Esc> in Normal mode makes Vim go to Insert mode.
5131 - CTRL-L in Insert mode is a command, it is not inserted.
5132 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
5133 However, when <Esc> is used inside a mapping, it behaves like
5134 'insertmode' was not set. This was done to be able to use the same
5135 mappings with 'insertmode' set or not set.
5136 When executing commands with |:normal| 'insertmode' is not used.
5137
5138 NOTE: This option is reset when 'compatible' is set.
5139
5140 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005141'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5143 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5144 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5145 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5146 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 The characters specified by this option are included in file names and
5149 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005150 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 Multi-byte characters 256 and above are always included, only the
5152 characters up to 255 are specified with this option.
5153 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005154 Think twice before adding white space to this option. Although a
5155 space may appear inside a file name, the effect will be that Vim
5156 doesn't know where a file name starts or ends when doing completion.
5157 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158
5159 Note that on systems using a backslash as path separator, Vim tries to
5160 do its best to make it work as you would expect. That is a bit
5161 tricky, since Vi originally used the backslash to escape special
5162 characters. Vim will not remove a backslash in front of a normal file
5163 name character on these systems, but it will on Unix and alikes. The
5164 '&' and '^' are not included by default, because these are special for
5165 cmd.exe.
5166
5167 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005168 Each part can be a single character number or a range. A range is two
5169 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 decimal number between 0 and 255 or the ASCII character itself (does
5171 not work for digits). Example:
5172 "_,-,128-140,#-43" (include '_' and '-' and the range
5173 128 to 140 and '#' to 43)
5174 If a part starts with '^', the following character number or range
5175 will be excluded from the option. The option is interpreted from left
5176 to right. Put the excluded character after the range where it is
5177 included. To include '^' itself use it as the last character of the
5178 option or the end of a range. Example:
5179 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5180 If the character is '@', all characters where isalpha() returns TRUE
5181 are included. Normally these are the characters a to z and A to Z,
5182 plus accented characters. To include '@' itself use "@-@". Examples:
5183 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005184 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 "a-z,A-Z,@-@" All letters plus the '@' character.
5186 A comma can be included by using it where a character number is
5187 expected. Example:
5188 "48-57,,,_" Digits, comma and underscore.
5189 A comma can be excluded by prepending a '^'. Example:
5190 " -~,^,,9" All characters from space to '~', excluding
5191 comma, plus <Tab>.
5192 See |option-backslash| about including spaces and backslashes.
5193
5194 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005195'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 "@,48-57,_,128-167,224-235"
5197 otherwise: "@,48-57,_,192-255")
5198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 The characters given by this option are included in identifiers.
5200 Identifiers are used in recognizing environment variables and after a
5201 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005202 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005203 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005205 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5207
5208 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005209'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 "@,48-57,_,128-167,224-235"
5211 otherwise: "@,48-57,_,192-255"
5212 Vi default: "@,48-57,_")
5213 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005215 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005216 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005217 characters above 255 check the "word" character class (any character
5218 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005219 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 For a help file it is set to all non-blank printable characters except
5221 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5222 command).
5223 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005224 This option also influences syntax highlighting, unless the syntax
5225 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 NOTE: This option is set to the Vi default value when 'compatible' is
5227 set and to the Vim default value when 'compatible' is reset.
5228
5229 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005230'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 "@,~-255"; otherwise: "@,161-255")
5232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 The characters given by this option are displayed directly on the
5234 screen. It is also used for "\p" in a |pattern|. The characters from
5235 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5236 even when they are not included in 'isprint' or excluded. See
5237 'isfname' for a description of the format of this option.
5238
5239 Non-printable characters are displayed with two characters:
5240 0 - 31 "^@" - "^_"
5241 32 - 126 always single characters
5242 127 "^?"
5243 128 - 159 "~@" - "~_"
5244 160 - 254 "| " - "|~"
5245 255 "~?"
5246 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5247 displayed as <xx>, with the hexadecimal value of the byte.
5248 When 'display' contains "uhex" all unprintable characters are
5249 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005250 The SpecialKey highlighting will be used for unprintable characters.
5251 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252
5253 Multi-byte characters 256 and above are always included, only the
5254 characters up to 255 are specified with this option. When a character
5255 is printable but it is not available in the current font, a
5256 replacement character will be shown.
5257 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5258 There is no option to specify these characters.
5259
5260 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5261'joinspaces' 'js' boolean (default on)
5262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 Insert two spaces after a '.', '?' and '!' with a join command.
5264 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5265 Otherwise only one space is inserted.
5266 NOTE: This option is set when 'compatible' is set.
5267
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005268 *'jumpoptions'* *'jop'*
5269'jumpoptions' 'jop' string (default "")
5270 global
5271 List of words that change the behavior of the |jumplist|.
5272 stack Make the jumplist behave like the tagstack.
5273 Relative location of entries in the jumplist is
5274 preserved at the cost of discarding subsequent entries
5275 when navigating backwards in the jumplist and then
5276 jumping to a location. |jumplist-stack|
5277
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 *'key'*
5279'key' string (default "")
5280 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005281 {only available when compiled with the |+cryptv|
5282 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005284 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 Careful: Do not set the key value by hand, someone might see the typed
5286 key. Use the |:X| command. But you can make 'key' empty: >
5287 :set key=
5288< It is not possible to get the value of this option with ":set key" or
5289 "echo &key". This is to avoid showing it to someone who shouldn't
5290 know. It also means you cannot see it yourself once you have set it,
5291 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005292 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5293 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005294 You can use "&key" in an expression to detect whether encryption is
5295 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296
5297 *'keymap'* *'kmp'* *E544*
5298'keymap' 'kmp' string (default "")
5299 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 {only available when compiled with the |+keymap|
5301 feature}
5302 Name of a keyboard mapping. See |mbyte-keymap|.
5303 Setting this option to a valid keymap name has the side effect of
5304 setting 'iminsert' to one, so that the keymap becomes effective.
5305 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005306 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307
5308 *'keymodel'* *'km'*
5309'keymodel' 'km' string (default "")
5310 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005311 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 can do. These values can be used:
5313 startsel Using a shifted special key starts selection (either
5314 Select mode or Visual mode, depending on "key" being
5315 present in 'selectmode').
5316 stopsel Using a not-shifted special key stops selection.
5317 Special keys in this context are the cursor keys, <End>, <Home>,
5318 <PageUp> and <PageDown>.
5319 The 'keymodel' option is set by the |:behave| command.
5320
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005321 *'keyprotocol'* *'kpc'*
5322'keyprotocol' 'kpc' string (default: see below)
5323 global
5324 Specifies what keyboard protocol to use depending on the value of
5325 'term'. The supported keyboard protocols names are:
5326 none whatever the terminal uses
5327 mok2 modifyOtherKeys level 2, as supported by xterm
5328 kitty Kitty keyboard protocol, as supported by Kitty
5329
Bram Moolenaara87749e2022-11-30 10:23:17 +00005330 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005331 a pattern that is matched against the 'term' option, a colon and the
5332 protocol name to be used. To illustrate this, the default value would
5333 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005334 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5335 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005336
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005337< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005338 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5339 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005340
5341 The first match is used, thus if you want to have "kitty" use the
5342 kitty protocol, but "badkitty" not, then you should match "badkitty"
5343 first and use the "none" value: >
5344 set keyprotocol=badkitty:none,kitty:kitty
5345<
5346 The option is used after 'term' has been changed. First the termcap
5347 entries are set, possibly using the builtin list, see |builtin-terms|.
5348 Then this option is inspected and if there is a match and a protocol
5349 is specified the following happens:
5350 none Nothing, the regular t_TE and t_TI values remain
5351
5352 mok2 The t_TE value is changed to:
5353 CSI >4;m disables modifyOtherKeys
5354 The t_TI value is changed to:
5355 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005356 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005357
5358 kitty The t_TE value is changed to:
5359 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005360 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005361 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005362 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005363 CSI ?u request kitty keyboard protocol state
5364 CSI >c request the termresponse
5365
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005366 If you notice problems, such as characters being displayed that
5367 disappear after `CTRL-L`, you might want to try making this option
5368 empty. Then set the 'term' option to have it take effect: >
5369 set keyprotocol=
5370 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005371<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005372
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 *'keywordprg'* *'kp'*
5374'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005375 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 Program to use for the |K| command. Environment variables are
5378 expanded |:set_env|. ":help" may be used to access the Vim internal
5379 help. (Note that previously setting the global option to the empty
5380 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005381 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005382 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005383 When "man", "man -s" or an Ex command is used, Vim will automatically
5384 translate a count for the "K" command and pass it as the first
5385 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 See |option-backslash| about including spaces and backslashes.
5387 Example: >
5388 :set keywordprg=man\ -s
5389< This option cannot be set from a |modeline| or in the |sandbox|, for
5390 security reasons.
5391
5392 *'langmap'* *'lmap'* *E357* *E358*
5393'langmap' 'lmap' string (default "")
5394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 {only available when compiled with the |+langmap|
5396 feature}
5397 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005398 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005399 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 care of translating these special characters to the original meaning
5401 of the key. This means you don't have to change the keyboard mode to
5402 be able to execute Normal mode commands.
5403 This is the opposite of the 'keymap' option, where characters are
5404 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005405 Also consider setting 'langremap' to off, to prevent 'langmap' from
5406 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005407 This option cannot be set from a |modeline| or in the |sandbox|, for
5408 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005410 Example (for Greek, in UTF-8): *greek* >
5411 :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 +00005412< Example (exchanges meaning of z and y for commands): >
5413 :set langmap=zy,yz,ZY,YZ
5414<
5415 The 'langmap' option is a list of parts, separated with commas. Each
5416 part can be in one of two forms:
5417 1. A list of pairs. Each pair is a "from" character immediately
5418 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005419 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 characters. Example: "abc;ABC"
5421 Example: "aA,fgh;FGH,cCdDeE"
5422 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005423 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424
5425 This will allow you to activate vim actions without having to switch
5426 back and forth between the languages. Your language characters will
5427 be understood as normal vim English characters (according to the
5428 langmap mappings) in the following cases:
5429 o Normal/Visual mode (commands, buffer/register names, user mappings)
5430 o Insert/Replace Mode: Register names after CTRL-R
5431 o Insert/Replace Mode: Mappings
5432 Characters entered in Command-line mode will NOT be affected by
5433 this option. Note that this option can be changed at any time
5434 allowing to switch between mappings for different languages/encodings.
5435 Use a mapping to avoid having to type it each time!
5436
5437 *'langmenu'* *'lm'*
5438'langmenu' 'lm' string (default "")
5439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 {only available when compiled with the |+menu| and
5441 |+multi_lang| features}
5442 Language to use for menu translation. Tells which file is loaded
5443 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005444 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445< (without the spaces). For example, to always use the Dutch menus, no
5446 matter what $LANG is set to: >
5447 :set langmenu=nl_NL.ISO_8859-1
5448< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005449 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 If your $LANG is set to a non-English language but you do want to use
5451 the English menus: >
5452 :set langmenu=none
5453< This option must be set before loading menus, switching on filetype
5454 detection or syntax highlighting. Once the menus are defined setting
5455 this option has no effect. But you could do this: >
5456 :source $VIMRUNTIME/delmenu.vim
5457 :set langmenu=de_DE.ISO_8859-1
5458 :source $VIMRUNTIME/menu.vim
5459< Warning: This deletes all menus that you defined yourself!
5460
Bram Moolenaard94464e2015-11-02 15:28:18 +01005461 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005462'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005463 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005464 {only available when compiled with the |+langmap|
5465 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005466 This is just like 'langremap' but with the value inverted. It only
5467 exists for backwards compatibility. When setting 'langremap' then
5468 'langnoremap' is set to the inverted value, and the other way around.
5469
5470 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005471'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005472 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005473 {only available when compiled with the |+langmap|
5474 feature}
5475 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005476 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005477 'langmap' disables some of your mappings, try resetting this option.
5478 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005479 that works for you to avoid mappings to break.
5480
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 *'laststatus'* *'ls'*
5482'laststatus' 'ls' number (default 1)
5483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 The value of this option influences when the last window will have a
5485 status line:
5486 0: never
5487 1: only if there are at least two windows
5488 2: always
5489 The screen looks nicer with a status line if you have several
5490 windows, but it takes another screen line. |status-line|
5491
5492 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5493'lazyredraw' 'lz' boolean (default off)
5494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 When this option is set, the screen will not be redrawn while
5496 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005497 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005499 This may occasionally cause display errors. It is only meant to be set
5500 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005501 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502
64-bitman88d41ab2025-04-06 17:20:39 +02005503 *'lhistory'* *'lhi'*
5504'lhistory' 'lhi' number (default: 10)
5505 local to window
5506 {only available when compiled with the |+quickfix|
5507 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005508 Like 'chistory', but for the location list stack associated with a
5509 window. If the option is changed in either the location list window
5510 itself or the window that is associated with the location list stack,
5511 the new value will also be applied to the other one. This means this
5512 value will always be the same for a given location list window and its
5513 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005514
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5516'linebreak' 'lbr' boolean (default off)
5517 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005518 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005520 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 than at the last character that fits on the screen. Unlike
5522 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005523 it only affects the way the file is displayed, not its contents.
5524 If 'breakindent' is set, line is visually indented. Then, the value
5525 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005526 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 Note that <Tab> characters after an <EOL> are mostly not displayed
5528 with the right amount of white space.
5529
5530 *'lines'* *E593*
5531'lines' number (default 24 or terminal height)
5532 global
5533 Number of lines of the Vim window.
5534 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005535 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 When Vim is running in the GUI or in a resizable window, setting this
5537 option will cause the window size to be changed. When you only want
5538 to use the size for the GUI, put the command in your |gvimrc| file.
5539 Vim limits the number of lines to what fits on the screen. You can
5540 use this command to get the tallest window possible: >
5541 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005542< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005543 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 When you set this option and Vim is unable to change the physical
5545 number of lines of the display, the display may be messed up.
5546
5547 *'linespace'* *'lsp'*
5548'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 {only in the GUI}
5551 Number of pixel lines inserted between characters. Useful if the font
5552 uses the full character cell height, making lines touch each other.
5553 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005554 With some fonts there can be too much room between lines (to have
5555 space for ascents and descents). Then it makes sense to set
5556 'linespace' to a negative value. This may cause display problems
5557 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
5559 *'lisp'* *'nolisp'*
5560'lisp' boolean (default off)
5561 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 Lisp mode: When <Enter> is typed in insert mode set the indent for
5563 the next line to Lisp standards (well, sort of). Also happens with
5564 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5565 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5566 better. Also see 'lispwords'.
5567 The '-' character is included in keyword characters. Redefines the
5568 "=" operator to use this same indentation algorithm rather than
5569 calling an external program if 'equalprg' is empty.
5570 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005572 *'lispoptions'* *'lop'*
5573'lispoptions' 'lop' string (default "")
5574 local to buffer
5575 Comma-separated list of items that influence the Lisp indenting when
5576 enabled with the |'lisp'| option. Currently only one item is
5577 supported:
5578 expr:1 use 'indentexpr' for Lisp indenting when it is set
5579 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5580 Note that when using 'indentexpr' the `=` operator indents all the
5581 lines, otherwise the first line is not indented (Vi-compatible).
5582
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 *'lispwords'* *'lw'*
5584'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005585 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005586 Comma-separated list of words that influence the Lisp indenting when
5587 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588
5589 *'list'* *'nolist'*
5590'list' boolean (default off)
5591 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005592 List mode: By default show tabs as CTRL-I is displayed, display $
5593 after end of line. Useful to see the difference between tabs and
5594 spaces and for trailing blanks. Further changed by the 'listchars'
5595 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005596
5597 The cursor is displayed at the start of the space a Tab character
5598 occupies, not at the end as usual in Normal mode. To get this cursor
5599 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005600 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005601<
5602 Note that list mode will also affect formatting (set with 'textwidth'
5603 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 changing the way tabs are displayed.
5605
5606 *'listchars'* *'lcs'*
5607'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005608 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005609 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005610 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005611 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 eol:c Character to show at the end of each line. When
5613 omitted, there is no extra character at the end of the
5614 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005615 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005616 tab:xy[z] Two or three characters to be used to show a tab.
5617 The third character is optional.
5618
5619 tab:xy The 'x' is always used, then 'y' as many times as will
5620 fit. Thus "tab:>-" displays:
5621 >
5622 >-
5623 >--
5624 etc.
5625
5626 tab:xyz The 'z' is always used, then 'x' is prepended, and
5627 then 'y' is used as many times as will fit. Thus
5628 "tab:<->" displays:
5629 >
5630 <>
5631 <->
5632 <-->
5633 etc.
5634
5635 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005636 *lcs-space*
5637 space:c Character to show for a space. When omitted, spaces
5638 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005639 *lcs-multispace*
5640 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005641 One or more characters to use cyclically to show for
5642 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005643 setting, except for single spaces. When omitted, the
5644 "space" setting is used. For example,
5645 `:set listchars=multispace:---+` shows ten consecutive
5646 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005647 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005648 *lcs-lead*
5649 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005650 leading spaces are blank. Overrides the "space" and
5651 "multispace" settings for leading spaces. You can
5652 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005653 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005654< *lcs-leadmultispace*
5655 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005656 Like the |lcs-multispace| value, but for leading
5657 spaces only. Also overrides |lcs-lead| for leading
5658 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005659 `:set listchars=leadmultispace:---+` shows ten
5660 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005661 ---+---+--XXX ~
5662 Where "XXX" denotes the first non-blank characters in
5663 the line.
5664 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005665 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005666 trailing spaces are blank. Overrides the "space" and
5667 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005668 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 extends:c Character to show in the last column, when 'wrap' is
5670 off and the line continues beyond the right of the
5671 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005672 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005673 precedes:c Character to show in the first visible column of the
5674 physical line, when there is text preceding the
5675 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005676 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005677 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005678 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005679 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005680 nbsp:c Character to show for a non-breakable space character
5681 (0xA0 (160 decimal) and U+202F). Left blank when
5682 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005686 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005688 Each character can be specified as hex: >
5689 set listchars=eol:\\x24
5690 set listchars=eol:\\u21b5
5691 set listchars=eol:\\U000021b5
5692< Note that a double backslash is used. The number of hex characters
5693 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5694
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 Examples: >
5696 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005697 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 :set lcs=extends:>,precedes:<
5699< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005700 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5701 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005702 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703
5704 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5705'loadplugins' 'lpl' boolean (default on)
5706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 When on the plugin scripts are loaded when starting up |load-plugins|.
5708 This option can be reset in your |vimrc| file to disable the loading
5709 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005710 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5711 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712
Bram Moolenaard94464e2015-11-02 15:28:18 +01005713 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005714'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005715 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005716 {only available when compiled with the |+lua/dyn|
5717 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005718 Specifies the name of the Lua shared library. The default is
5719 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005720 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005721 This option cannot be set from a |modeline| or in the |sandbox|, for
5722 security reasons.
5723
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005724 *'macatsui'* *'nomacatsui'*
5725'macatsui' boolean (default on)
5726 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005727 {not supported}
5728 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005729
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 *'magic'* *'nomagic'*
5731'magic' boolean (default on)
5732 global
5733 Changes the special characters that can be used in search patterns.
5734 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005735 WARNING: Switching this option off most likely breaks plugins! That
5736 is because many patterns assume it's on and will fail when it's off.
5737 Only switch it off when working with old Vi scripts. In any other
5738 situation write patterns that work when 'magic' is on. Include "\M"
5739 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005740 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5741 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
5743 *'makeef'* *'mef'*
5744'makeef' 'mef' string (default: "")
5745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 {not available when compiled without the |+quickfix|
5747 feature}
5748 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5749 and the |:grep| command.
5750 When it is empty, an internally generated temp file will be used.
5751 When "##" is included, it is replaced by a number to make the name
5752 unique. This makes sure that the ":make" command doesn't overwrite an
5753 existing file.
5754 NOT used for the ":cf" command. See 'errorfile' for that.
5755 Environment variables are expanded |:set_env|.
5756 See |option-backslash| about including spaces and backslashes.
5757 This option cannot be set from a |modeline| or in the |sandbox|, for
5758 security reasons.
5759
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005760 *'makeencoding'* *'menc'*
5761'makeencoding' 'menc' string (default "")
5762 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005763 Encoding used for reading the output of external commands. When empty,
5764 encoding is not converted.
5765 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5766 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5767 and `:laddfile`.
5768
5769 This would be mostly useful when you use MS-Windows and set 'encoding'
5770 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5771 'makeencoding' to "char" has the same effect as setting to the system
5772 locale encoding. Example: >
5773 :set encoding=utf-8
5774 :set makeencoding=char " system locale is used
5775<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 *'makeprg'* *'mp'*
5777'makeprg' 'mp' string (default "make", VMS: "MMS")
5778 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005779 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005780 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5781 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005782 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005783 Environment variables are expanded |:set_env|. See |option-backslash|
5784 about including spaces and backslashes.
5785 Note that a '|' must be escaped twice: once for ":set" and once for
5786 the interpretation of a command. When you use a filter called
5787 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 :set makeprg=gmake\ \\\|\ myfilter
5789< The placeholder "$*" can be given (even multiple times) to specify
5790 where the arguments will be included, for example: >
5791 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5792< This option cannot be set from a |modeline| or in the |sandbox|, for
5793 security reasons.
5794
5795 *'matchpairs'* *'mps'*
5796'matchpairs' 'mps' string (default "(:),{:},[:]")
5797 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005799 other.
5800 Only character pairs are allowed that are different, thus you cannot
5801 jump between two double quotes.
5802 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005803 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005804 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 :set mps+=<:>
5806
5807< A more exotic example, to jump between the '=' and ';' in an
5808 assignment, useful for languages like C and Java: >
5809 :au FileType c,cpp,java set mps+==:;
5810
5811< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005812 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813
5814 *'matchtime'* *'mat'*
5815'matchtime' 'mat' number (default 5)
5816 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 Tenths of a second to show the matching paren, when 'showmatch' is
5818 set. Note that this is not in milliseconds, like other options that
5819 set a time. This is to be compatible with Nvi.
5820
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005821 *'maxcombine'* *'mco'*
5822'maxcombine' 'mco' number (default 2)
5823 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005824 The maximum number of combining characters supported for displaying.
5825 Only used when 'encoding' is "utf-8".
5826 The default is OK for most languages. Hebrew may require 4.
5827 Maximum value is 6.
5828 Even when this option is set to 2 you can still edit text with more
5829 combining characters, you just can't see them. Use |g8| or |ga|.
Christian Brabandt6b2c1ad2025-05-30 17:43:42 +02005830 When set to 0, you will not be able to see any combining characters.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005831 See |mbyte-combining|.
5832
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 *'maxfuncdepth'* *'mfd'*
5834'maxfuncdepth' 'mfd' number (default 100)
5835 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005836 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005837 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 Maximum depth of function calls for user functions. This normally
5839 catches endless recursion. When using a recursive function with
5840 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5841 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005842 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005843 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005845 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846
5847 *'maxmapdepth'* *'mmd'* *E223*
5848'maxmapdepth' 'mmd' number (default 1000)
5849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 Maximum number of times a mapping is done without resulting in a
5851 character to be used. This normally catches endless mappings, like
5852 ":map x y" with ":map y x". It still does not catch ":map g wg",
5853 because the 'w' is used before the next mapping is done. See also
5854 |key-mapping|.
5855
5856 *'maxmem'* *'mm'*
5857'maxmem' 'mm' number (default between 256 to 5120 (system
5858 dependent) or half the amount of memory
5859 available)
5860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5862 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005863 other memory to be freed.
5864 The maximum usable value is about 2000000. Use this to work without a
5865 limit.
5866 The value is ignored when 'swapfile' is off.
5867 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005869 *'maxmempattern'* *'mmp'*
5870'maxmempattern' 'mmp' number (default 1000)
5871 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005872 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005873 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005874 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005875 When Vim runs into the limit it gives an error message and mostly
5876 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005877 Running into the limit often means that the pattern is very
5878 inefficient or too complex. This may already happen with the pattern
5879 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005880 Might also happen on redraw, when syntax rules try to match a complex
5881 text structure.
5882 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5883 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005884
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 *'maxmemtot'* *'mmt'*
5886'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5887 dependent) or half the amount of memory
5888 available)
5889 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005890 Maximum amount of memory in Kbyte to use for all buffers together.
5891 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005892 without a limit.
5893 On 64 bit machines higher values might work. But hey, do you really
5894 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005895 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005896 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005897 Buffers with 'swapfile' off still count to the total amount of memory
5898 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005899 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900
5901 *'menuitems'* *'mis'*
5902'menuitems' 'mis' number (default 25)
5903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {not available when compiled without the |+menu|
5905 feature}
5906 Maximum number of items to use in a menu. Used for menus that are
5907 generated from a list of items, e.g., the Buffers menu. Changing this
5908 option has no direct effect, the menu must be refreshed first.
5909
Christian Brabandt51d4d842024-12-06 17:26:25 +01005910 *'messagesopt'* *'mopt'*
5911'messagesopt' 'mopt' string (default "hit-enter,history:500")
5912 global
5913
zeertzjq8cc43da2024-12-07 16:09:08 +01005914 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005915 following items. Items must be separated by a comma.
5916
zeertzjq8cc43da2024-12-07 16:09:08 +01005917 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005918 'cmdheight' size.
5919
zeertzjq8cc43da2024-12-07 16:09:08 +01005920 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5921 {n} milliseconds so that the user has a chance to read
5922 the message. The maximum value of {n} is 10000. Use
5923 0 to disable the wait (but then the user may miss an
5924 important message).
5925 This item is ignored when "hit-enter" is present, but
5926 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005927
5928 history:{n} Determines how many entries are remembered in the
5929 |:messages| history. The maximum value is 10000.
5930 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005931 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005932
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005933 *'mkspellmem'* *'msm'*
5934'mkspellmem' 'msm' string (default "460000,2000,500")
5935 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005936 {not available when compiled without the |+syntax|
5937 feature}
5938 Parameters for |:mkspell|. This tunes when to start compressing the
5939 word tree. Compression can be slow when there are many words, but
5940 it's needed to avoid running out of memory. The amount of memory used
5941 per word depends very much on how similar the words are, that's why
5942 this tuning is complicated.
5943
5944 There are three numbers, separated by commas:
5945 {start},{inc},{added}
5946
5947 For most languages the uncompressed word tree fits in memory. {start}
5948 gives the amount of memory in Kbyte that can be used before any
5949 compression is done. It should be a bit smaller than the amount of
5950 memory that is available to Vim.
5951
5952 When going over the {start} limit the {inc} number specifies the
5953 amount of memory in Kbyte that can be allocated before another
5954 compression is done. A low number means compression is done after
5955 less words are added, which is slow. A high number means more memory
5956 will be allocated.
5957
5958 After doing compression, {added} times 1024 words can be added before
5959 the {inc} limit is ignored and compression is done when any extra
5960 amount of memory is needed. A low number means there is a smaller
5961 chance of hitting the {inc} limit, less memory is used but it's
5962 slower.
5963
5964 The languages for which these numbers are important are Italian and
5965 Hungarian. The default works for when you have about 512 Mbyte. If
5966 you have 1 Gbyte you could use: >
5967 :set mkspellmem=900000,3000,800
5968< If you have less than 512 Mbyte |:mkspell| may fail for some
5969 languages, no matter what you set 'mkspellmem' to.
5970
dkearns8ebdbc92023-10-29 06:26:19 +11005971 This option cannot be set from a |modeline| or in the |sandbox|, for
5972 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005973
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005975'modeline' 'ml' boolean (Vim default: on (off for root),
5976 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005978 If 'modeline' is on 'modelines' gives the number of lines that is
5979 checked for set commands. If 'modeline' is off or 'modelines' is zero
5980 no lines are checked. See |modeline|.
5981
5982 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5983'modelineexpr' 'mle' boolean (default: off)
5984 global
5985 When on allow some options that are an expression to be set in the
5986 modeline. Check the option for whether it is affected by
5987 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005988 This option cannot be set from a |modeline| or in the |sandbox|, for
5989 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005990
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 *'modelines'* *'mls'*
5992'modelines' 'mls' number (default 5)
5993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 If 'modeline' is on 'modelines' gives the number of lines that is
5995 checked for set commands. If 'modeline' is off or 'modelines' is zero
5996 no lines are checked. See |modeline|.
5997 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5998 set and to the Vim default value when 'compatible' is reset.
5999
6000 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02006001 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002'modifiable' 'ma' boolean (default on)
6003 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 When off the buffer contents cannot be changed. The 'fileformat' and
6005 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006006 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007
6008 *'modified'* *'mod'* *'nomodified'* *'nomod'*
6009'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006010 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 When on, the buffer is considered to be modified. This option is set
6012 when:
6013 1. A change was made to the text since it was last written. Using the
6014 |undo| command to go back to the original text will reset the
6015 option. But undoing changes that were made before writing the
6016 buffer will set the option again, since the text is different from
6017 when it was written.
6018 2. 'fileformat' or 'fileencoding' is different from its original
6019 value. The original value is set when the buffer is read or
6020 written. A ":set nomodified" command also resets the original
6021 values to the current values and the 'modified' option will be
6022 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01006023 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006024 This option is not set when a change is made to the buffer as the
6025 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
6026 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
6027 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 When 'buftype' is "nowrite" or "nofile" this option may be set, but
6029 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006030 Note that the text may actually be the same, e.g. 'modified' is set
6031 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032
6033 *'more'* *'nomore'*
6034'more' boolean (Vim default: on, Vi default: off)
6035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 When on, listings pause when the whole screen is filled. You will get
6037 the |more-prompt|. When this option is off there are no pauses, the
6038 listing continues until finished.
6039 NOTE: This option is set to the Vi default value when 'compatible' is
6040 set and to the Vim default value when 'compatible' is reset.
6041
Bram Moolenaar98a29d02021-01-18 19:55:44 +01006042 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006043'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01006044 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006046 Enable the use of the mouse. Works for most terminals (xterm, Win32
6047 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
6048 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
6049 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01006050 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 v Visual mode
6052 i Insert mode
6053 c Command-line mode
6054 h all previous modes when editing a help file
6055 a all previous modes
6056 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006057 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01006059< If your terminal can't overrule the mouse events going to the
6060 application, use: >
6061 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02006062< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01006063 back to Vim using the mouse events.
6064 In |defaults.vim| "nvi" is used if the 'term' option is not matching
6065 "xterm".
6066
6067 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 modeless selection. This doesn't move the text cursor.
6069
6070 See |mouse-using|. Also see |'clipboard'|.
6071
6072 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006073 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 the mouse buttons can still be used by keeping the shift key pressed.
6075 Also see the 'clipboard' option.
6076
6077 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
6078'mousefocus' 'mousef' boolean (default off)
6079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 {only works in the GUI}
6081 The window that the mouse pointer is on is automatically activated.
6082 When changing the window layout or window focus in another way, the
6083 mouse pointer is moved to the window with keyboard focus. Off is the
6084 default because it makes using the pull down menus a little goofy, as
6085 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006086 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01006087 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088
6089 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
6090'mousehide' 'mh' boolean (default on)
6091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 {only works in the GUI}
6093 When on, the mouse pointer is hidden when characters are typed.
6094 The mouse pointer is restored when the mouse is moved.
6095
6096 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006097'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 Sets the model to use for the mouse. The name mostly specifies what
6100 the right mouse button is used for:
6101 extend Right mouse button extends a selection. This works
6102 like in an xterm.
6103 popup Right mouse button pops up a menu. The shifted left
6104 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00006105 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 popup_setpos Like "popup", but the cursor will be moved to the
6107 position where the mouse was clicked, and thus the
6108 selected operation will act upon the clicked object.
6109 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00006110 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 course, that right clicking outside a selection will
6112 end Visual mode.
6113 Overview of what button does what for each model:
6114 mouse extend popup(_setpos) ~
6115 left click place cursor place cursor
6116 left drag start selection start selection
6117 shift-left search word extend selection
6118 right click extend selection popup menu (place cursor)
6119 right drag extend selection -
6120 middle click paste paste
6121
6122 In the "popup" model the right mouse button produces a pop-up menu.
6123 You need to define this first, see |popup-menu|.
6124
6125 Note that you can further refine the meaning of buttons with mappings.
6126 See |gui-mouse-mapping|. But mappings are NOT used for modeless
6127 selection (because that's handled in the GUI code directly).
6128
6129 The 'mousemodel' option is set by the |:behave| command.
6130
h_east59858792023-10-25 22:47:05 +09006131 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01006132'mousemoveevent' 'mousemev' boolean (default off)
6133 global
6134 {only works in the GUI}
6135 When on, mouse move events are delivered to the input queue and are
6136 available for mapping. The default, off, avoids the mouse movement
6137 overhead except when needed. See |gui-mouse-mapping|.
6138 Warning: Setting this option can make pending mappings to be aborted
6139 when the mouse is moved.
6140 Currently only works in the GUI, may be made to work in a terminal
6141 later.
6142
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006144'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6145 vs:leftright,vd:lrsizing,m:no,
6146 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 {only available when compiled with the |+mouseshape|
6149 feature}
6150 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006151 different modes. The option is a comma-separated list of parts, much
Drew Vogel48b19b22025-05-07 21:32:03 +02006152 like used for 'guicursor'. Each part consists of a mode/location-list
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 and an argument-list:
6154 mode-list:shape,mode-list:shape,..
6155 The mode-list is a dash separated list of these modes/locations:
6156 In a normal window: ~
6157 n Normal mode
6158 v Visual mode
6159 ve Visual mode with 'selection' "exclusive" (same as 'v',
6160 if not specified)
6161 o Operator-pending mode
6162 i Insert mode
6163 r Replace mode
6164
6165 Others: ~
6166 c appending to the command-line
6167 ci inserting in the command-line
6168 cr replacing in the command-line
6169 m at the 'Hit ENTER' or 'More' prompts
6170 ml idem, but cursor in the last line
6171 e any mode, pointer below last window
6172 s any mode, pointer on a status line
6173 sd any mode, while dragging a status line
6174 vs any mode, pointer on a vertical separator line
6175 vd any mode, while dragging a vertical separator line
6176 a everywhere
6177
6178 The shape is one of the following:
6179 avail name looks like ~
Drew Vogel48b19b22025-05-07 21:32:03 +02006180 w x g arrow Normal mouse pointer
6181 w x blank no pointer at all (use with care!)
6182 w x g beam I-beam
6183 w x g updown up-down sizing arrows
6184 w x g leftright left-right sizing arrows
6185 w x g busy The system's usual busy pointer
6186 w x g no The system's usual 'no input' pointer
6187 x g udsizing indicates up-down resizing
6188 x g lrsizing indicates left-right resizing
6189 x g crosshair like a big thin +
6190 x g hand1 black hand
6191 x g hand2 white hand
6192 x pencil what you write with
6193 x g question big ?
6194 x rightup-arrow arrow pointing right-up
6195 w x up-arrow arrow pointing up
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 x <number> any X11 pointer number (see X11/cursorfont.h)
6197
6198 The "avail" column contains a 'w' if the shape is available for Win32,
Drew Vogel48b19b22025-05-07 21:32:03 +02006199 x for X11 (including GTK+ 2), g for GTK+ 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 Any modes not specified or shapes not available use the normal mouse
6201 pointer.
6202
6203 Example: >
6204 :set mouseshape=s:udsizing,m:no
6205< will make the mouse turn to a sizing arrow over the status lines and
6206 indicate no input when the hit-enter prompt is displayed (since
6207 clicking the mouse has no effect in this state.)
6208
6209 *'mousetime'* *'mouset'*
6210'mousetime' 'mouset' number (default 500)
6211 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006212 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 time in msec between two mouse clicks for the second click to be
6214 recognized as a multi click.
6215
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006216
laburnumT3f7855a2023-12-05 18:37:03 +01006217 *'mzquantum'* *'mzq'*
6218'mzquantum' 'mzq' number (default 100)
6219 global
6220 {not available when compiled without the |+mzscheme|
6221 feature}
6222 The number of milliseconds between polls for MzScheme threads.
6223 Negative or zero value means no thread scheduling.
6224 NOTE: This option is set to the Vim default value when 'compatible'
6225 is reset.
6226
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006227 *'mzschemedll'*
6228'mzschemedll' string (default depends on the build)
6229 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006230 {only available when compiled with the |+mzscheme/dyn|
6231 feature}
6232 Specifies the name of the MzScheme shared library. The default is
6233 DYNAMIC_MZSCH_DLL which was specified at compile time.
6234 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006235 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006236 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006237 This option cannot be set from a |modeline| or in the |sandbox|, for
6238 security reasons.
6239
6240 *'mzschemegcdll'*
6241'mzschemegcdll' string (default depends on the build)
6242 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006243 {only available when compiled with the |+mzscheme/dyn|
6244 feature}
6245 Specifies the name of the MzScheme GC shared library. The default is
6246 DYNAMIC_MZGC_DLL which was specified at compile time.
6247 The value can be equal to 'mzschemedll' if it includes the GC code.
6248 Environment variables are expanded |:set_env|.
6249 This option cannot be set from a |modeline| or in the |sandbox|, for
6250 security reasons.
6251
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006253'nrformats' 'nf' string (default "bin,octal,hex",
6254 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 This defines what bases Vim will consider for numbers when using the
6257 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6258 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006259 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006261 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006262 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006264 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 considered to be hexadecimal. Example: Using CTRL-X on
6266 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006267 bin If included, numbers starting with "0b" or "0B" will be
6268 considered to be binary. Example: Using CTRL-X on
6269 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006270 unsigned If included, numbers are recognized as unsigned. Thus a
6271 leading dash or negative sign won't be considered as part of
6272 the number. Examples:
6273 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6274 (without "unsigned" it would become "9-2021").
6275 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6276 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006277 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6278 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006279 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006280 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006281 dash immediately preceded by a non-whitespace character (i.e.,
6282 not a tab or a " "), the negative sign won't be considered as
6283 part of the number. For example:
6284 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6285 (without "blank" it would become "Carbon-13").
6286 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006287 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006288 set, it would result in "Carbon -7").
6289 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006290 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006291 included, "unsigned" will take precedence.
6292
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 Numbers which simply begin with a digit in the range 1-9 are always
6294 considered decimal. This also happens for numbers that are not
6295 recognized as octal or hex.
6296
6297 *'number'* *'nu'* *'nonumber'* *'nonu'*
6298'number' 'nu' boolean (default off)
6299 local to window
6300 Print the line number in front of each line. When the 'n' option is
6301 excluded from 'cpoptions' a wrapped line will not use the column of
6302 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006303 The 'numberwidth' option can be used to set the room used for the line
6304 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 When a long, wrapped line doesn't start with the first character, '-'
6306 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006307 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6308 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006309 *number_relativenumber*
6310 The 'relativenumber' option changes the displayed number to be
6311 relative to the cursor. Together with 'number' there are these
6312 four combinations (cursor in line 3):
6313
Bram Moolenaar3848e002016-03-19 18:42:29 +01006314 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006315 'nornu' 'nornu' 'rnu' 'rnu'
6316
6317 |apple | 1 apple | 2 apple | 2 apple
6318 |pear | 2 pear | 1 pear | 1 pear
6319 |nobody | 3 nobody | 0 nobody |3 nobody
6320 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006322 *'numberwidth'* *'nuw'*
6323'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6324 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006325 {only available when compiled with the |+linebreak|
6326 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006327 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006328 when the 'number' or 'relativenumber' option is set or printing lines
6329 with a line number. Since one space is always between the number and
6330 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006331 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006332 fit the highest line number in the buffer respectively the number of
6333 rows in the window, depending on whether 'number' or 'relativenumber'
6334 is set. Thus with the Vim default of 4 there is room for a line number
6335 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006336 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006337 NOTE: This option is set to the Vi default value when 'compatible' is
6338 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006339
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006340 *'omnifunc'* *'ofu'*
6341'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006342 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006343 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006344 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006345 This option specifies a function to be used for Insert mode omni
6346 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006347 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006348 invoked and what it should return. The value can be the name of a
6349 function, a |lambda| or a |Funcref|. See |option-value-function| for
6350 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006351 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006352 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006353 This option cannot be set from a |modeline| or in the |sandbox|, for
6354 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006355
Bram Moolenaar02467872007-05-06 13:22:01 +00006356 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006357'opendevice' 'odev' boolean (default off)
6358 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006359 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006360 Enable reading and writing from devices. This may get Vim stuck on a
6361 device that can be opened but doesn't actually do the I/O. Therefore
6362 it is off by default.
6363 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6364 result in editing a device.
6365
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006366 *'operatorfunc'* *'opfunc'*
6367'operatorfunc' 'opfunc' string (default: empty)
6368 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006369 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006370 See |:map-operator| for more info and an example. The value can be
6371 the name of a function, a |lambda| or a |Funcref|. See
6372 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006373
6374 This option cannot be set from a |modeline| or in the |sandbox|, for
6375 security reasons.
6376
Bram Moolenaar251e1912011-06-19 05:09:16 +02006377 *'osfiletype'* *'oft'*
6378'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006380 This option was supported on RISC OS, which has been removed.
6381
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006382 *'packpath'* *'pp'*
6383'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006384 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006385 This option cannot be set from a |modeline| or in the |sandbox|, for
6386 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006387
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006389'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 global
6391 Specifies the nroff macros that separate paragraphs. These are pairs
6392 of two letters (see |object-motions|).
6393
6394 *'paste'* *'nopaste'*
6395'paste' boolean (default off)
6396 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006397 Put Vim in Paste mode. This is useful if you want to cut or copy
6398 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 unexpected effects.
6400 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006401 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 knows about pasting and will mostly do the right thing without 'paste'
6403 being set. The same is true for a terminal where Vim handles the
6404 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006405 This option is reset when starting the GUI. Thus if you set it in
6406 your .vimrc it will work in a terminal, but not in the GUI. Setting
6407 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6408 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 When the 'paste' option is switched on (also when it was already on):
6410 - mapping in Insert mode and Command-line mode is disabled
6411 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006413 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006414 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 - 'revins' is reset
6416 - 'ruler' is reset
6417 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006418 - 'smarttab' is reset
6419 - 'softtabstop' is set to 0
6420 - 'textwidth' is set to 0
6421 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006422 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006425 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006426 - 'indentexpr'
6427 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006428 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 NOTE: When you start editing another file while the 'paste' option is
6430 on, settings from the modelines or autocommands may change the
6431 settings again, causing trouble when pasting text. You might want to
6432 set the 'paste' option again.
6433 When the 'paste' option is reset the mentioned options are restored to
6434 the value before the moment 'paste' was switched from off to on.
6435 Resetting 'paste' before ever setting it does not have any effect.
6436 Since mapping doesn't work while 'paste' is active, you need to use
6437 the 'pastetoggle' option to toggle the 'paste' option with some key.
6438
6439 *'pastetoggle'* *'pt'*
6440'pastetoggle' 'pt' string (default "")
6441 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 When non-empty, specifies the key sequence that toggles the 'paste'
6443 option. This is like specifying a mapping: >
6444 :map {keys} :set invpaste<CR>
6445< Where {keys} is the value of 'pastetoggle'.
6446 The difference is that it will work even when 'paste' is set.
6447 'pastetoggle' works in Insert mode and Normal mode, but not in
6448 Command-line mode.
6449 Mappings are checked first, thus overrule 'pastetoggle'. However,
6450 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6451 this: >
6452 :map <F10> :set paste<CR>
6453 :map <F11> :set nopaste<CR>
6454 :imap <F10> <C-O>:set paste<CR>
6455 :imap <F11> <nop>
6456 :set pastetoggle=<F11>
6457< This will make <F10> start paste mode and <F11> stop paste mode.
6458 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6459 mode everything is inserted literally, except the 'pastetoggle' key
6460 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006461 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462
6463 *'pex'* *'patchexpr'*
6464'patchexpr' 'pex' string (default "")
6465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 {not available when compiled without the |+diff|
6467 feature}
6468 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006469 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006470 This option cannot be set from a |modeline| or in the |sandbox|, for
6471 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472
Bram Moolenaardbc28022014-07-26 13:40:44 +02006473 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474'patchmode' 'pm' string (default "")
6475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 When non-empty the oldest version of a file is kept. This can be used
6477 to keep the original version of a file if you are changing files in a
6478 source distribution. Only the first time that a file is written a
6479 copy of the original file will be kept. The name of the copy is the
6480 name of the original file with the string in the 'patchmode' option
6481 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006482 ".orig" or ".org". 'backupdir' must not be empty for this to work
6483 (Detail: The backup file is renamed to the patchmode file after the
6484 new file has been successfully written, that's why it must be possible
6485 to write a backup file). If there was no file to be backed up, an
6486 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 When the 'backupskip' pattern matches, a patchmode file is not made.
6488 Using 'patchmode' for compressed files appends the extension at the
6489 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6490 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006491 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006493 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 other systems: ".,,")
6496 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006498 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6499 provided that the file being searched for has a relative path (not
6500 starting with "/", "./" or "../"). The directories in the 'path'
6501 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 - Use commas to separate directory names: >
6503 :set path=.,/usr/local/include,/usr/include
6504< - Spaces can also be used to separate directory names (for backwards
6505 compatibility with version 3.0). To have a space in a directory
6506 name, precede it with an extra backslash, and escape the space: >
6507 :set path=.,/dir/with\\\ space
6508< - To include a comma in a directory name precede it with an extra
6509 backslash: >
6510 :set path=.,/dir/with\\,comma
6511< - To search relative to the directory of the current file, use: >
6512 :set path=.
6513< - To search in the current directory use an empty string between two
6514 commas: >
6515 :set path=,,
6516< - A directory name may end in a ':' or '/'.
6517 - Environment variables are expanded |:set_env|.
6518 - When using |netrw.vim| URLs can be used. For example, adding
6519 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006520 - Search upwards and downwards in a directory tree using "*", "**" and
6521 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 - Careful with '\' characters, type two to get one in the option: >
6523 :set path=.,c:\\include
6524< Or just use '/' instead: >
6525 :set path=.,c:/include
6526< Don't forget "." or files won't even be found in the same directory as
6527 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006528 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 it is something like 256 or 1024 characters.
6530 You can check if all the include files are found, using the value of
6531 'path', see |:checkpath|.
6532 The use of |:set+=| and |:set-=| is preferred when adding or removing
6533 directories from the list. This avoids problems when a future version
6534 uses another default. To remove the current directory use: >
6535 :set path-=
6536< To add the current directory use: >
6537 :set path+=
6538< To use an environment variable, you probably need to replace the
6539 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006540 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006541 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542< Replace the ';' with a ':' or whatever separator is used. Note that
6543 this doesn't work when $INCL contains a comma or white space.
6544
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006545 *'perldll'*
6546'perldll' string (default depends on the build)
6547 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006548 {only available when compiled with the |+perl/dyn|
6549 feature}
6550 Specifies the name of the Perl shared library. The default is
6551 DYNAMIC_PERL_DLL, which was specified at compile time.
6552 Environment variables are expanded |:set_env|.
6553 This option cannot be set from a |modeline| or in the |sandbox|, for
6554 security reasons.
6555
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6557'preserveindent' 'pi' boolean (default off)
6558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 When changing the indent of the current line, preserve as much of the
6560 indent structure as possible. Normally the indent is replaced by a
6561 series of tabs followed by spaces as required (unless |'expandtab'| is
6562 enabled, in which case only spaces are used). Enabling this option
6563 means the indent will preserve as many existing characters as possible
6564 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006565 'expandtab' does not apply to the preserved white space, a Tab remains
6566 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 NOTE: When using ">>" multiple times the resulting indent is a mix of
6568 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006569 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 Also see 'copyindent'.
6571 Use |:retab| to clean up white space.
6572
6573 *'previewheight'* *'pvh'*
6574'previewheight' 'pvh' number (default 12)
6575 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006576 {not available when compiled without the |+quickfix|
6577 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006579 commands. Used for |CTRL-W_}| when no count is given. Not used when
6580 'previewpopup' is set.
6581
6582 *'previewpopup'* *'pvp'*
6583'previewpopup' 'pvp' string (default empty)
6584 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006585 {not available when compiled without the |+textprop|
6586 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006587 When not empty a popup window is used for commands that would open a
6588 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006589 Not used for the insert completion info, add "popup" to
6590 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591
6592 *'previewwindow'* *'nopreviewwindow'*
6593 *'pvw'* *'nopvw'* *E590*
6594'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006595 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006596 {not available when compiled without the |+quickfix|
6597 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006598 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 set. It's normally not set directly, but by using one of the commands
6600 |:ptag|, |:pedit|, etc.
6601
6602 *'printdevice'* *'pdev'*
6603'printdevice' 'pdev' string (default empty)
6604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 {only available when compiled with the |+printer|
6606 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006607 The name of the printer to be used for |:hardcopy|.
6608 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006609 This option cannot be set from a |modeline| or in the |sandbox|, for
6610 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611
Bram Moolenaar8299df92004-07-10 09:47:34 +00006612 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006613'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 {only available when compiled with the |+printer|
6616 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006617 Sets the character encoding used when printing.
6618 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619
6620 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006621'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 {only available when compiled with the |+printer|
6624 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006625 Expression used to print the PostScript produced with |:hardcopy|.
6626 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006627 This option cannot be set from a |modeline| or in the |sandbox|, for
6628 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629
Bram Moolenaar8299df92004-07-10 09:47:34 +00006630 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631'printfont' 'pfn' string (default "courier")
6632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 {only available when compiled with the |+printer|
6634 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006635 The name of the font that will be used for |:hardcopy|.
6636 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637
6638 *'printheader'* *'pheader'*
6639'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 {only available when compiled with the |+printer|
6642 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006643 The format of the header produced in |:hardcopy| output.
6644 See |pheader-option|.
6645
6646 *'printmbcharset'* *'pmbcs'*
6647'printmbcharset' 'pmbcs' string (default "")
6648 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006649 {only available when compiled with the |+printer|
6650 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006651 The CJK character set to be used for CJK output from |:hardcopy|.
6652 See |pmbcs-option|.
6653
6654 *'printmbfont'* *'pmbfn'*
6655'printmbfont' 'pmbfn' string (default "")
6656 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006657 {only available when compiled with the |+printer|
6658 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006659 List of font names to be used for CJK output from |:hardcopy|.
6660 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661
6662 *'printoptions'* *'popt'*
6663'printoptions' 'popt' string (default "")
6664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006666 List of items that control the format of the output of |:hardcopy|.
6667 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006669 *'prompt'* *'noprompt'*
6670'prompt' boolean (default on)
6671 global
6672 When on a ":" prompt is used in Ex mode.
6673
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006674 *'pumheight'* *'ph'*
6675'pumheight' 'ph' number (default 0)
6676 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006677 Determines the maximum number of items to show in the popup menu for
6678 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006679 |ins-completion-menu|.
6680
glepnir88d75932025-03-27 20:09:07 +01006681 *'pummaxwidth'* *'pmw'*
6682'pummaxwidth' 'pmw' number (default 0)
6683 global
6684 Determines the maximum width to use for the popup menu for completion.
6685 When zero, there is no maximum width limit, otherwise the popup menu
6686 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006687 by "trunc" value of 'fillchars' option.
6688
6689 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006690 |ins-completion-menu|.
6691
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006692 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006693'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006694 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006695 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006696 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006697
Bram Moolenaard94464e2015-11-02 15:28:18 +01006698 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006699'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006700 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006701 {only available when compiled with the |+python/dyn|
6702 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006703 Specifies the name of the Python 2.x shared library. The default is
6704 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006705 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006706 This option cannot be set from a |modeline| or in the |sandbox|, for
6707 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006708
Bram Moolenaar94073162018-01-31 21:49:05 +01006709 *'pythonhome'*
6710'pythonhome' string (default "")
6711 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006712 {only available when compiled with the |+python/dyn|
6713 feature}
6714 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6715 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6716 which was specified at compile time, will be used for the Python 2.x
6717 home directory.
6718 Environment variables are expanded |:set_env|.
6719 This option cannot be set from a |modeline| or in the |sandbox|, for
6720 security reasons.
6721
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006722 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006723'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006724 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006725 {only available when compiled with the |+python3/dyn|
6726 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006727 Specifies the name of the Python 3 shared library. The default is
6728 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006729 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006730 This option cannot be set from a |modeline| or in the |sandbox|, for
6731 security reasons.
6732
Bram Moolenaar94073162018-01-31 21:49:05 +01006733 *'pythonthreehome'*
6734'pythonthreehome' string (default "")
6735 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006736 {only available when compiled with the |+python3/dyn|
6737 feature}
6738 Specifies the name of the Python 3 home directory. When
6739 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6740 PYTHON3_HOME, which was specified at compile time, will be used for
6741 the Python 3 home directory.
6742 Environment variables are expanded |:set_env|.
6743 This option cannot be set from a |modeline| or in the |sandbox|, for
6744 security reasons.
6745
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006746 *'pyxversion'* *'pyx'*
6747'pyxversion' 'pyx' number (default depends on the build)
6748 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006749 {only available when compiled with the |+python| or
6750 the |+python3| feature}
6751 Specifies the python version used for pyx* functions and commands
6752 |python_x|. The default value is as follows:
6753
6754 Compiled with Default ~
6755 |+python| and |+python3| 0
6756 only |+python| 2
6757 only |+python3| 3
6758
6759 Available values are 0, 2 and 3.
6760 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6761 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6762 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6763 to 2 if Python 2 is available.
6764 See also: |has-pythonx|
6765
6766 If Vim is compiled with only |+python| or |+python3| setting
6767 'pyxversion' has no effect. The pyx* functions and commands are
6768 always the same as the compiled version.
6769
6770 This option cannot be set from a |modeline| or in the |sandbox|, for
6771 security reasons.
6772
Bram Moolenaar858ba062020-05-31 23:11:59 +02006773 *'quickfixtextfunc'* *'qftf'*
6774'quickfixtextfunc' 'qftf' string (default "")
6775 global
6776 {only available when compiled with the |+quickfix|
6777 feature}
6778 This option specifies a function to be used to get the text to display
6779 in the quickfix and location list windows. This can be used to
6780 customize the information displayed in the quickfix or location window
6781 for each entry in the corresponding quickfix or location list. See
6782 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006783 function and an example. The value can be the name of a function, a
6784 |lambda| or a |Funcref|. See |option-value-function| for more
6785 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006786
6787 This option cannot be set from a |modeline| or in the |sandbox|, for
6788 security reasons.
6789
Bram Moolenaar677ee682005-01-27 14:41:15 +00006790 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006791'quoteescape' 'qe' string (default "\")
6792 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006793 The characters that are used to escape quotes in a string. Used for
6794 objects like a', a" and a` |a'|.
6795 When one of the characters in this option is found inside a string,
6796 the following character will be skipped. The default value makes the
6797 text "foo\"bar\\" considered to be one string.
6798
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6800'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006801 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 If on, writes fail unless you use a '!'. Protects you from
6803 accidentally overwriting a file. Default on when Vim is started
6804 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006805 When using ":w!" the 'readonly' option is reset for the current
6806 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006807 When using the ":view" command the 'readonly' option is set for the
6808 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006809 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006811 *'redrawtime'* *'rdt'*
6812'redrawtime' 'rdt' number (default 2000)
6813 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006814 {only available when compiled with the |+reltime|
6815 feature}
6816 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006817 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006818 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006819 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006820 matches will be highlighted.
6821 For syntax highlighting the time applies per window. When over the
6822 limit syntax highlighting is disabled until |CTRL-L| is used.
6823 This is used to avoid that Vim hangs when using a very complicated
6824 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006825
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006826 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006827'regexpengine' 're' number (default 0)
6828 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006829 This selects the default regexp engine. |two-engines|
6830 The possible values are:
6831 0 automatic selection
6832 1 old engine
6833 2 NFA engine
6834 Note that when using the NFA engine and the pattern contains something
6835 that is not supported the pattern will not match. This is only useful
6836 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006837 Using automatic selection enables Vim to switch the engine, if the
6838 default engine becomes too costly. E.g., when the NFA engine uses too
6839 many states. This should prevent Vim from hanging on a combination of
6840 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006841
Bram Moolenaar64486672010-05-16 15:46:46 +02006842 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6843'relativenumber' 'rnu' boolean (default off)
6844 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006845 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006846 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006847 precede some vertical motion commands (e.g. j k + -) with, without
6848 having to calculate it yourself. Especially useful in combination with
6849 other commands (e.g. y d c < > gq gw =).
6850 When the 'n' option is excluded from 'cpoptions' a wrapped
6851 line will not use the column of line numbers (this is the default when
6852 'compatible' isn't set).
6853 The 'numberwidth' option can be used to set the room used for the line
6854 number.
6855 When a long, wrapped line doesn't start with the first character, '-'
6856 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006857 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6858 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006859
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006860 The number in front of the cursor line also depends on the value of
6861 'number', see |number_relativenumber| for all combinations of the two
6862 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006863
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 *'remap'* *'noremap'*
6865'remap' boolean (default on)
6866 global
6867 Allows for mappings to work recursively. If you do not want this for
6868 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006869 NOTE: To avoid portability problems with Vim scripts, always keep
6870 this option at the default "on". Only switch it off when working with
6871 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872
zeertzjqd086b8f2024-02-25 15:42:52 +08006873 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006874'renderoptions' 'rop' string (default: empty)
6875 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006876 {only available when compiled with GUI and DIRECTX on
6877 MS-Windows}
6878 Select a text renderer and set its options. The options depend on the
6879 renderer.
6880
6881 Syntax: >
6882 set rop=type:{renderer}(,{name}:{value})*
6883<
6884 Currently, only one optional renderer is available.
6885
6886 render behavior ~
6887 directx Vim will draw text using DirectX (DirectWrite). It makes
6888 drawn glyphs more beautiful than default GDI.
6889 It requires 'encoding' is "utf-8", and only works on
6890 MS-Windows Vista or newer version.
6891
6892 Options:
6893 name meaning type value ~
6894 gamma gamma float 1.0 - 2.2 (maybe)
6895 contrast enhancedContrast float (unknown)
6896 level clearTypeLevel float (unknown)
6897 geom pixelGeometry int 0 - 2 (see below)
6898 renmode renderingMode int 0 - 6 (see below)
6899 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006900 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006901
Bram Moolenaar92467d32017-12-05 13:22:16 +01006902 See this URL for detail (except for scrlines):
6903 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006904
6905 For geom: structure of a device pixel.
6906 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6907 1 - DWRITE_PIXEL_GEOMETRY_RGB
6908 2 - DWRITE_PIXEL_GEOMETRY_BGR
6909
6910 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006911 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006912
6913 For renmode: method of rendering glyphs.
6914 0 - DWRITE_RENDERING_MODE_DEFAULT
6915 1 - DWRITE_RENDERING_MODE_ALIASED
6916 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6917 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6918 4 - DWRITE_RENDERING_MODE_NATURAL
6919 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6920 6 - DWRITE_RENDERING_MODE_OUTLINE
6921
6922 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006923 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006924
6925 For taamode: antialiasing mode used for drawing text.
6926 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6927 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6928 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6929 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6930
6931 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006932 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6933
Bram Moolenaara338adc2018-01-31 20:51:47 +01006934 For scrlines:
6935 This was used for optimizing scrolling behavior, however this
6936 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006937
6938 Example: >
6939 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006940 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006941 set rop=type:directx
6942<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006943 If select a raster font (Courier, Terminal or FixedSys which
6944 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006945 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006946
6947 NOTE: It is known that some fonts and options combination
6948 causes trouble on drawing glyphs.
6949
Bram Moolenaar92467d32017-12-05 13:22:16 +01006950 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006951 special made fonts (True-Type fonts which includes only
6952 bitmap glyphs).
6953 - 'taamode:3' will not work with some vector fonts.
6954
6955 NOTE: With this option, you can display colored emoji
6956 (emoticon) in Windows 8.1 or later. To display colored emoji,
6957 there are some conditions which you should notice.
6958
6959 - If your font includes non-colored emoji already, it will
6960 be used.
6961 - If your font doesn't have emoji, the system chooses an
6962 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6963 will be used.
6964 - When this alternative font didn't have fixed width glyph,
6965 emoji might be rendered beyond the bounding box of drawing
6966 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006967
6968 Other render types are currently not supported.
6969
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 *'report'*
6971'report' number (default 2)
6972 global
6973 Threshold for reporting number of lines changed. When the number of
6974 changed lines is more than 'report' a message will be given for most
6975 ":" commands. If you want it always, set 'report' to 0.
6976 For the ":substitute" command the number of substitutions is used
6977 instead of the number of lines.
6978
6979 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6980'restorescreen' 'rs' boolean (default on)
6981 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006982 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 When set, the screen contents is restored when exiting Vim. This also
6984 happens when executing external commands.
6985
6986 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6987 options in your .vimrc. To disable restoring:
6988 set t_ti= t_te=
6989 To enable restoring (for an xterm):
6990 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6991 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6992
6993 *'revins'* *'ri'* *'norevins'* *'nori'*
6994'revins' 'ri' boolean (default off)
6995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 {only available when compiled with the |+rightleft|
6997 feature}
6998 Inserting characters in Insert mode will work backwards. See "typing
6999 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
7000 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007001 NOTE: This option is reset when 'compatible' is set.
7002 This option is reset when 'paste' is set and restored when 'paste' is
7003 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004
7005 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
7006'rightleft' 'rl' boolean (default off)
7007 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 {only available when compiled with the |+rightleft|
7009 feature}
7010 When on, display orientation becomes right-to-left, i.e., characters
7011 that are stored in the file appear from the right to the left.
7012 Using this option, it is possible to edit files for languages that
7013 are written from the right to the left such as Hebrew and Arabic.
7014 This option is per window, so it is possible to edit mixed files
7015 simultaneously, or to view the same file in both ways (this is
7016 useful whenever you have a mixed text file with both right-to-left
7017 and left-to-right strings so that both sets are displayed properly
7018 in different windows). Also see |rileft.txt|.
7019
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02007020 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021'rightleftcmd' 'rlc' string (default "search")
7022 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 {only available when compiled with the |+rightleft|
7024 feature}
7025 Each word in this option enables the command line editing to work in
7026 right-to-left mode for a group of commands:
7027
7028 search "/" and "?" commands
7029
7030 This is useful for languages such as Hebrew, Arabic and Farsi.
7031 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
7032
Bram Moolenaard94464e2015-11-02 15:28:18 +01007033 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007034'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01007035 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01007036 {only available when compiled with the |+ruby/dyn|
7037 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01007038 Specifies the name of the Ruby shared library. The default is
7039 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007040 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01007041 This option cannot be set from a |modeline| or in the |sandbox|, for
7042 security reasons.
7043
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007045'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007048 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 text in the file is shown on the far right:
7050 Top first line is visible
7051 Bot last line is visible
7052 All first and last line are visible
7053 45% relative position in the file
7054 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007055 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01007056 ruler is shown there. Otherwise it is shown in the last line of the
7057 screen. If the statusline is given by 'statusline' (i.e. not empty),
7058 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02007060 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 the text column (byte number) and the screen column are shown,
7062 separated with a dash.
7063 For an empty line "0-1" is shown.
7064 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02007065 This option is reset when 'paste' is set and restored when 'paste' is
7066 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 If you don't want to see the ruler all the time but want to know where
7068 you are, use "g CTRL-G" |g_CTRL-G|.
7069 NOTE: This option is reset when 'compatible' is set.
7070
7071 *'rulerformat'* *'ruf'*
7072'rulerformat' 'ruf' string (default empty)
7073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 {not available when compiled without the |+statusline|
7075 feature}
7076 When this option is not empty, it determines the content of the ruler
7077 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00007078 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007079 This option cannot be set in a modeline when 'modelineexpr' is off.
7080
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 The default ruler width is 17 characters. To make the ruler 15
7082 characters wide, put "%15(" at the start and "%)" at the end.
7083 Example: >
7084 :set rulerformat=%15(%c%V\ %p%%%)
7085<
7086 *'runtimepath'* *'rtp'* *vimfiles*
7087'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007088 Unix: "$HOME/.vim or
7089 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 $VIM/vimfiles,
7091 $VIMRUNTIME,
7092 $VIM/vimfiles/after,
7093 $HOME/.vim/after"
7094 Amiga: "home:vimfiles,
7095 $VIM/vimfiles,
7096 $VIMRUNTIME,
7097 $VIM/vimfiles/after,
7098 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01007099 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 $VIM/vimfiles,
7101 $VIMRUNTIME,
7102 $VIM/vimfiles/after,
7103 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007104 Haiku: "$BE_USER_SETTINGS/vim,
7105 $VIM/vimfiles,
7106 $VIMRUNTIME,
7107 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01007108 $BE_USER_SETTINGS/vim/after"
7109 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 $VIM/vimfiles,
7111 $VIMRUNTIME,
7112 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00007113 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 This is a list of directories which will be searched for runtime
7116 files:
7117 filetype.vim filetypes by file name |new-filetype|
7118 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007119 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 colors/ color scheme files |:colorscheme|
7121 compiler/ compiler files |:compiler|
7122 doc/ documentation |write-local-help|
7123 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007124 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 indent/ indent scripts |indent-expression|
7126 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02007127 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02007129 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 plugin/ plugin scripts |write-plugin|
7131 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007132 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 syntax/ syntax files |mysyntaxfile|
7134 tutor/ files for vimtutor |tutor|
7135
7136 And any other file searched for with the |:runtime| command.
7137
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007138 For $XDG_CONFIG_HOME see |xdg-base-dir|.
7139
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 The defaults for most systems are setup to search five locations:
7141 1. In your home directory, for your personal preferences.
7142 2. In a system-wide Vim directory, for preferences from the system
7143 administrator.
7144 3. In $VIMRUNTIME, for files distributed with Vim.
7145 *after-directory*
7146 4. In the "after" directory in the system-wide Vim directory. This is
7147 for the system administrator to overrule or add to the distributed
7148 defaults (rarely needed)
7149 5. In the "after" directory in your home directory. This is for
7150 personal preferences to overrule or add to the distributed defaults
7151 or system-wide settings (rarely needed).
7152
Bram Moolenaard0796902016-09-16 20:02:31 +02007153 More entries are added when using |packages|. If it gets very long
7154 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7155 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007156
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7158 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 wildcards.
7161 See |:runtime|.
7162 Example: >
7163 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7164< This will use the directory "~/vimruntime" first (containing your
7165 personal Vim runtime files), then "/mygroup/vim" (shared between a
7166 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7167 files).
7168 You probably should always include $VIMRUNTIME somewhere, to use the
7169 distributed runtime files. You can put a directory before $VIMRUNTIME
7170 to find files which replace a distributed runtime files. You can put
7171 a directory after $VIMRUNTIME to find files which add to distributed
7172 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007173 When Vim is started with |--clean| the home directory entries are not
7174 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 This option cannot be set from a |modeline| or in the |sandbox|, for
7176 security reasons.
7177
7178 *'scroll'* *'scr'*
7179'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007180 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7182 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007183 changes. This may happen when enabling the |status-line| or
7184 'tabline' option after setting the 'scroll' option.
7185 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007186 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007187 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188
7189 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7190'scrollbind' 'scb' boolean (default off)
7191 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007192 See also |scroll-binding|. When this option is set, scrolling the
7193 current window also scrolls other scrollbind windows (windows that
7194 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 differences between two versions of a file, see 'diff'.
7196 See |'scrollopt'| for options that determine how this option should be
7197 interpreted.
7198 This option is mostly reset when splitting a window to edit another
7199 file. This means that ":split | edit file" results in two windows
7200 with scroll-binding, but ":split file" does not.
7201
Bram Moolenaarae20f342019-11-05 21:09:23 +01007202 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7203'scrollfocus' 'scf' boolean (default off)
7204 global
7205 {only for MS-Windows GUI}
7206 When using the scroll wheel and this option is set, the window under
7207 the mouse pointer is scrolled. With this option off the current
7208 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007209 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007210
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 *'scrolljump'* *'sj'*
7212'scrolljump' 'sj' number (default 1)
7213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 Minimal number of lines to scroll when the cursor gets off the
7215 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7216 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007217 When set to a negative number from -1 to -100 this is used as the
7218 percentage of the window height. Thus -50 scrolls half the window
7219 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 NOTE: This option is set to 1 when 'compatible' is set.
7221
7222 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007223'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007224 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 Minimal number of screen lines to keep above and below the cursor.
7226 This will make some context visible around where you are working. If
7227 you set it to a very large value (999) the cursor line will always be
7228 in the middle of the window (except at the start or end of the file or
7229 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007230 After using the local value, go back the global value with one of
7231 these two: >
7232 setlocal scrolloff<
7233 setlocal scrolloff=-1
7234< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 NOTE: This option is set to 0 when 'compatible' is set.
7236
7237 *'scrollopt'* *'sbo'*
7238'scrollopt' 'sbo' string (default "ver,jump")
7239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007241 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7242 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 The following words are available:
7244 ver Bind vertical scrolling for 'scrollbind' windows
7245 hor Bind horizontal scrolling for 'scrollbind' windows
7246 jump Applies to the offset between two windows for vertical
7247 scrolling. This offset is the difference in the first
7248 displayed line of the bound windows. When moving
7249 around in a window, another 'scrollbind' window may
7250 reach a position before the start or after the end of
7251 the buffer. The offset is not changed though, when
7252 moving back the 'scrollbind' window will try to scroll
7253 to the desired position when possible.
7254 When now making that window the current one, two
7255 things can be done with the relative offset:
7256 1. When "jump" is not included, the relative offset is
7257 adjusted for the scroll position in the new current
7258 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007259 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 2. When "jump" is included, the other windows are
7261 scrolled to keep the same relative offset. When
7262 going back to the other window, it still uses the
7263 same relative offset.
7264 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007265 When 'diff' mode is active there always is vertical scroll binding,
7266 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267
7268 *'sections'* *'sect'*
7269'sections' 'sect' string (default "SHNHH HUnhsh")
7270 global
7271 Specifies the nroff macros that separate sections. These are pairs of
7272 two letters (See |object-motions|). The default makes a section start
7273 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7274
7275 *'secure'* *'nosecure'* *E523*
7276'secure' boolean (default off)
7277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 When on, ":autocmd", shell and write commands are not allowed in
7279 ".vimrc" and ".exrc" in the current directory and map commands are
7280 displayed. Switch it off only if you know that you will not run into
7281 problems, or when the 'exrc' option is off. On Unix this option is
7282 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007283 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 'secure' at the end of your ~/.vimrc then.
7285 This option cannot be set from a |modeline| or in the |sandbox|, for
7286 security reasons.
7287
7288 *'selection'* *'sel'*
7289'selection' 'sel' string (default "inclusive")
7290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 This option defines the behavior of the selection. It is only used
7292 in Visual and Select mode.
7293 Possible values:
7294 value past line inclusive ~
7295 old no yes
7296 inclusive yes yes
7297 exclusive yes no
7298 "past line" means that the cursor is allowed to be positioned one
7299 character past the line.
7300 "inclusive" means that the last character of the selection is included
7301 in an operation. For example, when "x" is used to delete the
7302 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007303 When "old" is used and 'virtualedit' allows the cursor to move past
7304 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007305 When "exclusive" is used, cursor position in visual mode will be
7306 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Christian Brabandtbfeefc42025-06-02 19:56:57 +02007307
7308 Note:
7309 - When "exclusive" is used and selecting from the end backwards, you
7310 cannot include the last character of a line, when starting in Normal
7311 mode and 'virtualedit' empty.
7312 - when "exclusive" is used with a single character visual selection,
7313 Vim will behave as if the 'selection' is inclusive (in other words,
7314 you cannot visually select an empty region).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315
7316 The 'selection' option is set by the |:behave| command.
7317
7318 *'selectmode'* *'slm'*
7319'selectmode' 'slm' string (default "")
7320 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007321 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 Select mode instead of Visual mode, when a selection is started.
7323 Possible values:
7324 mouse when using the mouse
7325 key when using shifted special keys
7326 cmd when using "v", "V" or CTRL-V
7327 See |Select-mode|.
7328 The 'selectmode' option is set by the |:behave| command.
7329
7330 *'sessionoptions'* *'ssop'*
7331'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007332 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007334 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 feature}
7336 Changes the effect of the |:mksession| command. It is a comma
7337 separated list of words. Each word enables saving and restoring
7338 something:
7339 word save and restore ~
7340 blank empty windows
7341 buffers hidden and unloaded buffers, not just those in windows
7342 curdir the current directory
7343 folds manually created folds, opened/closed folds and local
7344 fold options
7345 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007346 and contain at least one lowercase letter. Only
7347 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 help the help window
7349 localoptions options and mappings local to a window or buffer (not
7350 global values for local options)
7351 options all options and mappings (also global values for local
7352 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007353 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 resize size of the Vim window: 'lines' and 'columns'
7355 sesdir the directory in which the session file is located
7356 will become the current directory (useful with
7357 projects accessed over a network from different
7358 systems)
7359 slash backslashes in file names replaced with forward
7360 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007361 tabpages all tab pages; without this only the current tab page
7362 is restored, so that you can make a session for each
7363 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007364 terminal include terminal windows where the command can be
7365 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 unix with Unix end-of-line format (single <NL>), even when
7367 on Windows or DOS
7368 winpos position of the whole Vim window
7369 winsize window sizes
7370
7371 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007372 When neither "curdir" nor "sesdir" is included, file names are stored
7373 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007374 If you leave out "options" many things won't work well after restoring
7375 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 "slash" and "unix" are useful on Windows when sharing session files
7377 with Unix. The Unix version of Vim cannot source dos format scripts,
7378 but the Windows version of Vim can source unix format scripts.
7379
7380 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007381'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 global
7383 Name of the shell to use for ! and :! commands. When changing the
7384 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7385 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 See |option-backslash| about including spaces and backslashes.
7388 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007389
Bram Moolenaara2baa732022-02-04 16:09:54 +00007390 In |restricted-mode| shell commands will not be possible. This mode
7391 is used if the value of $SHELL ends in "false" or "nologin".
7392
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007393 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007394 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7396< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007397 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007399 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007401 Example with escaped space (Vim will do this when initializing the
7402 option from $SHELL): >
7403 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007404< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007405 backslashes are consumed by `:set`.
7406
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 Under MS-Windows, when the executable ends in ".com" it must be
7408 included. Thus setting the shell to "command.com" or "4dos.com"
7409 works, but "command" and "4dos" do not work for all commands (e.g.,
7410 filtering).
7411 For unknown reasons, when using "4dos.com" the current directory is
7412 changed to "C:\". To avoid this set 'shell' like this: >
7413 :set shell=command.com\ /c\ 4dos
7414< This option cannot be set from a |modeline| or in the |sandbox|, for
7415 security reasons.
7416
7417 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007418'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007419 Win32, when 'shell' contains "powershell":
7420 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007421 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007424 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7425 For MS-Windows, the default is set according to the value of 'shell',
7426 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007427 On Unix it can have more than one flag. Each white space separated
7428 part is passed as an argument to the shell command.
7429 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007430 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 This option cannot be set from a |modeline| or in the |sandbox|, for
7432 security reasons.
7433
7434 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007435'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7436 "2>&1| tee", or
7437 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 {not available when compiled without the |+quickfix|
7440 feature}
7441 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 including spaces and backslashes.
7444 The name of the temporary file can be represented by "%s" if necessary
7445 (the file name is appended automatically if no %s appears in the value
7446 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007447 For the Amiga the default is ">". For MS-Windows using powershell the
7448 default is "2>&1 | Out-File -Encoding default", otherwise the default
7449 is ">%s 2>&1". The output is directly saved in a file and not echoed
7450 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007451 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 in a file and echoed to the screen. If the 'shell' option is "csh" or
7453 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007454 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007455 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7456 means that stderr is also included. Before using the 'shell' option a
7457 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007458 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7459 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 The initialization of this option is done after reading the ".vimrc"
7461 and the other initializations, so that when the 'shell' option is set
7462 there, the 'shellpipe' option changes automatically, unless it was
7463 explicitly set before.
7464 When 'shellpipe' is set to an empty string, no redirection of the
7465 ":make" output will be done. This is useful if you use a 'makeprg'
7466 that writes to 'makeef' by itself. If you want no piping, but do
7467 want to include the 'makeef', set 'shellpipe' to a single space.
7468 Don't forget to precede the space with a backslash: ":set sp=\ ".
7469 In the future pipes may be used for filtering and this option will
7470 become obsolete (at least for Unix).
7471 This option cannot be set from a |modeline| or in the |sandbox|, for
7472 security reasons.
7473
7474 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007475'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 Quoting character(s), put around the command passed to the shell, for
7478 the "!" and ":!" commands. The redirection is kept outside of the
7479 quoting. See 'shellxquote' to include the redirection. It's
7480 probably not useful to set both options.
7481 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007482 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007483 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 This option cannot be set from a |modeline| or in the |sandbox|, for
7485 security reasons.
7486
7487 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007488'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7489 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 String to be used to put the output of a filter command in a temporary
7492 file. See also |:!|. See |option-backslash| about including spaces
7493 and backslashes.
7494 The name of the temporary file can be represented by "%s" if necessary
7495 (the file name is appended automatically if no %s appears in the value
7496 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007497 The default is ">". For Unix, if the 'shell' option is "csh" or
7498 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007499 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007500 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7501 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007502 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7503 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007504 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7505 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 The initialization of this option is done after reading the ".vimrc"
7507 and the other initializations, so that when the 'shell' option is set
7508 there, the 'shellredir' option changes automatically unless it was
7509 explicitly set before.
7510 In the future pipes may be used for filtering and this option will
7511 become obsolete (at least for Unix).
7512 This option cannot be set from a |modeline| or in the |sandbox|, for
7513 security reasons.
7514
7515 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7516'shellslash' 'ssl' boolean (default off)
7517 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007518 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007520 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007521 powershell.exe. Backward slashes can still be typed, but they are
7522 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 Note that setting or resetting this option has no effect for some
7524 existing file names, thus this option needs to be set before opening
7525 any file for best results. This might change in the future.
7526 'shellslash' only works when a backslash can be used as a path
7527 separator. To test if this is so use: >
7528 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007529< Also see 'completeslash'.
7530
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007531 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7532'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7533 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007534 When on, use temp files for shell commands. When off use a pipe.
7535 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007536 Currently a pipe is only supported on Unix and MS-Windows 2K and
7537 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007538 :if has("filterpipe")
7539< The advantage of using a pipe is that nobody can read the temp file
7540 and the 'shell' command does not need to support redirection.
7541 The advantage of using a temp file is that the file type and encoding
7542 can be detected.
7543 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7544 |FilterWritePost| autocommands event are not triggered when
7545 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007546 The `system()` function does not respect this option and always uses
7547 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007548 NOTE: This option is set to the Vim default value when 'compatible'
7549 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007550
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 *'shelltype'* *'st'*
7552'shelltype' 'st' number (default 0)
7553 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007554 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 On the Amiga this option influences the way how the commands work
7556 which use a shell.
7557 0 and 1: always use the shell
7558 2 and 3: use the shell only to filter lines
7559 4 and 5: use shell only for ':sh' command
7560 When not using the shell, the command is executed directly.
7561
7562 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7563 1 and 3: use "shell cmd" to start external commands
7564
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007565 *'shellxescape'* *'sxe'*
7566'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007567 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007568 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007569 When 'shellxquote' is set to "(" then the characters listed in this
7570 option will be escaped with a '^' character. This makes it possible
7571 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007572 This option cannot be set from a |modeline| or in the |sandbox|, for
7573 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007574
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 *'shellxquote'* *'sxq'*
7576'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007577 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007578 for Win32, when 'shell' is
7579 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007580 for Win32, when 'shell' contains "sh"
7581 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 for Unix, when using system(): "\"")
7583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 Quoting character(s), put around the command passed to the shell, for
7585 the "!" and ":!" commands. Includes the redirection. See
7586 'shellquote' to exclude the redirection. It's probably not useful
7587 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007588 When the value is '(' then ')' is appended. When the value is '"('
7589 then ')"' is appended.
7590 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007591 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007592 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7593 pwsh.exe which automatically strips off the first and last quote on a
7594 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7595 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007596 'shell', to reduce the need to set this option by the user. See
7597 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 This option cannot be set from a |modeline| or in the |sandbox|, for
7599 security reasons.
7600
7601 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7602'shiftround' 'sr' boolean (default off)
7603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 Round indent to multiple of 'shiftwidth'. Applies to > and <
7605 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7606 a multiple of 'shiftwidth' (this is Vi compatible).
7607 NOTE: This option is reset when 'compatible' is set.
7608
7609 *'shiftwidth'* *'sw'*
7610'shiftwidth' 'sw' number (default 8)
7611 local to buffer
Damien Lejay95ea0b02025-06-01 19:10:36 +02007612 Number of columns that make up one level of (auto)indentation. Used
7613 by |'cindent'|, |<<|, |>>|, etc.
7614 If set to 0, Vim uses the current 'tabstop' value. Use |shiftwidth()|
7615 to obtain the effective value in scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
7617 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007618'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7619 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007620 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007622 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 It is a list of flags:
7624 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007625 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7626 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7627 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7628 m use "[+]" instead of "[Modified]" *shm-m*
7629 n use "[New]" instead of "[New File]" *shm-n*
7630 r use "[RO]" instead of "[readonly]" *shm-r*
7631 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007633 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7634 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007635 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007636 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007638 o overwrite message for writing a file with subsequent *shm-o*
7639 message for reading a file (useful for ":wn" or when
7640 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007641 O message for reading a file overwrites any previous *shm-O*
7642 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007643 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7644 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007645 the search count do not show "W" before the count message
7646 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007647 t truncate file message at the start if it is too long *shm-t*
7648 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007649 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007650 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007651 long to fit on the command line; "..." will appear in the
7652 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007653 W don't give "written" or "[w]" when writing a file *shm-W*
7654 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007655 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007656 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007657 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007658 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007659 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7660 match", "Pattern not found", "Back at original", etc.
7661 C don't give messages while scanning for ins-completion *shm-C*
7662 items, for instance "scanning tags"
7663 q use "recording" instead of "recording @a" *shm-q*
7664 F don't give the file info when editing a file, like *shm-F*
7665 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007666 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007667 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007668 "[1/5]". When the "S" flag is not present (e.g. search count
7669 is shown), the "search hit BOTTOM, continuing at TOP" and
7670 "search hit TOP, continuing at BOTTOM" messages are only
7671 indicated by a "W" (Mnemonic: Wrapped) letter before the
7672 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673
7674 This gives you the opportunity to avoid that a change between buffers
7675 requires you to hit <Enter>, but still gives as useful a message as
7676 possible for the space available. To get the whole message that you
7677 would have got with 'shm' empty, use ":file!"
7678 Useful values:
7679 shm= No abbreviation of message.
7680 shm=a Abbreviation, but no loss of information.
7681 shm=at Abbreviation, and truncate message when necessary.
7682
7683 NOTE: This option is set to the Vi default value when 'compatible' is
7684 set and to the Vim default value when 'compatible' is reset.
7685
7686 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7687'shortname' 'sn' boolean (default off)
7688 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 Filenames are assumed to be 8 characters plus one extension of 3
7690 characters. Multiple dots in file names are not allowed. When this
7691 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007692 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007694 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695
7696 *'showbreak'* *'sbr'* *E595*
7697'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007698 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007699 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 feature}
7701 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007702 values are "> " or "+++ ": >
7703 :set showbreak=>\
7704< Note the backslash to escape the trailing space. It's easier like
7705 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007706 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007707< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 comma (in a future version the comma might be used to separate the
7709 part that is shown at the end and at the start of a line).
7710 The characters are highlighted according to the '@' flag in
7711 'highlight'.
7712 Note that tabs after the showbreak will be displayed differently.
7713 If you want the 'showbreak' to appear in between line numbers, add the
7714 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007715 A window-local value overrules a global value. If the global value is
7716 set and you want no value in the current window use NONE: >
7717 :setlocal showbreak=NONE
7718<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007720'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7721 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007723 Show (partial) command in the last line of the screen. Set this
7724 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 In Visual mode the size of the selected area is shown:
7726 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007727 If the number of bytes is different it is also displayed: "2-6"
7728 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007730 - When selecting a block, the size in screen characters:
7731 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007732 This information can be displayed in an alternative location using the
7733 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 NOTE: This option is set to the Vi default value when 'compatible' is
7735 set and to the Vim default value when 'compatible' is reset.
7736
Luuk van Baalba936f62022-12-15 13:15:39 +00007737 *'showcmdloc'* *'sloc'*
7738'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007739 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007740 This option can be used to display the (partially) entered command in
7741 another location. Possible values are:
7742 last Last line of the screen (default).
7743 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007744 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007745 Setting this option to "statusline" or "tabline" means that these will
7746 be redrawn whenever the command changes, which can be on every key
7747 pressed.
7748 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7749 place the text. Without a custom 'statusline' or 'tabline' it will be
7750 displayed in a convenient location.
7751
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7753'showfulltag' 'sft' boolean (default off)
7754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 When completing a word in insert mode (see |ins-completion|) from the
7756 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007757 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 matched a C function, you can see a template for what arguments are
7759 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007760 Note that this doesn't work well together with having "longest" in
7761 'completeopt', because the completion from the search pattern may not
7762 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763
7764 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7765'showmatch' 'sm' boolean (default off)
7766 global
7767 When a bracket is inserted, briefly jump to the matching one. The
7768 jump is only done if the match can be seen on the screen. The time to
7769 show the match can be set with 'matchtime'.
7770 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007771 seen or not).
7772 This option is reset when 'paste' is set and restored when 'paste' is
7773 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 When the 'm' flag is not included in 'cpoptions', typing a character
7775 will immediately move the cursor back to where it belongs.
7776 See the "sm" field in 'guicursor' for setting the cursor shape and
7777 blinking when showing the match.
7778 The 'matchpairs' option can be used to specify the characters to show
7779 matches for. 'rightleft' and 'revins' are used to look for opposite
7780 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007781 Also see the matchparen plugin for highlighting the match when moving
7782 around |pi_paren.txt|.
7783 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784
7785 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7786'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7787 global
7788 If in Insert, Replace or Visual mode put a message on the last line.
7789 Use the 'M' flag in 'highlight' to set the type of highlighting for
7790 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007791 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 doesn't mean XIM is really active, especially when 'imactivatekey' is
7793 not set.
7794 NOTE: This option is set to the Vi default value when 'compatible' is
7795 set and to the Vim default value when 'compatible' is reset.
7796
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007797 *'showtabline'* *'stal'*
7798'showtabline' 'stal' number (default 1)
7799 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007800 The value of this option specifies when the line with tab page labels
7801 will be displayed:
7802 0: never
7803 1: only if there are at least two tab pages
7804 2: always
7805 This is both for the GUI and non-GUI implementation of the tab pages
7806 line.
7807 See |tab-page| for more information about tab pages.
7808
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007809 *'showtabpanel'* *'stpl'*
7810'showtabpanel' 'stpl' number (default 0)
7811 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007812 {not available when compiled without the |+tabpanel|
7813 feature}
7814 The value of this option specifies when the |tabpanel| with tab page
7815 labels will be displayed:
7816 0: never
7817 1: only if there are at least two tab pages
7818 2: always
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007819 See |tab-page| for more information about tab page labels.
7820
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 *'sidescroll'* *'ss'*
7822'sidescroll' 'ss' number (default 0)
7823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 The minimal number of columns to scroll horizontally. Used only when
7825 the 'wrap' option is off and the cursor is moved off of the screen.
7826 When it is zero the cursor will be put in the middle of the screen.
7827 When using a slow terminal set it to a large number or 0. When using
7828 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7829 commands.
7830
7831 *'sidescrolloff'* *'siso'*
7832'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007833 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007835 right of the cursor if 'nowrap' is set. Setting this option to a
7836 value greater than 0 while having |'sidescroll'| also at a non-zero
7837 value makes some context visible in the line you are scrolling in
7838 horizontally (except at beginning of the line). Setting this option
7839 to a large value (like 999) has the effect of keeping the cursor
7840 horizontally centered in the window, as long as one does not come too
7841 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007842 After using the local value, go back the global value with one of
7843 these two: >
7844 setlocal sidescrolloff<
7845 setlocal sidescrolloff=-1
7846< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847
7848 Example: Try this together with 'sidescroll' and 'listchars' as
7849 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007850 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851
7852 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7853 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007854<
7855 *'signcolumn'* *'scl'*
7856'signcolumn' 'scl' string (default "auto")
7857 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007858 {not available when compiled without the |+signs|
7859 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007860 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007861 "auto" only when there is a sign to display
7862 "no" never
7863 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007864 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007865 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7868'smartcase' 'scs' boolean (default off)
7869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 Override the 'ignorecase' option if the search pattern contains upper
7871 case characters. Only used when the search pattern is typed and
7872 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Girish Palyadc314052025-05-08 23:28:52 +02007873 ":g" and ":s" and when filtering matches for the completion menu
7874 |compl-states|.
7875 Not used for "*", "#", "gd", tag search, etc. After "*" and "#" you
7876 can make 'smartcase' used by doing a "/" command, recalling the search
7877 pattern from history and hitting <Enter>.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 NOTE: This option is reset when 'compatible' is set.
7879
7880 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7881'smartindent' 'si' boolean (default off)
7882 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 Do smart autoindenting when starting a new line. Works for C-like
7884 programs, but can also be used for other languages. 'cindent' does
7885 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007886 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007887 setting 'si' has no effect. 'indentexpr' is a more advanced
7888 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 Normally 'autoindent' should also be on when using 'smartindent'.
7890 An indent is automatically inserted:
7891 - After a line ending in '{'.
7892 - After a line starting with a keyword from 'cinwords'.
7893 - Before a line starting with '}' (only with the "O" command).
7894 When typing '}' as the first character in a new line, that line is
7895 given the same indent as the matching '{'.
7896 When typing '#' as the first character in a new line, the indent for
7897 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007898 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7900 When using the ">>" command, lines starting with '#' are not shifted
7901 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007902 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007903 This option is reset when 'paste' is set and restored when 'paste' is
7904 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905
7906 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7907'smarttab' 'sta' boolean (default off)
7908 global
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007909 When enabled, the <Tab> key will indent by 'shiftwidth' if the cursor
7910 is in leading whitespace. The <BS> key has the opposite effect.
Damien Lejaybfa16362025-06-10 21:12:31 +02007911 In leading whitespace, this has the same effect as setting
7912 'softtabstop' to the value of 'shiftwidth'.
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007913 This option is reset when 'compatible' is set; it is temporarily
7914 disabled when 'paste' is enabled, and restored when 'paste' is turned
7915 off.
Damien Lejaybfa16362025-06-10 21:12:31 +02007916 NOTE: in most cases, using 'softtabstop' is a better option. Have a
7917 look at section |30.5| of the user guide for detailed
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007918 explanations on how Vim works with tabs and spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007920 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7921'smoothscroll' 'sms' boolean (default off)
7922 local to window
7923 Scrolling works with screen lines. When 'wrap' is set and the first
7924 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007925 above the window. "<<<" is displayed at the start of the first line,
7926 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007927 You may also want to add "lastline" to the 'display' option to show as
7928 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007929 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007930
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 *'softtabstop'* *'sts'*
7932'softtabstop' 'sts' number (default 0)
7933 local to buffer
Damien Lejay91af4c42025-06-12 21:56:19 +02007934 Create soft tab stops, separated by 'softtabstop' number of columns.
7935 In Insert mode, pressing the <Tab> key will move the cursor to the
7936 next soft tab stop, instead of inserting a literal tab. <BS> behaves
7937 similarly in reverse. Vim inserts a minimal mix of tab and space
7938 characters to produce the visual effect.
7939
7940 This setting does not affect the display of existing tab characters.
7941
7942 A value of 0 disables this behaviour. A negative value makes Vim use
7943 'shiftwidth'. If you plan to use 'sts' and 'shiftwidth' with
7944 different values, you might consider setting 'smarttab'.
7945
7946 'softtabstop' is temporarily set to 0 when 'paste' is on and reset
7947 when it is turned off. It is also reset when 'compatible' is set.
7948
7949 The 'L' flag in 'cpoptions' alters tab behavior when 'list' is
7950 enabled. See also |ins-expandtab| ans user manual section |30.5| for
7951 in-depth explanations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007953 If Vim is compiled with the |+vartabs| feature then the value of
7954 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7955 anything other than an empty string.
7956
Bram Moolenaar217ad922005-03-20 22:37:15 +00007957 *'spell'* *'nospell'*
7958'spell' boolean (default off)
7959 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007960 {not available when compiled without the |+syntax|
7961 feature}
7962 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007963 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007964
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007965 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007966'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007967 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007968 {not available when compiled without the |+syntax|
7969 feature}
7970 Pattern to locate the end of a sentence. The following word will be
7971 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007972 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007973 When this check is not wanted make this option empty.
7974 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007975 Be careful with special characters, see |option-backslash| about
7976 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007977 To set this option automatically depending on the language, see
7978 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007979
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007980 *'spellfile'* *'spf'*
7981'spellfile' 'spf' string (default empty)
7982 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007983 {not available when compiled without the |+syntax|
7984 feature}
7985 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007986 commands. It must end in ".{encoding}.add". You need to include the
7987 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007988 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007989 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007990 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007991 |zg| and |zw| commands can be used to access each. This allows using
7992 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007993 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007994 you: Using the first directory in 'runtimepath' that is writable. If
7995 there is no "spell" directory yet it will be created. For the file
7996 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007997 ignoring the region.
7998 The resulting ".spl" file will be used for spell checking, it does not
7999 have to appear in 'spelllang'.
8000 Normally one file is used for all regions, but you can add the region
8001 name if you want to. However, it will then only be used when
8002 'spellfile' is set to it, for entries in 'spelllang' only files
8003 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00008004 This option cannot be set from a |modeline| or in the |sandbox|, for
8005 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008006
Bram Moolenaar217ad922005-03-20 22:37:15 +00008007 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008008'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00008009 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00008010 {not available when compiled without the |+syntax|
8011 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008012 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008013 on spellchecking will be done for these languages. Example: >
8014 set spelllang=en_us,nl,medical
8015< This means US English, Dutch and medical words are recognized. Words
8016 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02008017 The word list name must consist of alphanumeric characters, a dash or
8018 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008019 recommended to separate the two letter language name from a
8020 specification. Thus "en-rare" is used for rare English words.
8021 A region name must come last and have the form "_xx", where "xx" is
8022 the two-letter, lower case region name. You can use more than one
8023 region by listing them: "en_us,en_ca" supports both US and Canadian
8024 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01008025 Britain. (Note: currently en_au and en_nz dictionaries are older than
8026 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01008027 If the name "cjk" is included East Asian characters are excluded from
8028 spell checking. This is useful when editing text that also has Asian
8029 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02008030 Note that the "medical" dictionary does not exist, it is just an
8031 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008032 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008033 As a special case the name of a .spl file can be given as-is. The
8034 first "_xx" in the name is removed and used as the region name
8035 (_xx is an underscore, two letters and followed by a non-letter).
8036 This is mainly for testing purposes. You must make sure the correct
8037 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008038 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008039 idea to set 'spelllang' after setting 'encoding' to avoid loading the
8040 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00008041 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00008042
Bram Moolenaar98692072006-02-04 00:57:42 +00008043 If the |spellfile.vim| plugin is active and you use a language name
8044 for which Vim cannot find the .spl file in 'runtimepath' the plugin
8045 will ask you if you want to download the file.
8046
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008047 After this option has been set successfully, Vim will source the files
8048 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01008049 up to the first character that is not an ASCII letter or number and
8050 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008051
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008052 *'spelloptions'* *'spo'*
8053'spelloptions' 'spo' string (default "")
8054 local to buffer
8055 {not available when compiled without the |+syntax|
8056 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008057 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008058 camel When a word is CamelCased, assume "Cased" is a
8059 separate word: every upper-case character in a word
8060 that comes after a lower case character indicates the
8061 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008062
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008063 *'spellsuggest'* *'sps'*
8064'spellsuggest' 'sps' string (default "best")
8065 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008066 {not available when compiled without the |+syntax|
8067 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008068 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008069 the |spellsuggest()| function. This is a comma-separated list of
8070 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008071
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008072 best Internal method that works best for English. Finds
8073 changes like "fast" and uses a bit of sound-a-like
8074 scoring to improve the ordering.
8075
8076 double Internal method that uses two methods and mixes the
8077 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008078 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008079 word. That only works when the language specifies
8080 sound folding. Can be slow and doesn't always give
8081 better results.
8082
8083 fast Internal method that only checks for simple changes:
8084 character inserts/deletes/swaps. Works well for
8085 simple typing mistakes.
8086
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008087 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008088 Not used for |spellsuggest()|. The number of
8089 suggestions is never more than the value of 'lines'
8090 minus two.
8091
Bram Moolenaar585ee072022-01-29 11:22:17 +00008092 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02008093 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00008094 methods. When omitted the limit is 5000. When
8095 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01008096 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00008097
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008098 file:{filename} Read file {filename}, which must have two columns,
8099 separated by a slash. The first column contains the
8100 bad word, the second column the suggested good word.
8101 Example:
8102 theribal/terrible ~
8103 Use this for common mistakes that do not appear at the
8104 top of the suggestion list with the internal methods.
8105 Lines without a slash are ignored, use this for
8106 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008107 The word in the second column must be correct,
8108 otherwise it will not be used. Add the word to an
8109 ".add" file if it is currently flagged as a spelling
8110 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008111 The file is used for all languages.
8112
8113 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01008114 trouble with spaces. Best is to call a function
8115 without arguments, see |expr-option-function|.
8116 |v:val| holds the badly spelled word. The expression
8117 must evaluate to a List of Lists, each with a
8118 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008119 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01008120 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008121 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008122 internal methods use. A lower score is better.
8123 This may invoke |spellsuggest()| if you temporarily
8124 set 'spellsuggest' to exclude the "expr:" part.
8125 Errors are silently ignored, unless you set the
8126 'verbose' option to a non-zero value.
8127
8128 Only one of "best", "double" or "fast" may be used. The others may
8129 appear several times in any order. Example: >
8130 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
8131<
8132 This option cannot be set from a |modeline| or in the |sandbox|, for
8133 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008134
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
8136'splitbelow' 'sb' boolean (default off)
8137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 When on, splitting a window will put the new window below the current
8139 one. |:split|
8140
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008141 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008142'splitkeep' 'spk' string (default "cursor")
8143 global
8144 The value of this option determines the scroll behavior when opening,
8145 closing or resizing horizontal splits.
8146
8147 Possible values are:
8148 cursor Keep the same relative cursor position.
8149 screen Keep the text on the same screen line.
8150 topline Keep the topline the same.
8151
8152 For the "screen" and "topline" values, the cursor position will be
8153 changed when necessary. In this case, the jumplist will be populated
8154 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008155 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008156
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
8158'splitright' 'spr' boolean (default off)
8159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 When on, splitting a window will put the new window right of the
8161 current one. |:vsplit|
8162
8163 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8164'startofline' 'sol' boolean (default on)
8165 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008167 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008168 (if possible). This applies to the commands:
8169 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008170 - "d", "<<", "==" and ">>" with a linewise operator
8171 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008172 - "%" with a count
8173 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8174 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 In case of buffer changing commands the cursor is placed at the column
8176 where it was the last time the buffer was edited.
8177 NOTE: This option is set when 'compatible' is set.
8178
Bram Moolenaar00654022011-02-25 14:42:19 +01008179 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008181 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 {not available when compiled without the |+statusline|
8183 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008184 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 Also see |status-line|.
8186
8187 The option consists of printf style '%' items interspersed with
8188 normal text. Each status line item is of the form:
8189 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008190 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008191 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008193 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008194 When the option starts with "%!" then it is used as an expression,
8195 evaluated and the result is used as the option value. Example: >
8196 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008197< The *g:statusline_winid* variable will be set to the |window-ID| of the
8198 window that the status line belongs to.
8199 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008200 Note that the "%!" expression is evaluated in the context of the
8201 current window and buffer, while %{} items are evaluated in the
8202 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008203
8204 When there is error while evaluating the option then it will be made
8205 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008206 When the result contains unprintable characters the result is
8207 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008208
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 Note that the only effect of 'ruler' when this option is set (and
8210 'laststatus' is 2) is controlling the output of |CTRL-G|.
8211
8212 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008213 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008215 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 minwid Minimum width of the item, padding as set by '-' & '0'.
8217 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008218 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 on the left for text items. Numeric items will be
8220 shifted down to maxwid-2 digits followed by '>'number
8221 where number is the amount of missing digits, much like
8222 an exponential notation.
8223 item A one letter code as described below.
8224
8225 Following is a description of the possible statusline items. The
8226 second character in "item" is the type:
8227 N for number
8228 S for string
8229 F for flags as described below
8230 - not applicable
8231
8232 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008233 f S Path to the file in the buffer, as typed or relative to current
8234 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 F S Full path to the file in the buffer.
8236 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008237 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008239 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008241 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008243 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008245 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008247 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8249 being used: "<keymap>"
8250 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008251 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 B N As above, in hexadecimal.
8253 o N Byte number in file of byte under cursor, first byte is 1.
8254 Mnemonic: Offset from start of file (with one added)
8255 {not available when compiled without |+byte_offset| feature}
8256 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008257 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 l N Line number.
8259 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008260 c N Column number (byte index).
8261 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008262 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 p N Percentage through file in lines as in |CTRL-G|.
8264 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008265 percentage described for 'ruler'. Always 3 in length, unless
8266 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008267 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008268 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008270 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008271 Note that there is no '%' before the closing '}'. The
8272 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008273 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008274 {% - This is almost same as { except the result of the expression is
8275 re-evaluated as a statusline format string. Thus if the
8276 return value of expr contains % items they will get expanded.
8277 The expression can contain the } character, the end of
8278 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008279 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008280 func! Stl_filename() abort
8281 return "%t"
8282 endfunc
8283< `stl=%{Stl_filename()}` results in `"%t"`
8284 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008285 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 ( - Start of item group. Can be used for setting the width and
8287 alignment of a section. Must be followed by %) somewhere.
8288 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008289 T N For 'tabline': start of tab page N label. Use %T after the last
8290 label. This information is used for mouse clicks.
8291 X N For 'tabline': start of close tab N label. Use %X after the
8292 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8293 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 < - Where to truncate line if too long. Default is at the start.
8295 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008296 = - Separation point between alignment sections. Each section will
8297 be separated by an equal number of spaces. With one %= what
8298 comes after it will be right-aligned. With two %= there is a
8299 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008301 # - Set highlight group. The name must follow and then a # again.
8302 Thus use %#HLname# for highlight group HLname. The same
8303 highlighting is used, also for the statusline of non-current
8304 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008306 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008307 The difference between User{N} and StatusLine will be applied to
8308 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 The number N must be between 1 and 9. See |hl-User1..9|
8310
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008311 When displaying a flag, Vim removes the leading comma, if any, when
8312 that flag comes right after plaintext. This will make a nice display
8313 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314
Bram Moolenaar582fd852005-03-28 20:58:01 +00008315 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 not set) and a minwid is not set for the group, the whole group will
8317 become empty. This will make a group like the following disappear
8318 completely from the statusline when none of the flags are set. >
8319 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008320< Beware that an expression is evaluated each and every time the status
8321 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008322 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008323 While evaluating %{} the current buffer and current window will be set
8324 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008325 currently being drawn. The expression will evaluate in this context.
8326 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8327 real current buffer and "g:actual_curwin" to the |window-ID| of the
8328 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008329
Bram Moolenaar30b65812012-07-12 22:01:11 +02008330 The 'statusline' option will be evaluated in the |sandbox| if set from
8331 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008332 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008333
8334 It is not allowed to change text or jump to another window while
8335 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336
8337 If the statusline is not updated when you want it (e.g., after setting
8338 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008339 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008341 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 Otherwise the result is taken as flag text and applied to the rules
8343 described above.
8344
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008345 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008347 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348
8349 Examples:
8350 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008351 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352< Similar, but add ASCII value of char under the cursor (like "ga") >
8353 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8354< Display byte count and byte value, modified flag in red. >
8355 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8356 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8357< Display a ,GZ flag if a compressed file is loaded >
8358 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8359< In the |:autocmd|'s: >
8360 :let b:gzflag = 1
8361< And: >
8362 :unlet b:gzflag
8363< And define this function: >
8364 :function VarExists(var, val)
8365 : if exists(a:var) | return a:val | else | return '' | endif
8366 :endfunction
8367<
8368 *'suffixes'* *'su'*
8369'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 Files with these suffixes get a lower priority when multiple files
8372 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008373 suffixes. Spaces after the comma are ignored. A dot is also seen as
8374 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 separator, precede it with a backslash (see |option-backslash| about
8376 including spaces and backslashes).
8377 See 'wildignore' for completely ignoring files.
8378 The use of |:set+=| and |:set-=| is preferred when adding or removing
8379 suffixes from the list. This avoids problems when a future version
8380 uses another default.
8381
8382 *'suffixesadd'* *'sua'*
8383'suffixesadd' 'sua' string (default "")
8384 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008385 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 file for the "gf", "[I", etc. commands. Example: >
8387 :set suffixesadd=.java
8388<
8389 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8390'swapfile' 'swf' boolean (default on)
8391 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008392 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 swapfile is not wanted for a specific buffer. For example, with
8394 confidential information that even root must not be able to access.
8395 Careful: All text will be in memory:
8396 - Don't use this for big files.
8397 - Recovery will be impossible!
8398 A swapfile will only be present when |'updatecount'| is non-zero and
8399 'swapfile' is set.
8400 When 'swapfile' is reset, the swap file for the current buffer is
8401 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8402 non-zero, a swap file is immediately created.
8403 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008404 If you want to open a new buffer without creating a swap file for it,
8405 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008406 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407
8408 This option is used together with 'bufhidden' and 'buftype' to
8409 specify special kinds of buffers. See |special-buffers|.
8410
8411 *'swapsync'* *'sws'*
8412'swapsync' 'sws' string (default "fsync")
8413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008415 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 When this option is empty parts of the swap file may be in memory and
8417 not written to disk. When the system crashes you may lose more work.
8418 On Unix the system does a sync now and then without Vim asking for it,
8419 so the disadvantage of setting this option off is small. On some
8420 systems the swap file will not be written at all. For a unix system
8421 setting it to "sync" will use the sync() call instead of the default
8422 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008423 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424
8425 *'switchbuf'* *'swb'*
8426'switchbuf' 'swb' string (default "")
8427 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008429 This option is checked, when
8430 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008431 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008432 - jumping to a tag using the |:stag| command.
8433 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8434 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8435 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008436 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008437 useopen If included, jump to the first open window in the
8438 current tab page that contains the specified buffer
8439 (if there is one). Otherwise: Do not examine other
8440 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008441 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008442 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008444 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008445 Otherwise: do not split, use current window (when used
8446 in the quickfix window: the previously used window or
8447 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008448 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008449 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008450 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008451 uselast If included, jump to the previously used window when
8452 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008453 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8454 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008456 *'synmaxcol'* *'smc'*
8457'synmaxcol' 'smc' number (default 3000)
8458 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008459 {not available when compiled without the |+syntax|
8460 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008461 Maximum column in which to search for syntax items. In long lines the
8462 text after this column is not highlighted and following lines may not
8463 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008464 This helps to avoid very slow redrawing for an XML file that is one
8465 long line.
8466 Set to zero to remove the limit.
8467
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 *'syntax'* *'syn'*
8469'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008470 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 {not available when compiled without the |+syntax|
8472 feature}
8473 When this option is set, the syntax with this name is loaded, unless
8474 syntax highlighting has been switched off with ":syntax off".
8475 Otherwise this option does not always reflect the current syntax (the
8476 b:current_syntax variable does).
8477 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008478 not automatically recognized. Example, in an IDL file:
8479 /* vim: set syntax=idl : */ ~
8480 When a dot appears in the value then this separates two filetype
8481 names. Example:
8482 /* vim: set syntax=c.doxygen : */ ~
8483 This will use the "c" syntax first, then the "doxygen" syntax.
8484 Note that the second one must be prepared to be loaded as an addition,
8485 otherwise it will be skipped. More than one dot may appear.
8486 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 :set syntax=OFF
8488< To switch syntax highlighting on according to the current value of the
8489 'filetype' option: >
8490 :set syntax=ON
8491< What actually happens when setting the 'syntax' option is that the
8492 Syntax autocommand event is triggered with the value as argument.
8493 This option is not copied to another buffer, independent of the 's' or
8494 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008495 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496
LemonBoy5247b0b2024-07-12 19:30:58 +02008497 *'tabclose'* *'tcl'*
8498'tabclose' 'tcl' string (default "")
8499 global
8500 This option controls the behavior when closing tab pages (e.g., using
8501 |:tabclose|). When empty Vim goes to the next (right) tab page.
8502
8503 Possible values (comma-separated list):
8504 left If included, go to the previous tab page instead of
8505 the next one.
8506 uselast If included, go to the previously used tab page if
8507 possible. This option takes precedence over the
8508 others.
8509
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008510 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008511'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008512 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008513 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008514 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008515 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008516
8517 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008518 option and only when there is no GUI tab line. When 'e' is in
8519 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008520 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008521
8522 The value is evaluated like with 'statusline'. You can use
8523 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008524 the text to be displayed. Use "%1T" for the first label, "%2T" for
8525 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008526
Bram Moolenaare12bab32019-01-08 22:02:56 +01008527 When changing something that is used in 'tabline' that does not
8528 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008529 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008530
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008531 Keep in mind that only one of the tab pages is the current one, others
8532 are invisible and you can't jump to their windows.
8533
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008534 *'tabpagemax'* *'tpm'*
8535'tabpagemax' 'tpm' number (default 10)
8536 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008537 Maximum number of tab pages to be opened by the |-p| command line
8538 argument or the ":tab all" command. |tabpage|
8539
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008540 *'tabpanel'* *'tpl'* *g:actual_curtabpage*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008541'tabpanel' 'tpl' string (default empty)
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008542 global
Christ van Willegend65cdad2025-05-30 16:05:58 +02008543 When non-empty, this option determines the content of the |tabpanel|.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008544 The option consists of printf style '%' items interspersed with
8545 normal text, similar to the 'statusline' or 'tabline'.
8546
8547 When changing something that is used in 'tabpanel' that does not
8548 trigger it to be updated, use |:redrawtabpanel|.
8549 This option cannot be set in a modeline when 'modelineexpr' is off.
8550
8551 You can use |g:actual_curtabpage| within a function assigned to
8552 tabpanel. |g:actual_curtabpage| represents current tab's label number.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008553 The option value can contain line breaks: >
8554
8555 set tabpanel=%!TabPanel()
8556 function! TabPanel() abort
8557 return printf("(%2d)\n %%f", g:actual_curtabpage)
8558 endfunction
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008559<
8560 The result is:
8561>
8562 +-----------+---------------------------------
8563 |(1) |
8564 | ~/aaa.txt|
8565 |(2) |
8566 | ~/.vimrc |
8567 | |
8568 | |
8569 | |
8570<
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008571 *'tabpanelopt'* *'tplo'*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008572'tabpanelopt' 'tplo' string (default "")
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008573 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008574 Optional settings for the |tabpanel|, It can consist of the following
8575 items. Items must be separated by a comma.
8576
Christ van Willegend65cdad2025-05-30 16:05:58 +02008577 align:{text} Specifies the position of the tabpanel.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008578 Currently supported positions are:
8579
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008580 left left-side
8581 right right-side
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008582
8583 (default "left")
8584
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008585 columns:{n} Number of columns of the tabpanel.
8586 If this value is 0 or less than 'columns', the
8587 tab panel will not be displayed.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008588 (default 20)
8589
8590 vert Use a vertical separator for tabpanel.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008591 The vertical separator character is taken from
8592 "tpl_vert" in 'fillchars'.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008593 (default off)
8594
8595 Examples: >
8596 :set tabpanelopt=columns:16,align:right
8597 :set tabpanelopt=
8598 :set tabpanelopt=vert,align:right
8599 :set tabpanelopt=columns:16
8600<
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008601 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602'tabstop' 'ts' number (default 8)
8603 local to buffer
Damien Lejaya4a3f712025-05-30 17:36:37 +02008604 Defines the column multiple used to display the Horizontal Tab
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008605 character (ASCII 9); a Horizontal Tab always advances to the next tab
8606 stop.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008607 The value must be at least 1 and at most 9999.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008608 If Vim was compiled with |+vartabs| and |'vartabstop'| is set, this
8609 option is ignored.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008610 Leave it at 8 unless you have a strong reason (see usr |30.5|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008612
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8614'tagbsearch' 'tbs' boolean (default on)
8615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008617 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 searching makes searching for a tag a LOT faster, but a linear search
8619 will find more tags if the tags file wasn't properly sorted.
8620 Vim normally assumes that your tags files are sorted, or indicate that
8621 they are not sorted. Only when this is not the case does the
8622 'tagbsearch' option need to be switched off.
8623
8624 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008625 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 certain files, or retry all files with a linear search. When
8627 'tagbsearch' is off, only a linear search is done.
8628
8629 Linear searching is done anyway, for one file, when Vim finds a line
8630 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008631 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632< [The whitespace before and after the '0' must be a single <Tab>]
8633
8634 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008635 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 instead of a normal tag name, a retry is done with a linear search.
8637 Tags in unsorted tags files, and matches with different case will only
8638 be found in the retry.
8639
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008640 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008641 linear search can be avoided when case is ignored. Use a value of '2'
8642 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8643 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008644 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8645 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8646 used for this as well. Note that case must be folded to uppercase for
8647 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008648
8649 By default, tag searches are case-sensitive. Case is ignored when
8650 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8651 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008652 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8653 'tagcase' is "smart", and the pattern contains only lowercase
8654 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655
8656 When 'tagbsearch' is off, tags searching is slower when a full match
8657 exists, but faster when no full match exists. Tags in unsorted tags
8658 files may only be found with 'tagbsearch' off.
8659 When the tags file is not sorted, or sorted in a wrong way (not on
8660 ASCII byte value), 'tagbsearch' should be off, or the line given above
8661 must be included in the tags file.
8662 This option doesn't affect commands that find all matching tags (e.g.,
8663 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008665 *'tagcase'* *'tc'*
8666'tagcase' 'tc' string (default "followic")
8667 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008668 This option specifies how case is handled when searching the tags
8669 file:
8670 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008671 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008672 ignore Ignore case
8673 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008674 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008675 NOTE: This option is set to the Vi default value when 'compatible' is
8676 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008677
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008678 *'tagfunc'* *'tfu'*
8679'tagfunc' 'tfu' string (default: empty)
8680 local to buffer
8681 {not available when compiled without the |+eval|
8682 feature}
Christian Brabandtfb081922025-04-30 19:31:58 +02008683 This option specifies a function to be used to perform tag searches
8684 (including |taglist()|).
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008685 The function gets the tag pattern and should return a List of matching
8686 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008687 function and an example. The value can be the name of a function, a
8688 |lambda| or a |Funcref|. See |option-value-function| for more
8689 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008690 This option cannot be set from a |modeline| or in the |sandbox|, for
8691 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008692
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 *'taglength'* *'tl'*
8694'taglength' 'tl' number (default 0)
8695 global
8696 If non-zero, tags are significant up to this number of characters.
8697
8698 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8699'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8700 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008701 If on and using a tags file in another directory, file names in that
8702 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 NOTE: This option is set to the Vi default value when 'compatible' is
8704 set and to the Vim default value when 'compatible' is reset.
8705
8706 *'tags'* *'tag'* *E433*
8707'tags' 'tag' string (default "./tags,tags", when compiled with
8708 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8709 global or local to buffer |global-local|
8710 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008711 include a space or comma in a file name, precede it with backslashes
8712 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 When a file name starts with "./", the '.' is replaced with the path
8714 of the current file. But only when the 'd' flag is not included in
8715 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8716 |tags-option|.
8717 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008718 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8719 find all files named "tags" below "/lib". The filename itself cannot
8720 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008721 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008722 The |tagfiles()| function can be used to get a list of the file names
8723 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8725 files are also supported. They are automatically recognized. The
8726 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8727 differences are ignored (MS-Windows). |emacs-tags|
8728 The use of |:set+=| and |:set-=| is preferred when adding or removing
8729 file names from the list. This avoids problems when a future version
8730 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731
8732 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8733'tagstack' 'tgst' boolean (default on)
8734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 When on, the |tagstack| is used normally. When off, a ":tag" or
8736 ":tselect" command with an argument will not push the tag onto the
8737 tagstack. A following ":tag" without an argument, a ":pop" command or
8738 any other command that uses the tagstack will use the unmodified
8739 tagstack, but does change the pointer to the active entry.
8740 Resetting this option is useful when using a ":tag" command in a
8741 mapping which should not change the tagstack.
8742
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008743 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008744'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008745 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008746 {only available when compiled with the |+tcl/dyn|
8747 feature}
8748 Specifies the name of the Tcl shared library. The default is
8749 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008750 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008751 This option cannot be set from a |modeline| or in the |sandbox|, for
8752 security reasons.
8753
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 *'term'* *E529* *E530* *E531*
8755'term' string (default is $TERM, if that fails:
8756 in the GUI: "builtin_gui"
8757 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008758 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 on Unix: "ansi"
8761 on VMS: "ansi"
8762 on Win 32: "win32")
8763 global
8764 Name of the terminal. Used for choosing the terminal control
8765 characters. Environment variables are expanded |:set_env|.
8766 For example: >
8767 :set term=$TERM
8768< See |termcap|.
8769
8770 *'termbidi'* *'tbidi'*
8771 *'notermbidi'* *'notbidi'*
8772'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 {only available when compiled with the |+arabic|
8775 feature}
8776 The terminal is in charge of Bi-directionality of text (as specified
8777 by Unicode). The terminal is also expected to do the required shaping
8778 that some languages (such as Arabic) require.
8779 Setting this option implies that 'rightleft' will not be set when
8780 'arabic' is set and the value of 'arabicshape' will be ignored.
8781 Note that setting 'termbidi' has the immediate effect that
8782 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8783 This option is reset when the GUI is started.
8784 For further details see |arabic.txt|.
8785
8786 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008787'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 Encoding used for the terminal. This specifies what character
8790 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008791 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008792 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008793 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008794 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8796 Any attempts to set a different value will be rejected, and an error
8797 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008798 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 because the Win32 system always passes Unicode characters.
8800 When empty, the same encoding is used as for the 'encoding' option.
8801 This is the normal value.
8802 Not all combinations for 'termencoding' and 'encoding' are valid. See
8803 |encoding-table|.
8804 The value for this option must be supported by internal conversions or
8805 iconv(). When this is not possible no conversion will be done and you
8806 will probably experience problems with non-ASCII characters.
8807 Example: You are working with the locale set to euc-jp (Japanese) and
8808 want to edit a UTF-8 file: >
8809 :let &termencoding = &encoding
8810 :set encoding=utf-8
8811< You need to do this when your system has no locale support for UTF-8.
8812
Bram Moolenaar938ae282023-02-20 20:44:55 +00008813 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008814'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8815 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008816 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008817 {not available when compiled without the
8818 |+termguicolors| feature}
8819 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008820 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008821
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008822 Requires a ISO-8613-3 compatible terminal. If setting this option
8823 does not work (produces a colorless UI) reading |xterm-true-color|
8824 might help.
8825
8826 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8827 is required. Use this check to find out: >
8828 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008829< This requires Vim to be built with the |+vtp| feature.
8830
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008831 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008832
8833 When using Vim with Windows Terminal, the background of Windows
8834 Terminal is normally filled with the Vim background color. Setting
8835 'termguicolors' and the guibg of the Normal highlight group to NONE
8836 will make the background transparent: >
8837 :hi Normal guibg=NONE
8838<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008839 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008840
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008841 *'termwinkey'* *'twk'*
8842'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008843 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008844 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008845 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008846 The key can be specified as a single character, a |key-notation| (e.g.
8847 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8848 :set twk=X
8849 :set twk=^I
8850 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008851< The string must be one key stroke but can be multiple bytes.
8852 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008853 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008854 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008855
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008856 *'termwinscroll'* *'twsl'*
8857'termwinscroll' 'twsl' number (default 10000)
8858 local to buffer
8859 {not available when compiled without the
8860 |+terminal| feature}
8861 Number of scrollback lines to keep. When going over this limit the
8862 first 10% of the scrollback lines are deleted. This is just to reduce
8863 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008864 Also used as a limit for text sent to the terminal in one write,
8865 multiplied by the number of columns times 3 (average number of bytes
8866 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008867
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008868 *'termwinsize'* *'tws'*
8869'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008870 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008871 Size used when opening the |terminal| window. Format:
8872 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008873 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008874 - When set with a "x" (e.g., "24x80") the terminal size is not
8875 adjusted to the window size. If the window is smaller only the
8876 top-left part is displayed.
8877 - When set with a "*" (e.g., "10*50") the terminal size follows the
8878 window size, but will not be smaller than the specified rows and/or
8879 columns.
8880 - When rows is zero then use the height of the window.
8881 - When columns is zero then use the width of the window.
8882 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008883 - Can be overruled in the |term_start()| options with "term_rows" and
8884 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008885
8886 Examples:
8887 "30x0" uses 30 rows and the current window width.
8888 "20*0" uses at least 20 rows and the current window width.
8889 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008890 Note that the command running in the terminal window may still change
8891 the size of the terminal. In that case the Vim window will be
8892 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008893
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008894 *'termwintype'* *'twt'*
8895'termwintype' 'twt' string (default "")
8896 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008897 {only available when compiled with the |terminal|
8898 feature on MS-Windows}
8899 Specify the virtual console (pty) used when opening the terminal
8900 window.
8901
8902 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008903 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008904 "winpty" use winpty, fail if not supported
8905 "conpty" use |ConPTY|, fail if not supported
8906
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008907 |ConPTY| support depends on the platform. Windows 10 October 2018
8908 Update is the first version that supports ConPTY, however it is still
8909 considered unstable. ConPTY might become stable in the next release
8910 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008911 supported then you cannot open a terminal window.
8912
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 *'terse'* *'noterse'*
8914'terse' boolean (default off)
8915 global
8916 When set: Add 's' flag to 'shortmess' option (this makes the message
8917 for a search that hits the start or end of the file not being
8918 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8919 shortens a lot of messages}
8920
8921 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8922'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 This option is obsolete. Use 'fileformats'.
8925 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8926 set to the default value for the current system. When 'textauto' is
8927 reset, 'fileformats' is made empty.
8928 NOTE: This option is set to the Vi default value when 'compatible' is
8929 set and to the Vim default value when 'compatible' is reset.
8930
8931 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008932'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 others: default off)
8934 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 This option is obsolete. Use 'fileformat'.
8936 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8937 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8938 "unix".
8939
8940 *'textwidth'* *'tw'*
8941'textwidth' 'tw' number (default 0)
8942 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943 Maximum width of text that is being inserted. A longer line will be
8944 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008945 this.
8946 'textwidth' is set to 0 when the 'paste' option is set and restored
8947 when 'paste' is reset.
8948 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008950 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 NOTE: This option is set to 0 when 'compatible' is set.
8952
8953 *'thesaurus'* *'tsr'*
8954'thesaurus' 'tsr' string (default "")
8955 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008957 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8958 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008959
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008960 This option is not used if 'thesaurusfunc' is set, either for the
8961 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008962
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008963 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008965 name. See |option-backslash| about using backslashes. The use of
8966 |:set+=| and |:set-=| is preferred when adding or removing directories
8967 from the list. This avoids problems when a future version uses
8968 another default. Backticks cannot be used in this option for security
8969 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008971 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008972'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008973 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008974 {not available when compiled without the |+eval|
8975 feature}
8976 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008977 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008978 The value can be the name of a function, a |lambda| or a |Funcref|.
8979 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008980
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008981 This option cannot be set from a |modeline| or in the |sandbox|, for
8982 security reasons.
8983
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8985'tildeop' 'top' boolean (default off)
8986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 When on: The tilde command "~" behaves like an operator.
8988 NOTE: This option is reset when 'compatible' is set.
8989
8990 *'timeout'* *'to'* *'notimeout'* *'noto'*
8991'timeout' 'to' boolean (default on)
8992 global
laburnumT3f7855a2023-12-05 18:37:03 +01008993
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008995'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008997 These two options together determine the behavior when part of a
8998 mapped key sequence or keyboard code has been received:
8999
9000 'timeout' 'ttimeout' action ~
9001 off off do not time out
9002 on on or off time out on :mappings and key codes
9003 off on time out on key codes
9004
9005 If both options are off, Vim will wait until either the complete
9006 mapping or key sequence has been received, or it is clear that there
9007 is no mapping or key sequence for the received characters. For
9008 example: if you have mapped "vl" and Vim has received 'v', the next
9009 character is needed to see if the 'v' is followed by an 'l'.
9010 When one of the options is on, Vim will wait for about 1 second for
9011 the next character to arrive. After that the already received
9012 characters are interpreted as single characters. The waiting time can
9013 be changed with the 'timeoutlen' option.
9014 On slow terminals or very busy systems timing out may cause
9015 malfunctioning cursor keys. If both options are off, Vim waits
9016 forever after an entered <Esc> if there are key codes that start
9017 with <Esc>. You will have to type <Esc> twice. If you do not have
9018 problems with key codes, but would like to have :mapped key
9019 sequences not timing out in 1 second, set the 'ttimeout' option and
9020 reset the 'timeout' option.
9021
9022 NOTE: 'ttimeout' is reset when 'compatible' is set.
9023
9024 *'timeoutlen'* *'tm'*
9025'timeoutlen' 'tm' number (default 1000)
9026 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009027
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02009029'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 The time in milliseconds that is waited for a key code or mapped key
9032 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
9033 when part of a command has been typed.
9034 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
9035 different timeout value for key codes is desired set 'ttimeoutlen' to
9036 a non-negative number.
9037
9038 ttimeoutlen mapping delay key code delay ~
9039 < 0 'timeoutlen' 'timeoutlen'
9040 >= 0 'timeoutlen' 'ttimeoutlen'
9041
9042 The timeout only happens when the 'timeout' and 'ttimeout' options
9043 tell so. A useful setting would be >
9044 :set timeout timeoutlen=3000 ttimeoutlen=100
9045< (time out on mapping after three seconds, time out on key codes after
9046 a tenth of a second).
9047
9048 *'title'* *'notitle'*
9049'title' boolean (default off, on when title can be restored)
9050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 When on, the title of the window will be set to the value of
9052 'titlestring' (if it is not empty), or to:
9053 filename [+=-] (path) - VIM
9054 Where:
9055 filename the name of the file being edited
9056 - indicates the file cannot be modified, 'ma' off
9057 + indicates the file was modified
9058 = indicates the file is read-only
9059 =+ indicates the file is read-only and modified
9060 (path) is the path of the file being edited
9061 - VIM the server name |v:servername| or "VIM"
9062 Only works if the terminal supports setting window titles
9063 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02009064 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
9066 *X11*
9067 When Vim was compiled with HAVE_X11 defined, the original title will
9068 be restored if possible. The output of ":version" will include "+X11"
9069 when HAVE_X11 was defined, otherwise it will be "-X11". This also
9070 works for the icon name |'icon'|.
9071 But: When Vim was started with the |-X| argument, restoring the title
9072 will not work (except in the GUI).
9073 If the title cannot be restored, it is set to the value of 'titleold'.
9074 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009075 When using an xterm from a remote machine you can use this command: >
9076
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009078 ssh -X machine_name xterm &
9079<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 then the WINDOWID environment variable should be inherited and the
9081 title of the window should change back to what it should be after
9082 exiting Vim.
9083
9084 *'titlelen'*
9085'titlelen' number (default 85)
9086 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009088 title. When the title is longer, only the end of the path name is
9089 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 Using a percentage makes this adapt to the width of the window. But
9091 it won't work perfectly, because the actual number of characters
9092 available also depends on the font used and other things in the title
9093 bar. When 'titlelen' is zero the full path is used. Otherwise,
9094 values from 1 to 30000 percent can be used.
9095 'titlelen' is also used for the 'titlestring' option.
9096
9097 *'titleold'*
9098'titleold' string (default "Thanks for flying Vim")
9099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009100 This option will be used for the window title when exiting Vim if the
9101 original title cannot be restored. Only happens if 'title' is on or
9102 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009103 This option cannot be set from a |modeline| or in the |sandbox|, for
9104 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 *'titlestring'*
9106'titlestring' string (default "")
9107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 When this option is not empty, it will be used for the title of the
9109 window. This happens only when the 'title' option is on.
9110 Only works if the terminal supports setting window titles (currently
9111 Amiga console, Win32 console, all GUI versions and terminals with a
9112 non-empty 't_ts' option).
9113 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01009114 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009115
Bram Moolenaar071d4272004-06-13 20:20:40 +00009116 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02009117 expanded according to the rules used for 'statusline'. If it contains
9118 an invalid '%' format, the value is used as-is and no error or warning
9119 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009120 This option cannot be set in a modeline when 'modelineexpr' is off.
9121
Bram Moolenaar071d4272004-06-13 20:20:40 +00009122 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009123 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
9125< The value of 'titlelen' is used to align items in the middle or right
9126 of the available space.
9127 Some people prefer to have the file name first: >
9128 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
9129< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009130 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 separating space only when needed.
9132 NOTE: Use of special characters in 'titlestring' may cause the display
9133 to be garbled (e.g., when it contains a CR or NL character).
9134 {not available when compiled without the |+statusline| feature}
9135
9136 *'toolbar'* *'tb'*
9137'toolbar' 'tb' string (default "icons,tooltips")
9138 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009139 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009140 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 possible values are:
9142 icons Toolbar buttons are shown with icons.
9143 text Toolbar buttons shown with text.
9144 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009145 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 tooltips Tooltips are active for toolbar buttons.
9147 Tooltips refer to the popup help text which appears after the mouse
9148 cursor is placed over a toolbar button for a brief moment.
9149
9150 If you want the toolbar to be shown with icons as well as text, do the
9151 following: >
9152 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009153< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 will show icons if both are requested.
9155
9156 If none of the strings specified in 'toolbar' are valid or if
9157 'toolbar' is empty, this option is ignored. If you want to disable
9158 the toolbar, you need to set the 'guioptions' option. For example: >
9159 :set guioptions-=T
9160< Also see |gui-toolbar|.
9161
9162 *'toolbariconsize'* *'tbis'*
9163'toolbariconsize' 'tbis' string (default "small")
9164 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01009165 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009166 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009167 tiny Use tiny icons.
9168 small Use small icons (default).
9169 medium Use medium-sized icons.
9170 large Use large icons.
9171 huge Use even larger icons.
9172 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009174 the current theme. Common dimensions are giant=48x48, huge=32x32,
9175 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176
9177 If 'toolbariconsize' is empty, the global default size as determined
9178 by user preferences or the current theme is used.
9179
9180 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
9181'ttybuiltin' 'tbi' boolean (default on)
9182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 When on, the builtin termcaps are searched before the external ones.
9184 When off the builtin termcaps are searched after the external ones.
9185 When this option is changed, you should set the 'term' option next for
9186 the change to take effect, for example: >
9187 :set notbi term=$TERM
9188< See also |termcap|.
9189 Rationale: The default for this option is "on", because the builtin
9190 termcap entries are generally better (many systems contain faulty
9191 xterm entries...).
9192
9193 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009194'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 Indicates a fast terminal connection. More characters will be sent to
9197 the screen for redrawing, instead of using insert/delete line
9198 commands. Improves smoothness of redrawing when there are multiple
9199 windows and the terminal does not support a scrolling region.
9200 Also enables the extra writing of characters at the end of each screen
9201 line for lines that wrap. This helps when using copy/paste with the
9202 mouse in an xterm and other terminals.
9203
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009204 The default used to be set only for some terminal names, but these
9205 days nearly all terminals are fast, therefore the default is now "on".
9206 If you have a slow connection you may want to set this option off,
9207 e.g. depending on the host name: >
9208 if hostname() =~ 'faraway'
9209 set nottyfast
9210 endif
9211<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 *'ttymouse'* *'ttym'*
9213'ttymouse' 'ttym' string (default depends on 'term')
9214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 {only in Unix and VMS, doesn't work in the GUI; not
9216 available when compiled without |+mouse|}
9217 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009218 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 *xterm-mouse*
9220 xterm xterm-like mouse handling. The mouse generates
9221 "<Esc>[Mscr", where "scr" is three bytes:
9222 "s" = button state
9223 "c" = column plus 33
9224 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009225 This only works up to 223 columns! See "dec",
9226 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009227 xterm2 Works like "xterm", but with the xterm reporting the
9228 mouse position while the mouse is dragged. This works
9229 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009230 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009231 work. See below for how Vim detects this
9232 automatically.
9233 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009234 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009235 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009236 for the row and column. No other mouse events are
9237 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 *dec-mouse*
9239 dec DEC terminal mouse handling. The mouse generates a
9240 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009241 This is also available for an Xterm, if it was
9242 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 *jsbterm-mouse*
9244 jsbterm JSB term mouse handling.
9245 *pterm-mouse*
9246 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009247 *urxvt-mouse*
9248 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009249 The mouse works only if the terminal supports this
9250 encoding style, but it does not have 223 columns limit
9251 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009252 *sgr-mouse*
9253 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009254 mouse reporting. The mouse works even in columns
9255 beyond 223. This option is backward compatible with
9256 "xterm2" because it can also decode "xterm2" style
9257 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258
9259 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009260 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9261 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9263 recognized, if enabled at compile time. DEC terminal mouse codes
9264 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009265 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9266 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009267 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009268 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9269 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9270 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009271 If the terminfo/termcap entry "XM" exists and the first number is
9272 "1006" then 'ttymouse' will be set to "sgr". This works for many
9273 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009274 Additionally, if vim is compiled with the |+termresponse| feature and
9275 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009276 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009278 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9279 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9280 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009281 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9282 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283 :set t_RV=
9284<
9285 *'ttyscroll'* *'tsl'*
9286'ttyscroll' 'tsl' number (default 999)
9287 global
9288 Maximum number of lines to scroll the screen. If there are more lines
9289 to scroll the window is redrawn. For terminals where scrolling is
9290 very slow and redrawing is not slow this can be set to a small number,
9291 e.g., 3, to speed up displaying.
9292
9293 *'ttytype'* *'tty'*
9294'ttytype' 'tty' string (default from $TERM)
9295 global
9296 Alias for 'term', see above.
9297
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009298 *'undodir'* *'udir'*
9299'undodir' 'udir' string (default ".")
9300 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009301 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009302 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009303 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009304 "." means using the directory of the file. The undo file name for
9305 "file.txt" is ".file.txt.un~".
9306 For other directories the file name is the full path of the edited
9307 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009308 When writing: The first directory that exists is used. "." always
9309 works, no directories after "." will be used for writing.
9310 When reading all entries are tried to find an undo file. The first
9311 undo file that exists is used. When it cannot be read an error is
9312 given, no further entry is used.
9313 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009314 This option cannot be set from a |modeline| or in the |sandbox|, for
9315 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009316
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009317 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009318'undofile' 'udf' boolean (default off)
9319 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009320 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009321 When on, Vim automatically saves undo history to an undo file when
9322 writing a buffer to a file, and restores undo history from the same
9323 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009324 The directory where the undo file is stored is specified by 'undodir'.
9325 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009326 The undo file is not read when 'undoreload' causes the buffer from
9327 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009328 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009329 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009330
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009332'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009333 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009335 is kept in memory, higher numbers will cause more memory to be used.
9336 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009337 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9338 itself: >
9339 set ul=0
9340< But you can also get Vi compatibility by including the 'u' flag in
9341 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009342 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009343 Set to -1 for no undo at all. You might want to do this only for the
9344 current buffer: >
9345 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009347
9348 The local value is set to -123456 when the global value is to be used.
9349
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009350 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009351
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009352 *'undoreload'* *'ur'*
9353'undoreload' 'ur' number (default 10000)
9354 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009355 Save the whole buffer for undo when reloading it. This applies to the
9356 ":e!" command and reloading for when the buffer changed outside of
9357 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009358 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009359 of lines is smaller than the value of this option.
9360 Set this option to zero to disable undo for a reload.
9361
9362 When saving undo for a reload, any undo file is not read.
9363
9364 Note that this causes the whole buffer to be stored in memory. Set
9365 this option to a lower value if you run out of memory.
9366
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 *'updatecount'* *'uc'*
9368'updatecount' 'uc' number (default: 200)
9369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009370 After typing this many characters the swap file will be written to
9371 disk. When zero, no swap file will be created at all (see chapter on
9372 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9373 Vim with the "-n" option, see |startup|. When editing in readonly
9374 mode this option will be initialized to 10000.
9375 The swapfile can be disabled per buffer with |'swapfile'|.
9376 When 'updatecount' is set from zero to non-zero, swap files are
9377 created for all buffers that have 'swapfile' set. When 'updatecount'
9378 is set to zero, existing swap files are not deleted.
9379 Also see |'swapsync'|.
9380 This option has no meaning in buffers where |'buftype'| is "nofile"
9381 or "nowrite".
9382
9383 *'updatetime'* *'ut'*
9384'updatetime' 'ut' number (default 4000)
9385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386 If this many milliseconds nothing is typed the swap file will be
9387 written to disk (see |crash-recovery|). Also used for the
9388 |CursorHold| autocommand event.
9389
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009390 *'varsofttabstop'* *'vsts'*
9391'varsofttabstop' 'vsts' string (default "")
9392 local to buffer
9393 {only available when compiled with the |+vartabs|
9394 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009395 Defines variable-width soft tab stops. The value is a comma-separated
9396 list of widths in columns. Each width defines the number of columns
9397 before the next soft tab stop. The last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009398
9399 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009400 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009401 to use the following: >
9402 :set varsofttabstop=8,32,8
Damien Lejay91af4c42025-06-12 21:56:19 +02009403< This sets soft tab stops at column 8, then at column 40 (8 + 32), and
9404 every 8 columns thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009405
Damien Lejay91af4c42025-06-12 21:56:19 +02009406 Note: this setting overrides 'softtabstop'.
9407 See section |30.5| of the user manual for detailed explanations on how
9408 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009409
9410 *'vartabstop'* *'vts'*
9411'vartabstop' 'vts' string (default "")
9412 local to buffer
9413 {only available when compiled with the |+vartabs|
9414 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009415 Defines variable-width tab stops. The value is a comma-separated list
9416 of widths in columns. Each width defines the number of columns
9417 before the next tab stop; the last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009418
Damien Lejay91af4c42025-06-12 21:56:19 +02009419 For example: >
9420 :set vartabstop=4,8
9421< This places the first tab stop 4 columns from the start of the line
9422 and each subsequent tab stop 8 columns apart.
9423
9424 Note: this setting overrides 'tabstop'.
9425 On UNIX, it is recommended to keep the default tabstop value of 8.
9426 Consider setting 'varsofttabstop' instead.
9427 See section |30.5| of the user manual for detailed explanations on how
9428 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009429
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430 *'verbose'* *'vbs'*
9431'verbose' 'vbs' number (default 0)
9432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 When bigger than zero, Vim will give messages about what it is doing.
9434 Currently, these messages are given:
9435 >= 1 When the viminfo file is read or written.
9436 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009437 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009438 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 >= 8 Files for which a group of autocommands is executed.
9440 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009441 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009442 >= 12 Every executed function.
9443 >= 13 When an exception is thrown, caught, finished, or discarded.
9444 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009445 >= 15 Every executed Ex command from a script (truncated at 200
9446 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009447 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009448
9449 This option can also be set with the "-V" argument. See |-V|.
9450 This option is also set by the |:verbose| command.
9451
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009452 When the 'verbosefile' option is set then the verbose messages are not
9453 displayed.
9454
9455 *'verbosefile'* *'vfile'*
9456'verbosefile' 'vfile' string (default empty)
9457 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009458 When not empty all messages are written in a file with this name.
9459 When the file exists messages are appended.
9460 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009461 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009462 Setting 'verbosefile' to a new value is like making it empty first.
9463 The difference with |:redir| is that verbose messages are not
9464 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009465 This option cannot be set from a |modeline| or in the |sandbox|, for
9466 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009467
Bram Moolenaar071d4272004-06-13 20:20:40 +00009468 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009469'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009470 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009471 for Unix: "$HOME/.vim/view" or
9472 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009473 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009475 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009476 feature}
9477 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009478 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009479 This option cannot be set from a |modeline| or in the |sandbox|, for
9480 security reasons.
9481
9482 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009483'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009484 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009485 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009486 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009487 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009488 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009489 word save and restore ~
9490 cursor cursor position in file and in window
9491 folds manually created folds, opened/closed folds and local
9492 fold options
9493 options options and mappings local to a window or buffer (not
9494 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009495 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009496 slash backslashes in file names replaced with forward
9497 slashes
9498 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009499 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009500 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009501
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009502 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009503 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009504 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505
9506 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009507'viminfo' 'vi' string (Vi default: "", Vim default for
9508 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009509 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9510 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009512 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009513 feature}
9514 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009515 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9516 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009517 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009518 consisting of a single character identifying the particular parameter,
9519 followed by a number or string which specifies the value of that
9520 parameter. If a particular character is left out, then the default
9521 value is used for that parameter. The following is a list of the
9522 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009524 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009525 ! When included, save and restore global variables that start
9526 with an uppercase letter, and don't contain a lowercase
9527 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009528 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009529 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009530 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009531 " Maximum number of lines saved for each register. Old name of
9532 the '<' item, with the disadvantage that you need to put a
9533 backslash before the ", otherwise it will be recognized as the
9534 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009535 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536 % When included, save and restore the buffer list. If Vim is
9537 started with a file name argument, the buffer list is not
9538 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009539 buffer list is restored from the viminfo file. Quickfix
9540 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9541 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009542 When followed by a number, the number specifies the maximum
9543 number of buffers that are stored. Without a number all
9544 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009545 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009546 ' Maximum number of previously edited files for which the marks
9547 are remembered. This parameter must always be included when
9548 'viminfo' is non-empty.
9549 Including this item also means that the |jumplist| and the
9550 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009551 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009552 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009553 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554 patterns are also saved. When not included, the value of
9555 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009556 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009558 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009559 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009560 < Maximum number of lines saved for each register. If zero then
9561 registers are not saved. When not included, all lines are
9562 saved. '"' is the old name for this item.
9563 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009564 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009566 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009567 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009568 c When included, convert the text in the viminfo file from the
9569 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009570 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009571 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009572 f Whether file marks need to be stored. If zero, file marks ('0
9573 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009574 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009576 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009577 h Disable the effect of 'hlsearch' when loading the viminfo
9578 file. When not included, it depends on whether ":nohlsearch"
9579 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009580 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009581 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009582 the 'n'. Must be at the end of the option! If the
9583 'viminfofile' option is set, that file name overrides the one
9584 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009585 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009586 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009587 r Removable media. The argument is a string (up to the next
9588 ','). This parameter can be given several times. Each
9589 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009590 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9592 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9593 ignored. Maximum length of each 'r' argument is 50
9594 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009595 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009596 s Maximum size of an item in Kbyte. If zero then registers are
9597 not saved. Currently only applies to registers. The default
9598 "s10" will exclude registers with more than 10 Kbyte of text.
9599 Also see the '<' item above: line count limit.
9600
9601 Example: >
9602 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9603<
9604 '50 Marks will be remembered for the last 50 files you
9605 edited.
9606 <1000 Contents of registers (up to 1000 lines each) will be
9607 remembered.
9608 s100 Registers with more than 100 Kbyte text are skipped.
9609 :0 Command-line history will not be saved.
9610 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9611 no / Since '/' is not specified, the default will be used,
9612 that is, save all of the search history, and also the
9613 previous search and substitute patterns.
9614 no % The buffer list will not be saved nor read back.
9615 no h 'hlsearch' highlighting will be restored.
9616
9617 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9618 load the contents of the file, this is not done automatically.
9619
9620 This option cannot be set from a |modeline| or in the |sandbox|, for
9621 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009622 NOTE: This option is set to the Vim default value when 'compatible'
9623 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009624
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009625 *'viminfofile'* *'vif'*
9626'viminfofile' 'vif' string (default: "")
9627 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009628 {not available when compiled without the |+viminfo|
9629 feature}
9630 When non-empty, overrides the file name used for viminfo.
9631 When equal to "NONE" no viminfo file will be read or written.
9632 This option can be set with the |-i| command line flag. The |--clean|
9633 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009634 This option cannot be set from a |modeline| or in the |sandbox|, for
9635 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009636
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637 *'virtualedit'* *'ve'*
9638'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009639 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009640 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009641 block Allow virtual editing in Visual block mode.
9642 insert Allow virtual editing in Insert mode.
9643 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009644 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009645 none When used as the local value, do not allow virtual
9646 editing even when the global value is set. When used
9647 as the global value, "none" is the same as "".
9648 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009649
Bram Moolenaar071d4272004-06-13 20:20:40 +00009650 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009651 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009652 of the line. Useful for selecting a rectangle in Visual mode and
9653 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009654 "onemore" is not the same, it will only allow moving the cursor just
9655 after the last character of the line. This makes some commands more
9656 consistent. Previously the cursor was always past the end of the line
9657 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009658 break some plugins or Vim scripts. For example because |l| can move
9659 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009660 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009661 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009662 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009663 It doesn't make sense to combine "all" with "onemore", but you will
9664 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009665 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009666 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009667
9668 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9669'visualbell' 'vb' boolean (default off)
9670 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009671 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009672 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009673 use: >
9674 :set vb t_vb=
9675< If you want a short flash, you can use this on many terminals: >
9676 :set vb t_vb=[?5h$<100>[?5l
9677< Here $<100> specifies the time, you can use a smaller or bigger value
9678 to get a shorter or longer flash.
9679
9680 Note: Vim will limit the bell to once per half a second. This avoids
9681 having to wait for the flashing to finish when there are lots of
9682 bells, e.g. on key repeat. This also happens without 'visualbell'
9683 set.
9684
Bram Moolenaar071d4272004-06-13 20:20:40 +00009685 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9686 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9687 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009688
9689 Note: When the GUI starts, 't_vb' is reset to its default value. You
9690 might want to set it again in your |gvimrc|.
9691
Bram Moolenaar071d4272004-06-13 20:20:40 +00009692 Does not work on the Amiga, you always get a screen flash.
9693 Also see 'errorbells'.
9694
9695 *'warn'* *'nowarn'*
9696'warn' boolean (default on)
9697 global
9698 Give a warning message when a shell command is used while the buffer
9699 has been changed.
9700
9701 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9702'weirdinvert' 'wiv' boolean (default off)
9703 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009704 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009705 It is provided for backwards compatibility with version 4.x.
9706 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9707 vice versa. Has no effect when the GUI is running.
9708
9709 *'whichwrap'* *'ww'*
9710'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009712 Allow specified keys that move the cursor left/right to move to the
9713 previous/next line when the cursor is on the first/last character in
9714 the line. Concatenate characters to allow this for these keys:
9715 char key mode ~
9716 b <BS> Normal and Visual
9717 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009718 h "h" Normal and Visual (not recommended)
9719 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009720 < <Left> Normal and Visual
9721 > <Right> Normal and Visual
9722 ~ "~" Normal
9723 [ <Left> Insert and Replace
9724 ] <Right> Insert and Replace
9725 For example: >
9726 :set ww=<,>,[,]
9727< allows wrap only when cursor keys are used.
9728 When the movement keys are used in combination with a delete or change
9729 operator, the <EOL> also counts for a character. This makes "3h"
9730 different from "3dh" when the cursor crosses the end of a line. This
9731 is also true for "x" and "X", because they do the same as "dl" and
9732 "dh". If you use this, you may also want to use the mapping
9733 ":map <BS> X" to make backspace delete the character in front of the
9734 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009735 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009736 line (not an empty line) then it will not move to the next line. This
9737 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009738 NOTE: This option is set to the Vi default value when 'compatible' is
9739 set and to the Vim default value when 'compatible' is reset.
9740
9741 *'wildchar'* *'wc'*
9742'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009744 Character you have to type to start wildcard expansion in the
9745 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009746 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009747 The character is not recognized when used inside a macro. See
9748 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009749 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009750 <Esc> can be used, but hitting it twice in a row will still exit
9751 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009752 Although 'wc' is a number option, it can be specified as a number, a
9753 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9754 preceded with a caret (e.g. `^F` is CTRL-F): >
9755 :set wc=27
9756 :set wc=X
9757 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009758 :set wc=<Tab>
Girish Palya6b49fba2025-06-28 19:47:34 +02009759< 'wildchar' also enables completion in search pattern contexts such as
9760 |/|, |?|, |:s|, |:g|, |:v|, and |:vim|. To insert a literal <Tab>
9761 instead of triggering completion, type <C-V><Tab> or "\t".
Girish Palya93c2d5b2025-07-08 21:29:02 +02009762 See also |'wildoptions'|.
Girish Palya6b49fba2025-06-28 19:47:34 +02009763 NOTE: This option is set to the Vi default value when 'compatible' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009764 set and to the Vim default value when 'compatible' is reset.
9765
9766 *'wildcharm'* *'wcm'*
9767'wildcharm' 'wcm' number (default: none (0))
9768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009769 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009770 recognized when used inside a macro. You can find "spare" command-line
9771 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009772 you'll never actually type 'wildcharm', just use it in mappings that
9773 automatically invoke completion mode, e.g.: >
9774 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009775 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009776< Then after typing :ss you can use CTRL-P & CTRL-N.
9777
9778 *'wildignore'* *'wig'*
9779'wildignore' 'wig' string (default "")
9780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009781 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009782 patterns is ignored when expanding |wildcards|, completing file or
9783 directory names, and influences the result of |expand()|, |glob()| and
9784 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009785 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9786 Also see 'suffixes'.
9787 Example: >
9788 :set wildignore=*.o,*.obj
9789< The use of |:set+=| and |:set-=| is preferred when adding or removing
9790 a pattern from the list. This avoids problems when a future version
9791 uses another default.
9792
h_east596a9f22023-11-21 21:24:23 +09009793 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009794'wildignorecase' 'wic' boolean (default off)
9795 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009796 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009797 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009798 Does not apply when the shell is used to expand wildcards, which
9799 happens when there are special characters.
9800
Bram Moolenaar071d4272004-06-13 20:20:40 +00009801 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009802'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009804 When 'wildmenu' is on, command-line completion operates in an enhanced
9805 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009806 the possible matches are shown.
9807 When 'wildoptions' contains "pum", then the completion matches are
9808 shown in a popup menu. Otherwise they are displayed just above the
9809 command line, with the first match highlighted (overwriting the status
9810 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009811 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009812 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9813 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9814 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009815 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009816 If there are more matches than can fit in the line, a ">" is shown on
9817 the right and/or a "<" is shown on the left. The status line scrolls
9818 as needed.
9819 The "wildmenu" mode is abandoned when a key is hit that is not used
9820 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009821 While the "wildmenu" is active, the following keys have special
9822 meanings:
9823 CTRL-P - go to the previous entry
9824 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009825 <CR> - in menu completion, when the cursor is just after a
9826 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009827 CTRL-E - end completion, go back to what was there before
9828 selecting a match.
9829 CTRL-Y - accept the currently selected match and stop
9830 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009831
9832 When not using the popup menu for command line completion, the
9833 following keys have special meanings:
9834 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009835 <Up> - in filename/menu name completion: move up into
9836 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009837 <Down> - in filename/menu name completion: move into a
9838 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009839
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009840 When using the popup menu for command line completion, the following
9841 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009842 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009843 <PageUp> - select a match several entries back
9844 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009845 <Left> - in filename/menu name completion: move up into
9846 parent directory or parent menu.
9847 <Right> - in filename/menu name completion: move into a
9848 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009849
Bram Moolenaar071d4272004-06-13 20:20:40 +00009850 This makes the menus accessible from the console |console-menus|.
9851
9852 If you prefer the <Left> and <Right> keys to move the cursor instead
9853 of selecting a different match, use this: >
9854 :cnoremap <Left> <Space><BS><Left>
9855 :cnoremap <Right> <Space><BS><Right>
9856<
9857 The "WildMenu" highlighting is used for displaying the current match
9858 |hl-WildMenu|.
9859
9860 *'wildmode'* *'wim'*
9861'wildmode' 'wim' string (Vim default: "full")
9862 global
Girish Palyaeded3362025-04-12 18:03:32 +02009863 Completion mode used for the character specified with 'wildchar'.
9864 This option is a comma-separated list of up to four parts,
9865 corresponding to the first, second, third, and fourth presses of
9866 'wildchar'. Each part is a colon-separated list of completion
9867 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009868
Girish Palyaeded3362025-04-12 18:03:32 +02009869 The possible behavior values are:
9870 "" Only complete (insert) the first match. No further
9871 matches are cycled or listed.
9872 "full" Complete the next full match. Cycles through all
9873 matches, returning to the original input after the
9874 last match. If 'wildmenu' is enabled, it will be
9875 shown.
9876 "longest" Complete to the longest common substring. If this
9877 doesn't extend the input, the next 'wildmode' part is
9878 used.
9879 "list" If multiple matches are found, list all of them.
9880 "lastused" When completing buffer names, sort them by most
9881 recently used (excluding the current buffer). Only
9882 applies to buffer name completion.
9883 "noselect" If 'wildmenu' is enabled, show the menu but do not
9884 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009885 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009886 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009887
Girish Palyaeded3362025-04-12 18:03:32 +02009888 Some useful combinations of colon-separated values:
9889 "longest:full" Start with the longest common string and show
9890 'wildmenu' (if enabled). Does not cycle
9891 through full matches.
9892 "list:full" List all matches and complete first match.
9893 "list:longest" List all matches and complete till the longest
9894 common prefix.
9895 "list:lastused" List all matches. When completing buffers,
9896 sort them by most recently used (excluding the
9897 current buffer).
9898 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9899 if it is active. When completing buffers,
9900 sort them by most recently used (excluding the
9901 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009902
9903 Examples: >
9904 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009905< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009906 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009907< First press: longest common substring
9908 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009909 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009910< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009911 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009912< First press: list matches only
9913 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009914 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009915< First press: longest common substring
9916 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009917 :set wildmode=noselect:full
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02009918< First press: show 'wildmenu' without completing or selecting
9919 Second press: cycle full matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009920 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009921< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009922 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009923
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009924 *'wildoptions'* *'wop'*
9925'wildoptions' 'wop' string (default "")
9926 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009927 A list of words that change how |cmdline-completion| is done.
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009928
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009929 The following values are supported:
Girish Palya93c2d5b2025-07-08 21:29:02 +02009930 exacttext When this flag is present, search pattern completion
9931 (e.g., in |/|, |?|, |:s|, |:g|, |:v|, and |:vim|)
9932 shows exact buffer text as menu items, without
9933 preserving regex artifacts like position
9934 anchors (e.g., |/\<|). This provides more intuitive
9935 menu items that match the actual buffer text.
9936 However, searches may be less accurate since the
9937 pattern is not preserved exactly.
9938 By default, Vim preserves the typed pattern (with
9939 anchors) and appends the matched word. This preserves
9940 search correctness, especially when using regular
9941 expressions or with 'smartcase' enabled. However, the
9942 case of the appended matched word may not exactly
9943 match the case of the word in the buffer.
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009944 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009945 this value is specified, wildcard expansion will not
9946 be used for completion. The matches will be sorted by
9947 the "best match" rather than alphabetically sorted.
9948 This will find more matches than the wildcard
9949 expansion. Currently fuzzy matching based completion
9950 is not supported for file and directory names and
9951 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009952 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009953 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009954 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009955 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009956 is displayed per line. Often used tag kinds are:
9957 d #define
9958 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009959
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009960 This option does not apply to |ins-completion|. See 'completeopt' for
9961 that.
9962
Bram Moolenaar071d4272004-06-13 20:20:40 +00009963 *'winaltkeys'* *'wak'*
9964'winaltkeys' 'wak' string (default "menu")
9965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009966 {only used in Win32, Motif, GTK and Photon GUI}
9967 Some GUI versions allow the access to menu entries by using the ALT
9968 key in combination with a character that appears underlined in the
9969 menu. This conflicts with the use of the ALT key for mappings and
9970 entering special characters. This option tells what to do:
9971 no Don't use ALT keys for menus. ALT key combinations can be
9972 mapped, but there is no automatic handling. This can then be
9973 done with the |:simalt| command.
9974 yes ALT key handling is done by the windowing system. ALT key
9975 combinations cannot be mapped.
9976 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009977 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009978 keys can be mapped.
9979 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9980 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009981 This option is not used for <F10>; on Win32 and with GTK <F10> will
9982 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009983
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009984 *'wincolor'* *'wcr'*
9985'wincolor' 'wcr' string (default empty)
9986 local to window
9987 Highlight group name to use for this window instead of the Normal
9988 color |hl-Normal|.
9989
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009990 *'window'* *'wi'*
9991'window' 'wi' number (default screen height - 1)
9992 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009993 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9994 window and the value is smaller than 'lines' minus one. The screen
9995 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009996 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9997 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009998 When resizing the Vim window, and the value is smaller than 1 or more
9999 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +020010000 Note: Do not confuse this with the height of the Vim window, use
10001 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +000010002
Doug Kearns002548b2025-06-05 21:18:09 +020010003 *'winfixbuf'* *'wfb'*
Colin Kennedy21570352024-03-03 16:16:47 +010010004'winfixbuf' 'wfb' boolean (default off)
10005 local to window
zeertzjq0049a492024-03-11 23:13:16 +080010006 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +010010007 For example, attempting to change the buffer with |:edit| will fail.
10008 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +080010009 also skip any window with 'winfixbuf' enabled. However if an Ex
10010 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +010010011
laburnumT3f7855a2023-12-05 18:37:03 +010010012 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
10013'winfixheight' 'wfh' boolean (default off)
10014 local to window |local-noglobal|
10015 Keep the window height when windows are opened or closed and
10016 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
10017 |preview-window| and |quickfix-window|.
10018 The height may be changed anyway when running out of room.
10019
10020 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
10021'winfixwidth' 'wfw' boolean (default off)
10022 local to window |local-noglobal|
10023 Keep the window width when windows are opened or closed and
10024 'equalalways' is set. Also for |CTRL-W_=|.
10025 The width may be changed anyway when running out of room.
10026
Bram Moolenaar071d4272004-06-13 20:20:40 +000010027 *'winheight'* *'wh'* *E591*
10028'winheight' 'wh' number (default 1)
10029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010030 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010031 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +000010032 focus goes to a window that is smaller, its size is increased, at the
10033 cost of the height of other windows.
10034 Set 'winheight' to a small number for normal editing.
10035 Set it to 999 to make the current window fill most of the screen.
10036 Other windows will be only 'winminheight' high. This has the drawback
10037 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
10038 to create only two windows, set the option after startup is done,
10039 using the |VimEnter| event: >
10040 au VimEnter * set winheight=999
10041< Minimum value is 1.
10042 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010043 height of the current window.
10044 'winheight' applies to the current window. Use 'winminheight' to set
10045 the minimal height for other windows.
10046
Bram Moolenaar071d4272004-06-13 20:20:40 +000010047 *'winminheight'* *'wmh'*
10048'winminheight' 'wmh' number (default 1)
10049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010050 The minimal height of a window, when it's not the current window.
10051 This is a hard minimum, windows will never become smaller.
10052 When set to zero, windows may be "squashed" to zero lines (i.e. just a
10053 status bar) if necessary. They will return to at least one line when
10054 they become active (since the cursor has to have somewhere to go.)
10055 Use 'winheight' to set the minimal height of the current window.
10056 This option is only checked when making a window smaller. Don't use a
10057 large number, it will cause errors when opening more than a few
10058 windows. A value of 0 to 3 is reasonable.
10059
10060 *'winminwidth'* *'wmw'*
10061'winminwidth' 'wmw' number (default 1)
10062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010063 The minimal width of a window, when it's not the current window.
10064 This is a hard minimum, windows will never become smaller.
10065 When set to zero, windows may be "squashed" to zero columns (i.e. just
10066 a vertical separator) if necessary. They will return to at least one
10067 line when they become active (since the cursor has to have somewhere
10068 to go.)
10069 Use 'winwidth' to set the minimal width of the current window.
10070 This option is only checked when making a window smaller. Don't use a
10071 large number, it will cause errors when opening more than a few
10072 windows. A value of 0 to 12 is reasonable.
10073
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010074 *'winptydll'*
10075'winptydll' string (default "winpty32.dll" or "winpty64.dll")
10076 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010077 {only available when compiled with the |terminal|
10078 feature on MS-Windows}
10079 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +020010080 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +020010081 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010082 a fallback.
10083 Environment variables are expanded |:set_env|.
10084 This option cannot be set from a |modeline| or in the |sandbox|, for
10085 security reasons.
10086
Bram Moolenaar071d4272004-06-13 20:20:40 +000010087 *'winwidth'* *'wiw'* *E592*
10088'winwidth' 'wiw' number (default 20)
10089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010090 Minimal number of columns for the current window. This is not a hard
10091 minimum, Vim will use fewer columns if there is not enough room. If
10092 the current window is smaller, its size is increased, at the cost of
10093 the width of other windows. Set it to 999 to make the current window
10094 always fill the screen. Set it to a small number for normal editing.
10095 The width is not adjusted after one of the commands to change the
10096 width of the current window.
10097 'winwidth' applies to the current window. Use 'winminwidth' to set
10098 the minimal width for other windows.
10099
Foxe Chenb90c2392025-06-27 21:10:35 +020010100 *'wlseat'* *'wse'*
10101'wlseat' 'wse' string (default "")
10102 global
10103 {only when the |+wayland| feature is included}
10104 Specifies the Wayland seat to use for Wayland functionality,
Hirohito Higashi73b96502025-06-28 18:18:21 +020010105 specifically the clipboard. If the seat does not exist, then the
Foxe Chenb90c2392025-06-27 21:10:35 +020010106 option will still be set to the new value, with the Wayland clipboard
Hirohito Higashi73b96502025-06-28 18:18:21 +020010107 being unavailable as a result. If an empty value is passed then Vim
Foxe Chen7a4cf4b2025-06-29 18:00:46 +020010108 will attempt to use the first seat found available. Updating this
Foxe Chenb90c2392025-06-27 21:10:35 +020010109 option will also update |v:clipmethod|.
10110
Hirohito Higashi73b96502025-06-28 18:18:21 +020010111 *'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
Foxe Chenb90c2392025-06-27 21:10:35 +020010112'wlsteal' 'wst' boolean (default off)
10113 global
10114 {only when the |+wayland_clipboard| feature is included}
10115 When enabled, then allow Vim to steal focus by creating a temporary
Hirohito Higashi73b96502025-06-28 18:18:21 +020010116 surface, in order to access the clipboard. For more information see
Foxe Chenb90c2392025-06-27 21:10:35 +020010117 |wayland-focus-steal|.
10118
10119 *'wltimeoutlen'* *'wtm'*
10120'wltimeoutlen' 'wtm' number (default 500)
10121 global
10122 {only when the |+wayland| feature is included}
10123 The timeout in milliseconds before Vim gives up on waiting for the
10124 Wayland compositor. While Vim waits on the compositor, it is
10125 unresponsive to input and does not update the screen. Therefore
10126 setting this to a lower value may make Vim feel more responsive in
10127 some cases. On the other hand, it may also mean you receive errors
10128 when the compositor takes more time to respond than usual.
10129
10130 Additionally, this option is also used as the maximum timeout when
10131 waiting for a surface to gain focus, see |wayland-focus-steal|.
10132
Bram Moolenaar071d4272004-06-13 20:20:40 +000010133 *'wrap'* *'nowrap'*
10134'wrap' boolean (default on)
10135 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +000010136 This option changes how text is displayed. It doesn't change the text
10137 in the buffer, see 'textwidth' for that.
10138 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010139 displaying continues on the next line. When off lines will not wrap
10140 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +000010141 moved to a part that is not shown, the screen will scroll
10142 horizontally.
10143 The line will be broken in the middle of a word if necessary. See
10144 'linebreak' to get the break at a word boundary.
10145 To make scrolling horizontally a bit more useful, try this: >
10146 :set sidescroll=5
10147 :set listchars+=precedes:<,extends:>
10148< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010149 This option can't be set from a |modeline| when the 'diff' option is
10150 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010151
10152 *'wrapmargin'* *'wm'*
10153'wrapmargin' 'wm' number (default 0)
10154 local to buffer
10155 Number of characters from the right window border where wrapping
10156 starts. When typing text beyond this limit, an <EOL> will be inserted
10157 and inserting continues on the next line.
10158 Options that add a margin, such as 'number' and 'foldcolumn', cause
10159 the text width to be further reduced. This is Vi compatible.
10160 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +020010161 This option is set to 0 when 'paste' is set and restored when 'paste'
10162 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +020010163 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010164
10165 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
10166'wrapscan' 'ws' boolean (default on) *E384* *E385*
10167 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +000010168 Searches wrap around the end of the file. Also applies to |]s| and
10169 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010170
10171 *'write'* *'nowrite'*
10172'write' boolean (default on)
10173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010174 Allows writing files. When not set, writing a file is not allowed.
10175 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010176 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +000010177 argument. Filtering text is still possible, even though this requires
10178 writing a temporary file.
10179
10180 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
10181'writeany' 'wa' boolean (default off)
10182 global
10183 Allows writing to any file with no need for "!" override.
10184
10185 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
10186'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
10187 otherwise)
10188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010189 Make a backup before overwriting a file. The backup is removed after
10190 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +020010191 also on.
10192 WARNING: Switching this option off means that when Vim fails to write
10193 your buffer correctly and then, for whatever reason, Vim exits, you
10194 lose both the original file and what you were writing. Only reset
10195 this option if your file system is almost full and it makes the write
10196 fail (and make sure not to exit Vim until the write was successful).
10197 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010198 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +010010199 Depending on 'backupcopy' the backup is a new file or the original
10200 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010201 NOTE: This option is set to the default value when 'compatible' is
10202 set.
10203
10204 *'writedelay'* *'wd'*
10205'writedelay' 'wd' number (default 0)
10206 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +020010207 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010208 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010010209 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010210
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010211 *'xtermcodes'* *'noxtermcodes'*
10212'xtermcodes' boolean (default on)
10213 global
10214 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +000010215 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010216 key codes and number of colors from the terminal. This takes care of
10217 various configuration options of the terminal that cannot be obtained
10218 from the termlib/terminfo entry, see |xterm-codes|.
10219 A side effect may be that t_Co changes and Vim will redraw the
10220 display.
10221
10222
Bram Moolenaar91f84f62018-07-29 15:07:52 +020010223 vim:tw=78:ts=8:noet:ft=help:norl: