blob: d4fb51ea2751a7cb4890b1136046615b15782d77 [file] [log] [blame]
Foxe Chenb90c2392025-06-27 21:10:35 +02001*options.txt* For Vim version 9.1. Last change: 2025 Jun 27
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
1813 option, yank operations (but not delete, change or
1814 put) will additionally copy the text into register
Foxe Chenb90c2392025-06-27 21:10:35 +02001815 '*'. If wayland is being used and the compositor does
1816 not support the primary-selection-unstable-v1
1817 protocol, then the regular selection is used in its
1818 place. Only available with the |+X11| or
1819 |+wayland_clipboard| feature. Availability can be
1820 checked with: >
1821 if has('unnamedplus')
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001822<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001823 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 autoselect Works like the 'a' flag in 'guioptions': If present,
1825 then whenever Visual mode is started, or the Visual
1826 area extended, Vim tries to become the owner of the
1827 windowing system's global selection or put the
1828 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001829 register "*. See |'go-a'| and |quotestar| for details.
1830 When the GUI is active, the 'a' flag in 'guioptions'
1831 is used, when the GUI is not active, this "autoselect"
1832 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 Also applies to the modeless selection.
1834
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001835 *clipboard-autoselectplus*
1836 autoselectplus Like "autoselect" but using the + register instead of
1837 the * register. Compare to the 'P' flag in
1838 'guioptions'.
1839
1840 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 autoselectml Like "autoselect", but for the modeless selection
1842 only. Compare to the 'A' flag in 'guioptions'.
1843
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001844 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001845 html When the clipboard contains HTML, use this when
1846 pasting. When putting text on the clipboard, mark it
1847 as HTML. This works to copy rendered HTML from
1848 Firefox, paste it as raw HTML in Vim, select the HTML
1849 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001850 You probably want to add this only temporarily,
1851 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001852 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001853
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001854 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 exclude:{pattern}
1856 Defines a pattern that is matched against the name of
1857 the terminal 'term'. If there is a match, no
Foxe Chenb90c2392025-06-27 21:10:35 +02001858 connection will be made to the X server or wayland
1859 compositor. This is useful in this situation:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 - Running Vim in a console.
Foxe Chenb90c2392025-06-27 21:10:35 +02001861 - $DISPLAY/$WAYLAND_DISPLAY is set to start
1862 applications on another display.
1863 - You do not want to connect to the X server/Wayland
1864 compositor in the console, but do want this in a
1865 terminal emulator.
1866 To never connect to the X server/Wayland compositor
1867 use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 exclude:.*
Foxe Chenb90c2392025-06-27 21:10:35 +02001869< This has the same effect as using the |-X| or |-Y| 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
Foxe Chenb90c2392025-06-27 21:10:35 +02001872 cannot be accessed. This is the same for Wayland,
1873 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: "")
1883
1884 global
1885 {only when the |+xterm_clipboard| or |+wayland_clipboard|
1886 features are included}
1887 Specifies which method of accessing the system clipboard is used,
1888 depending on which method works first or is available. Supported
1889 methods are:
1890 wayland Wayland selections
1891 x11 X11 selections
1892
1893 Note: This option is ignored when either the GUI is running or if Vim
1894 is run on a system without wayland or X11 support, such as Windows or
1895 macOS. The GUI or system way of accessing the clipboard is always
1896 used instead.
1897
1898 The option value is a list of comma separated items. The list is parsed
1899 left to right in order, and the first method that Vim determines is
1900 available or is working is used as the actual method for accessing the
1901 clipboard.
1902
1903 The current method that is being used can be found in the |v:clipmethod|
1904 variable.
1905
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 *'cmdheight'* *'ch'*
1907'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001908 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001909 Number of screen lines to use for the command-line. A larger value
1910 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001911 The value of this option is stored with the tab page, so that each tab
1912 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913
1914 *'cmdwinheight'* *'cwh'*
1915'cmdwinheight' 'cwh' number (default 7)
1916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 Number of screen lines to use for the command-line window. |cmdwin|
1918
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001919 *'colorcolumn'* *'cc'*
1920'colorcolumn' 'cc' string (default "")
1921 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001922 {not available when compiled without the |+syntax|
1923 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001924 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001925 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1926 text. Will make screen redrawing slower.
1927 The screen column can be an absolute number, or a number preceded with
1928 '+' or '-', which is added to or subtracted from 'textwidth'. >
1929
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001930 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001931 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1932 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1933<
1934 When 'textwidth' is zero then the items with '-' and '+' are not used.
1935 A maximum of 256 columns are highlighted.
1936
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 *'columns'* *'co'* *E594*
1938'columns' 'co' number (default 80 or terminal width)
1939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001941 initialization and does not have to be set by hand. Also see
1942 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 When Vim is running in the GUI or in a resizable window, setting this
1944 option will cause the window size to be changed. When you only want
1945 to use the size for the GUI, put the command in your |gvimrc| file.
1946 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001947 number of columns of the display, the display may be messed up. For
1948 the GUI it is always possible and Vim limits the number of columns to
1949 what fits on the screen. You can use this command to get the widest
1950 window possible: >
1951 :set columns=9999
1952< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953
1954 *'comments'* *'com'* *E524* *E525*
1955'comments' 'com' string (default
1956 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1957 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001958 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 |format-comments|. See |option-backslash| about using backslashes to
1960 insert a space.
1961
1962 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001963'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 {not available when compiled without the |+folding|
1966 feature}
1967 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001968 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001969 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001970 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971
1972 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001973'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001974 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 This option has the effect of making Vim either more Vi-compatible, or
1977 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001978
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001980 other options are also changed as a side effect.
1981 NOTE: Setting or resetting this option can have a lot of unexpected
1982 effects: Mappings are interpreted in another way, undo behaves
1983 differently, etc. If you set this option in your vimrc file, you
1984 should probably put it at the very start.
1985
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 By default this option is on and the Vi defaults are used for the
1987 options. This default was chosen for those people who want to use Vim
1988 just like Vi, and don't even (want to) know about the 'compatible'
1989 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001990 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001991 this option is switched off, and all options that have not been
1992 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001993 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001994 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001995 happen for the system-wide vimrc or gvimrc file, nor for a file given
1996 with the |-u| argument). Also see |compatible-default| and
1997 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998 You can also set this option with the "-C" argument, and reset it with
1999 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01002000 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001
Bram Moolenaar214641f2017-03-05 17:04:09 +01002002 When this option is set, numerous other options are set to make Vim as
2003 Vi-compatible as possible. When this option is unset, various options
2004 are set to make Vim more useful. The table below lists all the
2005 options affected.
2006 The {?} column indicates when the options are affected:
2007 + Means that the option is set to the value given in {set value} when
2008 'compatible' is set.
2009 & Means that the option is set to the value given in {set value} when
2010 'compatible' is set AND is set to its Vim default value when
2011 'compatible' is unset.
2012 - Means the option is NOT changed when setting 'compatible' but IS
2013 set to its Vim default when 'compatible' is unset.
2014 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015
Bram Moolenaar036986f2017-03-16 17:41:02 +01002016 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01002017
2018 'allowrevins' + off no CTRL-_ command
2019 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00002020 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01002021 'arabicshape' + on correct character shapes
2022 'backspace' + "" normal backspace
2023 'backup' + off no backup file
2024 'backupcopy' & Unix: "yes" backup file is a copy
2025 else: "auto" copy or rename backup file
2026 'balloonexpr' + "" text to show in evaluation balloon
2027 'breakindent' + off don't indent when wrapping lines
2028 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00002029 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002030 'cindent' + off no C code indentation
2031 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
2032 'copyindent' + off don't copy indent structure
2033 'cpoptions' & (all flags) Vi-compatible flags
2034 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01002035 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002036 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01002037 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002038 'cscopeverbose' + off see |cscopeverbose|
2039 'delcombine' + off unicode: delete whole char combination
2040 'digraph' + off no digraphs
2041 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02002042 this also disables |modifyOtherKeys|
2043 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'expandtab' + off tabs not expanded to spaces
2045 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002046 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002047 'formatexpr' + "" use 'formatprg' for auto-formatting
2048 'formatoptions' & "vt" Vi compatible formatting
2049 'gdefault' + off no default 'g' flag for ":s"
2050 'history' & 0 no commandline history
2051 'hkmap' + off no Hebrew keyboard mapping
2052 'hkmapp' + off no phonetic Hebrew keyboard mapping
2053 'hlsearch' + off no highlighting of search matches
2054 'incsearch' + off no incremental searching
2055 'indentexpr' + "" no indenting by expression
2056 'insertmode' + off do not start in Insert mode
2057 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002059 'joinspaces' + on insert 2 spaces after period
2060 'modeline' & off no modelines
2061 'more' & off no pauses in listings
2062 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2063 'numberwidth' & 8 min number of columns for line number
2064 'preserveindent'+ off don't preserve current indent structure
2065 when changing it
2066 'revins' + off no reverse insert
2067 'ruler' + off no ruler
2068 'scrolljump' + 1 no jump scroll
2069 'scrolloff' + 0 no scroll offset
2070 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2071 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002072 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002073 'showcmd' & off command characters not shown
2074 'showmode' & off current mode not shown
2075 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2076 'smartcase' + off no automatic ignore case switch
2077 'smartindent' + off no smart indentation
2078 'smarttab' + off no smart tab size
Damien Lejay91af4c42025-06-12 21:56:19 +02002079 'softtabstop' + 0 no soft tab stops
Bram Moolenaar214641f2017-03-05 17:04:09 +01002080 'startofline' + on goto startofline with some commands
2081 'tagcase' & "followic" 'ignorecase' when searching tags file
2082 'tagrelative' & off tag file names are not relative
2083 'termguicolors' + off don't use highlight-(guifg|guibg)
2084 'textauto' & off no automatic textmode detection
2085 'textwidth' + 0 no automatic line wrap
2086 'tildeop' + off tilde is not an operator
2087 'ttimeout' + off no terminal timeout
2088 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002089 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002090 'virtualedit' + "" cursor can only be placed on characters
2091 'whichwrap' & "" left-right movements don't wrap
2092 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002094 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095
2096 *'complete'* *'cpt'* *E535*
2097'complete' 'cpt' string (default: ".,w,b,u,t,i")
2098 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 This option specifies how keyword completion |ins-completion| works
2100 when CTRL-P or CTRL-N are used. It is also used for whole-line
2101 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002102 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002103 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 w scan buffers from other windows
2105 b scan other loaded buffers that are in the buffer list
2106 u scan the unloaded buffers that are in the buffer list
2107 U scan the buffers that are not in the buffer list
2108 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002109 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 k{dict} scan the file {dict}. Several "k" flags can be given,
2111 patterns are valid too. For example: >
2112 :set cpt=k/usr/dict/*,k~/spanish
2113< s scan the files given with the 'thesaurus' option
2114 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2115 are valid too.
2116 i scan current and included files
2117 d scan current and included files for defined name or macro
2118 |i_CTRL-X_CTRL-D|
2119 ] tag completion
2120 t same as "]"
Girish Palya14f6da52025-05-26 19:04:25 +02002121 F{func} call the function {func}. Multiple "F" flags may be specified.
Girish Palyacbe53192025-04-14 22:13:15 +02002122 Refer to |complete-functions| for details on how the function
2123 is invoked and what it should return. The value can be the
2124 name of a function or a |Funcref|. For |Funcref| values,
2125 spaces must be escaped with a backslash ('\'), and commas with
2126 double backslashes ('\\') (see |option-backslash|).
2127 If the Dict returned by the {func} includes {"refresh": "always"},
2128 the function will be invoked again whenever the leading text
2129 changes.
2130 Completion matches are always inserted at the keyword
2131 boundary, regardless of the column returned by {func} when
2132 a:findstart is 1. This ensures compatibility with other
2133 completion sources.
2134 To make further modifications to the inserted text, {func}
2135 can make use of |CompleteDonePre|.
2136 If generating matches is potentially slow, |complete_check()|
2137 should be used to avoid blocking and preserve editor
2138 responsiveness.
Girish Palya14f6da52025-05-26 19:04:25 +02002139 F equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002140 the 'completefunc' option.
Girish Palya14f6da52025-05-26 19:04:25 +02002141 o equivalent to using "F{func}", where the function is taken from
Girish Palyacbe53192025-04-14 22:13:15 +02002142 the 'omnifunc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143
2144 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2145 not executed, this may lead to unexpected completions from some files
2146 (gzipped files for example). Unloaded buffers are not scanned for
2147 whole-line completion.
2148
2149 The default is ".,w,b,u,t,i", which means to scan:
2150 1. the current buffer
2151 2. buffers in other windows
2152 3. other loaded buffers
2153 4. unloaded buffers
2154 5. tags
2155 6. included files
2156
2157 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002158 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2159 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160
Girish Palya0ac1eb32025-04-16 20:18:33 +02002161 An optional match limit can be specified for a completion source by
2162 appending a caret ("^") followed by a {count} to the source flag.
2163 For example: ".^9,w,u,t^5" limits matches from the current buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02002164 to 9 and from tags to 5. Other sources remain unlimited.
2165 Note: The match limit takes effect only during forward completion
2166 (CTRL-N) and is ignored during backward completion (CTRL-P).
Girish Palya0ac1eb32025-04-16 20:18:33 +02002167
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002168 *'completefunc'* *'cfu'*
2169'completefunc' 'cfu' string (default: empty)
2170 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002171 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002172 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002173 This option specifies a function to be used for Insert mode completion
2174 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002175 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002176 invoked and what it should return. The value can be the name of a
2177 function, a |lambda| or a |Funcref|. See |option-value-function| for
2178 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002179 This option cannot be set from a |modeline| or in the |sandbox|, for
2180 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002181
glepnirf31cfa22025-03-06 21:59:13 +01002182 *'completefuzzycollect'* *'cfc'*
2183'completefuzzycollect' 'cfc' string (default: empty)
2184 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002185 A comma-separated list of strings to enable fuzzy collection for
2186 specific |ins-completion| modes, affecting how matches are gathered
2187 during completion. For specified modes, fuzzy matching is used to
2188 find completion candidates instead of the standard prefix-based
2189 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002190
glepnir58760162025-03-13 21:39:51 +01002191 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2192 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2193 "b", "u", "U" and "k{dict}" in 'complete'
2194 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002195
glepnir58760162025-03-13 21:39:51 +01002196 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002197
glepnir58760162025-03-13 21:39:51 +01002198 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002199
Christian Brabandtf22580e2025-03-14 12:05:52 +01002200 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002201 can identify the longest common string among the best fuzzy matches
2202 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002203
glepnir6a89c942024-10-01 20:32:12 +02002204 *'completeitemalign'* *'cia'*
2205'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2206 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002207 A comma-separated list of strings that controls the alignment and
2208 display order of items in the popup menu during Insert mode
2209 completion. The supported values are "abbr", "kind", and "menu".
2210 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002211 popup menu. Note: must always contain those three values in any
2212 order.
2213
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002214 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002215'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002216 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002217 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002218 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002219
glepnira2c55592025-02-28 17:43:42 +01002220 fuzzy Enable |fuzzy-matching| for completion candidates. This
2221 allows for more flexible and intuitive matching, where
2222 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002223 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002224 does not affect the collection of candidate list, it only
2225 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002226 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002227 to gather more alternatives for your candidate list,
2228 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002229
2230 longest Only insert the longest common text of the matches. If
2231 the menu is displayed you can use CTRL-L to add more
2232 characters. Whether case is ignored depends on the kind
2233 of completion. For buffer text the 'ignorecase' option is
2234 used.
2235
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002236 menu Use a popup menu to show the possible completions. The
2237 menu is only shown when there is more than one match and
2238 sufficient colors are available. |ins-completion-menu|
2239
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002240 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002241 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002242 match, e.g., what file it comes from.
2243
Girish Palyacb3b7522025-04-18 18:52:28 +02002244 nearest Matches are listed based on their proximity to the cursor
2245 position, unlike the default behavior, which only
2246 considers proximity for matches appearing below the
2247 cursor. This applies only to matches from the current
Girish Palyab1565882025-04-15 20:16:00 +02002248 buffer. No effect if "fuzzy" is present.
2249
glepnira2c55592025-02-28 17:43:42 +01002250 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002251 a match from the menu. Only works in combination with
2252 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002253
glepnira2c55592025-02-28 17:43:42 +01002254 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002255 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002256 present, "noselect" has precedence.
2257
2258 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002259 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002260 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002261
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002262 popup Show extra information about the currently selected
2263 completion in a popup window. Only works in combination
2264 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002265 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002266 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002267
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002268 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002269 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002270 |CompleteChanged| autocommand to fetch the info and call
2271 |popup_show()| once the popup has been filled.
2272 See the example at |complete-popuphidden|.
2273 {only works when compiled with the |+textprop| feature}
2274
glepniredd4ac32025-01-29 18:53:51 +01002275 preinsert
2276 Preinsert the portion of the first candidate word that is
2277 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002278 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002279 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002280
2281 preview Show extra information about the currently selected
2282 completion in the preview window. Only works in
2283 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002284
Ilya Grigoriev053aee02025-06-11 21:07:35 +02002285 This option does not apply to |cmdline-completion|. See 'wildoptions'
2286 for that.
2287
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002288 *'completepopup'* *'cpp'*
2289'completepopup' 'cpp' string (default empty)
2290 global
2291 {not available when compiled without the |+textprop|
2292 or |+quickfix| feature}
2293 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002294 properties of the info popup when it is created. If an info popup
2295 window already exists it is closed, so that the option value is
2296 applied when it is created again.
2297 You can also use |popup_findinfo()| and then set properties for an
2298 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002299
laburnumT3f7855a2023-12-05 18:37:03 +01002300 *'completeslash'* *'csl'*
2301'completeslash' 'csl' string (default: "")
2302 local to buffer
2303 {only for MS-Windows}
2304 When this option is set it overrules 'shellslash' for completion:
2305 - When this option is set to "slash", a forward slash is used for path
2306 completion in insert mode. This is useful when editing HTML tag, or
2307 Makefile with 'noshellslash' on MS-Windows.
2308 - When this option is set to "backslash", backslash is used. This is
2309 useful when editing a batch file with 'shellslash' set on MS-Windows.
2310 - When this option is empty, same character is used as for
2311 'shellslash'.
2312 For Insert mode completion the buffer-local value is used. For
2313 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002314
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002315 *'concealcursor'* *'cocu'*
2316'concealcursor' 'cocu' string (default: "")
2317 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002318 {not available when compiled without the |+conceal|
2319 feature}
2320 Sets the modes in which text in the cursor line can also be concealed.
2321 When the current mode is listed then concealing happens just like in
2322 other lines.
2323 n Normal mode
2324 v Visual mode
2325 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002326 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002327
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002328 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002329 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002330 are moving around text is concealed, but when starting to insert text
2331 or selecting a Visual area the concealed text is displayed, so that
2332 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002333 Keep in mind that the cursor position is not always where it's
2334 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002335
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002336 *'conceallevel'* *'cole'*
2337'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002338 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002339 {not available when compiled without the |+conceal|
2340 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002341 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2342 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002343
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002344 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002345 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002346 1 Each block of concealed text is replaced with one
2347 character. If the syntax item does not have a custom
2348 replacement character defined (see |:syn-cchar|) the
2349 character defined in 'listchars' is used (default is a
2350 space).
2351 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002352 2 Concealed text is completely hidden unless it has a
2353 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002354 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002355 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002356
Bram Moolenaara7781e02010-07-19 20:13:22 +02002357 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002358 edit and copy the text. This can be changed with the 'concealcursor'
2359 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002360
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2362'confirm' 'cf' boolean (default off)
2363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 When 'confirm' is on, certain operations that would normally
2365 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2366 instead raise a |dialog| asking if you wish to save the current
2367 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2368 If 'confirm' is off you can still activate confirmation for one
2369 command only (this is most useful in mappings) with the |:confirm|
2370 command.
2371 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2372
2373 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2374'conskey' 'consk' boolean (default off)
2375 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002376 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377
2378 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2379'copyindent' 'ci' boolean (default off)
2380 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 Copy the structure of the existing lines indent when autoindenting a
2382 new line. Normally the new indent is reconstructed by a series of
2383 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2384 in which case only spaces are used). Enabling this option makes the
2385 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002386 existing line. 'expandtab' has no effect on these characters, a Tab
2387 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002389 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 Also see 'preserveindent'.
2391
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002392 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002393'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2394 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002395 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002398 this indicates Vi-compatible behavior. This is used for things where
2399 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 'cpoptions' stands for "compatible-options".
2401 Commas can be added for readability.
2402 To avoid problems with flags that are added in the future, use the
2403 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002404
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 NOTE: This option is set to the Vi default value when 'compatible' is
2406 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002407
2408 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2409 is saved, 'cpoptions' is set to the Vim default, and the saved value
2410 is restored at the end of the script. Changes to the value of
2411 'cpoptions' will be applied to the saved value, but keep in mind that
2412 removing a flag that is not present when 'cpoptions' is changed has no
2413 effect. In the |.vimrc| file the value is not restored, thus using
2414 `vim9script` in the |.vimrc| file results in using the Vim default.
2415
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002416 NOTE: This option is set to the POSIX default value at startup when
2417 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002418 variable exists |posix|. This means Vim tries to behave like the
2419 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420
2421 contains behavior ~
2422 *cpo-a*
2423 a When included, a ":read" command with a file name
2424 argument will set the alternate file name for the
2425 current window.
2426 *cpo-A*
2427 A When included, a ":write" command with a file name
2428 argument will set the alternate file name for the
2429 current window.
2430 *cpo-b*
2431 b "\|" in a ":map" command is recognized as the end of
2432 the map command. The '\' is included in the mapping,
2433 the text after the '|' is interpreted as the next
2434 command. Use a CTRL-V instead of a backslash to
2435 include the '|' in the mapping. Applies to all
2436 mapping, abbreviation, menu and autocmd commands.
2437 See also |map_bar|.
2438 *cpo-B*
2439 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002440 abbreviations, user commands and the "to" part of the
2441 menu commands. Remove this flag to be able to use a
2442 backslash like a CTRL-V. For example, the command
2443 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 'B' included: "\^[" (^[ is a real <Esc>)
2445 'B' excluded: "<Esc>" (5 characters)
2446 ('<' excluded in both cases)
2447 *cpo-c*
2448 c Searching continues at the end of any match at the
2449 cursor position, but not further than the start of the
2450 next line. When not present searching continues
2451 one character from the cursor position. With 'c'
2452 "abababababab" only gets three matches when repeating
2453 "/abab", without 'c' there are five matches.
2454 *cpo-C*
2455 C Do not concatenate sourced lines that start with a
2456 backslash. See |line-continuation|.
2457 *cpo-d*
2458 d Using "./" in the 'tags' option doesn't mean to use
2459 the tags file relative to the current file, but the
2460 tags file in the current directory.
2461 *cpo-D*
2462 D Can't use CTRL-K to enter a digraph after Normal mode
2463 commands with a character argument, like |r|, |f| and
2464 |t|.
2465 *cpo-e*
2466 e When executing a register with ":@r", always add a
2467 <CR> to the last line, also when the register is not
2468 linewise. If this flag is not present, the register
2469 is not linewise and the last line does not end in a
2470 <CR>, then the last line is put on the command-line
2471 and can be edited before hitting <CR>.
2472 *cpo-E*
2473 E It is an error when using "y", "d", "c", "g~", "gu" or
2474 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002475 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 This makes "y0" fail in the first column.
2477 *cpo-f*
2478 f When included, a ":read" command with a file name
2479 argument will set the file name for the current buffer,
2480 if the current buffer doesn't have a file name yet.
2481 *cpo-F*
2482 F When included, a ":write" command with a file name
2483 argument will set the file name for the current
2484 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002485 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 *cpo-g*
2487 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002488 *cpo-H*
2489 H When using "I" on a line with only blanks, insert
2490 before the last blank. Without this flag insert after
2491 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 *cpo-i*
2493 i When included, interrupting the reading of a file will
2494 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002495 *cpo-I*
2496 I When moving the cursor up or down just after inserting
2497 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 *cpo-j*
2499 j When joining lines, only add two spaces after a '.',
2500 not after '!' or '?'. Also see 'joinspaces'.
2501 *cpo-J*
2502 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002503 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 white space.
2505 *cpo-k*
2506 k Disable the recognition of raw key codes in
2507 mappings, abbreviations, and the "to" part of menu
2508 commands. For example, if <Key> sends ^[OA (where ^[
2509 is <Esc>), the command ":map X ^[OA" results in X
2510 being mapped to:
2511 'k' included: "^[OA" (3 characters)
2512 'k' excluded: "<Key>" (one key code)
2513 Also see the '<' flag below.
2514 *cpo-K*
2515 K Don't wait for a key code to complete when it is
2516 halfway a mapping. This breaks mapping <F1><F1> when
2517 only part of the second <F1> has been read. It
2518 enables cancelling the mapping by typing <F1><Esc>.
2519 *cpo-l*
2520 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002521 literally, only "\]", "\^", "\-" and "\\" are special.
2522 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2524 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002525 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 *cpo-L*
2527 L When the 'list' option is set, 'wrapmargin',
2528 'textwidth', 'softtabstop' and Virtual Replace mode
2529 (see |gR|) count a <Tab> as two characters, instead of
2530 the normal behavior of a <Tab>.
2531 *cpo-m*
2532 m When included, a showmatch will always wait half a
2533 second. When not included, a showmatch will wait half
2534 a second or until a character is typed. |'showmatch'|
2535 *cpo-M*
2536 M When excluded, "%" matching will take backslashes into
2537 account. Thus in "( \( )" and "\( ( \)" the outer
2538 parenthesis match. When included "%" ignores
2539 backslashes, which is Vi compatible.
2540 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002541 n When included, the column used for 'number' and
2542 'relativenumber' will also be used for text of wrapped
2543 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 *cpo-o*
2545 o Line offset to search command is not remembered for
2546 next search.
2547 *cpo-O*
2548 O Don't complain if a file is being overwritten, even
2549 when it didn't exist when editing it. This is a
2550 protection against a file unexpectedly created by
2551 someone else. Vi didn't complain about this.
2552 *cpo-p*
2553 p Vi compatible Lisp indenting. When not present, a
2554 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002555 *cpo-P*
2556 P When included, a ":write" command that appends to a
2557 file will set the file name for the current buffer, if
2558 the current buffer doesn't have a file name yet and
2559 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002560 *cpo-q*
2561 q When joining multiple lines leave the cursor at the
2562 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 *cpo-r*
2564 r Redo ("." command) uses "/" to repeat a search
2565 command, instead of the actually used search string.
2566 *cpo-R*
2567 R Remove marks from filtered lines. Without this flag
2568 marks are kept like |:keepmarks| was used.
2569 *cpo-s*
2570 s Set buffer options when entering the buffer for the
2571 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 set when the buffer is created.
2574 *cpo-S*
2575 S Set buffer options always when entering a buffer
2576 (except 'readonly', 'fileformat', 'filetype' and
2577 'syntax'). This is the (most) Vi compatible setting.
2578 The options are set to the values in the current
2579 buffer. When you change an option and go to another
2580 buffer, the value is copied. Effectively makes the
2581 buffer options global to all buffers.
2582
2583 's' 'S' copy buffer options
2584 no no when buffer created
2585 yes no when buffer first entered (default)
2586 X yes each time when buffer entered (vi comp.)
2587 *cpo-t*
2588 t Search pattern for the tag command is remembered for
2589 "n" command. Otherwise Vim only puts the pattern in
2590 the history for search pattern, but doesn't change the
2591 last used search pattern.
2592 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002593 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 *cpo-v*
2595 v Backspaced characters remain visible on the screen in
2596 Insert mode. Without this flag the characters are
2597 erased from the screen right away. With this flag the
2598 screen newly typed text overwrites backspaced
2599 characters.
2600 *cpo-w*
2601 w When using "cw" on a blank character, only change one
2602 character and not all blanks until the start of the
2603 next word.
2604 *cpo-W*
2605 W Don't overwrite a readonly file. When omitted, ":w!"
2606 overwrites a readonly file, if possible.
2607 *cpo-x*
2608 x <Esc> on the command-line executes the command-line.
2609 The default in Vim is to abandon the command-line,
2610 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002611 *cpo-X*
2612 X When using a count with "R" the replaced text is
2613 deleted only once. Also when repeating "R" with "."
2614 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002616 y A yank command can be redone with ".". Think twice if
2617 you really want to use this, it may break some
2618 plugins, since most people expect "." to only repeat a
2619 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002620 *cpo-Z*
2621 Z When using "w!" while the 'readonly' option is set,
2622 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002623 *cpo-z*
2624 z Special casing the "cw" and "d" command (see |cw| and
2625 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 *cpo-!*
2627 ! When redoing a filter command, use the last used
2628 external command, whatever it was. Otherwise the last
2629 used -filter- command is used.
2630 *cpo-$*
2631 $ When making a change to one line, don't redisplay the
2632 line, but put a '$' at the end of the changed text.
2633 The changed text will be overwritten when you type the
2634 new text. The line is redisplayed if you type any
2635 command that moves the cursor from the insertion
2636 point.
2637 *cpo-%*
2638 % Vi-compatible matching is done for the "%" command.
2639 Does not recognize "#if", "#endif", etc.
2640 Does not recognize "/*" and "*/".
2641 Parens inside single and double quotes are also
2642 counted, causing a string that contains a paren to
2643 disturb the matching. For example, in a line like
2644 "if (strcmp("foo(", s))" the first paren does not
2645 match the last one. When this flag is not included,
2646 parens inside single and double quotes are treated
2647 specially. When matching a paren outside of quotes,
2648 everything inside quotes is ignored. When matching a
2649 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002650 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002651 This flag is also used for other features, such as
2652 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002653 *cpo--*
2654 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002655 it would go above the first line or below the last
2656 line. Without it the cursor moves to the first or
2657 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002658 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002659 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002660 *cpo-+*
2661 + When included, a ":write file" command will reset the
2662 'modified' flag of the buffer, even though the buffer
2663 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002664 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 * Use ":*" in the same way as ":@". When not included,
2666 ":*" is an alias for ":'<,'>", select the Visual area.
2667 *cpo-<*
2668 < Disable the recognition of special key codes in |<>|
2669 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002670 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 ":map X <Tab>" results in X being mapped to:
2672 '<' included: "<Tab>" (5 characters)
2673 '<' excluded: "^I" (^I is a real <Tab>)
2674 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002675 *cpo->*
2676 > When appending to a register, put a line break before
2677 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002678 *cpo-;*
2679 ; When using |,| or |;| to repeat the last |t| search
2680 and the cursor is right in front of the searched
2681 character, the cursor won't move. When not included,
2682 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002683 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002684
2685 POSIX flags. These are not included in the Vi default value, except
2686 when $VIM_POSIX was set on startup. |posix|
2687
2688 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002689 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002690 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002691 *cpo-&*
2692 & When ":preserve" was used keep the swap file when
2693 exiting normally while this buffer is still loaded.
2694 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002695 *cpo-\*
2696 \ Backslash in a [] range in a search pattern is taken
2697 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002698 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2699 '\' excluded: "/[ \-]" finds <Space> and '-'
2700 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002701 *cpo-/*
2702 / When "%" is used as the replacement string in a |:s|
2703 command, use the previous replacement string. |:s%|
2704 *cpo-{*
2705 { The |{| and |}| commands also stop at a "{" character
2706 at the start of a line.
2707 *cpo-.*
2708 . The ":chdir" and ":cd" commands fail if the current
2709 buffer is modified, unless ! is used. Vim doesn't
2710 need this, since it remembers the full path of an
2711 opened file.
2712 *cpo-bar*
2713 | The value of the $LINES and $COLUMNS environment
2714 variables overrule the terminal size values obtained
2715 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002716
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002717 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002718'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002719 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002720 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002721 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002722 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002723 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002724 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002725 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002726 blowfish Blowfish method. Medium strong encryption but it has
2727 an implementation flaw. Requires Vim 7.3 or later,
2728 files can NOT be read by Vim 7.2 and older. This adds
2729 a "seed" to the file, every time you write the file
2730 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002731 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002732 *blowfish2*
2733 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002734 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002735 and older. This adds a "seed" to the file, every time
2736 you write the file the encrypted bytes will be
2737 different. The whole undo file is encrypted, not just
2738 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002739 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002740 *E1197* *E1198* *E1199* *E1200* *E1201*
2741 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002742 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002743 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002744 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002745 It adds a seed and a message authentication code (MAC)
2746 to the file. This needs at least a Vim 8.2.3022 to
2747 read the encrypted file.
2748 Encryption of swap files is not supported, therefore
2749 no swap file will be used when xchacha20 encryption is
2750 enabled.
2751 Encryption of undo files is not yet supported,
2752 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002753 CAREFUL: Files written with this method might have to
2754 be read back with the same version of Vim if the
2755 binary format changes later.
2756 Obsolete, please do no longer use.
2757 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2758 stores the key derivation parameters together with the
2759 encrypted file. Should work better in case the
2760 parameters in the libsodium library ever change.
2761 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002762 might have to be read back with the same version of
2763 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002764
Christian Brabandtaae58342023-04-23 17:50:22 +01002765 You should use "blowfish2", also to re-encrypt older files. The
2766 "xchacha20" method provides better encryption, but it does not work
2767 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002768
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002769 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002770 to the detected method of the file being read. Thus if you write it
2771 without changing 'cryptmethod' the same method will be used.
2772 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002773 explicitly write it, you don't get a warning unless there are other
2774 modifications. Also see |:X|.
2775
2776 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002777 the value "blowfish2". When setting the local value to an empty
2778 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002779
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002780 When a new encryption method is added in a later version of Vim, and
2781 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002782 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 *'cscopepathcomp'* *'cspc'*
2785'cscopepathcomp' 'cspc' number (default 0)
2786 global
2787 {not available when compiled without the |+cscope|
2788 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 Determines how many components of the path to show in a list of tags.
2790 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002791 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792
2793 *'cscopeprg'* *'csprg'*
2794'cscopeprg' 'csprg' string (default "cscope")
2795 global
2796 {not available when compiled without the |+cscope|
2797 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 Specifies the command to execute cscope. See |cscopeprg|.
2799 This option cannot be set from a |modeline| or in the |sandbox|, for
2800 security reasons.
2801
2802 *'cscopequickfix'* *'csqf'*
2803'cscopequickfix' 'csqf' string (default "")
2804 global
2805 {not available when compiled without the |+cscope|
2806 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 Specifies whether to use quickfix window to show cscope results.
2808 See |cscopequickfix|.
2809
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002810 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002811'cscoperelative' 'csre' boolean (default off)
2812 global
2813 {not available when compiled without the |+cscope|
2814 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002815 In the absence of a prefix (-P) for cscope. setting this option enables
2816 to use the basename of cscope.out path as the prefix.
2817 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002818 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002819
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2821'cscopetag' 'cst' boolean (default off)
2822 global
2823 {not available when compiled without the |+cscope|
2824 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 Use cscope for tag commands. See |cscope-options|.
2826 NOTE: This option is reset when 'compatible' is set.
2827
2828 *'cscopetagorder'* *'csto'*
2829'cscopetagorder' 'csto' number (default 0)
2830 global
2831 {not available when compiled without the |+cscope|
2832 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 Determines the order in which ":cstag" performs a search. See
2834 |cscopetagorder|.
2835 NOTE: This option is set to 0 when 'compatible' is set.
2836
2837 *'cscopeverbose'* *'csverb'*
2838 *'nocscopeverbose'* *'nocsverb'*
2839'cscopeverbose' 'csverb' boolean (default off)
2840 global
2841 {not available when compiled without the |+cscope|
2842 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 Give messages when adding a cscope database. See |cscopeverbose|.
2844 NOTE: This option is reset when 'compatible' is set.
2845
Bram Moolenaar860cae12010-06-05 23:22:07 +02002846 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2847'cursorbind' 'crb' boolean (default off)
2848 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002849 When this option is set, as the cursor in the current
2850 window moves other cursorbound windows (windows that also have
2851 this option set) move their cursors to the corresponding line and
2852 column. This option is useful for viewing the
2853 differences between two versions of a file (see 'diff'); in diff mode,
2854 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002855 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002856
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002857 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2858'cursorcolumn' 'cuc' boolean (default off)
2859 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002860 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002861 feature}
2862 Highlight the screen column of the cursor with CursorColumn
2863 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2864 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002865 If you only want the highlighting in the current window you can use
2866 these autocommands: >
2867 au WinLeave * set nocursorline nocursorcolumn
2868 au WinEnter * set cursorline cursorcolumn
2869<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002870
2871 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2872'cursorline' 'cul' boolean (default off)
2873 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002874 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002875 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002876 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2877 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002878 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002879 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002880
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002881 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002882'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002883 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002884 {not available when compiled without the |+syntax|
2885 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002886 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002887 Valid values:
2888 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002889 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002890 "screenline" Highlight only the screen line of the cursor with
2891 CursorLine |hl-CursorLine|.
2892 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002893 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002894
2895 Special value:
2896 "both" Alias for the values "line,number".
2897
2898 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002899
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 *'debug'*
2901'debug' string (default "")
2902 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002903 These values can be used:
2904 msg Error messages that would otherwise be omitted will be given
2905 anyway.
2906 throw Error messages that would otherwise be omitted will be given
2907 anyway and also throw an exception and set |v:errmsg|.
2908 beep A message will be given when otherwise only a beep would be
2909 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002910 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002911 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2912 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913
2914 *'define'* *'def'*
2915'define' 'def' string (default "^\s*#\s*define")
2916 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 pattern, just like for the "/" command. This option is used for the
2919 commands like "[i" and "[d" |include-search|. The 'isident' option is
2920 used to recognize the defined name after the match:
2921 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2922 See |option-backslash| about inserting backslashes to include a space
2923 or backslash.
2924 The default value is for C programs. For C++ this value would be
2925 useful, to include const type declarations: >
2926 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002927< You can also use "\ze" just before the name and continue the pattern
2928 to check what is following. E.g. for Javascript, if a function is
2929 defined with "func_name = function(args)": >
2930 ^\s*\ze\i\+\s*=\s*function(
2931< If the function is defined with "func_name : function() {...": >
2932 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002934 To avoid that use `:let` with a single quote string: >
2935 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002936<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937
2938 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2939'delcombine' 'deco' boolean (default off)
2940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 If editing Unicode and this option is set, backspace and Normal mode
2942 "x" delete each combining character on its own. When it is off (the
2943 default) the character along with its combining characters are
2944 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002945 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946
2947 This is useful for Arabic, Hebrew and many other languages where one
2948 may have combining characters overtop of base characters, and want
2949 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002950 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951
2952 *'dictionary'* *'dict'*
2953'dictionary' 'dict' string (default "")
2954 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 List of file names, separated by commas, that are used to lookup words
2956 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2957 contain a list of words. This can be one word per line, or several
2958 words per line, separated by non-keyword characters (white space is
2959 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002960
2961 When this option is empty or an entry "spell" is present, and spell
2962 checking is enabled, words in the word lists for the currently active
2963 'spelllang' are used. See |spell|.
2964
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002965 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 after a comma are ignored, otherwise spaces are included in the file
2967 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002968 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 Where to find a list of words?
2970 - On FreeBSD, there is the file "/usr/share/dict/words".
2971 - In the Simtel archive, look in the "msdos/linguist" directory.
2972 - In "miscfiles" of the GNU collection.
2973 The use of |:set+=| and |:set-=| is preferred when adding or removing
2974 directories from the list. This avoids problems when a future version
2975 uses another default.
2976 Backticks cannot be used in this option for security reasons.
2977
2978 *'diff'* *'nodiff'*
2979'diff' boolean (default off)
2980 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 {not available when compiled without the |+diff|
2982 feature}
2983 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002984 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985
2986 *'dex'* *'diffexpr'*
2987'diffexpr' 'dex' string (default "")
2988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 {not available when compiled without the |+diff|
2990 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002991 Expression which is evaluated to obtain a diff file (either ed-style
2992 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 This option cannot be set from a |modeline| or in the |sandbox|, for
2994 security reasons.
2995
2996 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002997'diffopt' 'dip' string (default
2998 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 {not available when compiled without the |+diff|
3001 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003002 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 All are optional. Items must be separated by a comma.
3004
Jonathon7c7a4e62025-01-12 09:58:00 +01003005 algorithm:{text} Use the specified diff algorithm with the
3006 internal diff engine. Currently supported
3007 algorithms are:
3008 myers the default algorithm
3009 minimal spend extra time to generate the
3010 smallest possible diff
3011 patience patience diff algorithm
3012 histogram histogram diff algorithm
3013
3014 closeoff When a window is closed where 'diff' is set
3015 and there is only one window remaining in the
3016 same tab page with 'diff' set, execute
3017 `:diffoff` in that window. This undoes a
3018 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019
3020 context:{n} Use a context of {n} lines between a change
3021 and a fold that contains unchanged lines.
3022 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01003023 When using zero the context is actually one,
3024 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02003025 for a deleted line. Set it to a very large
3026 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 See |fold-diff|.
3028
Jonathon7c7a4e62025-01-12 09:58:00 +01003029 filler Show filler lines, to keep the text
3030 synchronized with a window that has inserted
3031 lines at the same position. Mostly useful
3032 when windows are side-by-side and 'scrollbind'
3033 is set.
3034
3035 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
3036 starting diff mode. Without this 2 is used.
3037
3038 followwrap Follow the 'wrap' option and leave as it is.
3039
3040 horizontal Start diff mode with horizontal splits (unless
3041 explicitly specified otherwise).
3042
3043 hiddenoff Do not use diff mode for a buffer when it
3044 becomes hidden.
3045
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003046 iblank Ignore changes where lines are all blank. Adds
3047 the "-B" flag to the "diff" command if
3048 'diffexpr' is empty. Check the documentation
3049 of the "diff" command for what this does
3050 exactly.
3051 NOTE: the diff windows will get out of sync,
3052 because no differences between blank lines are
3053 taken into account.
3054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 icase Ignore changes in case of text. "a" and "A"
3056 are considered the same. Adds the "-i" flag
3057 to the "diff" command if 'diffexpr' is empty.
3058
Jonathon7c7a4e62025-01-12 09:58:00 +01003059 indent-heuristic
3060 Use the indent heuristic for the internal
3061 diff library.
3062
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003063 inline:{text} Highlight inline differences within a change.
3064 See |view-diffs|. Supported values are:
3065
3066 none Do not perform inline highlighting.
3067 simple Highlight from first different
3068 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003069 line. This is the default if no
3070 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003071 char Use internal diff to perform a
3072 character-wise diff and highlight the
3073 difference.
3074 word Use internal diff to perform a
3075 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003076 difference. Non-alphanumeric
3077 multi-byte characters such as emoji
3078 and CJK characters are considered
3079 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003080
Jonathon7c7a4e62025-01-12 09:58:00 +01003081 internal Use the internal diff library. This is
3082 ignored when 'diffexpr' is set. *E960*
3083 When running out of memory when writing a
3084 buffer this item will be ignored for diffs
3085 involving that buffer. Set the 'verbose'
3086 option to see when this happens.
3087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 iwhite Ignore changes in amount of white space. Adds
3089 the "-b" flag to the "diff" command if
3090 'diffexpr' is empty. Check the documentation
3091 of the "diff" command for what this does
3092 exactly. It should ignore adding trailing
3093 white space, but not leading white space.
3094
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003095 iwhiteall Ignore all white space changes. Adds
3096 the "-w" flag to the "diff" command if
3097 'diffexpr' is empty. Check the documentation
3098 of the "diff" command for what this does
3099 exactly.
3100
3101 iwhiteeol Ignore white space changes at end of line.
3102 Adds the "-Z" flag to the "diff" command if
3103 'diffexpr' is empty. Check the documentation
3104 of the "diff" command for what this does
3105 exactly.
3106
Jonathon7c7a4e62025-01-12 09:58:00 +01003107 linematch:{n} Align and mark changes between the most
3108 similar lines between the buffers. When the
3109 total number of lines in the diff hunk exceeds
3110 {n}, the lines will not be aligned because for
3111 very large diff hunks there will be a
3112 noticeable lag. A reasonable setting is
3113 "linematch:60", as this will enable alignment
3114 for a 2 buffer diff hunk of 30 lines each,
3115 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003116
3117 vertical Start diff mode with vertical splits (unless
3118 explicitly specified otherwise).
3119
Bram Moolenaare828b762018-09-10 17:51:58 +02003120 Examples: >
3121 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003123 :set diffopt=internal,filler,foldcolumn:3
3124 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125<
3126 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3127'digraph' 'dg' boolean (default off)
3128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 {not available when compiled without the |+digraphs|
3130 feature}
3131 Enable the entering of digraphs in Insert mode with {char1} <BS>
3132 {char2}. See |digraphs|.
3133 NOTE: This option is reset when 'compatible' is set.
3134
3135 *'directory'* *'dir'*
3136'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003137 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 for Unix: ".,~/tmp,/var/tmp,/tmp")
3139 global
3140 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003141 Recommended value: ".,~/vimswap//" - this will put the swap file next
3142 to the edited file if possible, and in your personal swap directory
3143 otherwise. Make sure "~/vimswap//" is only readable for you.
3144
3145 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 - The swap file will be created in the first directory where this is
3147 possible.
3148 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003149 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 - A directory "." means to put the swap file in the same directory as
3151 the edited file. On Unix, a dot is prepended to the file name, so
3152 it doesn't show in a directory listing. On MS-Windows the "hidden"
3153 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003154 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3155 the swap file relative to where the edited file is. The leading "."
3156 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003157 - For Unix and Win32, if a directory ends in two path separators "//",
3158 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003159 with all path separators replaced by percent '%' signs (including
3160 the colon following the drive letter on Win32). This will ensure
3161 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003162 On Win32, it is also possible to end with "\\". However, When a
3163 separating comma is following, you must use "//", since "\\" will
3164 include the comma in the file name. Therefore it is recommended to
3165 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 - Spaces after the comma are ignored, other spaces are considered part
3167 of the directory name. To have a space at the start of a directory
3168 name, precede it with a backslash.
3169 - To include a comma in a directory name precede it with a backslash.
3170 - A directory name may end in an ':' or '/'.
3171 - Environment variables are expanded |:set_env|.
3172 - Careful with '\' characters, type one before a space, type two to
3173 get one in the option (see |option-backslash|), for example: >
3174 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3175< - For backwards compatibility with Vim version 3.0 a '>' at the start
3176 of the option is removed.
3177 Using "." first in the list is recommended. This means that editing
3178 the same file twice will result in a warning. Using "/tmp" on Unix is
3179 discouraged: When the system crashes you lose the swap file.
3180 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003181 choice than "/tmp". But others on the computer may be able to see the
3182 files, and it can contain a lot of files, your swap files get lost in
3183 the crowd. That is why a "tmp" directory in your home directory is
3184 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 The use of |:set+=| and |:set-=| is preferred when adding or removing
3186 directories from the list. This avoids problems when a future version
3187 uses another default.
3188 This option cannot be set from a |modeline| or in the |sandbox|, for
3189 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190
3191 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003192'display' 'dy' string (default "", set to "truncate" in
3193 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003195 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 flags:
3197 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003198 in a window will be displayed. "@@@" is put in the
3199 last columns of the last screen line to indicate the
3200 rest of the line is not displayed.
3201 truncate Like "lastline", but "@@@" is displayed in the first
3202 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 uhex Show unprintable characters hexadecimal as <xx>
3204 instead of using ^C and ~C.
3205
Bram Moolenaard0796902016-09-16 20:02:31 +02003206 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003207 doesn't fit is replaced with "@" lines.
3208
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003209 The "@" character can be changed by setting the "lastline" item in
3210 'fillchars'. The character is highlighted with |hl-NonText|.
3211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 *'eadirection'* *'ead'*
3213'eadirection' 'ead' string (default "both")
3214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 Tells when the 'equalalways' option applies:
3216 ver vertically, width of windows is not affected
3217 hor horizontally, height of windows is not affected
3218 both width and height of windows is affected
3219
3220 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3221'edcompatible' 'ed' boolean (default off)
3222 global
3223 Makes the 'g' and 'c' flags of the ":substitute" command to be
3224 toggled each time the flag is given. See |complex-change|. See
3225 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003226 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003227 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228
Bram Moolenaar03413f42016-04-12 21:07:15 +02003229 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003230'emoji' 'emo' boolean (default: on)
3231 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003232 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003233 This excludes "text emoji" characters, which are normally displayed as
3234 single width. Unfortunately there is no good specification for this
3235 and it has been determined on trial-and-error basis. Use the
3236 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003239'encoding' 'enc' string (default for MS-Windows: "utf-8",
3240 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Sets the character encoding used inside Vim. It applies to text in
3243 the buffers, registers, Strings in expressions, text stored in the
3244 viminfo file, etc. It sets the kind of characters which Vim can work
3245 with. See |encoding-names| for the possible values.
3246
3247 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003248 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003250 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251
Bram Moolenaar865242e2010-07-14 21:12:05 +02003252 This option cannot be set from a |modeline|. It would most likely
3253 corrupt the text.
3254
Bram Moolenaar3df01732017-02-17 22:47:16 +01003255 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3256 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 'encoding', "utf-8" is the natural choice for the environment and
3258 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003259 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 versions, and to avoid changing the encoding of newly created files
3261 without your knowledge (in case 'fileencodings' is empty).
3262
3263 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003264 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 iconv() or as specified with 'charconvert'.
3266
Bram Moolenaar207f0092020-08-30 17:20:20 +02003267 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003268 can use: >
3269 if has("multi_byte_encoding")
3270<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 Normally 'encoding' will be equal to your current locale. This will
3272 be the default if Vim recognizes your environment settings. If
3273 'encoding' is not set to the current locale, 'termencoding' must be
3274 set to convert typed and displayed text. See |encoding-table|.
3275
3276 When you set this option, it fires the |EncodingChanged| autocommand
3277 event so that you can set up fonts if necessary.
3278
3279 When the option is set, the value is converted to lowercase. Thus
3280 you can set it with uppercase values too. Underscores are translated
3281 to '-' signs.
3282 When the encoding is recognized, it is changed to the standard name.
3283 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3284 "iso-8859-2" and "utf8" becomes "utf-8".
3285
3286 Note: "latin1" is also used when the encoding could not be detected.
3287 This only works when editing files in the same encoding! When the
3288 actual character set is not latin1, make sure 'fileencoding' and
3289 'fileencodings' are empty. When conversion is needed, switch to using
3290 utf-8.
3291
3292 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3293 You don't notice this while editing, but it does matter for the
3294 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3295 setting 'encoding' to one of these values instead of utf-8 only has
3296 effect for encoding used for files when 'fileencoding' is empty.
3297
Bram Moolenaar661b1822005-07-28 22:36:45 +00003298 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3299 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003301 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003302'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003304 Indicates that a CTRL-Z character was found at the end of the file
3305 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003307 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003308 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003309 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003310
3311 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3312'endofline' 'eol' boolean (default on)
3313 local to buffer
3314 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003315 is on, or 'fixeol' option is off, no <EOL> will be written for the
3316 last line in the file. This option is automatically set or reset when
3317 starting to edit a new file, depending on whether file has an <EOL>
3318 for the last line in the file. Normally you don't have to set or
3319 reset this option.
3320 When 'binary' is off and 'fixeol' is on the value is not used when
3321 writing the file. When 'binary' is on or 'fixeol' is off it is used
3322 to remember the presence of a <EOL> for the last line in the file, so
3323 that when you write the file the situation from the original file can
3324 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003325 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326
3327 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3328'equalalways' 'ea' boolean (default on)
3329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003331 splitting or closing a window. This also happens the moment the
3332 option is switched on. When off, splitting a window will reduce the
3333 size of the current window and leave the other windows the same. When
3334 closing a window the extra lines are given to the window next to it
3335 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 When mixing vertically and horizontally split windows, a minimal size
3337 is computed and some windows may be larger if there is room. The
3338 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003339 Changing the height and width of a window can be avoided by setting
3340 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003341 If a window size is specified when creating a new window sizes are
3342 currently not equalized (it's complicated, but may be implemented in
3343 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344
3345 *'equalprg'* *'ep'*
3346'equalprg' 'ep' string (default "")
3347 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003349 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003350 or 'indentexpr'. When Vim was compiled without internal formatting,
3351 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003352 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 about including spaces and backslashes.
3354 This option cannot be set from a |modeline| or in the |sandbox|, for
3355 security reasons.
3356
3357 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3358'errorbells' 'eb' boolean (default off)
3359 global
3360 Ring the bell (beep or screen flash) for error messages. This only
3361 makes a difference for error messages, the bell will be used always
3362 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003363 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003364 screen flash or do nothing. See 'belloff' to finetune when to ring the
3365 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366
3367 *'errorfile'* *'ef'*
3368'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3369 others: "errors.err")
3370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 {not available when compiled without the |+quickfix|
3372 feature}
3373 Name of the errorfile for the QuickFix mode (see |:cf|).
3374 When the "-q" command-line argument is used, 'errorfile' is set to the
3375 following argument. See |-q|.
3376 NOT used for the ":make" command. See 'makeef' for that.
3377 Environment variables are expanded |:set_env|.
3378 See |option-backslash| about including spaces and backslashes.
3379 This option cannot be set from a |modeline| or in the |sandbox|, for
3380 security reasons.
3381
3382 *'errorformat'* *'efm'*
3383'errorformat' 'efm' string (default is very long)
3384 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 {not available when compiled without the |+quickfix|
3386 feature}
3387 Scanf-like description of the format for the lines in the error file
3388 (see |errorformat|).
3389
3390 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3391'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 Function keys that start with an <Esc> are recognized in Insert
3394 mode. When this option is off, the cursor and function keys cannot be
3395 used in Insert mode if they start with an <Esc>. The advantage of
3396 this is that the single <Esc> is recognized immediately, instead of
3397 after one second. Instead of resetting this option, you might want to
3398 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3399 when 'esckeys' is off, you can still map anything, but the cursor keys
3400 won't work by default.
3401 NOTE: This option is set to the Vi default value when 'compatible' is
3402 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003403 NOTE: when this option is off then the |modifyOtherKeys| and
3404 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3405 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406
3407 *'eventignore'* *'ei'*
3408'eventignore' 'ei' string (default "")
3409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003411 When set to "all" or when "all" is one of the items, all autocommand
3412 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003413 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 :set ei=WinEnter,WinLeave
3415<
Luuk van Baal8cc6d8b2025-05-31 12:10:31 +02003416 To ignore all but some events, a "-" prefix can be used: >
3417 :set ei=all,-WinLeave
3418<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003419 *'eventignorewin'* *'eiw'*
3420'eventignorewin' 'eiw' string (default "")
3421 window-local
3422 Similar to 'eventignore' but applies to a particular window and its
3423 buffers, for which window and buffer related autocommands can be
3424 ignored indefinitely without affecting the global 'eventignore'.
3425
glepnir631a50c2025-06-15 16:05:10 +02003426 Note: The following events are considered to happen outside of a
3427 window context and thus cannot be ignored by 'eventignorewin':
3428
3429 |CmdlineChanged|,
3430 |CmdlineEnter|,
3431 |CmdlineLeave|,
3432 |CmdlineLeavePre|,
3433 |CmdUndefined|,
3434 |CmdwinEnter|,
3435 |CmdwinLeave|,
3436 |ColorScheme|,
3437 |ColorSchemePre|,
3438 |CompleteChanged|,
3439 |CompleteDone|,
3440 |CompleteDonePre|,
3441 |DiffUpdated|,
3442 |DirChanged|,
3443 |DirChangedPre|,
3444 |EncodingChanged|,
3445 |ExitPre|,
3446 |FocusGained|,
3447 |FocusLost|,
3448 |FuncUndefined|,
3449 |GUIEnter|,
3450 |GUIFailed|,
3451 |KeyInputPre|,
3452 |MenuPopup|,
3453 |ModeChanged|,
3454 |OptionSet|,
3455 |QuickFixCmdPost|,
3456 |QuickFixCmdPre|,
3457 |QuitPre|,
3458 |RemoteReply|,
3459 |SafeState|,
3460 |SafeStateAgain|,
3461 |SessionLoadPost|,
3462 |SessionWritePost|,
3463 |ShellCmdPost|,
3464 |SigUSR1|,
3465 |SourceCmd|,
3466 |SourcePost|,
3467 |SourcePre|,
3468 |SpellFileMissing|,
3469 |StdinReadPost|,
3470 |StdinReadPre|,
3471 |SwapExists|,
3472 |Syntax|,
3473 |TabClosed|,
3474 |TabClosedPre|,
3475 |TabEnter|,
3476 |TabLeave|,
3477 |TabNew|,
3478 |TermChanged|,
3479 |TerminalOpen|,
3480 |TerminalWinOpen|,
3481 |TermResponse|,
3482 |TermResponseAll|,
3483 |User|,
3484 |VimEnter|,
3485 |VimLeave|,
3486 |VimLeavePre|,
3487 |VimResized|,
3488 |VimResume|,
3489 |VimSuspend|,
3490 |WinNew|,
3491 |WinNewPre|
3492
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3494'expandtab' 'et' boolean (default off)
3495 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003497 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3499 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003500 This option is reset when the 'paste' option is set and restored when
3501 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 NOTE: This option is reset when 'compatible' is set.
3503
3504 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3505'exrc' 'ex' boolean (default off)
3506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003508 directory.
3509
3510 Setting this option is a potential security leak. E.g., consider
3511 unpacking a package or fetching files from github, a .vimrc in there
3512 might be a trojan horse. BETTER NOT SET THIS OPTION!
3513 Instead, define an autocommand in your .vimrc to set options for a
3514 matching directory.
3515
3516 If you do switch this option on you should also consider setting the
3517 'secure' option (see |initialization|).
3518 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 This option cannot be set from a |modeline| or in the |sandbox|, for
3520 security reasons.
3521
3522 *'fileencoding'* *'fenc'* *E213*
3523'fileencoding' 'fenc' string (default: "")
3524 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003526
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003528 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 When 'fileencoding' is empty, the same value as 'encoding' will be
3530 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003531 No error will be given when the value is set, only when it is used,
3532 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003533 Conversion will also be done when 'encoding' and 'fileencoding' are
3534 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3535 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003537 'encoding' is "utf-8" or another Unicode encoding, conversion
3538 is most likely done in a way that the reverse conversion
3539 results in the same text. When 'encoding' is not "utf-8" some
3540 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 See 'encoding' for the possible values. Additionally, values may be
3543 specified that can be handled by the converter, see
3544 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 When reading a file 'fileencoding' will be set from 'fileencodings'.
3547 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003548 'fileencoding', use the |++enc| argument. One exception: when
3549 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003550 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003551
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3553 When the option is set, the value is converted to lowercase. Thus
3554 you can set it with uppercase values too. '_' characters are
3555 replaced with '-'. If a name is recognized from the list for
3556 'encoding', it is replaced by the standard name. For example
3557 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003558
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 When this option is set, after starting to edit a file, the 'modified'
3560 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003561
3562 Keep in mind that changing 'fenc' from a modeline happens
3563 AFTER the text has been read, thus it applies to when the file will be
3564 written. If you do set 'fenc' in a modeline, you might want to set
3565 'nomodified' to avoid not being able to ":q".
3566
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 This option can not be changed when 'modifiable' is off.
3568
3569 *'fe'*
3570 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003571 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 old short name was 'fe', which is no longer used.
3573
3574 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003575'fileencodings' 'fencs' string (default: "ucs-bom",
3576 "ucs-bom,utf-8,default,latin1" when
3577 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 This is a list of character encodings considered when starting to edit
3580 an existing file. When a file is read, Vim tries to use the first
3581 mentioned character encoding. If an error is detected, the next one
3582 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003583 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 an empty string, which means the value of 'encoding' is used.
3585 WARNING: Conversion can cause loss of information! When
3586 'encoding' is "utf-8" (or one of the other Unicode variants)
3587 conversion is most likely done in a way that the reverse
3588 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003589 "utf-8" some non-ASCII characters may be lost! You can use
3590 the |++bad| argument to specify what is done with characters
3591 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 For an empty file or a file with only ASCII characters most encodings
3593 will work and the first entry of 'fileencodings' will be used (except
3594 "ucs-bom", which requires the BOM to be present). If you prefer
3595 another encoding use an BufReadPost autocommand event to test if your
3596 preferred encoding is to be used. Example: >
3597 au BufReadPost * if search('\S', 'w') == 0 |
3598 \ set fenc=iso-2022-jp | endif
3599< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3600 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003601 When the |++enc| argument is used then the value of 'fileencodings' is
3602 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003603 Note that 'fileencodings' is not used for a new file, the global value
3604 of 'fileencoding' is used instead. You can set it with: >
3605 :setglobal fenc=iso-8859-2
3606< This means that a non-existing file may get a different encoding than
3607 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 The special value "ucs-bom" can be used to check for a Unicode BOM
3609 (Byte Order Mark) at the start of the file. It must not be preceded
3610 by "utf-8" or another Unicode encoding for this to work properly.
3611 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3612 because Vim cannot detect an error, thus the encoding is always
3613 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003614 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003615 environment. On MS-Windows this is the system encoding. Otherwise
3616 this is the default value for 'encoding'. It is useful when
3617 'encoding' is set to "utf-8" and your environment uses a non-latin1
3618 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003619 When 'encoding' is "utf-8" and a file contains an illegal byte
3620 sequence it won't be recognized as UTF-8. You can use the |8g8|
3621 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 WRONG VALUES: WHAT'S WRONG:
3623 latin1,utf-8 "latin1" will always be used
3624 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3625 file
3626 cp1250,latin1 "cp1250" will always be used
3627 If 'fileencodings' is empty, 'fileencoding' is not modified.
3628 See 'fileencoding' for the possible values.
3629 Setting this option does not have an effect until the next time a file
3630 is read.
3631
3632 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003633'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003634 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 This gives the <EOL> of the current buffer, which is used for
3637 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003638 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 unix <NL>
3640 mac <CR>
3641 When "dos" is used, CTRL-Z at the end of a file is ignored.
3642 See |file-formats| and |file-read|.
3643 For the character encoding of the file see 'fileencoding'.
3644 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003645 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 This option is set automatically when starting to edit a file and
3647 'fileformats' is not empty and 'binary' is off.
3648 When this option is set, after starting to edit a file, the 'modified'
3649 option is set, because the file would be different when written.
3650 This option can not be changed when 'modifiable' is off.
3651 For backwards compatibility: When this option is set to "dos",
3652 'textmode' is set, otherwise 'textmode' is reset.
3653
3654 *'fileformats'* *'ffs'*
3655'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003656 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003657 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 Vi Cygwin: "unix,dos",
3659 Vi others: "")
3660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 This gives the end-of-line (<EOL>) formats that will be tried when
3662 starting to edit a new buffer and when reading a file into an existing
3663 buffer:
3664 - When empty, the format defined with 'fileformat' will be used
3665 always. It is not set automatically.
3666 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003667 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 'fileformats' name will be used when a file is read into an existing
3669 buffer, no matter what 'fileformat' for that buffer is set to.
3670 - When more than one name is present, separated by commas, automatic
3671 <EOL> detection will be done when reading a file. When starting to
3672 edit a file, a check is done for the <EOL>:
3673 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3674 'fileformat' is set to "dos".
3675 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003676 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003678 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3679 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003680 This means that "mac" is only chosen when:
3681 "unix" is not present or no <NL> is found in the file, and
3682 "dos" is not present or no <CR><NL> is found in the file.
3683 Except: if "unix" was chosen, but there is a <CR> before
3684 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003685 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 4. If 'fileformat' is still not set, the first name from
3687 'fileformats' is used.
3688 When reading a file into an existing buffer, the same is done, but
3689 this happens like 'fileformat' has been set appropriately for that
3690 file only, the option is not changed.
3691 When 'binary' is set, the value of 'fileformats' is not used.
3692
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003693 When Vim starts up with an empty buffer the first item is used. You
3694 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003695
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3697 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3698 done:
3699 - When 'fileformats' is empty, there is no automatic detection. Dos
3700 format will be used.
3701 - When 'fileformats' is set to one or more names, automatic detection
3702 is done. This is based on the first <NL> in the file: If there is a
3703 <CR> in front of it, Dos format is used, otherwise Unix format is
3704 used.
3705 Also see |file-formats|.
3706 For backwards compatibility: When this option is set to an empty
3707 string or one format (no comma is included), 'textauto' is reset,
3708 otherwise 'textauto' is set.
3709 NOTE: This option is set to the Vi default value when 'compatible' is
3710 set and to the Vim default value when 'compatible' is reset.
3711
Bram Moolenaarbf884932013-04-05 22:26:15 +02003712 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3713'fileignorecase' 'fic' boolean (default on for systems where case in file
3714 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003715 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003716 When set case is ignored when using file names and directories.
3717 See 'wildignorecase' for only ignoring case when doing completion.
3718
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 *'filetype'* *'ft'*
3720'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003721 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 When this option is set, the FileType autocommand event is triggered.
3723 All autocommands that match with the value of this option will be
3724 executed. Thus the value of 'filetype' is used in place of the file
3725 name.
3726 Otherwise this option does not always reflect the current file type.
3727 This option is normally set when the file type is detected. To enable
3728 this use the ":filetype on" command. |:filetype|
3729 Setting this option to a different value is most useful in a modeline,
3730 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003731 Example, for in an IDL file:
3732 /* vim: set filetype=idl : */ ~
3733 |FileType| |filetypes|
3734 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003735 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003736 /* vim: set filetype=c.doxygen : */ ~
3737 This will use the "c" filetype first, then the "doxygen" filetype.
3738 This works both for filetype plugins and for syntax files. More than
3739 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 This option is not copied to another buffer, independent of the 's' or
3741 'S' flag in 'cpoptions'.
Christian Brabandtf0c70902025-05-26 21:18:19 +02003742 Only alphanumeric characters, '-' and '_' can be used (and a '.' is
Doug Kearnsa6172f82025-05-26 20:32:35 +02003743 allowed as delimiter when combining different filetypes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
3745 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003746'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003747 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003748 Characters to fill the statuslines, vertical separators, special
3749 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003750 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003751 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003753 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003754 stl ' ' statusline of the current window
3755 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003756 vert '|' vertical separators |:vsplit|
3757 fold '-' filling 'foldtext'
3758 foldopen '-' mark the beginning of a fold
3759 foldclose '+' show a closed fold
3760 foldsep '|' open fold middle character
3761 diff '-' deleted lines of the 'diff' option
3762 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003763 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003764 trunc '>' truncated text in the
3765 |ins-completion-menu|.
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02003766 truncrl '<' same as "trunc" in 'rightleft' mode
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003767 tpl_vert '|' vertical separators of 'tabpanel'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003769 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770
3771 Example: >
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02003772 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-,tpl_vert:\|
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003773<
Hirohito Higashi0553f2f2025-05-10 14:56:17 +02003774 All items support single-byte and multibyte characters. But
3775 double-width characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003776
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003778 item name highlight group ~
3779 stl StatusLine |hl-StatusLine|
3780 stlnc StatusLineNC |hl-StatusLineNC|
3781 vert VertSplit |hl-VertSplit|
3782 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003783 foldopen FoldColumn |hl-FoldColumn|
3784 foldclose FoldColumn |hl-FoldColumn|
3785 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003786 diff DiffDelete |hl-DiffDelete|
3787 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003788 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003789 trunc one of the many Popup menu highlighting groups like
3790 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003791 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003793 *'findfunc'* *'ffu'* *E1514*
3794'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003795 global or local to buffer |global-local|
3796 {not available when compiled without the |+eval|
3797 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003798 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003799 command. When this option is empty, the internal |file-searching|
3800 mechanism is used.
3801
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003802 The value can be the name of a function, a |lambda| or a |Funcref|.
3803 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003804
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003805 The function is called with two arguments. The first argument is a
3806 |String| and is the |:find| command argument. The second argument is
3807 a |Boolean| and is set to |v:true| when the function is called to get
3808 a List of command-line completion matches for the |:find| command.
3809 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003810
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003811 The function is called only once per |:find| command invocation.
3812 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003813
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003814 If a match is found, the function should return a |List| containing
3815 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003816 should return an empty List.
3817
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003818 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003819 empty List is used as the return value.
3820
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003821 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003822 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003823
3824 This option cannot be set from a |modeline| or in the |sandbox|, for
3825 security reasons.
3826
3827 Examples:
3828>
3829 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003830 func FindFuncGlob(cmdarg, cmdcomplete)
3831 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003832 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003833 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003834 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003835
3836 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003837 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003838 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003839 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003840 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003841 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003842<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003843 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3844'fixendofline' 'fixeol' boolean (default on)
3845 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003846 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003847 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003848 preserve the situation from the original file.
3849 When the 'binary' option is set the value of this option doesn't
3850 matter.
3851 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003852 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003853
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003855'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 {only available when compiled with the |+rightleft|
3858 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003859 This option was for using Farsi, which has been removed. See
3860 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861
3862 *'foldclose'* *'fcl'*
3863'foldclose' 'fcl' string (default "")
3864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 {not available when compiled without the |+folding|
3866 feature}
3867 When set to "all", a fold is closed when the cursor isn't in it and
3868 its level is higher than 'foldlevel'. Useful if you want folds to
3869 automatically close when moving out of them.
3870
3871 *'foldcolumn'* *'fdc'*
3872'foldcolumn' 'fdc' number (default 0)
3873 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 {not available when compiled without the |+folding|
3875 feature}
3876 When non-zero, a column with the specified width is shown at the side
3877 of the window which indicates open and closed folds. The maximum
3878 value is 12.
3879 See |folding|.
3880
3881 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3882'foldenable' 'fen' boolean (default on)
3883 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 {not available when compiled without the |+folding|
3885 feature}
3886 When off, all folds are open. This option can be used to quickly
3887 switch between showing all text unfolded and viewing the text with
3888 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003889 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'foldenable' is off.
3891 This option is set by commands that create a new fold or close a fold.
3892 See |folding|.
3893
3894 *'foldexpr'* *'fde'*
3895'foldexpr' 'fde' string (default: "0")
3896 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003898 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003900 for each line to obtain its fold level. The context is set to the
3901 script where 'foldexpr' was set, script-local items can be accessed.
3902 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003903
Bram Moolenaar30b65812012-07-12 22:01:11 +02003904 The expression will be evaluated in the |sandbox| if set from a
3905 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003906 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003907 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003908
3909 It is not allowed to change text or jump to another window while
3910 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911
3912 *'foldignore'* *'fdi'*
3913'foldignore' 'fdi' string (default: "#")
3914 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 {not available when compiled without the |+folding|
3916 feature}
3917 Used only when 'foldmethod' is "indent". Lines starting with
3918 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003919 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 The default "#" works well for C programs. See |fold-indent|.
3921
3922 *'foldlevel'* *'fdl'*
3923'foldlevel' 'fdl' number (default: 0)
3924 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 {not available when compiled without the |+folding|
3926 feature}
3927 Sets the fold level: Folds with a higher level will be closed.
3928 Setting this option to zero will close all folds. Higher numbers will
3929 close fewer folds.
3930 This option is set by commands like |zm|, |zM| and |zR|.
3931 See |fold-foldlevel|.
3932
3933 *'foldlevelstart'* *'fdls'*
3934'foldlevelstart' 'fdls' number (default: -1)
3935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 {not available when compiled without the |+folding|
3937 feature}
3938 Sets 'foldlevel' when starting to edit another buffer in a window.
3939 Useful to always start editing with all folds closed (value zero),
3940 some folds closed (one) or no folds closed (99).
3941 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003942 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 ignores this option and closes all folds.
3944 It is also done before BufReadPre autocommands, to allow an autocmd to
3945 overrule the 'foldlevel' value for specific files.
3946 When the value is negative, it is not used.
3947
3948 *'foldmarker'* *'fmr'* *E536*
3949'foldmarker' 'fmr' string (default: "{{{,}}}")
3950 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 {not available when compiled without the |+folding|
3952 feature}
3953 The start and end marker used when 'foldmethod' is "marker". There
3954 must be one comma, which separates the start and end marker. The
3955 marker is a literal string (a regular expression would be too slow).
3956 See |fold-marker|.
3957
3958 *'foldmethod'* *'fdm'*
3959'foldmethod' 'fdm' string (default: "manual")
3960 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 {not available when compiled without the |+folding|
3962 feature}
3963 The kind of folding used for the current window. Possible values:
3964 |fold-manual| manual Folds are created manually.
3965 |fold-indent| indent Lines with equal indent form a fold.
3966 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3967 |fold-marker| marker Markers are used to specify folds.
3968 |fold-syntax| syntax Syntax highlighting items specify folds.
3969 |fold-diff| diff Fold text that is not changed.
3970
3971 *'foldminlines'* *'fml'*
3972'foldminlines' 'fml' number (default: 1)
3973 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 {not available when compiled without the |+folding|
3975 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003976 Sets the number of screen lines above which a fold can be displayed
3977 closed. Also for manually closed folds. With the default value of
3978 one a fold can only be closed if it takes up two or more screen lines.
3979 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003980 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 "zc" to close a fold, which is displayed open because it's smaller
3982 than 'foldminlines', a following "zc" may close a containing fold.
3983
3984 *'foldnestmax'* *'fdn'*
3985'foldnestmax' 'fdn' number (default: 20)
3986 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {not available when compiled without the |+folding|
3988 feature}
3989 Sets the maximum nesting of folds for the "indent" and "syntax"
3990 methods. This avoids that too many folds will be created. Using more
3991 than 20 doesn't work, because the internal limit is 20.
3992
3993 *'foldopen'* *'fdo'*
3994'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3995 search,tag,undo")
3996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 {not available when compiled without the |+folding|
3998 feature}
3999 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004000 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02004002 NOTE: When the command is part of a mapping this option is not used.
4003 Add the |zv| command to the mapping to get the same effect.
4004 (rationale: the mapping may want to control opening folds itself)
4005
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 item commands ~
4007 all any
4008 block "(", "{", "[[", "[{", etc.
4009 hor horizontal movements: "l", "w", "fx", etc.
4010 insert any command in Insert mode
4011 jump far jumps: "G", "gg", etc.
4012 mark jumping to a mark: "'m", CTRL-O, etc.
4013 percent "%"
4014 quickfix ":cn", ":crew", ":make", etc.
4015 search search for a pattern: "/", "n", "*", "gd", etc.
4016 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004017 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 tag jumping to a tag: ":ta", CTRL-T, etc.
4019 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 When a movement command is used for an operator (e.g., "dl" or "y%")
4021 this option is not used. This means the operator will include the
4022 whole closed fold.
4023 Note that vertical movements are not here, because it would make it
4024 very difficult to move onto a closed fold.
4025 In insert mode the folds containing the cursor will always be open
4026 when text is inserted.
4027 To close folds you can re-apply 'foldlevel' with the |zx| command or
4028 set the 'foldclose' option to "all".
4029
4030 *'foldtext'* *'fdt'*
4031'foldtext' 'fdt' string (default: "foldtext()")
4032 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 {not available when compiled without the |+folding|
4034 feature}
4035 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004036 fold. The context is set to the script where 'foldexpr' was set,
4037 script-local items can be accessed. See |fold-foldtext| for the
4038 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039
Bram Moolenaar30b65812012-07-12 22:01:11 +02004040 The expression will be evaluated in the |sandbox| if set from a
4041 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004042 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004043
4044 It is not allowed to change text or jump to another window while
4045 evaluating 'foldtext' |textlock|.
4046
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004047 *'formatexpr'* *'fex'*
4048'formatexpr' 'fex' string (default "")
4049 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004050 {not available when compiled without the |+eval|
4051 feature}
4052 Expression which is evaluated to format a range of lines for the |gq|
4053 operator or automatic formatting (see 'formatoptions'). When this
4054 option is empty 'formatprg' is used.
4055
4056 The |v:lnum| variable holds the first line to be formatted.
4057 The |v:count| variable holds the number of lines to be formatted.
4058 The |v:char| variable holds the character that is going to be
4059 inserted if the expression is being evaluated due to
4060 automatic formatting. This can be empty. Don't insert
4061 it yet!
4062
4063 Example: >
4064 :set formatexpr=mylang#Format()
4065< This will invoke the mylang#Format() function in the
4066 autoload/mylang.vim file in 'runtimepath'. |autoload|
4067
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004068 The advantage of using a function call without arguments is that it is
4069 faster, see |expr-option-function|.
4070
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004071 The expression is also evaluated when 'textwidth' is set and adding
4072 text beyond that limit. This happens under the same conditions as
4073 when internal formatting is used. Make sure the cursor is kept in the
4074 same spot relative to the text then! The |mode()| function will
4075 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004076
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004077 When the expression evaluates to non-zero Vim will fall back to using
4078 the internal format mechanism.
4079
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004080 If the expression starts with s: or |<SID>|, then it is replaced with
4081 the script ID (|local-function|). Example: >
4082 set formatexpr=s:MyFormatExpr()
4083 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004084< Otherwise, the expression is evaluated in the context of the script
4085 where the option was set, thus script-local items are available.
4086
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004087 The expression will be evaluated in the |sandbox| when set from a
4088 modeline, see |sandbox-option|. That stops the option from working,
4089 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004090 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004091 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02004092
Bram Moolenaar86b68352004-12-27 21:59:20 +00004093 *'formatlistpat'* *'flp'*
4094'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
4095 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00004096 A pattern that is used to recognize a list header. This is used for
4097 the "n" flag in 'formatoptions'.
4098 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00004099 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00004100 while still checking more characters. There must be a character
4101 following the pattern, when it matches the whole line it is handled
4102 like there is no match.
4103 The default recognizes a number, followed by an optional punctuation
4104 character and white space.
4105
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004106 *'formatoptions'* *'fo'*
4107'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
4108 local to buffer
4109 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01004110 formatting is to be done.
4111 See |fo-table| for possible values and |gq| for how to format text.
4112 When the 'paste' option is on, no formatting is done (like
4113 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004114 To avoid problems with flags that are added in the future, use the
4115 "+=" and "-=" feature of ":set" |add-option-flags|.
4116 NOTE: This option is set to the Vi default value when 'compatible' is
4117 set and to the Vim default value when 'compatible' is reset.
4118
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 *'formatprg'* *'fp'*
4120'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004121 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004123 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004125 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004126 If the 'formatexpr' option is not empty it will be used instead.
4127 Otherwise, if 'formatprg' option is an empty string, the internal
4128 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004129 Environment variables are expanded |:set_env|. See |option-backslash|
4130 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004131 This option cannot be set from a |modeline| or in the |sandbox|, for
4132 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133
Bram Moolenaard94464e2015-11-02 15:28:18 +01004134 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004135'fsync' 'fs' boolean (default on)
4136 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004137 When on, the library function fsync() will be called after writing a
4138 file. This will flush a file to disk, ensuring that it is safely
4139 written even on filesystems which do metadata-only journaling. This
4140 will force the harddrive to spin up on Linux systems running in laptop
4141 mode, so it may be undesirable in some situations. Be warned that
4142 turning this off increases the chances of data loss after a crash. On
4143 systems without an fsync() implementation, this variable is always
4144 off.
4145 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004146 'fsync' also applies to |writefile()| (unless a flag is used to
4147 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004148 This option cannot be set from a |modeline| or in the |sandbox|, for
4149 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004150
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4152'gdefault' 'gd' boolean (default off)
4153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 When on, the ":substitute" flag 'g' is default on. This means that
4155 all matches in a line are substituted instead of one. When a 'g' flag
4156 is given to a ":substitute" command, this will toggle the substitution
4157 of all or one match. See |complex-change|.
4158
4159 command 'gdefault' on 'gdefault' off ~
4160 :s/// subst. all subst. one
4161 :s///g subst. one subst. all
4162 :s///gg subst. all subst. one
4163
4164 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004165 Setting this option may break plugins that rely on the default
4166 behavior of the 'g' flag. This will also make the 'g' flag have the
4167 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004168 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169
4170 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004171'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
glepnir7b9eb632025-05-16 19:49:23 +02004172 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 Format to recognize for the ":grep" command output.
4174 This is a scanf-like string that uses the same format as the
4175 'errorformat' option: see |errorformat|.
4176
4177 *'grepprg'* *'gp'*
4178'grepprg' 'gp' string (default "grep -n ",
4179 Unix: "grep -n $* /dev/null",
4180 Win32: "findstr /n" or "grep -n",
4181 VMS: "SEARCH/NUMBERS ")
4182 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004183 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 and '#' characters, which are expanded like when used in a command-
4185 line. The placeholder "$*" is allowed to specify where the arguments
4186 will be included. Environment variables are expanded |:set_env|. See
4187 |option-backslash| about including spaces and backslashes.
4188 When your "grep" accepts the "-H" argument, use this to make ":grep"
4189 also work well with a single file: >
4190 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004191< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004192 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4193 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004194 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 apply equally to 'grepprg'.
4196 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4197 otherwise it's "grep -n".
4198 This option cannot be set from a |modeline| or in the |sandbox|, for
4199 security reasons.
4200
4201 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4202'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4203 ve:ver35-Cursor,
4204 o:hor50-Cursor,
4205 i-ci:ver25-Cursor/lCursor,
4206 r-cr:hor20-Cursor/lCursor,
4207 sm:block-Cursor
4208 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004209 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 "n-v-c:block,o:hor50,i-ci:hor15,
4211 r-cr:hor30,sm:block")
4212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004214 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004216 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004217 height of the cursor can be changed. This can be done by specifying a
4218 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004219 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4220 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004222 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 mode-list and an argument-list:
4224 mode-list:argument-list,mode-list:argument-list,..
4225 The mode-list is a dash separated list of these modes:
4226 n Normal mode
4227 v Visual mode
4228 ve Visual mode with 'selection' "exclusive" (same as 'v',
4229 if not specified)
4230 o Operator-pending mode
4231 i Insert mode
4232 r Replace mode
4233 c Command-line Normal (append) mode
4234 ci Command-line Insert mode
4235 cr Command-line Replace mode
4236 sm showmatch in Insert mode
4237 a all modes
4238 The argument-list is a dash separated list of these arguments:
4239 hor{N} horizontal bar, {N} percent of the character height
4240 ver{N} vertical bar, {N} percent of the character width
4241 block block cursor, fills the whole character
4242 [only one of the above three should be present]
4243 blinkwait{N} *cursor-blinking*
4244 blinkon{N}
4245 blinkoff{N}
4246 blink times for cursor: blinkwait is the delay before
4247 the cursor starts blinking, blinkon is the time that
4248 the cursor is shown and blinkoff is the time that the
4249 cursor is not shown. The times are in msec. When one
4250 of the numbers is zero, there is no blinking. The
4251 default is: "blinkwait700-blinkon400-blinkoff250".
4252 These numbers are used for a missing entry. This
4253 means that blinking is enabled by default. To switch
4254 blinking off you can use "blinkon0". The cursor only
4255 blinks when Vim is waiting for input, not while
4256 executing a command.
4257 To make the cursor blink in an xterm, see
4258 |xterm-blink|.
4259 {group-name}
4260 a highlight group name, that sets the color and font
4261 for the cursor
4262 {group-name}/{group-name}
4263 Two highlight group names, the first is used when
4264 no language mappings are used, the other when they
4265 are. |language-mapping|
4266
4267 Examples of parts:
4268 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4269 block cursor with colors from the "nCursor"
4270 highlight group
4271 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4272 In Insert and Command-line Insert mode, use a
4273 30% vertical bar cursor with colors from the
4274 "iCursor" highlight group. Blink a bit
4275 faster.
4276
4277 The 'a' mode is different. It will set the given argument-list for
4278 all modes. It does not reset anything to defaults. This can be used
4279 to do a common setting for all modes. For example, to switch off
4280 blinking: "a:blinkon0"
4281
4282 Examples of cursor highlighting: >
4283 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4284 :highlight Cursor gui=NONE guifg=bg guibg=fg
4285<
4286 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004287 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288'guifont' 'gfn' string (default "")
4289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 {only available when compiled with GUI enabled}
4291 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004292 In its simplest form the value is just one font name.
4293 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294
4295 *'guifontset'* *'gfs'*
4296 *E250* *E252* *E234* *E597* *E598*
4297'guifontset' 'gfs' string (default "")
4298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 {only available when compiled with GUI enabled and
4300 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004301 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 When not empty, specifies two (or more) fonts to be used. The first
4303 one for normal English, the second one for your special language. See
4304 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004305
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4307'guifontwide' 'gfw' string (default "")
4308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 {only available when compiled with GUI enabled}
4310 When not empty, specifies a comma-separated list of fonts to be used
4311 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004312 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'guiheadroom'* *'ghr'*
4315'guiheadroom' 'ghr' number (default 50)
4316 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004317 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 The number of pixels subtracted from the screen height when fitting
4319 the GUI window on the screen. Set this before the GUI is started,
4320 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004321 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 lines will be left for window decorations and other items on the
4323 screen. Set it to a negative value to allow windows taller than the
4324 screen.
4325
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004326 *'guiligatures'* *'gli'* *E1243*
4327'guiligatures' 'gli' string (default "")
4328 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004329 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004330 List of ASCII characters that, when combined together, can create more
4331 complex shapes. Each character must be a printable ASCII character
4332 with a value in the 32-127 range.
4333 Example: >
4334 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4335< Changing this option updates screen output immediately. Set it to an
4336 empty string to disable ligatures.
4337
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004339'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4340 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004341 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004342 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004345 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 sequence of letters which describes what components and options of the
4347 GUI should be used.
4348 To avoid problems with flags that are added in the future, use the
4349 "+=" and "-=" feature of ":set" |add-option-flags|.
4350
Bram Moolenaar13568252018-03-16 20:46:58 +01004351 Valid characters are as follows:
4352 *'go-!'*
4353 '!' External commands are executed in a terminal window. Without
4354 this flag the MS-Windows GUI will open a console window to
4355 execute the command. The Unix GUI will simulate a dumb
4356 terminal to list the command output.
4357 The terminal window will be positioned at the bottom, and grow
4358 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004359 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 'a' Autoselect: If present, then whenever VISUAL mode is started,
4361 or the Visual area extended, Vim tries to become the owner of
4362 the windowing system's global selection. This means that the
4363 Visually highlighted text is available for pasting into other
4364 applications as well as into Vim itself. When the Visual mode
4365 ends, possibly due to an operation on the text, or when an
4366 application wants to paste the selection, the highlighted text
4367 is automatically yanked into the "* selection register.
4368 Thus the selection is still available for pasting into other
4369 applications after the VISUAL mode has ended.
4370 If not present, then Vim won't become the owner of the
4371 windowing system's global selection unless explicitly told to
4372 by a yank or delete operation for the "* register.
4373 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004374 *'go-P'*
4375 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004376 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004377 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004378 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 applies to the modeless selection.
4380
4381 'guioptions' autoselect Visual autoselect modeless ~
4382 "" - -
4383 "a" yes yes
4384 "A" - yes
4385 "aA" yes yes
4386
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004387 When using a terminal see the 'clipboard' option.
4388
Bram Moolenaar02467872007-05-06 13:22:01 +00004389 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 'c' Use console dialogs instead of popup dialogs for simple
4391 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004392 *'go-d'*
4393 'd' Use dark theme variant if available. Currently only works for
4394 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004395 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004396 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004397 'guitablabel' can be used to change the text in the labels.
4398 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004399 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004400 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004401 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 'f' Foreground: Don't use fork() to detach the GUI from the shell
4403 where it was started. Use this for programs that wait for the
4404 editor to finish (e.g., an e-mail program). Alternatively you
4405 can use "gvim -f" or ":gui -f" to start the GUI in the
4406 foreground. |gui-fork|
4407 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004408 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004409 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4411 corner of the window. It's black&white on non-GTK, because of
4412 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004413 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004415 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004416 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004418 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004420 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004421 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 'g' Grey menu items: Make menu items that are not active grey. If
4423 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004424 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 't' Include tearoff menu items. Currently only works for Win32,
4426 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004427 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004428 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4429 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004430 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004432 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 'R' Right-hand scrollbar is present when there is a vertically
4434 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004435 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004437 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 'L' Left-hand scrollbar is present when there is a vertically
4439 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004440 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4442 the longest visible line, or on the cursor line if the 'h'
4443 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004444 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 'h' Limit horizontal scrollbar size to the length of the cursor
4446 line. Reduces computations. |gui-horiz-scroll|
4447
4448 And yes, you may even have scrollbars on the left AND the right if
4449 you really want to :-). See |gui-scrollbars| for more information.
4450
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004451 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 'v' Use a vertical button layout for dialogs. When not included,
4453 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004454 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004455 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 'p' Use Pointer callbacks for X11 GUI. This is required for some
4457 window managers. If the cursor is not blinking or hollow at
4458 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004459 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004461 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004462 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004463 *'go-k'*
4464 'k' Keep the GUI window size when adding/removing a scrollbar, or
4465 toolbar, tabline, etc. Instead, the behavior is similar to
4466 when the window is maximized and will adjust 'lines' and
4467 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004468 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004469 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004470
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 *'guipty'* *'noguipty'*
4472'guipty' boolean (default on)
4473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 {only available when compiled with GUI enabled}
4475 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4476 I/O to/from shell commands. See |gui-pty|.
4477
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004478 *'guitablabel'* *'gtl'*
4479'guitablabel' 'gtl' string (default empty)
4480 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004481 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004482 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004483 pages line. When empty and when the result is empty Vim will use a
4484 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004485
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004486 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004487 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004488 The expression will be evaluated in the |sandbox| when set from a
4489 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004490 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004491
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004492 Only used when the GUI tab pages line is displayed. 'e' must be
4493 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4494 used.
4495
Bram Moolenaar57657d82006-04-21 22:12:41 +00004496 *'guitabtooltip'* *'gtt'*
4497'guitabtooltip' 'gtt' string (default empty)
4498 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004499 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004500 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004501 pages line. When empty Vim will use a default tooltip.
4502 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004503 You can include a line break. Simplest method is to use |:let|: >
4504 :let &guitabtooltip = "line one\nline two"
4505<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004506
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004508'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 (others) "$VIMRUNTIME/doc/help.txt")
4510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Name of the main help file. All distributed help files should be
4512 placed together in one directory. Additionally, all "doc" directories
4513 in 'runtimepath' will be used.
4514 Environment variables are expanded |:set_env|. For example:
4515 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004516 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 spaces and backslashes.
4518 This option cannot be set from a |modeline| or in the |sandbox|, for
4519 security reasons.
4520
4521 *'helpheight'* *'hh'*
4522'helpheight' 'hh' number (default 20)
4523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 Minimal initial height of the help window when it is opened with the
4525 ":help" command. The initial height of the help window is half of the
4526 current window, or (when the 'ea' option is on) the same as other
4527 windows. When the height is less than 'helpheight', the height is
4528 set to 'helpheight'. Set to zero to disable.
4529
4530 *'helplang'* *'hlg'*
4531'helplang' 'hlg' string (default: messages language or empty)
4532 global
4533 {only available when compiled with the |+multi_lang|
4534 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004535 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 for which the desired help can be found. The English help will always
4537 be used as a last resort. You can add "en" to prefer English over
4538 another language, but that will only find tags that exist in that
4539 language and not in the English help.
4540 Example: >
4541 :set helplang=de,it
4542< This will first search German, then Italian and finally English help
4543 files.
4544 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4545 try to find the tag in the current language before using this option.
4546 See |help-translated|.
4547
4548 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4549'hidden' 'hid' boolean (default off)
4550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 When off a buffer is unloaded when it is |abandon|ed. When on a
4552 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4553 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004554
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004556 hidden even if the 'hidden' option is off when these three are true:
4557 - the buffer is modified
4558 - 'autowrite' is off or writing is not possible
4559 - the '!' flag was used
4560 Also see |windows.txt|.
4561
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004562 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 This option is set for one command with ":hide {command}" |:hide|.
4564 WARNING: It's easy to forget that you have changes in hidden buffers.
4565 Think twice when using ":q!" or ":qa!".
4566
4567 *'highlight'* *'hl'*
4568'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004569 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4570 d:Directory,e:ErrorMsg,i:IncSearch,
4571 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004572 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004573 N:CursorLineNr,r:Question,s:StatusLine,
4574 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004575 v:Visual,V:VisualNOS,w:WarningMsg,
4576 W:WildMenu,f:Folded,F:FoldColumn,
4577 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004578 T:DiffText,E:DiffTextAdd,>:SignColumn,
4579 -:Conceal,B:SpellBad,P:SpellCap,
4580 R:SpellRare, L:SpellLocal,+:Pmenu,
4581 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004582 [:PmenuKind,]:PmenuKindSel,
4583 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004584 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4585 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004586 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004587 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004588 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004591 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004593 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004595 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4596 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 characters from 'showbreak'
4598 |hl-Directory| d directories in CTRL-D listing and other special
4599 things in listings
4600 |hl-ErrorMsg| e error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004602 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4604 |hl-MoreMsg| m |more-prompt|
4605 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004606 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004607 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004608 |hl-LineNr| n line number for ":number" and ":#" commands, and
4609 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004610 |hl-LineNrAbove| a line number above the cursor for when the
4611 'relativenumber' option is set.
4612 |hl-LineNrBelow| b line number below the cursor for when the
4613 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004614 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4615 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 |hl-Question| r |hit-enter| prompt and yes/no questions
4617 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004618 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4620 |hl-VertSplit| c column used to separate vertically split windows
4621 |hl-Visual| v Visual mode
Foxe Chenb90c2392025-06-27 21:10:35 +02004622 |hl-VisualNOS| V Visual mode when Vim is "Not Owning the
4623 Selection" Only X11 Gui's |gui-x11|,
4624 |xterm-clipboard| and |wayland-selections|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 |hl-WarningMsg| w warning messages
4626 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4627 |hl-Folded| f line used for closed folds
4628 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004629 |hl-DiffAdd| A added line in diff mode
4630 |hl-DiffChange| C changed line in diff mode
4631 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004632 |hl-DiffText| T changed text in diff mode
4633 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004635 |hl-Conceal| - the placeholders used for concealed characters
4636 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004637 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004638 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004639 |hl-SpellRare| R rare word |spell|
4640 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004641 |hl-Pmenu| + popup menu normal line
4642 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004643 |hl-PmenuKind| [ popup menu "kind" normal line
4644 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004645 |hl-PmenuExtra| { popup menu "extra" normal line
4646 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004647 |hl-PmenuSbar| x popup menu scrollbar
4648 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004649 |hl-PmenuMatch| k popup menu matched text
4650 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
4652 The display modes are:
4653 r reverse (termcap entry "mr" and "me")
4654 i italic (termcap entry "ZH" and "ZR")
4655 b bold (termcap entry "md" and "me")
4656 s standout (termcap entry "so" and "se")
4657 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004658 c undercurl (termcap entry "Us" and "Ce")
4659 2 double underline (termcap entry "Ds" and "Ce")
4660 d dotted underline (termcap entry "ds" and "Ce")
4661 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004662 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 n no highlighting
4664 - no highlighting
4665 : use a highlight group
4666 The default is used for occasions that are not included.
4667 If you want to change what the display modes do, see |dos-colors|
4668 for an example.
4669 When using the ':' display mode, this must be followed by the name of
4670 a highlight group. A highlight group can be used to define any type
4671 of highlighting, including using color. See |:highlight| on how to
4672 define one. The default uses a different group for each occasion.
4673 See |highlight-default| for the default highlight groups.
4674
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004676'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004679 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004680 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004681 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004682 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 NOTE: This option is set to the Vi default value when 'compatible' is
4684 set and to the Vim default value when 'compatible' is reset.
4685
4686 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4687'hkmap' 'hk' boolean (default off)
4688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 {only available when compiled with the |+rightleft|
4690 feature}
4691 When on, the keyboard is mapped for the Hebrew character set.
4692 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4693 toggle this option. See |rileft.txt|.
4694 NOTE: This option is reset when 'compatible' is set.
4695
4696 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4697'hkmapp' 'hkp' boolean (default off)
4698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 {only available when compiled with the |+rightleft|
4700 feature}
4701 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4702 This is useful if you have a non-Hebrew keyboard.
4703 See |rileft.txt|.
4704 NOTE: This option is reset when 'compatible' is set.
4705
Bram Moolenaar036986f2017-03-16 17:41:02 +01004706 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4707'hlsearch' 'hls' boolean (default off)
4708 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004709 {not available when compiled without the
4710 |+extra_search| feature}
4711 When there is a previous search pattern, highlight all its matches.
4712 The type of highlighting used can be set with the 'l' occasion in the
4713 'highlight' option. This uses the "Search" highlight group by
4714 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004715 are not applied. If the "CurSearch" highlight group is set then the
4716 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004717 See also: 'incsearch' and |:match|.
4718 When you get bored looking at the highlighted matches, you can turn it
4719 off with |:nohlsearch|. This does not change the option value, as
4720 soon as you use a search command, the highlighting comes back.
4721 'redrawtime' specifies the maximum time spent on finding matches.
4722 When the search pattern can match an end-of-line, Vim will try to
4723 highlight all of the matched text. However, this depends on where the
4724 search starts. This will be the first line in the window or the first
4725 line below a closed fold. A match in a previous line which is not
4726 drawn may not continue in a newly drawn line.
4727 You can specify whether the highlight status is restored on startup
4728 with the 'h' flag in 'viminfo' |viminfo-h|.
4729 NOTE: This option is reset when 'compatible' is set.
4730
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 *'icon'* *'noicon'*
4732'icon' boolean (default off, on when title can be restored)
4733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 When on, the icon text of the window will be set to the value of
4735 'iconstring' (if it is not empty), or to the name of the file
4736 currently being edited. Only the last part of the name is used.
4737 Overridden by the 'iconstring' option.
4738 Only works if the terminal supports setting window icons (currently
4739 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4740 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4741 builtin termcap).
4742 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004743 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004745 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746
4747 *'iconstring'*
4748'iconstring' string (default "")
4749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 When this option is not empty, it will be used for the icon text of
4751 the window. This happens only when the 'icon' option is on.
4752 Only works if the terminal supports setting window icon text
4753 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004754 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 When Vim was compiled with HAVE_X11 defined, the original icon will be
4756 restored if possible |X11|.
4757 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004758 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004760 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 {not available when compiled without the |+statusline| feature}
4762
4763 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4764'ignorecase' 'ic' boolean (default off)
4765 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004766 Ignore case in search patterns, |cmdline-completion|, when
glepnir05460682025-05-26 18:23:27 +02004767 searching in the tags file, non-|Vim9| |expr-==| and for Insert-mode
4768 completion |ins-completion|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004769 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 Can be overruled by using "\c" or "\C" in the pattern, see
4771 |/ignorecase|.
4772
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004773 *'imactivatefunc'* *'imaf'*
4774'imactivatefunc' 'imaf' string (default "")
4775 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004776 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004777 activate or deactivate the Input Method. The value can be the name of
4778 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4779 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004780 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004781 The expression will be evaluated in the |sandbox| when set from a
4782 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004783
4784 Example: >
4785 function ImActivateFunc(active)
4786 if a:active
4787 ... do something
4788 else
4789 ... do something
4790 endif
4791 " return value is not used
4792 endfunction
4793 set imactivatefunc=ImActivateFunc
4794<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 *'imactivatekey'* *'imak'*
4796'imactivatekey' 'imak' string (default "")
4797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004799 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 Specifies the key that your Input Method in X-Windows uses for
4801 activation. When this is specified correctly, vim can fully control
4802 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4803 You can't use this option to change the activation key, the option
4804 tells Vim what the key is.
4805 Format:
4806 [MODIFIER_FLAG-]KEY_STRING
4807
4808 These characters can be used for MODIFIER_FLAG (case is ignored):
4809 S Shift key
4810 L Lock key
4811 C Control key
4812 1 Mod1 key
4813 2 Mod2 key
4814 3 Mod3 key
4815 4 Mod4 key
4816 5 Mod5 key
4817 Combinations are allowed, for example "S-C-space" or "SC-space" are
4818 both shift+ctrl+space.
4819 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4820
4821 Example: >
4822 :set imactivatekey=S-space
4823< "S-space" means shift+space. This is the activation key for kinput2 +
4824 canna (Japanese), and ami (Korean).
4825
4826 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4827'imcmdline' 'imc' boolean (default off)
4828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 When set the Input Method is always on when starting to edit a command
4830 line, unless entering a search pattern (see 'imsearch' for that).
4831 Setting this option is useful when your input method allows entering
4832 English characters directly, e.g., when it's used to type accented
4833 characters with dead keys.
4834
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004835 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 When set the Input Method is never used. This is useful to disable
4839 the IM when it doesn't work properly.
4840 Currently this option is on by default for SGI/IRIX machines. This
4841 may change in later releases.
4842
4843 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004844'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 Specifies whether :lmap or an Input Method (IM) is to be used in
4847 Insert mode. Valid values:
4848 0 :lmap is off and IM is off
4849 1 :lmap is ON and IM is off
4850 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 To always reset the option to zero when leaving Insert mode with <Esc>
4852 this can be used: >
4853 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4854< This makes :lmap and IM turn off automatically when leaving Insert
4855 mode.
4856 Note that this option changes when using CTRL-^ in Insert mode
4857 |i_CTRL-^|.
4858 The value is set to 1 when setting 'keymap' to a valid keymap name.
4859 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004860 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 methods. Use 'imdisable' to disable XIM then.
4862
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004863 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004864 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004865 |+multi_byte_ime| or |global-ime|.
4866
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004868'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 Specifies whether :lmap or an Input Method (IM) is to be used when
4871 entering a search pattern. Valid values:
4872 -1 the value of 'iminsert' is used, makes it look like
4873 'iminsert' is also used when typing a search pattern
4874 0 :lmap is off and IM is off
4875 1 :lmap is ON and IM is off
4876 2 :lmap is off and IM is ON
4877 Note that this option changes when using CTRL-^ in Command-line mode
4878 |c_CTRL-^|.
4879 The value is set to 1 when it is not -1 and setting the 'keymap'
4880 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004881 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 methods. Use 'imdisable' to disable XIM then.
4883
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004884 *'imstatusfunc'* *'imsf'*
4885'imstatusfunc' 'imsf' string (default "")
4886 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004887 This option specifies a function that is called to obtain the status
4888 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004889 The value can be the name of a function, a |lambda| or a |Funcref|.
4890 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004891 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004892
4893 Example: >
4894 function ImStatusFunc()
4895 let is_active = ...do something
4896 return is_active ? 1 : 0
4897 endfunction
4898 set imstatusfunc=ImStatusFunc
4899<
4900 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004901 The expression will be evaluated in the |sandbox| when set from a
4902 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004903
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004904 *'imstyle'* *'imst'*
4905'imstyle' 'imst' number (default 1)
4906 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004907 {only available when compiled with |+xim| and
4908 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004909 This option specifies the input style of Input Method:
4910 0 use on-the-spot style
4911 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004912 See: |xim-input-style|
4913
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004914 For a long time on-the-spot style had been used in the GTK version of
4915 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004916 |single-repeat|, etc. Therefore over-the-spot style becomes the
4917 default now. This should work fine for most people, however if you
4918 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004919 The expression will be evaluated in the |sandbox| when set from a
4920 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004921
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 *'include'* *'inc'*
4923'include' 'inc' string (default "^\s*#\s*include")
4924 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 {not available when compiled without the
4926 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004927 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 pattern, just like for the "/" command (See |pattern|). The default
4929 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004930 "]I", "[d", etc.
4931 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004932 comes after the matched pattern. But if "\zs" appears in the pattern
4933 then the text matched from "\zs" to the end, or until "\ze" if it
4934 appears, is used as the file name. Use this to include characters
4935 that are not in 'isfname', such as a space. You can then use
4936 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004937 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'includeexpr'* *'inex'*
4940'includeexpr' 'inex' string (default "")
4941 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004943 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004945 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004946 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004948 Note the double backslash: the `:set` command first halves them, then
4949 one remains it the value, where "\." matches a dot literally. For
4950 simple character replacements `tr()` avoids the need for escaping: >
4951 :setlocal includeexpr=tr(v:fname,'.','/')
4952<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004954 found. Allows doing "gf" on the name after an 'include' statement.
Christian Brabandt23984602025-04-19 11:54:08 +02004955 Note: Not used for |<cfile>|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004957 If the expression starts with s: or |<SID>|, then it is replaced with
4958 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004959 setlocal includeexpr=s:MyIncludeExpr()
4960 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004961< Otherwise, the expression is evaluated in the context of the script
4962 where the option was set, thus script-local items are available.
4963
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004964 It is more efficient if the value is just a function call without
4965 arguments, see |expr-option-function|.
4966
Bram Moolenaar30b65812012-07-12 22:01:11 +02004967 The expression will be evaluated in the |sandbox| when set from a
4968 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004969 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004970
4971 It is not allowed to change text or jump to another window while
4972 evaluating 'includeexpr' |textlock|.
4973
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004975'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004976 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004979 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004980 While typing a search command, show where the pattern, as it was typed
4981 so far, matches. The matched string is highlighted. If the pattern
4982 is invalid or not found, nothing is shown. The screen will be updated
4983 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004984 Also applies to the pattern in commands: >
4985 :global
4986 :lvimgrep
4987 :lvimgrepadd
4988 :smagic
4989 :snomagic
4990 :sort
4991 :substitute
4992 :vglobal
4993 :vimgrep
4994 :vimgrepadd
4995< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004996 original position when no match is found and when pressing <Esc>. You
4997 still need to finish the search command with <Enter> to move the
4998 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004999 You can use the CTRL-G and CTRL-T keys to move to the next and
5000 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005001 When compiled with the |+reltime| feature Vim only searches for about
5002 half a second. With a complicated pattern and/or a lot of text the
5003 match may not be found. This is to avoid that Vim hangs while you
5004 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00005005 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01005006 When 'hlsearch' is on, all matched strings are highlighted too while
5007 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02005008 If you don't want to turn 'hlsearch' on, but want to highlight all
5009 matches while searching, you can turn on and off 'hlsearch' with
5010 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005011 augroup vimrc-incsearch-highlight
5012 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01005013 autocmd CmdlineEnter /,\? :set hlsearch
5014 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01005015 augroup END
5016<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005017 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02005018 to the command line. If 'ignorecase' and 'smartcase' are set and the
5019 command line has no uppercase characters, the added character is
5020 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00005021 CTRL-R CTRL-W can be used to add the word at the end of the current
5022 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 NOTE: This option is reset when 'compatible' is set.
5024
5025 *'indentexpr'* *'inde'*
5026'indentexpr' 'inde' string (default "")
5027 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005028 {not available when compiled without the |+eval|
5029 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 Expression which is evaluated to obtain the proper indent for a line.
5031 It is used when a new line is created, for the |=| operator and
5032 in Insert mode as specified with the 'indentkeys' option.
5033 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02005034 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02005035 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 When 'paste' is set this option is not used for indenting.
5037 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005038 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005040
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00005041 If the expression starts with s: or |<SID>|, then it is replaced with
5042 the script ID (|local-function|). Example: >
5043 set indentexpr=s:MyIndentExpr()
5044 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005045< Otherwise, the expression is evaluated in the context of the script
5046 where the option was set, thus script-local items are available.
5047
Bram Moolenaara4e0b972022-10-01 19:43:52 +01005048 The advantage of using a function call without arguments is that it is
5049 faster, see |expr-option-function|.
5050
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 The expression must return the number of spaces worth of indent. It
5052 can return "-1" to keep the current indent (this means 'autoindent' is
5053 used for the indent).
5054 Functions useful for computing the indent are |indent()|, |cindent()|
5055 and |lispindent()|.
5056 The evaluation of the expression must not have side effects! It must
5057 not change the text, jump to another window, etc. Afterwards the
5058 cursor position is always restored, thus the cursor may be moved.
5059 Normally this option would be set to call a function: >
5060 :set indentexpr=GetMyIndent()
5061< Error messages will be suppressed, unless the 'debug' option contains
5062 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005063 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005064 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
Bram Moolenaar30b65812012-07-12 22:01:11 +02005066 The expression will be evaluated in the |sandbox| when set from a
5067 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005068 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005069
5070 It is not allowed to change text or jump to another window while
5071 evaluating 'indentexpr' |textlock|.
5072
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01005074'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 A list of keys that, when typed in Insert mode, cause reindenting of
5077 the current line. Only happens if 'indentexpr' isn't empty.
5078 The format is identical to 'cinkeys', see |indentkeys-format|.
5079 See |C-indenting| and |indent-expression|.
5080
5081 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
5082'infercase' 'inf' boolean (default off)
5083 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00005085 'ignorecase' is also on, the case of the match is adjusted depending
5086 on the typed text. If the typed text contains a lowercase letter
5087 where the match has an upper case letter, the completed part is made
5088 lowercase. If the typed text has no lowercase letters and the match
5089 has a lowercase letter where the typed text has an uppercase letter,
5090 and there is a letter before it, the completed part is made uppercase.
5091 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
glepnirbcd59952025-04-24 21:48:35 +02005093 *'isexpand'* *'ise'*
5094'isexpand' 'ise' string (default: "")
5095 local to buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02005096 Defines characters and patterns for completion in insert mode. Used
5097 by the |complete_match()| function to determine the starting position
5098 for completion. This is a comma-separated list of triggers. Each
5099 trigger can be:
glepnirbcd59952025-04-24 21:48:35 +02005100 - A single character like "." or "/"
5101 - A sequence of characters like "->", "/*", or "/**"
5102
5103 Note: Use "\\," to add a literal comma as trigger character, see
5104 |option-backslash|.
5105
glepnirffc89e42025-04-27 14:59:17 +02005106 Examples: >
5107 set isexpand=.,->,/*,\\,
5108<
5109
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
5111'insertmode' 'im' boolean (default off)
5112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 Makes Vim work in a way that Insert mode is the default mode. Useful
5114 if you want to use Vim as a modeless editor. Used for |evim|.
5115 These Insert mode commands will be useful:
5116 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005117 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 this is a mapping, it is executed as if 'insertmode' was off.
5119 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00005121 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
5122 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 These items change when 'insertmode' is set:
5125 - when starting to edit of a file, Vim goes to Insert mode.
5126 - <Esc> in Insert mode is a no-op and beeps.
5127 - <Esc> in Normal mode makes Vim go to Insert mode.
5128 - CTRL-L in Insert mode is a command, it is not inserted.
5129 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
5130 However, when <Esc> is used inside a mapping, it behaves like
5131 'insertmode' was not set. This was done to be able to use the same
5132 mappings with 'insertmode' set or not set.
5133 When executing commands with |:normal| 'insertmode' is not used.
5134
5135 NOTE: This option is reset when 'compatible' is set.
5136
5137 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005138'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5140 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5141 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5142 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5143 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 The characters specified by this option are included in file names and
5146 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005147 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 Multi-byte characters 256 and above are always included, only the
5149 characters up to 255 are specified with this option.
5150 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005151 Think twice before adding white space to this option. Although a
5152 space may appear inside a file name, the effect will be that Vim
5153 doesn't know where a file name starts or ends when doing completion.
5154 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
5156 Note that on systems using a backslash as path separator, Vim tries to
5157 do its best to make it work as you would expect. That is a bit
5158 tricky, since Vi originally used the backslash to escape special
5159 characters. Vim will not remove a backslash in front of a normal file
5160 name character on these systems, but it will on Unix and alikes. The
5161 '&' and '^' are not included by default, because these are special for
5162 cmd.exe.
5163
5164 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005165 Each part can be a single character number or a range. A range is two
5166 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 decimal number between 0 and 255 or the ASCII character itself (does
5168 not work for digits). Example:
5169 "_,-,128-140,#-43" (include '_' and '-' and the range
5170 128 to 140 and '#' to 43)
5171 If a part starts with '^', the following character number or range
5172 will be excluded from the option. The option is interpreted from left
5173 to right. Put the excluded character after the range where it is
5174 included. To include '^' itself use it as the last character of the
5175 option or the end of a range. Example:
5176 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5177 If the character is '@', all characters where isalpha() returns TRUE
5178 are included. Normally these are the characters a to z and A to Z,
5179 plus accented characters. To include '@' itself use "@-@". Examples:
5180 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005181 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 "a-z,A-Z,@-@" All letters plus the '@' character.
5183 A comma can be included by using it where a character number is
5184 expected. Example:
5185 "48-57,,,_" Digits, comma and underscore.
5186 A comma can be excluded by prepending a '^'. Example:
5187 " -~,^,,9" All characters from space to '~', excluding
5188 comma, plus <Tab>.
5189 See |option-backslash| about including spaces and backslashes.
5190
5191 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005192'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 "@,48-57,_,128-167,224-235"
5194 otherwise: "@,48-57,_,192-255")
5195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 The characters given by this option are included in identifiers.
5197 Identifiers are used in recognizing environment variables and after a
5198 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005199 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005200 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005202 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5204
5205 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005206'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 "@,48-57,_,128-167,224-235"
5208 otherwise: "@,48-57,_,192-255"
5209 Vi default: "@,48-57,_")
5210 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005212 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005213 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005214 characters above 255 check the "word" character class (any character
5215 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005216 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 For a help file it is set to all non-blank printable characters except
5218 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5219 command).
5220 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005221 This option also influences syntax highlighting, unless the syntax
5222 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 NOTE: This option is set to the Vi default value when 'compatible' is
5224 set and to the Vim default value when 'compatible' is reset.
5225
5226 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005227'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 "@,~-255"; otherwise: "@,161-255")
5229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 The characters given by this option are displayed directly on the
5231 screen. It is also used for "\p" in a |pattern|. The characters from
5232 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5233 even when they are not included in 'isprint' or excluded. See
5234 'isfname' for a description of the format of this option.
5235
5236 Non-printable characters are displayed with two characters:
5237 0 - 31 "^@" - "^_"
5238 32 - 126 always single characters
5239 127 "^?"
5240 128 - 159 "~@" - "~_"
5241 160 - 254 "| " - "|~"
5242 255 "~?"
5243 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5244 displayed as <xx>, with the hexadecimal value of the byte.
5245 When 'display' contains "uhex" all unprintable characters are
5246 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005247 The SpecialKey highlighting will be used for unprintable characters.
5248 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249
5250 Multi-byte characters 256 and above are always included, only the
5251 characters up to 255 are specified with this option. When a character
5252 is printable but it is not available in the current font, a
5253 replacement character will be shown.
5254 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5255 There is no option to specify these characters.
5256
5257 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5258'joinspaces' 'js' boolean (default on)
5259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 Insert two spaces after a '.', '?' and '!' with a join command.
5261 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5262 Otherwise only one space is inserted.
5263 NOTE: This option is set when 'compatible' is set.
5264
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005265 *'jumpoptions'* *'jop'*
5266'jumpoptions' 'jop' string (default "")
5267 global
5268 List of words that change the behavior of the |jumplist|.
5269 stack Make the jumplist behave like the tagstack.
5270 Relative location of entries in the jumplist is
5271 preserved at the cost of discarding subsequent entries
5272 when navigating backwards in the jumplist and then
5273 jumping to a location. |jumplist-stack|
5274
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 *'key'*
5276'key' string (default "")
5277 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005278 {only available when compiled with the |+cryptv|
5279 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005281 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 Careful: Do not set the key value by hand, someone might see the typed
5283 key. Use the |:X| command. But you can make 'key' empty: >
5284 :set key=
5285< It is not possible to get the value of this option with ":set key" or
5286 "echo &key". This is to avoid showing it to someone who shouldn't
5287 know. It also means you cannot see it yourself once you have set it,
5288 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005289 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5290 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005291 You can use "&key" in an expression to detect whether encryption is
5292 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293
5294 *'keymap'* *'kmp'* *E544*
5295'keymap' 'kmp' string (default "")
5296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 {only available when compiled with the |+keymap|
5298 feature}
5299 Name of a keyboard mapping. See |mbyte-keymap|.
5300 Setting this option to a valid keymap name has the side effect of
5301 setting 'iminsert' to one, so that the keymap becomes effective.
5302 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005303 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304
5305 *'keymodel'* *'km'*
5306'keymodel' 'km' string (default "")
5307 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005308 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 can do. These values can be used:
5310 startsel Using a shifted special key starts selection (either
5311 Select mode or Visual mode, depending on "key" being
5312 present in 'selectmode').
5313 stopsel Using a not-shifted special key stops selection.
5314 Special keys in this context are the cursor keys, <End>, <Home>,
5315 <PageUp> and <PageDown>.
5316 The 'keymodel' option is set by the |:behave| command.
5317
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005318 *'keyprotocol'* *'kpc'*
5319'keyprotocol' 'kpc' string (default: see below)
5320 global
5321 Specifies what keyboard protocol to use depending on the value of
5322 'term'. The supported keyboard protocols names are:
5323 none whatever the terminal uses
5324 mok2 modifyOtherKeys level 2, as supported by xterm
5325 kitty Kitty keyboard protocol, as supported by Kitty
5326
Bram Moolenaara87749e2022-11-30 10:23:17 +00005327 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005328 a pattern that is matched against the 'term' option, a colon and the
5329 protocol name to be used. To illustrate this, the default value would
5330 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005331 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5332 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005333
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005334< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005335 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5336 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005337
5338 The first match is used, thus if you want to have "kitty" use the
5339 kitty protocol, but "badkitty" not, then you should match "badkitty"
5340 first and use the "none" value: >
5341 set keyprotocol=badkitty:none,kitty:kitty
5342<
5343 The option is used after 'term' has been changed. First the termcap
5344 entries are set, possibly using the builtin list, see |builtin-terms|.
5345 Then this option is inspected and if there is a match and a protocol
5346 is specified the following happens:
5347 none Nothing, the regular t_TE and t_TI values remain
5348
5349 mok2 The t_TE value is changed to:
5350 CSI >4;m disables modifyOtherKeys
5351 The t_TI value is changed to:
5352 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005353 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005354
5355 kitty The t_TE value is changed to:
5356 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005357 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005358 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005359 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005360 CSI ?u request kitty keyboard protocol state
5361 CSI >c request the termresponse
5362
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005363 If you notice problems, such as characters being displayed that
5364 disappear after `CTRL-L`, you might want to try making this option
5365 empty. Then set the 'term' option to have it take effect: >
5366 set keyprotocol=
5367 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005368<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005369
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 *'keywordprg'* *'kp'*
5371'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005372 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 Program to use for the |K| command. Environment variables are
5375 expanded |:set_env|. ":help" may be used to access the Vim internal
5376 help. (Note that previously setting the global option to the empty
5377 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005378 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005379 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005380 When "man", "man -s" or an Ex command is used, Vim will automatically
5381 translate a count for the "K" command and pass it as the first
5382 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 See |option-backslash| about including spaces and backslashes.
5384 Example: >
5385 :set keywordprg=man\ -s
5386< This option cannot be set from a |modeline| or in the |sandbox|, for
5387 security reasons.
5388
5389 *'langmap'* *'lmap'* *E357* *E358*
5390'langmap' 'lmap' string (default "")
5391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 {only available when compiled with the |+langmap|
5393 feature}
5394 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005395 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005396 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 care of translating these special characters to the original meaning
5398 of the key. This means you don't have to change the keyboard mode to
5399 be able to execute Normal mode commands.
5400 This is the opposite of the 'keymap' option, where characters are
5401 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005402 Also consider setting 'langremap' to off, to prevent 'langmap' from
5403 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005404 This option cannot be set from a |modeline| or in the |sandbox|, for
5405 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005407 Example (for Greek, in UTF-8): *greek* >
5408 :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 +00005409< Example (exchanges meaning of z and y for commands): >
5410 :set langmap=zy,yz,ZY,YZ
5411<
5412 The 'langmap' option is a list of parts, separated with commas. Each
5413 part can be in one of two forms:
5414 1. A list of pairs. Each pair is a "from" character immediately
5415 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005416 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 characters. Example: "abc;ABC"
5418 Example: "aA,fgh;FGH,cCdDeE"
5419 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005420 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421
5422 This will allow you to activate vim actions without having to switch
5423 back and forth between the languages. Your language characters will
5424 be understood as normal vim English characters (according to the
5425 langmap mappings) in the following cases:
5426 o Normal/Visual mode (commands, buffer/register names, user mappings)
5427 o Insert/Replace Mode: Register names after CTRL-R
5428 o Insert/Replace Mode: Mappings
5429 Characters entered in Command-line mode will NOT be affected by
5430 this option. Note that this option can be changed at any time
5431 allowing to switch between mappings for different languages/encodings.
5432 Use a mapping to avoid having to type it each time!
5433
5434 *'langmenu'* *'lm'*
5435'langmenu' 'lm' string (default "")
5436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 {only available when compiled with the |+menu| and
5438 |+multi_lang| features}
5439 Language to use for menu translation. Tells which file is loaded
5440 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005441 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442< (without the spaces). For example, to always use the Dutch menus, no
5443 matter what $LANG is set to: >
5444 :set langmenu=nl_NL.ISO_8859-1
5445< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005446 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 If your $LANG is set to a non-English language but you do want to use
5448 the English menus: >
5449 :set langmenu=none
5450< This option must be set before loading menus, switching on filetype
5451 detection or syntax highlighting. Once the menus are defined setting
5452 this option has no effect. But you could do this: >
5453 :source $VIMRUNTIME/delmenu.vim
5454 :set langmenu=de_DE.ISO_8859-1
5455 :source $VIMRUNTIME/menu.vim
5456< Warning: This deletes all menus that you defined yourself!
5457
Bram Moolenaard94464e2015-11-02 15:28:18 +01005458 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005459'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005460 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005461 {only available when compiled with the |+langmap|
5462 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005463 This is just like 'langremap' but with the value inverted. It only
5464 exists for backwards compatibility. When setting 'langremap' then
5465 'langnoremap' is set to the inverted value, and the other way around.
5466
5467 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005468'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005469 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005470 {only available when compiled with the |+langmap|
5471 feature}
5472 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005473 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005474 'langmap' disables some of your mappings, try resetting this option.
5475 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005476 that works for you to avoid mappings to break.
5477
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 *'laststatus'* *'ls'*
5479'laststatus' 'ls' number (default 1)
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 The value of this option influences when the last window will have a
5482 status line:
5483 0: never
5484 1: only if there are at least two windows
5485 2: always
5486 The screen looks nicer with a status line if you have several
5487 windows, but it takes another screen line. |status-line|
5488
5489 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5490'lazyredraw' 'lz' boolean (default off)
5491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 When this option is set, the screen will not be redrawn while
5493 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005494 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005496 This may occasionally cause display errors. It is only meant to be set
5497 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005498 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499
64-bitman88d41ab2025-04-06 17:20:39 +02005500 *'lhistory'* *'lhi'*
5501'lhistory' 'lhi' number (default: 10)
5502 local to window
5503 {only available when compiled with the |+quickfix|
5504 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005505 Like 'chistory', but for the location list stack associated with a
5506 window. If the option is changed in either the location list window
5507 itself or the window that is associated with the location list stack,
5508 the new value will also be applied to the other one. This means this
5509 value will always be the same for a given location list window and its
5510 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005511
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5513'linebreak' 'lbr' boolean (default off)
5514 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005515 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005517 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 than at the last character that fits on the screen. Unlike
5519 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005520 it only affects the way the file is displayed, not its contents.
5521 If 'breakindent' is set, line is visually indented. Then, the value
5522 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005523 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 Note that <Tab> characters after an <EOL> are mostly not displayed
5525 with the right amount of white space.
5526
5527 *'lines'* *E593*
5528'lines' number (default 24 or terminal height)
5529 global
5530 Number of lines of the Vim window.
5531 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005532 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 When Vim is running in the GUI or in a resizable window, setting this
5534 option will cause the window size to be changed. When you only want
5535 to use the size for the GUI, put the command in your |gvimrc| file.
5536 Vim limits the number of lines to what fits on the screen. You can
5537 use this command to get the tallest window possible: >
5538 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005539< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005540 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 When you set this option and Vim is unable to change the physical
5542 number of lines of the display, the display may be messed up.
5543
5544 *'linespace'* *'lsp'*
5545'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 {only in the GUI}
5548 Number of pixel lines inserted between characters. Useful if the font
5549 uses the full character cell height, making lines touch each other.
5550 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005551 With some fonts there can be too much room between lines (to have
5552 space for ascents and descents). Then it makes sense to set
5553 'linespace' to a negative value. This may cause display problems
5554 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555
5556 *'lisp'* *'nolisp'*
5557'lisp' boolean (default off)
5558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 Lisp mode: When <Enter> is typed in insert mode set the indent for
5560 the next line to Lisp standards (well, sort of). Also happens with
5561 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5562 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5563 better. Also see 'lispwords'.
5564 The '-' character is included in keyword characters. Redefines the
5565 "=" operator to use this same indentation algorithm rather than
5566 calling an external program if 'equalprg' is empty.
5567 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005569 *'lispoptions'* *'lop'*
5570'lispoptions' 'lop' string (default "")
5571 local to buffer
5572 Comma-separated list of items that influence the Lisp indenting when
5573 enabled with the |'lisp'| option. Currently only one item is
5574 supported:
5575 expr:1 use 'indentexpr' for Lisp indenting when it is set
5576 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5577 Note that when using 'indentexpr' the `=` operator indents all the
5578 lines, otherwise the first line is not indented (Vi-compatible).
5579
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 *'lispwords'* *'lw'*
5581'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005582 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005583 Comma-separated list of words that influence the Lisp indenting when
5584 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585
5586 *'list'* *'nolist'*
5587'list' boolean (default off)
5588 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005589 List mode: By default show tabs as CTRL-I is displayed, display $
5590 after end of line. Useful to see the difference between tabs and
5591 spaces and for trailing blanks. Further changed by the 'listchars'
5592 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005593
5594 The cursor is displayed at the start of the space a Tab character
5595 occupies, not at the end as usual in Normal mode. To get this cursor
5596 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005597 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005598<
5599 Note that list mode will also affect formatting (set with 'textwidth'
5600 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 changing the way tabs are displayed.
5602
5603 *'listchars'* *'lcs'*
5604'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005605 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005606 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005607 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005608 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 eol:c Character to show at the end of each line. When
5610 omitted, there is no extra character at the end of the
5611 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005612 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005613 tab:xy[z] Two or three characters to be used to show a tab.
5614 The third character is optional.
5615
5616 tab:xy The 'x' is always used, then 'y' as many times as will
5617 fit. Thus "tab:>-" displays:
5618 >
5619 >-
5620 >--
5621 etc.
5622
5623 tab:xyz The 'z' is always used, then 'x' is prepended, and
5624 then 'y' is used as many times as will fit. Thus
5625 "tab:<->" displays:
5626 >
5627 <>
5628 <->
5629 <-->
5630 etc.
5631
5632 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005633 *lcs-space*
5634 space:c Character to show for a space. When omitted, spaces
5635 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005636 *lcs-multispace*
5637 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005638 One or more characters to use cyclically to show for
5639 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005640 setting, except for single spaces. When omitted, the
5641 "space" setting is used. For example,
5642 `:set listchars=multispace:---+` shows ten consecutive
5643 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005644 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005645 *lcs-lead*
5646 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005647 leading spaces are blank. Overrides the "space" and
5648 "multispace" settings for leading spaces. You can
5649 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005650 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005651< *lcs-leadmultispace*
5652 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005653 Like the |lcs-multispace| value, but for leading
5654 spaces only. Also overrides |lcs-lead| for leading
5655 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005656 `:set listchars=leadmultispace:---+` shows ten
5657 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005658 ---+---+--XXX ~
5659 Where "XXX" denotes the first non-blank characters in
5660 the line.
5661 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005662 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005663 trailing spaces are blank. Overrides the "space" and
5664 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005665 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 extends:c Character to show in the last column, when 'wrap' is
5667 off and the line continues beyond the right of the
5668 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005669 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005670 precedes:c Character to show in the first visible column of the
5671 physical line, when there is text preceding the
5672 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005673 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005674 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005675 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005676 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005677 nbsp:c Character to show for a non-breakable space character
5678 (0xA0 (160 decimal) and U+202F). Left blank when
5679 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005681 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005683 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005685 Each character can be specified as hex: >
5686 set listchars=eol:\\x24
5687 set listchars=eol:\\u21b5
5688 set listchars=eol:\\U000021b5
5689< Note that a double backslash is used. The number of hex characters
5690 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5691
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 Examples: >
5693 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005694 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 :set lcs=extends:>,precedes:<
5696< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005697 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5698 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005699 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
5701 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5702'loadplugins' 'lpl' boolean (default on)
5703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 When on the plugin scripts are loaded when starting up |load-plugins|.
5705 This option can be reset in your |vimrc| file to disable the loading
5706 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005707 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5708 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709
Bram Moolenaard94464e2015-11-02 15:28:18 +01005710 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005711'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005712 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005713 {only available when compiled with the |+lua/dyn|
5714 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005715 Specifies the name of the Lua shared library. The default is
5716 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005717 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005718 This option cannot be set from a |modeline| or in the |sandbox|, for
5719 security reasons.
5720
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005721 *'macatsui'* *'nomacatsui'*
5722'macatsui' boolean (default on)
5723 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005724 {not supported}
5725 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005726
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 *'magic'* *'nomagic'*
5728'magic' boolean (default on)
5729 global
5730 Changes the special characters that can be used in search patterns.
5731 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005732 WARNING: Switching this option off most likely breaks plugins! That
5733 is because many patterns assume it's on and will fail when it's off.
5734 Only switch it off when working with old Vi scripts. In any other
5735 situation write patterns that work when 'magic' is on. Include "\M"
5736 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005737 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5738 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739
5740 *'makeef'* *'mef'*
5741'makeef' 'mef' string (default: "")
5742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 {not available when compiled without the |+quickfix|
5744 feature}
5745 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5746 and the |:grep| command.
5747 When it is empty, an internally generated temp file will be used.
5748 When "##" is included, it is replaced by a number to make the name
5749 unique. This makes sure that the ":make" command doesn't overwrite an
5750 existing file.
5751 NOT used for the ":cf" command. See 'errorfile' for that.
5752 Environment variables are expanded |:set_env|.
5753 See |option-backslash| about including spaces and backslashes.
5754 This option cannot be set from a |modeline| or in the |sandbox|, for
5755 security reasons.
5756
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005757 *'makeencoding'* *'menc'*
5758'makeencoding' 'menc' string (default "")
5759 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005760 Encoding used for reading the output of external commands. When empty,
5761 encoding is not converted.
5762 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5763 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5764 and `:laddfile`.
5765
5766 This would be mostly useful when you use MS-Windows and set 'encoding'
5767 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5768 'makeencoding' to "char" has the same effect as setting to the system
5769 locale encoding. Example: >
5770 :set encoding=utf-8
5771 :set makeencoding=char " system locale is used
5772<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 *'makeprg'* *'mp'*
5774'makeprg' 'mp' string (default "make", VMS: "MMS")
5775 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005776 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005777 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5778 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005779 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005780 Environment variables are expanded |:set_env|. See |option-backslash|
5781 about including spaces and backslashes.
5782 Note that a '|' must be escaped twice: once for ":set" and once for
5783 the interpretation of a command. When you use a filter called
5784 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 :set makeprg=gmake\ \\\|\ myfilter
5786< The placeholder "$*" can be given (even multiple times) to specify
5787 where the arguments will be included, for example: >
5788 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5789< This option cannot be set from a |modeline| or in the |sandbox|, for
5790 security reasons.
5791
5792 *'matchpairs'* *'mps'*
5793'matchpairs' 'mps' string (default "(:),{:},[:]")
5794 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005796 other.
5797 Only character pairs are allowed that are different, thus you cannot
5798 jump between two double quotes.
5799 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005800 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005801 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 :set mps+=<:>
5803
5804< A more exotic example, to jump between the '=' and ';' in an
5805 assignment, useful for languages like C and Java: >
5806 :au FileType c,cpp,java set mps+==:;
5807
5808< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005809 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
5811 *'matchtime'* *'mat'*
5812'matchtime' 'mat' number (default 5)
5813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 Tenths of a second to show the matching paren, when 'showmatch' is
5815 set. Note that this is not in milliseconds, like other options that
5816 set a time. This is to be compatible with Nvi.
5817
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005818 *'maxcombine'* *'mco'*
5819'maxcombine' 'mco' number (default 2)
5820 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005821 The maximum number of combining characters supported for displaying.
5822 Only used when 'encoding' is "utf-8".
5823 The default is OK for most languages. Hebrew may require 4.
5824 Maximum value is 6.
5825 Even when this option is set to 2 you can still edit text with more
5826 combining characters, you just can't see them. Use |g8| or |ga|.
Christian Brabandt6b2c1ad2025-05-30 17:43:42 +02005827 When set to 0, you will not be able to see any combining characters.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005828 See |mbyte-combining|.
5829
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 *'maxfuncdepth'* *'mfd'*
5831'maxfuncdepth' 'mfd' number (default 100)
5832 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005833 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005834 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 Maximum depth of function calls for user functions. This normally
5836 catches endless recursion. When using a recursive function with
5837 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5838 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005839 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005840 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005842 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843
5844 *'maxmapdepth'* *'mmd'* *E223*
5845'maxmapdepth' 'mmd' number (default 1000)
5846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 Maximum number of times a mapping is done without resulting in a
5848 character to be used. This normally catches endless mappings, like
5849 ":map x y" with ":map y x". It still does not catch ":map g wg",
5850 because the 'w' is used before the next mapping is done. See also
5851 |key-mapping|.
5852
5853 *'maxmem'* *'mm'*
5854'maxmem' 'mm' number (default between 256 to 5120 (system
5855 dependent) or half the amount of memory
5856 available)
5857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5859 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005860 other memory to be freed.
5861 The maximum usable value is about 2000000. Use this to work without a
5862 limit.
5863 The value is ignored when 'swapfile' is off.
5864 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005866 *'maxmempattern'* *'mmp'*
5867'maxmempattern' 'mmp' number (default 1000)
5868 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005869 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005870 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005871 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005872 When Vim runs into the limit it gives an error message and mostly
5873 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005874 Running into the limit often means that the pattern is very
5875 inefficient or too complex. This may already happen with the pattern
5876 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005877 Might also happen on redraw, when syntax rules try to match a complex
5878 text structure.
5879 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5880 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005881
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 *'maxmemtot'* *'mmt'*
5883'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5884 dependent) or half the amount of memory
5885 available)
5886 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005887 Maximum amount of memory in Kbyte to use for all buffers together.
5888 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005889 without a limit.
5890 On 64 bit machines higher values might work. But hey, do you really
5891 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005892 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005893 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005894 Buffers with 'swapfile' off still count to the total amount of memory
5895 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005896 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897
5898 *'menuitems'* *'mis'*
5899'menuitems' 'mis' number (default 25)
5900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 {not available when compiled without the |+menu|
5902 feature}
5903 Maximum number of items to use in a menu. Used for menus that are
5904 generated from a list of items, e.g., the Buffers menu. Changing this
5905 option has no direct effect, the menu must be refreshed first.
5906
Christian Brabandt51d4d842024-12-06 17:26:25 +01005907 *'messagesopt'* *'mopt'*
5908'messagesopt' 'mopt' string (default "hit-enter,history:500")
5909 global
5910
zeertzjq8cc43da2024-12-07 16:09:08 +01005911 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005912 following items. Items must be separated by a comma.
5913
zeertzjq8cc43da2024-12-07 16:09:08 +01005914 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005915 'cmdheight' size.
5916
zeertzjq8cc43da2024-12-07 16:09:08 +01005917 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5918 {n} milliseconds so that the user has a chance to read
5919 the message. The maximum value of {n} is 10000. Use
5920 0 to disable the wait (but then the user may miss an
5921 important message).
5922 This item is ignored when "hit-enter" is present, but
5923 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005924
5925 history:{n} Determines how many entries are remembered in the
5926 |:messages| history. The maximum value is 10000.
5927 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005928 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005929
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005930 *'mkspellmem'* *'msm'*
5931'mkspellmem' 'msm' string (default "460000,2000,500")
5932 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005933 {not available when compiled without the |+syntax|
5934 feature}
5935 Parameters for |:mkspell|. This tunes when to start compressing the
5936 word tree. Compression can be slow when there are many words, but
5937 it's needed to avoid running out of memory. The amount of memory used
5938 per word depends very much on how similar the words are, that's why
5939 this tuning is complicated.
5940
5941 There are three numbers, separated by commas:
5942 {start},{inc},{added}
5943
5944 For most languages the uncompressed word tree fits in memory. {start}
5945 gives the amount of memory in Kbyte that can be used before any
5946 compression is done. It should be a bit smaller than the amount of
5947 memory that is available to Vim.
5948
5949 When going over the {start} limit the {inc} number specifies the
5950 amount of memory in Kbyte that can be allocated before another
5951 compression is done. A low number means compression is done after
5952 less words are added, which is slow. A high number means more memory
5953 will be allocated.
5954
5955 After doing compression, {added} times 1024 words can be added before
5956 the {inc} limit is ignored and compression is done when any extra
5957 amount of memory is needed. A low number means there is a smaller
5958 chance of hitting the {inc} limit, less memory is used but it's
5959 slower.
5960
5961 The languages for which these numbers are important are Italian and
5962 Hungarian. The default works for when you have about 512 Mbyte. If
5963 you have 1 Gbyte you could use: >
5964 :set mkspellmem=900000,3000,800
5965< If you have less than 512 Mbyte |:mkspell| may fail for some
5966 languages, no matter what you set 'mkspellmem' to.
5967
dkearns8ebdbc92023-10-29 06:26:19 +11005968 This option cannot be set from a |modeline| or in the |sandbox|, for
5969 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005970
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005972'modeline' 'ml' boolean (Vim default: on (off for root),
5973 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005975 If 'modeline' is on 'modelines' gives the number of lines that is
5976 checked for set commands. If 'modeline' is off or 'modelines' is zero
5977 no lines are checked. See |modeline|.
5978
5979 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5980'modelineexpr' 'mle' boolean (default: off)
5981 global
5982 When on allow some options that are an expression to be set in the
5983 modeline. Check the option for whether it is affected by
5984 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005985 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005987
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 *'modelines'* *'mls'*
5989'modelines' 'mls' number (default 5)
5990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 If 'modeline' is on 'modelines' gives the number of lines that is
5992 checked for set commands. If 'modeline' is off or 'modelines' is zero
5993 no lines are checked. See |modeline|.
5994 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5995 set and to the Vim default value when 'compatible' is reset.
5996
5997 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005998 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999'modifiable' 'ma' boolean (default on)
6000 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 When off the buffer contents cannot be changed. The 'fileformat' and
6002 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006003 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004
6005 *'modified'* *'mod'* *'nomodified'* *'nomod'*
6006'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006007 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 When on, the buffer is considered to be modified. This option is set
6009 when:
6010 1. A change was made to the text since it was last written. Using the
6011 |undo| command to go back to the original text will reset the
6012 option. But undoing changes that were made before writing the
6013 buffer will set the option again, since the text is different from
6014 when it was written.
6015 2. 'fileformat' or 'fileencoding' is different from its original
6016 value. The original value is set when the buffer is read or
6017 written. A ":set nomodified" command also resets the original
6018 values to the current values and the 'modified' option will be
6019 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01006020 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006021 This option is not set when a change is made to the buffer as the
6022 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
6023 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
6024 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 When 'buftype' is "nowrite" or "nofile" this option may be set, but
6026 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006027 Note that the text may actually be the same, e.g. 'modified' is set
6028 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029
6030 *'more'* *'nomore'*
6031'more' boolean (Vim default: on, Vi default: off)
6032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 When on, listings pause when the whole screen is filled. You will get
6034 the |more-prompt|. When this option is off there are no pauses, the
6035 listing continues until finished.
6036 NOTE: This option is set to the Vi default value when 'compatible' is
6037 set and to the Vim default value when 'compatible' is reset.
6038
Bram Moolenaar98a29d02021-01-18 19:55:44 +01006039 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006040'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01006041 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006043 Enable the use of the mouse. Works for most terminals (xterm, Win32
6044 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
6045 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
6046 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01006047 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 v Visual mode
6049 i Insert mode
6050 c Command-line mode
6051 h all previous modes when editing a help file
6052 a all previous modes
6053 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006054 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01006056< If your terminal can't overrule the mouse events going to the
6057 application, use: >
6058 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02006059< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01006060 back to Vim using the mouse events.
6061 In |defaults.vim| "nvi" is used if the 'term' option is not matching
6062 "xterm".
6063
6064 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 modeless selection. This doesn't move the text cursor.
6066
6067 See |mouse-using|. Also see |'clipboard'|.
6068
6069 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006070 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 the mouse buttons can still be used by keeping the shift key pressed.
6072 Also see the 'clipboard' option.
6073
6074 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
6075'mousefocus' 'mousef' boolean (default off)
6076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 {only works in the GUI}
6078 The window that the mouse pointer is on is automatically activated.
6079 When changing the window layout or window focus in another way, the
6080 mouse pointer is moved to the window with keyboard focus. Off is the
6081 default because it makes using the pull down menus a little goofy, as
6082 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006083 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01006084 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085
6086 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
6087'mousehide' 'mh' boolean (default on)
6088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 {only works in the GUI}
6090 When on, the mouse pointer is hidden when characters are typed.
6091 The mouse pointer is restored when the mouse is moved.
6092
6093 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006094'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 Sets the model to use for the mouse. The name mostly specifies what
6097 the right mouse button is used for:
6098 extend Right mouse button extends a selection. This works
6099 like in an xterm.
6100 popup Right mouse button pops up a menu. The shifted left
6101 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00006102 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 popup_setpos Like "popup", but the cursor will be moved to the
6104 position where the mouse was clicked, and thus the
6105 selected operation will act upon the clicked object.
6106 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00006107 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 course, that right clicking outside a selection will
6109 end Visual mode.
6110 Overview of what button does what for each model:
6111 mouse extend popup(_setpos) ~
6112 left click place cursor place cursor
6113 left drag start selection start selection
6114 shift-left search word extend selection
6115 right click extend selection popup menu (place cursor)
6116 right drag extend selection -
6117 middle click paste paste
6118
6119 In the "popup" model the right mouse button produces a pop-up menu.
6120 You need to define this first, see |popup-menu|.
6121
6122 Note that you can further refine the meaning of buttons with mappings.
6123 See |gui-mouse-mapping|. But mappings are NOT used for modeless
6124 selection (because that's handled in the GUI code directly).
6125
6126 The 'mousemodel' option is set by the |:behave| command.
6127
h_east59858792023-10-25 22:47:05 +09006128 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01006129'mousemoveevent' 'mousemev' boolean (default off)
6130 global
6131 {only works in the GUI}
6132 When on, mouse move events are delivered to the input queue and are
6133 available for mapping. The default, off, avoids the mouse movement
6134 overhead except when needed. See |gui-mouse-mapping|.
6135 Warning: Setting this option can make pending mappings to be aborted
6136 when the mouse is moved.
6137 Currently only works in the GUI, may be made to work in a terminal
6138 later.
6139
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006141'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6142 vs:leftright,vd:lrsizing,m:no,
6143 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 {only available when compiled with the |+mouseshape|
6146 feature}
6147 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006148 different modes. The option is a comma-separated list of parts, much
Drew Vogel48b19b22025-05-07 21:32:03 +02006149 like used for 'guicursor'. Each part consists of a mode/location-list
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 and an argument-list:
6151 mode-list:shape,mode-list:shape,..
6152 The mode-list is a dash separated list of these modes/locations:
6153 In a normal window: ~
6154 n Normal mode
6155 v Visual mode
6156 ve Visual mode with 'selection' "exclusive" (same as 'v',
6157 if not specified)
6158 o Operator-pending mode
6159 i Insert mode
6160 r Replace mode
6161
6162 Others: ~
6163 c appending to the command-line
6164 ci inserting in the command-line
6165 cr replacing in the command-line
6166 m at the 'Hit ENTER' or 'More' prompts
6167 ml idem, but cursor in the last line
6168 e any mode, pointer below last window
6169 s any mode, pointer on a status line
6170 sd any mode, while dragging a status line
6171 vs any mode, pointer on a vertical separator line
6172 vd any mode, while dragging a vertical separator line
6173 a everywhere
6174
6175 The shape is one of the following:
6176 avail name looks like ~
Drew Vogel48b19b22025-05-07 21:32:03 +02006177 w x g arrow Normal mouse pointer
6178 w x blank no pointer at all (use with care!)
6179 w x g beam I-beam
6180 w x g updown up-down sizing arrows
6181 w x g leftright left-right sizing arrows
6182 w x g busy The system's usual busy pointer
6183 w x g no The system's usual 'no input' pointer
6184 x g udsizing indicates up-down resizing
6185 x g lrsizing indicates left-right resizing
6186 x g crosshair like a big thin +
6187 x g hand1 black hand
6188 x g hand2 white hand
6189 x pencil what you write with
6190 x g question big ?
6191 x rightup-arrow arrow pointing right-up
6192 w x up-arrow arrow pointing up
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 x <number> any X11 pointer number (see X11/cursorfont.h)
6194
6195 The "avail" column contains a 'w' if the shape is available for Win32,
Drew Vogel48b19b22025-05-07 21:32:03 +02006196 x for X11 (including GTK+ 2), g for GTK+ 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 Any modes not specified or shapes not available use the normal mouse
6198 pointer.
6199
6200 Example: >
6201 :set mouseshape=s:udsizing,m:no
6202< will make the mouse turn to a sizing arrow over the status lines and
6203 indicate no input when the hit-enter prompt is displayed (since
6204 clicking the mouse has no effect in this state.)
6205
6206 *'mousetime'* *'mouset'*
6207'mousetime' 'mouset' number (default 500)
6208 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006209 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 time in msec between two mouse clicks for the second click to be
6211 recognized as a multi click.
6212
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006213
laburnumT3f7855a2023-12-05 18:37:03 +01006214 *'mzquantum'* *'mzq'*
6215'mzquantum' 'mzq' number (default 100)
6216 global
6217 {not available when compiled without the |+mzscheme|
6218 feature}
6219 The number of milliseconds between polls for MzScheme threads.
6220 Negative or zero value means no thread scheduling.
6221 NOTE: This option is set to the Vim default value when 'compatible'
6222 is reset.
6223
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006224 *'mzschemedll'*
6225'mzschemedll' string (default depends on the build)
6226 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006227 {only available when compiled with the |+mzscheme/dyn|
6228 feature}
6229 Specifies the name of the MzScheme shared library. The default is
6230 DYNAMIC_MZSCH_DLL which was specified at compile time.
6231 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006232 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006233 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006234 This option cannot be set from a |modeline| or in the |sandbox|, for
6235 security reasons.
6236
6237 *'mzschemegcdll'*
6238'mzschemegcdll' string (default depends on the build)
6239 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006240 {only available when compiled with the |+mzscheme/dyn|
6241 feature}
6242 Specifies the name of the MzScheme GC shared library. The default is
6243 DYNAMIC_MZGC_DLL which was specified at compile time.
6244 The value can be equal to 'mzschemedll' if it includes the GC code.
6245 Environment variables are expanded |:set_env|.
6246 This option cannot be set from a |modeline| or in the |sandbox|, for
6247 security reasons.
6248
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006250'nrformats' 'nf' string (default "bin,octal,hex",
6251 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 This defines what bases Vim will consider for numbers when using the
6254 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6255 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006256 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006258 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006259 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006261 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 considered to be hexadecimal. Example: Using CTRL-X on
6263 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006264 bin If included, numbers starting with "0b" or "0B" will be
6265 considered to be binary. Example: Using CTRL-X on
6266 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006267 unsigned If included, numbers are recognized as unsigned. Thus a
6268 leading dash or negative sign won't be considered as part of
6269 the number. Examples:
6270 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6271 (without "unsigned" it would become "9-2021").
6272 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6273 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006274 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6275 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006276 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006277 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006278 dash immediately preceded by a non-whitespace character (i.e.,
6279 not a tab or a " "), the negative sign won't be considered as
6280 part of the number. For example:
6281 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6282 (without "blank" it would become "Carbon-13").
6283 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006284 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006285 set, it would result in "Carbon -7").
6286 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006287 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006288 included, "unsigned" will take precedence.
6289
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 Numbers which simply begin with a digit in the range 1-9 are always
6291 considered decimal. This also happens for numbers that are not
6292 recognized as octal or hex.
6293
6294 *'number'* *'nu'* *'nonumber'* *'nonu'*
6295'number' 'nu' boolean (default off)
6296 local to window
6297 Print the line number in front of each line. When the 'n' option is
6298 excluded from 'cpoptions' a wrapped line will not use the column of
6299 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006300 The 'numberwidth' option can be used to set the room used for the line
6301 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 When a long, wrapped line doesn't start with the first character, '-'
6303 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006304 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6305 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006306 *number_relativenumber*
6307 The 'relativenumber' option changes the displayed number to be
6308 relative to the cursor. Together with 'number' there are these
6309 four combinations (cursor in line 3):
6310
Bram Moolenaar3848e002016-03-19 18:42:29 +01006311 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006312 'nornu' 'nornu' 'rnu' 'rnu'
6313
6314 |apple | 1 apple | 2 apple | 2 apple
6315 |pear | 2 pear | 1 pear | 1 pear
6316 |nobody | 3 nobody | 0 nobody |3 nobody
6317 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006319 *'numberwidth'* *'nuw'*
6320'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6321 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006322 {only available when compiled with the |+linebreak|
6323 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006324 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006325 when the 'number' or 'relativenumber' option is set or printing lines
6326 with a line number. Since one space is always between the number and
6327 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006328 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006329 fit the highest line number in the buffer respectively the number of
6330 rows in the window, depending on whether 'number' or 'relativenumber'
6331 is set. Thus with the Vim default of 4 there is room for a line number
6332 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006333 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006334 NOTE: This option is set to the Vi default value when 'compatible' is
6335 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006336
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006337 *'omnifunc'* *'ofu'*
6338'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006339 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006340 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006341 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006342 This option specifies a function to be used for Insert mode omni
6343 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006344 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006345 invoked and what it should return. The value can be the name of a
6346 function, a |lambda| or a |Funcref|. See |option-value-function| for
6347 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006348 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006349 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006350 This option cannot be set from a |modeline| or in the |sandbox|, for
6351 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006352
Bram Moolenaar02467872007-05-06 13:22:01 +00006353 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006354'opendevice' 'odev' boolean (default off)
6355 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006356 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006357 Enable reading and writing from devices. This may get Vim stuck on a
6358 device that can be opened but doesn't actually do the I/O. Therefore
6359 it is off by default.
6360 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6361 result in editing a device.
6362
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006363 *'operatorfunc'* *'opfunc'*
6364'operatorfunc' 'opfunc' string (default: empty)
6365 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006366 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006367 See |:map-operator| for more info and an example. The value can be
6368 the name of a function, a |lambda| or a |Funcref|. See
6369 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006370
6371 This option cannot be set from a |modeline| or in the |sandbox|, for
6372 security reasons.
6373
Bram Moolenaar251e1912011-06-19 05:09:16 +02006374 *'osfiletype'* *'oft'*
6375'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006377 This option was supported on RISC OS, which has been removed.
6378
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006379 *'packpath'* *'pp'*
6380'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006381 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006382 This option cannot be set from a |modeline| or in the |sandbox|, for
6383 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006384
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006386'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 global
6388 Specifies the nroff macros that separate paragraphs. These are pairs
6389 of two letters (see |object-motions|).
6390
6391 *'paste'* *'nopaste'*
6392'paste' boolean (default off)
6393 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006394 Put Vim in Paste mode. This is useful if you want to cut or copy
6395 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 unexpected effects.
6397 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 knows about pasting and will mostly do the right thing without 'paste'
6400 being set. The same is true for a terminal where Vim handles the
6401 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006402 This option is reset when starting the GUI. Thus if you set it in
6403 your .vimrc it will work in a terminal, but not in the GUI. Setting
6404 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6405 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 When the 'paste' option is switched on (also when it was already on):
6407 - mapping in Insert mode and Command-line mode is disabled
6408 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006410 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006411 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 - 'revins' is reset
6413 - 'ruler' is reset
6414 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006415 - 'smarttab' is reset
6416 - 'softtabstop' is set to 0
6417 - 'textwidth' is set to 0
6418 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006419 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006422 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006423 - 'indentexpr'
6424 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006425 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 NOTE: When you start editing another file while the 'paste' option is
6427 on, settings from the modelines or autocommands may change the
6428 settings again, causing trouble when pasting text. You might want to
6429 set the 'paste' option again.
6430 When the 'paste' option is reset the mentioned options are restored to
6431 the value before the moment 'paste' was switched from off to on.
6432 Resetting 'paste' before ever setting it does not have any effect.
6433 Since mapping doesn't work while 'paste' is active, you need to use
6434 the 'pastetoggle' option to toggle the 'paste' option with some key.
6435
6436 *'pastetoggle'* *'pt'*
6437'pastetoggle' 'pt' string (default "")
6438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 When non-empty, specifies the key sequence that toggles the 'paste'
6440 option. This is like specifying a mapping: >
6441 :map {keys} :set invpaste<CR>
6442< Where {keys} is the value of 'pastetoggle'.
6443 The difference is that it will work even when 'paste' is set.
6444 'pastetoggle' works in Insert mode and Normal mode, but not in
6445 Command-line mode.
6446 Mappings are checked first, thus overrule 'pastetoggle'. However,
6447 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6448 this: >
6449 :map <F10> :set paste<CR>
6450 :map <F11> :set nopaste<CR>
6451 :imap <F10> <C-O>:set paste<CR>
6452 :imap <F11> <nop>
6453 :set pastetoggle=<F11>
6454< This will make <F10> start paste mode and <F11> stop paste mode.
6455 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6456 mode everything is inserted literally, except the 'pastetoggle' key
6457 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006458 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459
6460 *'pex'* *'patchexpr'*
6461'patchexpr' 'pex' string (default "")
6462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 {not available when compiled without the |+diff|
6464 feature}
6465 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006466 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006467 This option cannot be set from a |modeline| or in the |sandbox|, for
6468 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469
Bram Moolenaardbc28022014-07-26 13:40:44 +02006470 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471'patchmode' 'pm' string (default "")
6472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 When non-empty the oldest version of a file is kept. This can be used
6474 to keep the original version of a file if you are changing files in a
6475 source distribution. Only the first time that a file is written a
6476 copy of the original file will be kept. The name of the copy is the
6477 name of the original file with the string in the 'patchmode' option
6478 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006479 ".orig" or ".org". 'backupdir' must not be empty for this to work
6480 (Detail: The backup file is renamed to the patchmode file after the
6481 new file has been successfully written, that's why it must be possible
6482 to write a backup file). If there was no file to be backed up, an
6483 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 When the 'backupskip' pattern matches, a patchmode file is not made.
6485 Using 'patchmode' for compressed files appends the extension at the
6486 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6487 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006488 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006490 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 other systems: ".,,")
6493 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006495 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6496 provided that the file being searched for has a relative path (not
6497 starting with "/", "./" or "../"). The directories in the 'path'
6498 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 - Use commas to separate directory names: >
6500 :set path=.,/usr/local/include,/usr/include
6501< - Spaces can also be used to separate directory names (for backwards
6502 compatibility with version 3.0). To have a space in a directory
6503 name, precede it with an extra backslash, and escape the space: >
6504 :set path=.,/dir/with\\\ space
6505< - To include a comma in a directory name precede it with an extra
6506 backslash: >
6507 :set path=.,/dir/with\\,comma
6508< - To search relative to the directory of the current file, use: >
6509 :set path=.
6510< - To search in the current directory use an empty string between two
6511 commas: >
6512 :set path=,,
6513< - A directory name may end in a ':' or '/'.
6514 - Environment variables are expanded |:set_env|.
6515 - When using |netrw.vim| URLs can be used. For example, adding
6516 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006517 - Search upwards and downwards in a directory tree using "*", "**" and
6518 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 - Careful with '\' characters, type two to get one in the option: >
6520 :set path=.,c:\\include
6521< Or just use '/' instead: >
6522 :set path=.,c:/include
6523< Don't forget "." or files won't even be found in the same directory as
6524 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006525 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 it is something like 256 or 1024 characters.
6527 You can check if all the include files are found, using the value of
6528 'path', see |:checkpath|.
6529 The use of |:set+=| and |:set-=| is preferred when adding or removing
6530 directories from the list. This avoids problems when a future version
6531 uses another default. To remove the current directory use: >
6532 :set path-=
6533< To add the current directory use: >
6534 :set path+=
6535< To use an environment variable, you probably need to replace the
6536 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006537 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006538 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539< Replace the ';' with a ':' or whatever separator is used. Note that
6540 this doesn't work when $INCL contains a comma or white space.
6541
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006542 *'perldll'*
6543'perldll' string (default depends on the build)
6544 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006545 {only available when compiled with the |+perl/dyn|
6546 feature}
6547 Specifies the name of the Perl shared library. The default is
6548 DYNAMIC_PERL_DLL, which was specified at compile time.
6549 Environment variables are expanded |:set_env|.
6550 This option cannot be set from a |modeline| or in the |sandbox|, for
6551 security reasons.
6552
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6554'preserveindent' 'pi' boolean (default off)
6555 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 When changing the indent of the current line, preserve as much of the
6557 indent structure as possible. Normally the indent is replaced by a
6558 series of tabs followed by spaces as required (unless |'expandtab'| is
6559 enabled, in which case only spaces are used). Enabling this option
6560 means the indent will preserve as many existing characters as possible
6561 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006562 'expandtab' does not apply to the preserved white space, a Tab remains
6563 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 NOTE: When using ">>" multiple times the resulting indent is a mix of
6565 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006566 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 Also see 'copyindent'.
6568 Use |:retab| to clean up white space.
6569
6570 *'previewheight'* *'pvh'*
6571'previewheight' 'pvh' number (default 12)
6572 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006573 {not available when compiled without the |+quickfix|
6574 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006576 commands. Used for |CTRL-W_}| when no count is given. Not used when
6577 'previewpopup' is set.
6578
6579 *'previewpopup'* *'pvp'*
6580'previewpopup' 'pvp' string (default empty)
6581 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006582 {not available when compiled without the |+textprop|
6583 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006584 When not empty a popup window is used for commands that would open a
6585 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006586 Not used for the insert completion info, add "popup" to
6587 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588
6589 *'previewwindow'* *'nopreviewwindow'*
6590 *'pvw'* *'nopvw'* *E590*
6591'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006592 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006593 {not available when compiled without the |+quickfix|
6594 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006595 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 set. It's normally not set directly, but by using one of the commands
6597 |:ptag|, |:pedit|, etc.
6598
6599 *'printdevice'* *'pdev'*
6600'printdevice' 'pdev' string (default empty)
6601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 {only available when compiled with the |+printer|
6603 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006604 The name of the printer to be used for |:hardcopy|.
6605 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006606 This option cannot be set from a |modeline| or in the |sandbox|, for
6607 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608
Bram Moolenaar8299df92004-07-10 09:47:34 +00006609 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006610'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 {only available when compiled with the |+printer|
6613 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006614 Sets the character encoding used when printing.
6615 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616
6617 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006618'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 {only available when compiled with the |+printer|
6621 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006622 Expression used to print the PostScript produced with |:hardcopy|.
6623 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006624 This option cannot be set from a |modeline| or in the |sandbox|, for
6625 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626
Bram Moolenaar8299df92004-07-10 09:47:34 +00006627 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628'printfont' 'pfn' string (default "courier")
6629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 {only available when compiled with the |+printer|
6631 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006632 The name of the font that will be used for |:hardcopy|.
6633 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634
6635 *'printheader'* *'pheader'*
6636'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 {only available when compiled with the |+printer|
6639 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006640 The format of the header produced in |:hardcopy| output.
6641 See |pheader-option|.
6642
6643 *'printmbcharset'* *'pmbcs'*
6644'printmbcharset' 'pmbcs' string (default "")
6645 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006646 {only available when compiled with the |+printer|
6647 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006648 The CJK character set to be used for CJK output from |:hardcopy|.
6649 See |pmbcs-option|.
6650
6651 *'printmbfont'* *'pmbfn'*
6652'printmbfont' 'pmbfn' string (default "")
6653 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006654 {only available when compiled with the |+printer|
6655 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006656 List of font names to be used for CJK output from |:hardcopy|.
6657 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658
6659 *'printoptions'* *'popt'*
6660'printoptions' 'popt' string (default "")
6661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006663 List of items that control the format of the output of |:hardcopy|.
6664 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006666 *'prompt'* *'noprompt'*
6667'prompt' boolean (default on)
6668 global
6669 When on a ":" prompt is used in Ex mode.
6670
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006671 *'pumheight'* *'ph'*
6672'pumheight' 'ph' number (default 0)
6673 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006674 Determines the maximum number of items to show in the popup menu for
6675 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006676 |ins-completion-menu|.
6677
glepnir88d75932025-03-27 20:09:07 +01006678 *'pummaxwidth'* *'pmw'*
6679'pummaxwidth' 'pmw' number (default 0)
6680 global
6681 Determines the maximum width to use for the popup menu for completion.
6682 When zero, there is no maximum width limit, otherwise the popup menu
6683 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006684 by "trunc" value of 'fillchars' option.
6685
6686 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006687 |ins-completion-menu|.
6688
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006689 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006690'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006691 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006692 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006693 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006694
Bram Moolenaard94464e2015-11-02 15:28:18 +01006695 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006696'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006697 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006698 {only available when compiled with the |+python/dyn|
6699 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006700 Specifies the name of the Python 2.x shared library. The default is
6701 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006702 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006703 This option cannot be set from a |modeline| or in the |sandbox|, for
6704 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006705
Bram Moolenaar94073162018-01-31 21:49:05 +01006706 *'pythonhome'*
6707'pythonhome' string (default "")
6708 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006709 {only available when compiled with the |+python/dyn|
6710 feature}
6711 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6712 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6713 which was specified at compile time, will be used for the Python 2.x
6714 home directory.
6715 Environment variables are expanded |:set_env|.
6716 This option cannot be set from a |modeline| or in the |sandbox|, for
6717 security reasons.
6718
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006719 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006720'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006721 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006722 {only available when compiled with the |+python3/dyn|
6723 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006724 Specifies the name of the Python 3 shared library. The default is
6725 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006726 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006727 This option cannot be set from a |modeline| or in the |sandbox|, for
6728 security reasons.
6729
Bram Moolenaar94073162018-01-31 21:49:05 +01006730 *'pythonthreehome'*
6731'pythonthreehome' string (default "")
6732 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006733 {only available when compiled with the |+python3/dyn|
6734 feature}
6735 Specifies the name of the Python 3 home directory. When
6736 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6737 PYTHON3_HOME, which was specified at compile time, will be used for
6738 the Python 3 home directory.
6739 Environment variables are expanded |:set_env|.
6740 This option cannot be set from a |modeline| or in the |sandbox|, for
6741 security reasons.
6742
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006743 *'pyxversion'* *'pyx'*
6744'pyxversion' 'pyx' number (default depends on the build)
6745 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006746 {only available when compiled with the |+python| or
6747 the |+python3| feature}
6748 Specifies the python version used for pyx* functions and commands
6749 |python_x|. The default value is as follows:
6750
6751 Compiled with Default ~
6752 |+python| and |+python3| 0
6753 only |+python| 2
6754 only |+python3| 3
6755
6756 Available values are 0, 2 and 3.
6757 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6758 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6759 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6760 to 2 if Python 2 is available.
6761 See also: |has-pythonx|
6762
6763 If Vim is compiled with only |+python| or |+python3| setting
6764 'pyxversion' has no effect. The pyx* functions and commands are
6765 always the same as the compiled version.
6766
6767 This option cannot be set from a |modeline| or in the |sandbox|, for
6768 security reasons.
6769
Bram Moolenaar858ba062020-05-31 23:11:59 +02006770 *'quickfixtextfunc'* *'qftf'*
6771'quickfixtextfunc' 'qftf' string (default "")
6772 global
6773 {only available when compiled with the |+quickfix|
6774 feature}
6775 This option specifies a function to be used to get the text to display
6776 in the quickfix and location list windows. This can be used to
6777 customize the information displayed in the quickfix or location window
6778 for each entry in the corresponding quickfix or location list. See
6779 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006780 function and an example. The value can be the name of a function, a
6781 |lambda| or a |Funcref|. See |option-value-function| for more
6782 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006783
6784 This option cannot be set from a |modeline| or in the |sandbox|, for
6785 security reasons.
6786
Bram Moolenaar677ee682005-01-27 14:41:15 +00006787 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006788'quoteescape' 'qe' string (default "\")
6789 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006790 The characters that are used to escape quotes in a string. Used for
6791 objects like a', a" and a` |a'|.
6792 When one of the characters in this option is found inside a string,
6793 the following character will be skipped. The default value makes the
6794 text "foo\"bar\\" considered to be one string.
6795
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6797'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006798 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 If on, writes fail unless you use a '!'. Protects you from
6800 accidentally overwriting a file. Default on when Vim is started
6801 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006802 When using ":w!" the 'readonly' option is reset for the current
6803 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006804 When using the ":view" command the 'readonly' option is set for the
6805 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006806 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006808 *'redrawtime'* *'rdt'*
6809'redrawtime' 'rdt' number (default 2000)
6810 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006811 {only available when compiled with the |+reltime|
6812 feature}
6813 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006814 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006815 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006816 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006817 matches will be highlighted.
6818 For syntax highlighting the time applies per window. When over the
6819 limit syntax highlighting is disabled until |CTRL-L| is used.
6820 This is used to avoid that Vim hangs when using a very complicated
6821 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006822
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006823 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006824'regexpengine' 're' number (default 0)
6825 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006826 This selects the default regexp engine. |two-engines|
6827 The possible values are:
6828 0 automatic selection
6829 1 old engine
6830 2 NFA engine
6831 Note that when using the NFA engine and the pattern contains something
6832 that is not supported the pattern will not match. This is only useful
6833 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006834 Using automatic selection enables Vim to switch the engine, if the
6835 default engine becomes too costly. E.g., when the NFA engine uses too
6836 many states. This should prevent Vim from hanging on a combination of
6837 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006838
Bram Moolenaar64486672010-05-16 15:46:46 +02006839 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6840'relativenumber' 'rnu' boolean (default off)
6841 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006842 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006843 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006844 precede some vertical motion commands (e.g. j k + -) with, without
6845 having to calculate it yourself. Especially useful in combination with
6846 other commands (e.g. y d c < > gq gw =).
6847 When the 'n' option is excluded from 'cpoptions' a wrapped
6848 line will not use the column of line numbers (this is the default when
6849 'compatible' isn't set).
6850 The 'numberwidth' option can be used to set the room used for the line
6851 number.
6852 When a long, wrapped line doesn't start with the first character, '-'
6853 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006854 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6855 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006856
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006857 The number in front of the cursor line also depends on the value of
6858 'number', see |number_relativenumber| for all combinations of the two
6859 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006860
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 *'remap'* *'noremap'*
6862'remap' boolean (default on)
6863 global
6864 Allows for mappings to work recursively. If you do not want this for
6865 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006866 NOTE: To avoid portability problems with Vim scripts, always keep
6867 this option at the default "on". Only switch it off when working with
6868 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869
zeertzjqd086b8f2024-02-25 15:42:52 +08006870 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006871'renderoptions' 'rop' string (default: empty)
6872 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006873 {only available when compiled with GUI and DIRECTX on
6874 MS-Windows}
6875 Select a text renderer and set its options. The options depend on the
6876 renderer.
6877
6878 Syntax: >
6879 set rop=type:{renderer}(,{name}:{value})*
6880<
6881 Currently, only one optional renderer is available.
6882
6883 render behavior ~
6884 directx Vim will draw text using DirectX (DirectWrite). It makes
6885 drawn glyphs more beautiful than default GDI.
6886 It requires 'encoding' is "utf-8", and only works on
6887 MS-Windows Vista or newer version.
6888
6889 Options:
6890 name meaning type value ~
6891 gamma gamma float 1.0 - 2.2 (maybe)
6892 contrast enhancedContrast float (unknown)
6893 level clearTypeLevel float (unknown)
6894 geom pixelGeometry int 0 - 2 (see below)
6895 renmode renderingMode int 0 - 6 (see below)
6896 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006897 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006898
Bram Moolenaar92467d32017-12-05 13:22:16 +01006899 See this URL for detail (except for scrlines):
6900 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006901
6902 For geom: structure of a device pixel.
6903 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6904 1 - DWRITE_PIXEL_GEOMETRY_RGB
6905 2 - DWRITE_PIXEL_GEOMETRY_BGR
6906
6907 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006908 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006909
6910 For renmode: method of rendering glyphs.
6911 0 - DWRITE_RENDERING_MODE_DEFAULT
6912 1 - DWRITE_RENDERING_MODE_ALIASED
6913 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6914 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6915 4 - DWRITE_RENDERING_MODE_NATURAL
6916 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6917 6 - DWRITE_RENDERING_MODE_OUTLINE
6918
6919 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006920 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006921
6922 For taamode: antialiasing mode used for drawing text.
6923 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6924 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6925 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6926 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6927
6928 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006929 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6930
Bram Moolenaara338adc2018-01-31 20:51:47 +01006931 For scrlines:
6932 This was used for optimizing scrolling behavior, however this
6933 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006934
6935 Example: >
6936 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006937 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006938 set rop=type:directx
6939<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006940 If select a raster font (Courier, Terminal or FixedSys which
6941 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006942 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006943
6944 NOTE: It is known that some fonts and options combination
6945 causes trouble on drawing glyphs.
6946
Bram Moolenaar92467d32017-12-05 13:22:16 +01006947 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006948 special made fonts (True-Type fonts which includes only
6949 bitmap glyphs).
6950 - 'taamode:3' will not work with some vector fonts.
6951
6952 NOTE: With this option, you can display colored emoji
6953 (emoticon) in Windows 8.1 or later. To display colored emoji,
6954 there are some conditions which you should notice.
6955
6956 - If your font includes non-colored emoji already, it will
6957 be used.
6958 - If your font doesn't have emoji, the system chooses an
6959 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6960 will be used.
6961 - When this alternative font didn't have fixed width glyph,
6962 emoji might be rendered beyond the bounding box of drawing
6963 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006964
6965 Other render types are currently not supported.
6966
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 *'report'*
6968'report' number (default 2)
6969 global
6970 Threshold for reporting number of lines changed. When the number of
6971 changed lines is more than 'report' a message will be given for most
6972 ":" commands. If you want it always, set 'report' to 0.
6973 For the ":substitute" command the number of substitutions is used
6974 instead of the number of lines.
6975
6976 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6977'restorescreen' 'rs' boolean (default on)
6978 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006979 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 When set, the screen contents is restored when exiting Vim. This also
6981 happens when executing external commands.
6982
6983 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6984 options in your .vimrc. To disable restoring:
6985 set t_ti= t_te=
6986 To enable restoring (for an xterm):
6987 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6988 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6989
6990 *'revins'* *'ri'* *'norevins'* *'nori'*
6991'revins' 'ri' boolean (default off)
6992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 {only available when compiled with the |+rightleft|
6994 feature}
6995 Inserting characters in Insert mode will work backwards. See "typing
6996 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6997 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006998 NOTE: This option is reset when 'compatible' is set.
6999 This option is reset when 'paste' is set and restored when 'paste' is
7000 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001
7002 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
7003'rightleft' 'rl' boolean (default off)
7004 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 {only available when compiled with the |+rightleft|
7006 feature}
7007 When on, display orientation becomes right-to-left, i.e., characters
7008 that are stored in the file appear from the right to the left.
7009 Using this option, it is possible to edit files for languages that
7010 are written from the right to the left such as Hebrew and Arabic.
7011 This option is per window, so it is possible to edit mixed files
7012 simultaneously, or to view the same file in both ways (this is
7013 useful whenever you have a mixed text file with both right-to-left
7014 and left-to-right strings so that both sets are displayed properly
7015 in different windows). Also see |rileft.txt|.
7016
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02007017 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018'rightleftcmd' 'rlc' string (default "search")
7019 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 {only available when compiled with the |+rightleft|
7021 feature}
7022 Each word in this option enables the command line editing to work in
7023 right-to-left mode for a group of commands:
7024
7025 search "/" and "?" commands
7026
7027 This is useful for languages such as Hebrew, Arabic and Farsi.
7028 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
7029
Bram Moolenaard94464e2015-11-02 15:28:18 +01007030 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007031'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01007032 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01007033 {only available when compiled with the |+ruby/dyn|
7034 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01007035 Specifies the name of the Ruby shared library. The default is
7036 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007037 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01007038 This option cannot be set from a |modeline| or in the |sandbox|, for
7039 security reasons.
7040
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007042'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007045 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 text in the file is shown on the far right:
7047 Top first line is visible
7048 Bot last line is visible
7049 All first and last line are visible
7050 45% relative position in the file
7051 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007052 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01007053 ruler is shown there. Otherwise it is shown in the last line of the
7054 screen. If the statusline is given by 'statusline' (i.e. not empty),
7055 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02007057 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 the text column (byte number) and the screen column are shown,
7059 separated with a dash.
7060 For an empty line "0-1" is shown.
7061 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02007062 This option is reset when 'paste' is set and restored when 'paste' is
7063 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 If you don't want to see the ruler all the time but want to know where
7065 you are, use "g CTRL-G" |g_CTRL-G|.
7066 NOTE: This option is reset when 'compatible' is set.
7067
7068 *'rulerformat'* *'ruf'*
7069'rulerformat' 'ruf' string (default empty)
7070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 {not available when compiled without the |+statusline|
7072 feature}
7073 When this option is not empty, it determines the content of the ruler
7074 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00007075 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007076 This option cannot be set in a modeline when 'modelineexpr' is off.
7077
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 The default ruler width is 17 characters. To make the ruler 15
7079 characters wide, put "%15(" at the start and "%)" at the end.
7080 Example: >
7081 :set rulerformat=%15(%c%V\ %p%%%)
7082<
7083 *'runtimepath'* *'rtp'* *vimfiles*
7084'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007085 Unix: "$HOME/.vim or
7086 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 $VIM/vimfiles,
7088 $VIMRUNTIME,
7089 $VIM/vimfiles/after,
7090 $HOME/.vim/after"
7091 Amiga: "home:vimfiles,
7092 $VIM/vimfiles,
7093 $VIMRUNTIME,
7094 $VIM/vimfiles/after,
7095 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01007096 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 $VIM/vimfiles,
7098 $VIMRUNTIME,
7099 $VIM/vimfiles/after,
7100 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007101 Haiku: "$BE_USER_SETTINGS/vim,
7102 $VIM/vimfiles,
7103 $VIMRUNTIME,
7104 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01007105 $BE_USER_SETTINGS/vim/after"
7106 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 $VIM/vimfiles,
7108 $VIMRUNTIME,
7109 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00007110 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 This is a list of directories which will be searched for runtime
7113 files:
7114 filetype.vim filetypes by file name |new-filetype|
7115 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007116 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 colors/ color scheme files |:colorscheme|
7118 compiler/ compiler files |:compiler|
7119 doc/ documentation |write-local-help|
7120 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007121 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 indent/ indent scripts |indent-expression|
7123 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02007124 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02007126 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 plugin/ plugin scripts |write-plugin|
7128 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007129 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 syntax/ syntax files |mysyntaxfile|
7131 tutor/ files for vimtutor |tutor|
7132
7133 And any other file searched for with the |:runtime| command.
7134
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007135 For $XDG_CONFIG_HOME see |xdg-base-dir|.
7136
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 The defaults for most systems are setup to search five locations:
7138 1. In your home directory, for your personal preferences.
7139 2. In a system-wide Vim directory, for preferences from the system
7140 administrator.
7141 3. In $VIMRUNTIME, for files distributed with Vim.
7142 *after-directory*
7143 4. In the "after" directory in the system-wide Vim directory. This is
7144 for the system administrator to overrule or add to the distributed
7145 defaults (rarely needed)
7146 5. In the "after" directory in your home directory. This is for
7147 personal preferences to overrule or add to the distributed defaults
7148 or system-wide settings (rarely needed).
7149
Bram Moolenaard0796902016-09-16 20:02:31 +02007150 More entries are added when using |packages|. If it gets very long
7151 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7152 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007153
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7155 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007156 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 wildcards.
7158 See |:runtime|.
7159 Example: >
7160 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7161< This will use the directory "~/vimruntime" first (containing your
7162 personal Vim runtime files), then "/mygroup/vim" (shared between a
7163 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7164 files).
7165 You probably should always include $VIMRUNTIME somewhere, to use the
7166 distributed runtime files. You can put a directory before $VIMRUNTIME
7167 to find files which replace a distributed runtime files. You can put
7168 a directory after $VIMRUNTIME to find files which add to distributed
7169 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007170 When Vim is started with |--clean| the home directory entries are not
7171 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 This option cannot be set from a |modeline| or in the |sandbox|, for
7173 security reasons.
7174
7175 *'scroll'* *'scr'*
7176'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007177 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7179 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007180 changes. This may happen when enabling the |status-line| or
7181 'tabline' option after setting the 'scroll' option.
7182 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007183 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007184 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185
7186 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7187'scrollbind' 'scb' boolean (default off)
7188 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007189 See also |scroll-binding|. When this option is set, scrolling the
7190 current window also scrolls other scrollbind windows (windows that
7191 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 differences between two versions of a file, see 'diff'.
7193 See |'scrollopt'| for options that determine how this option should be
7194 interpreted.
7195 This option is mostly reset when splitting a window to edit another
7196 file. This means that ":split | edit file" results in two windows
7197 with scroll-binding, but ":split file" does not.
7198
Bram Moolenaarae20f342019-11-05 21:09:23 +01007199 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7200'scrollfocus' 'scf' boolean (default off)
7201 global
7202 {only for MS-Windows GUI}
7203 When using the scroll wheel and this option is set, the window under
7204 the mouse pointer is scrolled. With this option off the current
7205 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007206 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007207
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 *'scrolljump'* *'sj'*
7209'scrolljump' 'sj' number (default 1)
7210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 Minimal number of lines to scroll when the cursor gets off the
7212 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7213 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007214 When set to a negative number from -1 to -100 this is used as the
7215 percentage of the window height. Thus -50 scrolls half the window
7216 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 NOTE: This option is set to 1 when 'compatible' is set.
7218
7219 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007220'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007221 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 Minimal number of screen lines to keep above and below the cursor.
7223 This will make some context visible around where you are working. If
7224 you set it to a very large value (999) the cursor line will always be
7225 in the middle of the window (except at the start or end of the file or
7226 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007227 After using the local value, go back the global value with one of
7228 these two: >
7229 setlocal scrolloff<
7230 setlocal scrolloff=-1
7231< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 NOTE: This option is set to 0 when 'compatible' is set.
7233
7234 *'scrollopt'* *'sbo'*
7235'scrollopt' 'sbo' string (default "ver,jump")
7236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007238 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7239 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 The following words are available:
7241 ver Bind vertical scrolling for 'scrollbind' windows
7242 hor Bind horizontal scrolling for 'scrollbind' windows
7243 jump Applies to the offset between two windows for vertical
7244 scrolling. This offset is the difference in the first
7245 displayed line of the bound windows. When moving
7246 around in a window, another 'scrollbind' window may
7247 reach a position before the start or after the end of
7248 the buffer. The offset is not changed though, when
7249 moving back the 'scrollbind' window will try to scroll
7250 to the desired position when possible.
7251 When now making that window the current one, two
7252 things can be done with the relative offset:
7253 1. When "jump" is not included, the relative offset is
7254 adjusted for the scroll position in the new current
7255 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007256 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 2. When "jump" is included, the other windows are
7258 scrolled to keep the same relative offset. When
7259 going back to the other window, it still uses the
7260 same relative offset.
7261 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007262 When 'diff' mode is active there always is vertical scroll binding,
7263 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264
7265 *'sections'* *'sect'*
7266'sections' 'sect' string (default "SHNHH HUnhsh")
7267 global
7268 Specifies the nroff macros that separate sections. These are pairs of
7269 two letters (See |object-motions|). The default makes a section start
7270 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7271
7272 *'secure'* *'nosecure'* *E523*
7273'secure' boolean (default off)
7274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 When on, ":autocmd", shell and write commands are not allowed in
7276 ".vimrc" and ".exrc" in the current directory and map commands are
7277 displayed. Switch it off only if you know that you will not run into
7278 problems, or when the 'exrc' option is off. On Unix this option is
7279 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007280 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 'secure' at the end of your ~/.vimrc then.
7282 This option cannot be set from a |modeline| or in the |sandbox|, for
7283 security reasons.
7284
7285 *'selection'* *'sel'*
7286'selection' 'sel' string (default "inclusive")
7287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 This option defines the behavior of the selection. It is only used
7289 in Visual and Select mode.
7290 Possible values:
7291 value past line inclusive ~
7292 old no yes
7293 inclusive yes yes
7294 exclusive yes no
7295 "past line" means that the cursor is allowed to be positioned one
7296 character past the line.
7297 "inclusive" means that the last character of the selection is included
7298 in an operation. For example, when "x" is used to delete the
7299 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007300 When "old" is used and 'virtualedit' allows the cursor to move past
7301 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007302 When "exclusive" is used, cursor position in visual mode will be
7303 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Christian Brabandtbfeefc42025-06-02 19:56:57 +02007304
7305 Note:
7306 - When "exclusive" is used and selecting from the end backwards, you
7307 cannot include the last character of a line, when starting in Normal
7308 mode and 'virtualedit' empty.
7309 - when "exclusive" is used with a single character visual selection,
7310 Vim will behave as if the 'selection' is inclusive (in other words,
7311 you cannot visually select an empty region).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312
7313 The 'selection' option is set by the |:behave| command.
7314
7315 *'selectmode'* *'slm'*
7316'selectmode' 'slm' string (default "")
7317 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007318 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 Select mode instead of Visual mode, when a selection is started.
7320 Possible values:
7321 mouse when using the mouse
7322 key when using shifted special keys
7323 cmd when using "v", "V" or CTRL-V
7324 See |Select-mode|.
7325 The 'selectmode' option is set by the |:behave| command.
7326
7327 *'sessionoptions'* *'ssop'*
7328'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007329 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007331 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 feature}
7333 Changes the effect of the |:mksession| command. It is a comma
7334 separated list of words. Each word enables saving and restoring
7335 something:
7336 word save and restore ~
7337 blank empty windows
7338 buffers hidden and unloaded buffers, not just those in windows
7339 curdir the current directory
7340 folds manually created folds, opened/closed folds and local
7341 fold options
7342 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007343 and contain at least one lowercase letter. Only
7344 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 help the help window
7346 localoptions options and mappings local to a window or buffer (not
7347 global values for local options)
7348 options all options and mappings (also global values for local
7349 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007350 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 resize size of the Vim window: 'lines' and 'columns'
7352 sesdir the directory in which the session file is located
7353 will become the current directory (useful with
7354 projects accessed over a network from different
7355 systems)
7356 slash backslashes in file names replaced with forward
7357 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007358 tabpages all tab pages; without this only the current tab page
7359 is restored, so that you can make a session for each
7360 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007361 terminal include terminal windows where the command can be
7362 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 unix with Unix end-of-line format (single <NL>), even when
7364 on Windows or DOS
7365 winpos position of the whole Vim window
7366 winsize window sizes
7367
7368 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007369 When neither "curdir" nor "sesdir" is included, file names are stored
7370 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007371 If you leave out "options" many things won't work well after restoring
7372 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 "slash" and "unix" are useful on Windows when sharing session files
7374 with Unix. The Unix version of Vim cannot source dos format scripts,
7375 but the Windows version of Vim can source unix format scripts.
7376
7377 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007378'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 global
7380 Name of the shell to use for ! and :! commands. When changing the
7381 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7382 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007383 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 See |option-backslash| about including spaces and backslashes.
7385 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007386
Bram Moolenaara2baa732022-02-04 16:09:54 +00007387 In |restricted-mode| shell commands will not be possible. This mode
7388 is used if the value of $SHELL ends in "false" or "nologin".
7389
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007390 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007391 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7393< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007396 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007398 Example with escaped space (Vim will do this when initializing the
7399 option from $SHELL): >
7400 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007401< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007402 backslashes are consumed by `:set`.
7403
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 Under MS-Windows, when the executable ends in ".com" it must be
7405 included. Thus setting the shell to "command.com" or "4dos.com"
7406 works, but "command" and "4dos" do not work for all commands (e.g.,
7407 filtering).
7408 For unknown reasons, when using "4dos.com" the current directory is
7409 changed to "C:\". To avoid this set 'shell' like this: >
7410 :set shell=command.com\ /c\ 4dos
7411< This option cannot be set from a |modeline| or in the |sandbox|, for
7412 security reasons.
7413
7414 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007415'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007416 Win32, when 'shell' contains "powershell":
7417 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007418 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007421 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7422 For MS-Windows, the default is set according to the value of 'shell',
7423 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007424 On Unix it can have more than one flag. Each white space separated
7425 part is passed as an argument to the shell command.
7426 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007427 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 This option cannot be set from a |modeline| or in the |sandbox|, for
7429 security reasons.
7430
7431 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007432'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7433 "2>&1| tee", or
7434 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 {not available when compiled without the |+quickfix|
7437 feature}
7438 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007439 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 including spaces and backslashes.
7441 The name of the temporary file can be represented by "%s" if necessary
7442 (the file name is appended automatically if no %s appears in the value
7443 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007444 For the Amiga the default is ">". For MS-Windows using powershell the
7445 default is "2>&1 | Out-File -Encoding default", otherwise the default
7446 is ">%s 2>&1". The output is directly saved in a file and not echoed
7447 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007448 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 in a file and echoed to the screen. If the 'shell' option is "csh" or
7450 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007451 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007452 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7453 means that stderr is also included. Before using the 'shell' option a
7454 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007455 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7456 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 The initialization of this option is done after reading the ".vimrc"
7458 and the other initializations, so that when the 'shell' option is set
7459 there, the 'shellpipe' option changes automatically, unless it was
7460 explicitly set before.
7461 When 'shellpipe' is set to an empty string, no redirection of the
7462 ":make" output will be done. This is useful if you use a 'makeprg'
7463 that writes to 'makeef' by itself. If you want no piping, but do
7464 want to include the 'makeef', set 'shellpipe' to a single space.
7465 Don't forget to precede the space with a backslash: ":set sp=\ ".
7466 In the future pipes may be used for filtering and this option will
7467 become obsolete (at least for Unix).
7468 This option cannot be set from a |modeline| or in the |sandbox|, for
7469 security reasons.
7470
7471 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007472'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 Quoting character(s), put around the command passed to the shell, for
7475 the "!" and ":!" commands. The redirection is kept outside of the
7476 quoting. See 'shellxquote' to include the redirection. It's
7477 probably not useful to set both options.
7478 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007479 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007480 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 This option cannot be set from a |modeline| or in the |sandbox|, for
7482 security reasons.
7483
7484 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007485'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7486 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 String to be used to put the output of a filter command in a temporary
7489 file. See also |:!|. See |option-backslash| about including spaces
7490 and backslashes.
7491 The name of the temporary file can be represented by "%s" if necessary
7492 (the file name is appended automatically if no %s appears in the value
7493 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007494 The default is ">". For Unix, if the 'shell' option is "csh" or
7495 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007496 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007497 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7498 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007499 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7500 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007501 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7502 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 The initialization of this option is done after reading the ".vimrc"
7504 and the other initializations, so that when the 'shell' option is set
7505 there, the 'shellredir' option changes automatically unless it was
7506 explicitly set before.
7507 In the future pipes may be used for filtering and this option will
7508 become obsolete (at least for Unix).
7509 This option cannot be set from a |modeline| or in the |sandbox|, for
7510 security reasons.
7511
7512 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7513'shellslash' 'ssl' boolean (default off)
7514 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007515 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007517 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007518 powershell.exe. Backward slashes can still be typed, but they are
7519 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 Note that setting or resetting this option has no effect for some
7521 existing file names, thus this option needs to be set before opening
7522 any file for best results. This might change in the future.
7523 'shellslash' only works when a backslash can be used as a path
7524 separator. To test if this is so use: >
7525 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007526< Also see 'completeslash'.
7527
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007528 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7529'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7530 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007531 When on, use temp files for shell commands. When off use a pipe.
7532 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007533 Currently a pipe is only supported on Unix and MS-Windows 2K and
7534 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007535 :if has("filterpipe")
7536< The advantage of using a pipe is that nobody can read the temp file
7537 and the 'shell' command does not need to support redirection.
7538 The advantage of using a temp file is that the file type and encoding
7539 can be detected.
7540 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7541 |FilterWritePost| autocommands event are not triggered when
7542 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007543 The `system()` function does not respect this option and always uses
7544 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007545 NOTE: This option is set to the Vim default value when 'compatible'
7546 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007547
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 *'shelltype'* *'st'*
7549'shelltype' 'st' number (default 0)
7550 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007551 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 On the Amiga this option influences the way how the commands work
7553 which use a shell.
7554 0 and 1: always use the shell
7555 2 and 3: use the shell only to filter lines
7556 4 and 5: use shell only for ':sh' command
7557 When not using the shell, the command is executed directly.
7558
7559 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7560 1 and 3: use "shell cmd" to start external commands
7561
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007562 *'shellxescape'* *'sxe'*
7563'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007564 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007565 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007566 When 'shellxquote' is set to "(" then the characters listed in this
7567 option will be escaped with a '^' character. This makes it possible
7568 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007569 This option cannot be set from a |modeline| or in the |sandbox|, for
7570 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007571
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 *'shellxquote'* *'sxq'*
7573'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007574 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007575 for Win32, when 'shell' is
7576 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007577 for Win32, when 'shell' contains "sh"
7578 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 for Unix, when using system(): "\"")
7580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 Quoting character(s), put around the command passed to the shell, for
7582 the "!" and ":!" commands. Includes the redirection. See
7583 'shellquote' to exclude the redirection. It's probably not useful
7584 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007585 When the value is '(' then ')' is appended. When the value is '"('
7586 then ')"' is appended.
7587 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007588 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007589 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7590 pwsh.exe which automatically strips off the first and last quote on a
7591 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7592 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007593 'shell', to reduce the need to set this option by the user. See
7594 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 This option cannot be set from a |modeline| or in the |sandbox|, for
7596 security reasons.
7597
7598 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7599'shiftround' 'sr' boolean (default off)
7600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 Round indent to multiple of 'shiftwidth'. Applies to > and <
7602 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7603 a multiple of 'shiftwidth' (this is Vi compatible).
7604 NOTE: This option is reset when 'compatible' is set.
7605
7606 *'shiftwidth'* *'sw'*
7607'shiftwidth' 'sw' number (default 8)
7608 local to buffer
Damien Lejay95ea0b02025-06-01 19:10:36 +02007609 Number of columns that make up one level of (auto)indentation. Used
7610 by |'cindent'|, |<<|, |>>|, etc.
7611 If set to 0, Vim uses the current 'tabstop' value. Use |shiftwidth()|
7612 to obtain the effective value in scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613
7614 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007615'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7616 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007617 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007619 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 It is a list of flags:
7621 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007622 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7623 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7624 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7625 m use "[+]" instead of "[Modified]" *shm-m*
7626 n use "[New]" instead of "[New File]" *shm-n*
7627 r use "[RO]" instead of "[readonly]" *shm-r*
7628 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007630 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7631 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007632 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007633 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007635 o overwrite message for writing a file with subsequent *shm-o*
7636 message for reading a file (useful for ":wn" or when
7637 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007638 O message for reading a file overwrites any previous *shm-O*
7639 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007640 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7641 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007642 the search count do not show "W" before the count message
7643 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007644 t truncate file message at the start if it is too long *shm-t*
7645 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007646 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007647 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007648 long to fit on the command line; "..." will appear in the
7649 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007650 W don't give "written" or "[w]" when writing a file *shm-W*
7651 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007652 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007653 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007654 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007655 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007656 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7657 match", "Pattern not found", "Back at original", etc.
7658 C don't give messages while scanning for ins-completion *shm-C*
7659 items, for instance "scanning tags"
7660 q use "recording" instead of "recording @a" *shm-q*
7661 F don't give the file info when editing a file, like *shm-F*
7662 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007663 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007664 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007665 "[1/5]". When the "S" flag is not present (e.g. search count
7666 is shown), the "search hit BOTTOM, continuing at TOP" and
7667 "search hit TOP, continuing at BOTTOM" messages are only
7668 indicated by a "W" (Mnemonic: Wrapped) letter before the
7669 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670
7671 This gives you the opportunity to avoid that a change between buffers
7672 requires you to hit <Enter>, but still gives as useful a message as
7673 possible for the space available. To get the whole message that you
7674 would have got with 'shm' empty, use ":file!"
7675 Useful values:
7676 shm= No abbreviation of message.
7677 shm=a Abbreviation, but no loss of information.
7678 shm=at Abbreviation, and truncate message when necessary.
7679
7680 NOTE: This option is set to the Vi default value when 'compatible' is
7681 set and to the Vim default value when 'compatible' is reset.
7682
7683 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7684'shortname' 'sn' boolean (default off)
7685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 Filenames are assumed to be 8 characters plus one extension of 3
7687 characters. Multiple dots in file names are not allowed. When this
7688 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007689 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007691 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692
7693 *'showbreak'* *'sbr'* *E595*
7694'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007695 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007696 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 feature}
7698 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007699 values are "> " or "+++ ": >
7700 :set showbreak=>\
7701< Note the backslash to escape the trailing space. It's easier like
7702 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007703 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007704< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 comma (in a future version the comma might be used to separate the
7706 part that is shown at the end and at the start of a line).
7707 The characters are highlighted according to the '@' flag in
7708 'highlight'.
7709 Note that tabs after the showbreak will be displayed differently.
7710 If you want the 'showbreak' to appear in between line numbers, add the
7711 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007712 A window-local value overrules a global value. If the global value is
7713 set and you want no value in the current window use NONE: >
7714 :setlocal showbreak=NONE
7715<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007717'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7718 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007720 Show (partial) command in the last line of the screen. Set this
7721 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 In Visual mode the size of the selected area is shown:
7723 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007724 If the number of bytes is different it is also displayed: "2-6"
7725 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007727 - When selecting a block, the size in screen characters:
7728 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007729 This information can be displayed in an alternative location using the
7730 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 NOTE: This option is set to the Vi default value when 'compatible' is
7732 set and to the Vim default value when 'compatible' is reset.
7733
Luuk van Baalba936f62022-12-15 13:15:39 +00007734 *'showcmdloc'* *'sloc'*
7735'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007736 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007737 This option can be used to display the (partially) entered command in
7738 another location. Possible values are:
7739 last Last line of the screen (default).
7740 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007741 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007742 Setting this option to "statusline" or "tabline" means that these will
7743 be redrawn whenever the command changes, which can be on every key
7744 pressed.
7745 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7746 place the text. Without a custom 'statusline' or 'tabline' it will be
7747 displayed in a convenient location.
7748
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7750'showfulltag' 'sft' boolean (default off)
7751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 When completing a word in insert mode (see |ins-completion|) from the
7753 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007754 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 matched a C function, you can see a template for what arguments are
7756 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007757 Note that this doesn't work well together with having "longest" in
7758 'completeopt', because the completion from the search pattern may not
7759 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760
7761 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7762'showmatch' 'sm' boolean (default off)
7763 global
7764 When a bracket is inserted, briefly jump to the matching one. The
7765 jump is only done if the match can be seen on the screen. The time to
7766 show the match can be set with 'matchtime'.
7767 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007768 seen or not).
7769 This option is reset when 'paste' is set and restored when 'paste' is
7770 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 When the 'm' flag is not included in 'cpoptions', typing a character
7772 will immediately move the cursor back to where it belongs.
7773 See the "sm" field in 'guicursor' for setting the cursor shape and
7774 blinking when showing the match.
7775 The 'matchpairs' option can be used to specify the characters to show
7776 matches for. 'rightleft' and 'revins' are used to look for opposite
7777 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007778 Also see the matchparen plugin for highlighting the match when moving
7779 around |pi_paren.txt|.
7780 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781
7782 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7783'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7784 global
7785 If in Insert, Replace or Visual mode put a message on the last line.
7786 Use the 'M' flag in 'highlight' to set the type of highlighting for
7787 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007788 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 doesn't mean XIM is really active, especially when 'imactivatekey' is
7790 not set.
7791 NOTE: This option is set to the Vi default value when 'compatible' is
7792 set and to the Vim default value when 'compatible' is reset.
7793
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007794 *'showtabline'* *'stal'*
7795'showtabline' 'stal' number (default 1)
7796 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007797 The value of this option specifies when the line with tab page labels
7798 will be displayed:
7799 0: never
7800 1: only if there are at least two tab pages
7801 2: always
7802 This is both for the GUI and non-GUI implementation of the tab pages
7803 line.
7804 See |tab-page| for more information about tab pages.
7805
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007806 *'showtabpanel'* *'stpl'*
7807'showtabpanel' 'stpl' number (default 0)
7808 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007809 {not available when compiled without the |+tabpanel|
7810 feature}
7811 The value of this option specifies when the |tabpanel| with tab page
7812 labels will be displayed:
7813 0: never
7814 1: only if there are at least two tab pages
7815 2: always
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02007816 See |tab-page| for more information about tab page labels.
7817
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 *'sidescroll'* *'ss'*
7819'sidescroll' 'ss' number (default 0)
7820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 The minimal number of columns to scroll horizontally. Used only when
7822 the 'wrap' option is off and the cursor is moved off of the screen.
7823 When it is zero the cursor will be put in the middle of the screen.
7824 When using a slow terminal set it to a large number or 0. When using
7825 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7826 commands.
7827
7828 *'sidescrolloff'* *'siso'*
7829'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007830 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007832 right of the cursor if 'nowrap' is set. Setting this option to a
7833 value greater than 0 while having |'sidescroll'| also at a non-zero
7834 value makes some context visible in the line you are scrolling in
7835 horizontally (except at beginning of the line). Setting this option
7836 to a large value (like 999) has the effect of keeping the cursor
7837 horizontally centered in the window, as long as one does not come too
7838 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007839 After using the local value, go back the global value with one of
7840 these two: >
7841 setlocal sidescrolloff<
7842 setlocal sidescrolloff=-1
7843< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844
7845 Example: Try this together with 'sidescroll' and 'listchars' as
7846 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007847 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848
7849 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7850 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007851<
7852 *'signcolumn'* *'scl'*
7853'signcolumn' 'scl' string (default "auto")
7854 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007855 {not available when compiled without the |+signs|
7856 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007857 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007858 "auto" only when there is a sign to display
7859 "no" never
7860 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007861 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007862 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7865'smartcase' 'scs' boolean (default off)
7866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 Override the 'ignorecase' option if the search pattern contains upper
7868 case characters. Only used when the search pattern is typed and
7869 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Girish Palyadc314052025-05-08 23:28:52 +02007870 ":g" and ":s" and when filtering matches for the completion menu
7871 |compl-states|.
7872 Not used for "*", "#", "gd", tag search, etc. After "*" and "#" you
7873 can make 'smartcase' used by doing a "/" command, recalling the search
7874 pattern from history and hitting <Enter>.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 NOTE: This option is reset when 'compatible' is set.
7876
7877 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7878'smartindent' 'si' boolean (default off)
7879 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 Do smart autoindenting when starting a new line. Works for C-like
7881 programs, but can also be used for other languages. 'cindent' does
7882 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007883 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007884 setting 'si' has no effect. 'indentexpr' is a more advanced
7885 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 Normally 'autoindent' should also be on when using 'smartindent'.
7887 An indent is automatically inserted:
7888 - After a line ending in '{'.
7889 - After a line starting with a keyword from 'cinwords'.
7890 - Before a line starting with '}' (only with the "O" command).
7891 When typing '}' as the first character in a new line, that line is
7892 given the same indent as the matching '{'.
7893 When typing '#' as the first character in a new line, the indent for
7894 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007895 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7897 When using the ">>" command, lines starting with '#' are not shifted
7898 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007899 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007900 This option is reset when 'paste' is set and restored when 'paste' is
7901 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902
7903 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7904'smarttab' 'sta' boolean (default off)
7905 global
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007906 When enabled, the <Tab> key will indent by 'shiftwidth' if the cursor
7907 is in leading whitespace. The <BS> key has the opposite effect.
Damien Lejaybfa16362025-06-10 21:12:31 +02007908 In leading whitespace, this has the same effect as setting
7909 'softtabstop' to the value of 'shiftwidth'.
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007910 This option is reset when 'compatible' is set; it is temporarily
7911 disabled when 'paste' is enabled, and restored when 'paste' is turned
7912 off.
Damien Lejaybfa16362025-06-10 21:12:31 +02007913 NOTE: in most cases, using 'softtabstop' is a better option. Have a
7914 look at section |30.5| of the user guide for detailed
Damien Lejayd6c9ac92025-06-04 21:19:18 +02007915 explanations on how Vim works with tabs and spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007917 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7918'smoothscroll' 'sms' boolean (default off)
7919 local to window
7920 Scrolling works with screen lines. When 'wrap' is set and the first
7921 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007922 above the window. "<<<" is displayed at the start of the first line,
7923 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007924 You may also want to add "lastline" to the 'display' option to show as
7925 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007926 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007927
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 *'softtabstop'* *'sts'*
7929'softtabstop' 'sts' number (default 0)
7930 local to buffer
Damien Lejay91af4c42025-06-12 21:56:19 +02007931 Create soft tab stops, separated by 'softtabstop' number of columns.
7932 In Insert mode, pressing the <Tab> key will move the cursor to the
7933 next soft tab stop, instead of inserting a literal tab. <BS> behaves
7934 similarly in reverse. Vim inserts a minimal mix of tab and space
7935 characters to produce the visual effect.
7936
7937 This setting does not affect the display of existing tab characters.
7938
7939 A value of 0 disables this behaviour. A negative value makes Vim use
7940 'shiftwidth'. If you plan to use 'sts' and 'shiftwidth' with
7941 different values, you might consider setting 'smarttab'.
7942
7943 'softtabstop' is temporarily set to 0 when 'paste' is on and reset
7944 when it is turned off. It is also reset when 'compatible' is set.
7945
7946 The 'L' flag in 'cpoptions' alters tab behavior when 'list' is
7947 enabled. See also |ins-expandtab| ans user manual section |30.5| for
7948 in-depth explanations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007950 If Vim is compiled with the |+vartabs| feature then the value of
7951 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7952 anything other than an empty string.
7953
Bram Moolenaar217ad922005-03-20 22:37:15 +00007954 *'spell'* *'nospell'*
7955'spell' boolean (default off)
7956 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007957 {not available when compiled without the |+syntax|
7958 feature}
7959 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007960 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007961
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007962 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007963'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007964 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007965 {not available when compiled without the |+syntax|
7966 feature}
7967 Pattern to locate the end of a sentence. The following word will be
7968 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007969 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007970 When this check is not wanted make this option empty.
7971 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007972 Be careful with special characters, see |option-backslash| about
7973 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007974 To set this option automatically depending on the language, see
7975 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007976
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007977 *'spellfile'* *'spf'*
7978'spellfile' 'spf' string (default empty)
7979 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007980 {not available when compiled without the |+syntax|
7981 feature}
7982 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007983 commands. It must end in ".{encoding}.add". You need to include the
7984 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007985 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007986 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007987 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007988 |zg| and |zw| commands can be used to access each. This allows using
7989 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007990 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007991 you: Using the first directory in 'runtimepath' that is writable. If
7992 there is no "spell" directory yet it will be created. For the file
7993 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007994 ignoring the region.
7995 The resulting ".spl" file will be used for spell checking, it does not
7996 have to appear in 'spelllang'.
7997 Normally one file is used for all regions, but you can add the region
7998 name if you want to. However, it will then only be used when
7999 'spellfile' is set to it, for entries in 'spelllang' only files
8000 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00008001 This option cannot be set from a |modeline| or in the |sandbox|, for
8002 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008003
Bram Moolenaar217ad922005-03-20 22:37:15 +00008004 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008005'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00008006 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00008007 {not available when compiled without the |+syntax|
8008 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008009 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008010 on spellchecking will be done for these languages. Example: >
8011 set spelllang=en_us,nl,medical
8012< This means US English, Dutch and medical words are recognized. Words
8013 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02008014 The word list name must consist of alphanumeric characters, a dash or
8015 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00008016 recommended to separate the two letter language name from a
8017 specification. Thus "en-rare" is used for rare English words.
8018 A region name must come last and have the form "_xx", where "xx" is
8019 the two-letter, lower case region name. You can use more than one
8020 region by listing them: "en_us,en_ca" supports both US and Canadian
8021 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01008022 Britain. (Note: currently en_au and en_nz dictionaries are older than
8023 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01008024 If the name "cjk" is included East Asian characters are excluded from
8025 spell checking. This is useful when editing text that also has Asian
8026 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02008027 Note that the "medical" dictionary does not exist, it is just an
8028 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008029 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008030 As a special case the name of a .spl file can be given as-is. The
8031 first "_xx" in the name is removed and used as the region name
8032 (_xx is an underscore, two letters and followed by a non-letter).
8033 This is mainly for testing purposes. You must make sure the correct
8034 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008035 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008036 idea to set 'spelllang' after setting 'encoding' to avoid loading the
8037 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00008038 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00008039
Bram Moolenaar98692072006-02-04 00:57:42 +00008040 If the |spellfile.vim| plugin is active and you use a language name
8041 for which Vim cannot find the .spl file in 'runtimepath' the plugin
8042 will ask you if you want to download the file.
8043
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008044 After this option has been set successfully, Vim will source the files
8045 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01008046 up to the first character that is not an ASCII letter or number and
8047 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008048
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008049 *'spelloptions'* *'spo'*
8050'spelloptions' 'spo' string (default "")
8051 local to buffer
8052 {not available when compiled without the |+syntax|
8053 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008054 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02008055 camel When a word is CamelCased, assume "Cased" is a
8056 separate word: every upper-case character in a word
8057 that comes after a lower case character indicates the
8058 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00008059
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008060 *'spellsuggest'* *'sps'*
8061'spellsuggest' 'sps' string (default "best")
8062 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008063 {not available when compiled without the |+syntax|
8064 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008065 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008066 the |spellsuggest()| function. This is a comma-separated list of
8067 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008068
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008069 best Internal method that works best for English. Finds
8070 changes like "fast" and uses a bit of sound-a-like
8071 scoring to improve the ordering.
8072
8073 double Internal method that uses two methods and mixes the
8074 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008075 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008076 word. That only works when the language specifies
8077 sound folding. Can be slow and doesn't always give
8078 better results.
8079
8080 fast Internal method that only checks for simple changes:
8081 character inserts/deletes/swaps. Works well for
8082 simple typing mistakes.
8083
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008084 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008085 Not used for |spellsuggest()|. The number of
8086 suggestions is never more than the value of 'lines'
8087 minus two.
8088
Bram Moolenaar585ee072022-01-29 11:22:17 +00008089 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02008090 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00008091 methods. When omitted the limit is 5000. When
8092 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01008093 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00008094
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008095 file:{filename} Read file {filename}, which must have two columns,
8096 separated by a slash. The first column contains the
8097 bad word, the second column the suggested good word.
8098 Example:
8099 theribal/terrible ~
8100 Use this for common mistakes that do not appear at the
8101 top of the suggestion list with the internal methods.
8102 Lines without a slash are ignored, use this for
8103 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008104 The word in the second column must be correct,
8105 otherwise it will not be used. Add the word to an
8106 ".add" file if it is currently flagged as a spelling
8107 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008108 The file is used for all languages.
8109
8110 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01008111 trouble with spaces. Best is to call a function
8112 without arguments, see |expr-option-function|.
8113 |v:val| holds the badly spelled word. The expression
8114 must evaluate to a List of Lists, each with a
8115 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008116 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01008117 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00008118 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008119 internal methods use. A lower score is better.
8120 This may invoke |spellsuggest()| if you temporarily
8121 set 'spellsuggest' to exclude the "expr:" part.
8122 Errors are silently ignored, unless you set the
8123 'verbose' option to a non-zero value.
8124
8125 Only one of "best", "double" or "fast" may be used. The others may
8126 appear several times in any order. Example: >
8127 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
8128<
8129 This option cannot be set from a |modeline| or in the |sandbox|, for
8130 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008131
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
8133'splitbelow' 'sb' boolean (default off)
8134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 When on, splitting a window will put the new window below the current
8136 one. |:split|
8137
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008138 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008139'splitkeep' 'spk' string (default "cursor")
8140 global
8141 The value of this option determines the scroll behavior when opening,
8142 closing or resizing horizontal splits.
8143
8144 Possible values are:
8145 cursor Keep the same relative cursor position.
8146 screen Keep the text on the same screen line.
8147 topline Keep the topline the same.
8148
8149 For the "screen" and "topline" values, the cursor position will be
8150 changed when necessary. In this case, the jumplist will be populated
8151 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008152 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008153
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
8155'splitright' 'spr' boolean (default off)
8156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 When on, splitting a window will put the new window right of the
8158 current one. |:vsplit|
8159
8160 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8161'startofline' 'sol' boolean (default on)
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008164 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008165 (if possible). This applies to the commands:
8166 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008167 - "d", "<<", "==" and ">>" with a linewise operator
8168 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008169 - "%" with a count
8170 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8171 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 In case of buffer changing commands the cursor is placed at the column
8173 where it was the last time the buffer was edited.
8174 NOTE: This option is set when 'compatible' is set.
8175
Bram Moolenaar00654022011-02-25 14:42:19 +01008176 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008178 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 {not available when compiled without the |+statusline|
8180 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008181 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 Also see |status-line|.
8183
8184 The option consists of printf style '%' items interspersed with
8185 normal text. Each status line item is of the form:
8186 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008187 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008188 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008190 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008191 When the option starts with "%!" then it is used as an expression,
8192 evaluated and the result is used as the option value. Example: >
8193 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008194< The *g:statusline_winid* variable will be set to the |window-ID| of the
8195 window that the status line belongs to.
8196 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008197 Note that the "%!" expression is evaluated in the context of the
8198 current window and buffer, while %{} items are evaluated in the
8199 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008200
8201 When there is error while evaluating the option then it will be made
8202 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008203 When the result contains unprintable characters the result is
8204 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008205
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 Note that the only effect of 'ruler' when this option is set (and
8207 'laststatus' is 2) is controlling the output of |CTRL-G|.
8208
8209 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008210 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008212 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 minwid Minimum width of the item, padding as set by '-' & '0'.
8214 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008215 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 on the left for text items. Numeric items will be
8217 shifted down to maxwid-2 digits followed by '>'number
8218 where number is the amount of missing digits, much like
8219 an exponential notation.
8220 item A one letter code as described below.
8221
8222 Following is a description of the possible statusline items. The
8223 second character in "item" is the type:
8224 N for number
8225 S for string
8226 F for flags as described below
8227 - not applicable
8228
8229 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008230 f S Path to the file in the buffer, as typed or relative to current
8231 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 F S Full path to the file in the buffer.
8233 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008234 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008236 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008238 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008240 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008242 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008244 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8246 being used: "<keymap>"
8247 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008248 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 B N As above, in hexadecimal.
8250 o N Byte number in file of byte under cursor, first byte is 1.
8251 Mnemonic: Offset from start of file (with one added)
8252 {not available when compiled without |+byte_offset| feature}
8253 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008254 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 l N Line number.
8256 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008257 c N Column number (byte index).
8258 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008259 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 p N Percentage through file in lines as in |CTRL-G|.
8261 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008262 percentage described for 'ruler'. Always 3 in length, unless
8263 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008264 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008265 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008267 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008268 Note that there is no '%' before the closing '}'. The
8269 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008270 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008271 {% - This is almost same as { except the result of the expression is
8272 re-evaluated as a statusline format string. Thus if the
8273 return value of expr contains % items they will get expanded.
8274 The expression can contain the } character, the end of
8275 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008276 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008277 func! Stl_filename() abort
8278 return "%t"
8279 endfunc
8280< `stl=%{Stl_filename()}` results in `"%t"`
8281 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008282 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 ( - Start of item group. Can be used for setting the width and
8284 alignment of a section. Must be followed by %) somewhere.
8285 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008286 T N For 'tabline': start of tab page N label. Use %T after the last
8287 label. This information is used for mouse clicks.
8288 X N For 'tabline': start of close tab N label. Use %X after the
8289 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8290 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 < - Where to truncate line if too long. Default is at the start.
8292 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008293 = - Separation point between alignment sections. Each section will
8294 be separated by an equal number of spaces. With one %= what
8295 comes after it will be right-aligned. With two %= there is a
8296 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008298 # - Set highlight group. The name must follow and then a # again.
8299 Thus use %#HLname# for highlight group HLname. The same
8300 highlighting is used, also for the statusline of non-current
8301 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008303 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008304 The difference between User{N} and StatusLine will be applied to
8305 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 The number N must be between 1 and 9. See |hl-User1..9|
8307
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008308 When displaying a flag, Vim removes the leading comma, if any, when
8309 that flag comes right after plaintext. This will make a nice display
8310 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311
Bram Moolenaar582fd852005-03-28 20:58:01 +00008312 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 not set) and a minwid is not set for the group, the whole group will
8314 become empty. This will make a group like the following disappear
8315 completely from the statusline when none of the flags are set. >
8316 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008317< Beware that an expression is evaluated each and every time the status
8318 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008319 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008320 While evaluating %{} the current buffer and current window will be set
8321 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008322 currently being drawn. The expression will evaluate in this context.
8323 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8324 real current buffer and "g:actual_curwin" to the |window-ID| of the
8325 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008326
Bram Moolenaar30b65812012-07-12 22:01:11 +02008327 The 'statusline' option will be evaluated in the |sandbox| if set from
8328 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008329 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008330
8331 It is not allowed to change text or jump to another window while
8332 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333
8334 If the statusline is not updated when you want it (e.g., after setting
8335 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008336 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008338 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 Otherwise the result is taken as flag text and applied to the rules
8340 described above.
8341
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008342 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008344 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345
8346 Examples:
8347 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008348 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349< Similar, but add ASCII value of char under the cursor (like "ga") >
8350 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8351< Display byte count and byte value, modified flag in red. >
8352 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8353 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8354< Display a ,GZ flag if a compressed file is loaded >
8355 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8356< In the |:autocmd|'s: >
8357 :let b:gzflag = 1
8358< And: >
8359 :unlet b:gzflag
8360< And define this function: >
8361 :function VarExists(var, val)
8362 : if exists(a:var) | return a:val | else | return '' | endif
8363 :endfunction
8364<
8365 *'suffixes'* *'su'*
8366'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 Files with these suffixes get a lower priority when multiple files
8369 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008370 suffixes. Spaces after the comma are ignored. A dot is also seen as
8371 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 separator, precede it with a backslash (see |option-backslash| about
8373 including spaces and backslashes).
8374 See 'wildignore' for completely ignoring files.
8375 The use of |:set+=| and |:set-=| is preferred when adding or removing
8376 suffixes from the list. This avoids problems when a future version
8377 uses another default.
8378
8379 *'suffixesadd'* *'sua'*
8380'suffixesadd' 'sua' string (default "")
8381 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008382 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 file for the "gf", "[I", etc. commands. Example: >
8384 :set suffixesadd=.java
8385<
8386 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8387'swapfile' 'swf' boolean (default on)
8388 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008389 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 swapfile is not wanted for a specific buffer. For example, with
8391 confidential information that even root must not be able to access.
8392 Careful: All text will be in memory:
8393 - Don't use this for big files.
8394 - Recovery will be impossible!
8395 A swapfile will only be present when |'updatecount'| is non-zero and
8396 'swapfile' is set.
8397 When 'swapfile' is reset, the swap file for the current buffer is
8398 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8399 non-zero, a swap file is immediately created.
8400 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008401 If you want to open a new buffer without creating a swap file for it,
8402 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008403 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404
8405 This option is used together with 'bufhidden' and 'buftype' to
8406 specify special kinds of buffers. See |special-buffers|.
8407
8408 *'swapsync'* *'sws'*
8409'swapsync' 'sws' string (default "fsync")
8410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008412 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 When this option is empty parts of the swap file may be in memory and
8414 not written to disk. When the system crashes you may lose more work.
8415 On Unix the system does a sync now and then without Vim asking for it,
8416 so the disadvantage of setting this option off is small. On some
8417 systems the swap file will not be written at all. For a unix system
8418 setting it to "sync" will use the sync() call instead of the default
8419 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008420 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008421
8422 *'switchbuf'* *'swb'*
8423'switchbuf' 'swb' string (default "")
8424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008426 This option is checked, when
8427 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008428 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008429 - jumping to a tag using the |:stag| command.
8430 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8431 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8432 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008433 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008434 useopen If included, jump to the first open window in the
8435 current tab page that contains the specified buffer
8436 (if there is one). Otherwise: Do not examine other
8437 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008438 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008439 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008441 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008442 Otherwise: do not split, use current window (when used
8443 in the quickfix window: the previously used window or
8444 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008445 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008446 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008447 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008448 uselast If included, jump to the previously used window when
8449 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008450 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8451 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008453 *'synmaxcol'* *'smc'*
8454'synmaxcol' 'smc' number (default 3000)
8455 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008456 {not available when compiled without the |+syntax|
8457 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008458 Maximum column in which to search for syntax items. In long lines the
8459 text after this column is not highlighted and following lines may not
8460 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008461 This helps to avoid very slow redrawing for an XML file that is one
8462 long line.
8463 Set to zero to remove the limit.
8464
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 *'syntax'* *'syn'*
8466'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008467 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 {not available when compiled without the |+syntax|
8469 feature}
8470 When this option is set, the syntax with this name is loaded, unless
8471 syntax highlighting has been switched off with ":syntax off".
8472 Otherwise this option does not always reflect the current syntax (the
8473 b:current_syntax variable does).
8474 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008475 not automatically recognized. Example, in an IDL file:
8476 /* vim: set syntax=idl : */ ~
8477 When a dot appears in the value then this separates two filetype
8478 names. Example:
8479 /* vim: set syntax=c.doxygen : */ ~
8480 This will use the "c" syntax first, then the "doxygen" syntax.
8481 Note that the second one must be prepared to be loaded as an addition,
8482 otherwise it will be skipped. More than one dot may appear.
8483 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 :set syntax=OFF
8485< To switch syntax highlighting on according to the current value of the
8486 'filetype' option: >
8487 :set syntax=ON
8488< What actually happens when setting the 'syntax' option is that the
8489 Syntax autocommand event is triggered with the value as argument.
8490 This option is not copied to another buffer, independent of the 's' or
8491 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008492 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493
LemonBoy5247b0b2024-07-12 19:30:58 +02008494 *'tabclose'* *'tcl'*
8495'tabclose' 'tcl' string (default "")
8496 global
8497 This option controls the behavior when closing tab pages (e.g., using
8498 |:tabclose|). When empty Vim goes to the next (right) tab page.
8499
8500 Possible values (comma-separated list):
8501 left If included, go to the previous tab page instead of
8502 the next one.
8503 uselast If included, go to the previously used tab page if
8504 possible. This option takes precedence over the
8505 others.
8506
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008507 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008508'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008509 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008510 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008511 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008512 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008513
8514 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008515 option and only when there is no GUI tab line. When 'e' is in
8516 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008517 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008518
8519 The value is evaluated like with 'statusline'. You can use
8520 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008521 the text to be displayed. Use "%1T" for the first label, "%2T" for
8522 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008523
Bram Moolenaare12bab32019-01-08 22:02:56 +01008524 When changing something that is used in 'tabline' that does not
8525 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008526 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008527
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008528 Keep in mind that only one of the tab pages is the current one, others
8529 are invisible and you can't jump to their windows.
8530
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008531 *'tabpagemax'* *'tpm'*
8532'tabpagemax' 'tpm' number (default 10)
8533 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008534 Maximum number of tab pages to be opened by the |-p| command line
8535 argument or the ":tab all" command. |tabpage|
8536
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008537 *'tabpanel'* *'tpl'* *g:actual_curtabpage*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008538'tabpanel' 'tpl' string (default empty)
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008539 global
Christ van Willegend65cdad2025-05-30 16:05:58 +02008540 When non-empty, this option determines the content of the |tabpanel|.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008541 The option consists of printf style '%' items interspersed with
8542 normal text, similar to the 'statusline' or 'tabline'.
8543
8544 When changing something that is used in 'tabpanel' that does not
8545 trigger it to be updated, use |:redrawtabpanel|.
8546 This option cannot be set in a modeline when 'modelineexpr' is off.
8547
8548 You can use |g:actual_curtabpage| within a function assigned to
8549 tabpanel. |g:actual_curtabpage| represents current tab's label number.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008550 The option value can contain line breaks: >
8551
8552 set tabpanel=%!TabPanel()
8553 function! TabPanel() abort
8554 return printf("(%2d)\n %%f", g:actual_curtabpage)
8555 endfunction
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008556<
8557 The result is:
8558>
8559 +-----------+---------------------------------
8560 |(1) |
8561 | ~/aaa.txt|
8562 |(2) |
8563 | ~/.vimrc |
8564 | |
8565 | |
8566 | |
8567<
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008568 *'tabpanelopt'* *'tplo'*
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008569'tabpanelopt' 'tplo' string (default "")
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008570 global
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008571 Optional settings for the |tabpanel|, It can consist of the following
8572 items. Items must be separated by a comma.
8573
Christ van Willegend65cdad2025-05-30 16:05:58 +02008574 align:{text} Specifies the position of the tabpanel.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008575 Currently supported positions are:
8576
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008577 left left-side
8578 right right-side
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008579
8580 (default "left")
8581
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008582 columns:{n} Number of columns of the tabpanel.
8583 If this value is 0 or less than 'columns', the
8584 tab panel will not be displayed.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008585 (default 20)
8586
8587 vert Use a vertical separator for tabpanel.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008588 The vertical separator character is taken from
8589 "tpl_vert" in 'fillchars'.
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +02008590 (default off)
8591
8592 Examples: >
8593 :set tabpanelopt=columns:16,align:right
8594 :set tabpanelopt=
8595 :set tabpanelopt=vert,align:right
8596 :set tabpanelopt=columns:16
8597<
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008598 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599'tabstop' 'ts' number (default 8)
8600 local to buffer
Damien Lejaya4a3f712025-05-30 17:36:37 +02008601 Defines the column multiple used to display the Horizontal Tab
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008602 character (ASCII 9); a Horizontal Tab always advances to the next tab
8603 stop.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008604 The value must be at least 1 and at most 9999.
Hirohito Higashi8f7256a2025-06-07 18:31:42 +02008605 If Vim was compiled with |+vartabs| and |'vartabstop'| is set, this
8606 option is ignored.
Damien Lejaya4a3f712025-05-30 17:36:37 +02008607 Leave it at 8 unless you have a strong reason (see usr |30.5|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008609
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8611'tagbsearch' 'tbs' boolean (default on)
8612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008614 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 searching makes searching for a tag a LOT faster, but a linear search
8616 will find more tags if the tags file wasn't properly sorted.
8617 Vim normally assumes that your tags files are sorted, or indicate that
8618 they are not sorted. Only when this is not the case does the
8619 'tagbsearch' option need to be switched off.
8620
8621 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008622 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 certain files, or retry all files with a linear search. When
8624 'tagbsearch' is off, only a linear search is done.
8625
8626 Linear searching is done anyway, for one file, when Vim finds a line
8627 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008628 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629< [The whitespace before and after the '0' must be a single <Tab>]
8630
8631 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008632 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 instead of a normal tag name, a retry is done with a linear search.
8634 Tags in unsorted tags files, and matches with different case will only
8635 be found in the retry.
8636
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008637 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008638 linear search can be avoided when case is ignored. Use a value of '2'
8639 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8640 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008641 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8642 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8643 used for this as well. Note that case must be folded to uppercase for
8644 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008645
8646 By default, tag searches are case-sensitive. Case is ignored when
8647 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8648 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008649 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8650 'tagcase' is "smart", and the pattern contains only lowercase
8651 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652
8653 When 'tagbsearch' is off, tags searching is slower when a full match
8654 exists, but faster when no full match exists. Tags in unsorted tags
8655 files may only be found with 'tagbsearch' off.
8656 When the tags file is not sorted, or sorted in a wrong way (not on
8657 ASCII byte value), 'tagbsearch' should be off, or the line given above
8658 must be included in the tags file.
8659 This option doesn't affect commands that find all matching tags (e.g.,
8660 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008662 *'tagcase'* *'tc'*
8663'tagcase' 'tc' string (default "followic")
8664 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008665 This option specifies how case is handled when searching the tags
8666 file:
8667 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008668 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008669 ignore Ignore case
8670 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008671 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008672 NOTE: This option is set to the Vi default value when 'compatible' is
8673 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008674
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008675 *'tagfunc'* *'tfu'*
8676'tagfunc' 'tfu' string (default: empty)
8677 local to buffer
8678 {not available when compiled without the |+eval|
8679 feature}
Christian Brabandtfb081922025-04-30 19:31:58 +02008680 This option specifies a function to be used to perform tag searches
8681 (including |taglist()|).
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008682 The function gets the tag pattern and should return a List of matching
8683 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008684 function and an example. The value can be the name of a function, a
8685 |lambda| or a |Funcref|. See |option-value-function| for more
8686 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008687 This option cannot be set from a |modeline| or in the |sandbox|, for
8688 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008689
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 *'taglength'* *'tl'*
8691'taglength' 'tl' number (default 0)
8692 global
8693 If non-zero, tags are significant up to this number of characters.
8694
8695 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8696'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8697 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008698 If on and using a tags file in another directory, file names in that
8699 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 NOTE: This option is set to the Vi default value when 'compatible' is
8701 set and to the Vim default value when 'compatible' is reset.
8702
8703 *'tags'* *'tag'* *E433*
8704'tags' 'tag' string (default "./tags,tags", when compiled with
8705 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8706 global or local to buffer |global-local|
8707 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008708 include a space or comma in a file name, precede it with backslashes
8709 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 When a file name starts with "./", the '.' is replaced with the path
8711 of the current file. But only when the 'd' flag is not included in
8712 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8713 |tags-option|.
8714 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008715 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8716 find all files named "tags" below "/lib". The filename itself cannot
8717 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008718 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008719 The |tagfiles()| function can be used to get a list of the file names
8720 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8722 files are also supported. They are automatically recognized. The
8723 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8724 differences are ignored (MS-Windows). |emacs-tags|
8725 The use of |:set+=| and |:set-=| is preferred when adding or removing
8726 file names from the list. This avoids problems when a future version
8727 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728
8729 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8730'tagstack' 'tgst' boolean (default on)
8731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 When on, the |tagstack| is used normally. When off, a ":tag" or
8733 ":tselect" command with an argument will not push the tag onto the
8734 tagstack. A following ":tag" without an argument, a ":pop" command or
8735 any other command that uses the tagstack will use the unmodified
8736 tagstack, but does change the pointer to the active entry.
8737 Resetting this option is useful when using a ":tag" command in a
8738 mapping which should not change the tagstack.
8739
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008740 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008741'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008742 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008743 {only available when compiled with the |+tcl/dyn|
8744 feature}
8745 Specifies the name of the Tcl shared library. The default is
8746 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008747 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008748 This option cannot be set from a |modeline| or in the |sandbox|, for
8749 security reasons.
8750
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 *'term'* *E529* *E530* *E531*
8752'term' string (default is $TERM, if that fails:
8753 in the GUI: "builtin_gui"
8754 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008755 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 on Unix: "ansi"
8758 on VMS: "ansi"
8759 on Win 32: "win32")
8760 global
8761 Name of the terminal. Used for choosing the terminal control
8762 characters. Environment variables are expanded |:set_env|.
8763 For example: >
8764 :set term=$TERM
8765< See |termcap|.
8766
8767 *'termbidi'* *'tbidi'*
8768 *'notermbidi'* *'notbidi'*
8769'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 {only available when compiled with the |+arabic|
8772 feature}
8773 The terminal is in charge of Bi-directionality of text (as specified
8774 by Unicode). The terminal is also expected to do the required shaping
8775 that some languages (such as Arabic) require.
8776 Setting this option implies that 'rightleft' will not be set when
8777 'arabic' is set and the value of 'arabicshape' will be ignored.
8778 Note that setting 'termbidi' has the immediate effect that
8779 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8780 This option is reset when the GUI is started.
8781 For further details see |arabic.txt|.
8782
8783 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008784'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 Encoding used for the terminal. This specifies what character
8787 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008788 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008789 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008790 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008791 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8793 Any attempts to set a different value will be rejected, and an error
8794 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008795 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 because the Win32 system always passes Unicode characters.
8797 When empty, the same encoding is used as for the 'encoding' option.
8798 This is the normal value.
8799 Not all combinations for 'termencoding' and 'encoding' are valid. See
8800 |encoding-table|.
8801 The value for this option must be supported by internal conversions or
8802 iconv(). When this is not possible no conversion will be done and you
8803 will probably experience problems with non-ASCII characters.
8804 Example: You are working with the locale set to euc-jp (Japanese) and
8805 want to edit a UTF-8 file: >
8806 :let &termencoding = &encoding
8807 :set encoding=utf-8
8808< You need to do this when your system has no locale support for UTF-8.
8809
Bram Moolenaar938ae282023-02-20 20:44:55 +00008810 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008811'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8812 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008813 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008814 {not available when compiled without the
8815 |+termguicolors| feature}
8816 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008817 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008818
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008819 Requires a ISO-8613-3 compatible terminal. If setting this option
8820 does not work (produces a colorless UI) reading |xterm-true-color|
8821 might help.
8822
8823 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8824 is required. Use this check to find out: >
8825 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008826< This requires Vim to be built with the |+vtp| feature.
8827
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008828 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008829
8830 When using Vim with Windows Terminal, the background of Windows
8831 Terminal is normally filled with the Vim background color. Setting
8832 'termguicolors' and the guibg of the Normal highlight group to NONE
8833 will make the background transparent: >
8834 :hi Normal guibg=NONE
8835<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008836 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008837
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008838 *'termwinkey'* *'twk'*
8839'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008840 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008841 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008842 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008843 The key can be specified as a single character, a |key-notation| (e.g.
8844 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8845 :set twk=X
8846 :set twk=^I
8847 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008848< The string must be one key stroke but can be multiple bytes.
8849 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008850 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008851 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008852
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008853 *'termwinscroll'* *'twsl'*
8854'termwinscroll' 'twsl' number (default 10000)
8855 local to buffer
8856 {not available when compiled without the
8857 |+terminal| feature}
8858 Number of scrollback lines to keep. When going over this limit the
8859 first 10% of the scrollback lines are deleted. This is just to reduce
8860 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008861 Also used as a limit for text sent to the terminal in one write,
8862 multiplied by the number of columns times 3 (average number of bytes
8863 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008864
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008865 *'termwinsize'* *'tws'*
8866'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008867 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008868 Size used when opening the |terminal| window. Format:
8869 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008870 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008871 - When set with a "x" (e.g., "24x80") the terminal size is not
8872 adjusted to the window size. If the window is smaller only the
8873 top-left part is displayed.
8874 - When set with a "*" (e.g., "10*50") the terminal size follows the
8875 window size, but will not be smaller than the specified rows and/or
8876 columns.
8877 - When rows is zero then use the height of the window.
8878 - When columns is zero then use the width of the window.
8879 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008880 - Can be overruled in the |term_start()| options with "term_rows" and
8881 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008882
8883 Examples:
8884 "30x0" uses 30 rows and the current window width.
8885 "20*0" uses at least 20 rows and the current window width.
8886 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008887 Note that the command running in the terminal window may still change
8888 the size of the terminal. In that case the Vim window will be
8889 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008890
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008891 *'termwintype'* *'twt'*
8892'termwintype' 'twt' string (default "")
8893 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008894 {only available when compiled with the |terminal|
8895 feature on MS-Windows}
8896 Specify the virtual console (pty) used when opening the terminal
8897 window.
8898
8899 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008900 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008901 "winpty" use winpty, fail if not supported
8902 "conpty" use |ConPTY|, fail if not supported
8903
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008904 |ConPTY| support depends on the platform. Windows 10 October 2018
8905 Update is the first version that supports ConPTY, however it is still
8906 considered unstable. ConPTY might become stable in the next release
8907 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008908 supported then you cannot open a terminal window.
8909
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 *'terse'* *'noterse'*
8911'terse' boolean (default off)
8912 global
8913 When set: Add 's' flag to 'shortmess' option (this makes the message
8914 for a search that hits the start or end of the file not being
8915 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8916 shortens a lot of messages}
8917
8918 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8919'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 This option is obsolete. Use 'fileformats'.
8922 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8923 set to the default value for the current system. When 'textauto' is
8924 reset, 'fileformats' is made empty.
8925 NOTE: This option is set to the Vi default value when 'compatible' is
8926 set and to the Vim default value when 'compatible' is reset.
8927
8928 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008929'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 others: default off)
8931 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 This option is obsolete. Use 'fileformat'.
8933 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8934 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8935 "unix".
8936
8937 *'textwidth'* *'tw'*
8938'textwidth' 'tw' number (default 0)
8939 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 Maximum width of text that is being inserted. A longer line will be
8941 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008942 this.
8943 'textwidth' is set to 0 when the 'paste' option is set and restored
8944 when 'paste' is reset.
8945 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008947 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 NOTE: This option is set to 0 when 'compatible' is set.
8949
8950 *'thesaurus'* *'tsr'*
8951'thesaurus' 'tsr' string (default "")
8952 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008954 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8955 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008956
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008957 This option is not used if 'thesaurusfunc' is set, either for the
8958 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008959
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008960 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008962 name. See |option-backslash| about using backslashes. The use of
8963 |:set+=| and |:set-=| is preferred when adding or removing directories
8964 from the list. This avoids problems when a future version uses
8965 another default. Backticks cannot be used in this option for security
8966 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008968 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008969'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008970 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008971 {not available when compiled without the |+eval|
8972 feature}
8973 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008974 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008975 The value can be the name of a function, a |lambda| or a |Funcref|.
8976 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008977
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008978 This option cannot be set from a |modeline| or in the |sandbox|, for
8979 security reasons.
8980
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8982'tildeop' 'top' boolean (default off)
8983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 When on: The tilde command "~" behaves like an operator.
8985 NOTE: This option is reset when 'compatible' is set.
8986
8987 *'timeout'* *'to'* *'notimeout'* *'noto'*
8988'timeout' 'to' boolean (default on)
8989 global
laburnumT3f7855a2023-12-05 18:37:03 +01008990
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008992'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 These two options together determine the behavior when part of a
8995 mapped key sequence or keyboard code has been received:
8996
8997 'timeout' 'ttimeout' action ~
8998 off off do not time out
8999 on on or off time out on :mappings and key codes
9000 off on time out on key codes
9001
9002 If both options are off, Vim will wait until either the complete
9003 mapping or key sequence has been received, or it is clear that there
9004 is no mapping or key sequence for the received characters. For
9005 example: if you have mapped "vl" and Vim has received 'v', the next
9006 character is needed to see if the 'v' is followed by an 'l'.
9007 When one of the options is on, Vim will wait for about 1 second for
9008 the next character to arrive. After that the already received
9009 characters are interpreted as single characters. The waiting time can
9010 be changed with the 'timeoutlen' option.
9011 On slow terminals or very busy systems timing out may cause
9012 malfunctioning cursor keys. If both options are off, Vim waits
9013 forever after an entered <Esc> if there are key codes that start
9014 with <Esc>. You will have to type <Esc> twice. If you do not have
9015 problems with key codes, but would like to have :mapped key
9016 sequences not timing out in 1 second, set the 'ttimeout' option and
9017 reset the 'timeout' option.
9018
9019 NOTE: 'ttimeout' is reset when 'compatible' is set.
9020
9021 *'timeoutlen'* *'tm'*
9022'timeoutlen' 'tm' number (default 1000)
9023 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009024
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02009026'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 The time in milliseconds that is waited for a key code or mapped key
9029 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
9030 when part of a command has been typed.
9031 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
9032 different timeout value for key codes is desired set 'ttimeoutlen' to
9033 a non-negative number.
9034
9035 ttimeoutlen mapping delay key code delay ~
9036 < 0 'timeoutlen' 'timeoutlen'
9037 >= 0 'timeoutlen' 'ttimeoutlen'
9038
9039 The timeout only happens when the 'timeout' and 'ttimeout' options
9040 tell so. A useful setting would be >
9041 :set timeout timeoutlen=3000 ttimeoutlen=100
9042< (time out on mapping after three seconds, time out on key codes after
9043 a tenth of a second).
9044
9045 *'title'* *'notitle'*
9046'title' boolean (default off, on when title can be restored)
9047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 When on, the title of the window will be set to the value of
9049 'titlestring' (if it is not empty), or to:
9050 filename [+=-] (path) - VIM
9051 Where:
9052 filename the name of the file being edited
9053 - indicates the file cannot be modified, 'ma' off
9054 + indicates the file was modified
9055 = indicates the file is read-only
9056 =+ indicates the file is read-only and modified
9057 (path) is the path of the file being edited
9058 - VIM the server name |v:servername| or "VIM"
9059 Only works if the terminal supports setting window titles
9060 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02009061 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
9063 *X11*
9064 When Vim was compiled with HAVE_X11 defined, the original title will
9065 be restored if possible. The output of ":version" will include "+X11"
9066 when HAVE_X11 was defined, otherwise it will be "-X11". This also
9067 works for the icon name |'icon'|.
9068 But: When Vim was started with the |-X| argument, restoring the title
9069 will not work (except in the GUI).
9070 If the title cannot be restored, it is set to the value of 'titleold'.
9071 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009072 When using an xterm from a remote machine you can use this command: >
9073
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01009075 ssh -X machine_name xterm &
9076<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 then the WINDOWID environment variable should be inherited and the
9078 title of the window should change back to what it should be after
9079 exiting Vim.
9080
9081 *'titlelen'*
9082'titlelen' number (default 85)
9083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009085 title. When the title is longer, only the end of the path name is
9086 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 Using a percentage makes this adapt to the width of the window. But
9088 it won't work perfectly, because the actual number of characters
9089 available also depends on the font used and other things in the title
9090 bar. When 'titlelen' is zero the full path is used. Otherwise,
9091 values from 1 to 30000 percent can be used.
9092 'titlelen' is also used for the 'titlestring' option.
9093
9094 *'titleold'*
9095'titleold' string (default "Thanks for flying Vim")
9096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 This option will be used for the window title when exiting Vim if the
9098 original title cannot be restored. Only happens if 'title' is on or
9099 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009100 This option cannot be set from a |modeline| or in the |sandbox|, for
9101 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 *'titlestring'*
9103'titlestring' string (default "")
9104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 When this option is not empty, it will be used for the title of the
9106 window. This happens only when the 'title' option is on.
9107 Only works if the terminal supports setting window titles (currently
9108 Amiga console, Win32 console, all GUI versions and terminals with a
9109 non-empty 't_ts' option).
9110 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01009111 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009112
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02009114 expanded according to the rules used for 'statusline'. If it contains
9115 an invalid '%' format, the value is used as-is and no error or warning
9116 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009117 This option cannot be set in a modeline when 'modelineexpr' is off.
9118
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009120 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
9122< The value of 'titlelen' is used to align items in the middle or right
9123 of the available space.
9124 Some people prefer to have the file name first: >
9125 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
9126< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009127 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 separating space only when needed.
9129 NOTE: Use of special characters in 'titlestring' may cause the display
9130 to be garbled (e.g., when it contains a CR or NL character).
9131 {not available when compiled without the |+statusline| feature}
9132
9133 *'toolbar'* *'tb'*
9134'toolbar' 'tb' string (default "icons,tooltips")
9135 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009136 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009137 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 possible values are:
9139 icons Toolbar buttons are shown with icons.
9140 text Toolbar buttons shown with text.
9141 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009142 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 tooltips Tooltips are active for toolbar buttons.
9144 Tooltips refer to the popup help text which appears after the mouse
9145 cursor is placed over a toolbar button for a brief moment.
9146
9147 If you want the toolbar to be shown with icons as well as text, do the
9148 following: >
9149 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009150< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 will show icons if both are requested.
9152
9153 If none of the strings specified in 'toolbar' are valid or if
9154 'toolbar' is empty, this option is ignored. If you want to disable
9155 the toolbar, you need to set the 'guioptions' option. For example: >
9156 :set guioptions-=T
9157< Also see |gui-toolbar|.
9158
9159 *'toolbariconsize'* *'tbis'*
9160'toolbariconsize' 'tbis' string (default "small")
9161 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01009162 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009163 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009164 tiny Use tiny icons.
9165 small Use small icons (default).
9166 medium Use medium-sized icons.
9167 large Use large icons.
9168 huge Use even larger icons.
9169 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009171 the current theme. Common dimensions are giant=48x48, huge=32x32,
9172 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173
9174 If 'toolbariconsize' is empty, the global default size as determined
9175 by user preferences or the current theme is used.
9176
9177 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
9178'ttybuiltin' 'tbi' boolean (default on)
9179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 When on, the builtin termcaps are searched before the external ones.
9181 When off the builtin termcaps are searched after the external ones.
9182 When this option is changed, you should set the 'term' option next for
9183 the change to take effect, for example: >
9184 :set notbi term=$TERM
9185< See also |termcap|.
9186 Rationale: The default for this option is "on", because the builtin
9187 termcap entries are generally better (many systems contain faulty
9188 xterm entries...).
9189
9190 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009191'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193 Indicates a fast terminal connection. More characters will be sent to
9194 the screen for redrawing, instead of using insert/delete line
9195 commands. Improves smoothness of redrawing when there are multiple
9196 windows and the terminal does not support a scrolling region.
9197 Also enables the extra writing of characters at the end of each screen
9198 line for lines that wrap. This helps when using copy/paste with the
9199 mouse in an xterm and other terminals.
9200
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009201 The default used to be set only for some terminal names, but these
9202 days nearly all terminals are fast, therefore the default is now "on".
9203 If you have a slow connection you may want to set this option off,
9204 e.g. depending on the host name: >
9205 if hostname() =~ 'faraway'
9206 set nottyfast
9207 endif
9208<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 *'ttymouse'* *'ttym'*
9210'ttymouse' 'ttym' string (default depends on 'term')
9211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 {only in Unix and VMS, doesn't work in the GUI; not
9213 available when compiled without |+mouse|}
9214 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009215 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 *xterm-mouse*
9217 xterm xterm-like mouse handling. The mouse generates
9218 "<Esc>[Mscr", where "scr" is three bytes:
9219 "s" = button state
9220 "c" = column plus 33
9221 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009222 This only works up to 223 columns! See "dec",
9223 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 xterm2 Works like "xterm", but with the xterm reporting the
9225 mouse position while the mouse is dragged. This works
9226 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009227 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009228 work. See below for how Vim detects this
9229 automatically.
9230 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009231 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009233 for the row and column. No other mouse events are
9234 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009235 *dec-mouse*
9236 dec DEC terminal mouse handling. The mouse generates a
9237 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009238 This is also available for an Xterm, if it was
9239 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 *jsbterm-mouse*
9241 jsbterm JSB term mouse handling.
9242 *pterm-mouse*
9243 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009244 *urxvt-mouse*
9245 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009246 The mouse works only if the terminal supports this
9247 encoding style, but it does not have 223 columns limit
9248 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009249 *sgr-mouse*
9250 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009251 mouse reporting. The mouse works even in columns
9252 beyond 223. This option is backward compatible with
9253 "xterm2" because it can also decode "xterm2" style
9254 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255
9256 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009257 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9258 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9260 recognized, if enabled at compile time. DEC terminal mouse codes
9261 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009262 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9263 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009264 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009265 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9266 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9267 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009268 If the terminfo/termcap entry "XM" exists and the first number is
9269 "1006" then 'ttymouse' will be set to "sgr". This works for many
9270 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009271 Additionally, if vim is compiled with the |+termresponse| feature and
9272 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009273 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009275 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9276 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9277 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009278 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9279 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 :set t_RV=
9281<
9282 *'ttyscroll'* *'tsl'*
9283'ttyscroll' 'tsl' number (default 999)
9284 global
9285 Maximum number of lines to scroll the screen. If there are more lines
9286 to scroll the window is redrawn. For terminals where scrolling is
9287 very slow and redrawing is not slow this can be set to a small number,
9288 e.g., 3, to speed up displaying.
9289
9290 *'ttytype'* *'tty'*
9291'ttytype' 'tty' string (default from $TERM)
9292 global
9293 Alias for 'term', see above.
9294
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009295 *'undodir'* *'udir'*
9296'undodir' 'udir' string (default ".")
9297 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009298 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009299 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009300 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009301 "." means using the directory of the file. The undo file name for
9302 "file.txt" is ".file.txt.un~".
9303 For other directories the file name is the full path of the edited
9304 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009305 When writing: The first directory that exists is used. "." always
9306 works, no directories after "." will be used for writing.
9307 When reading all entries are tried to find an undo file. The first
9308 undo file that exists is used. When it cannot be read an error is
9309 given, no further entry is used.
9310 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009311 This option cannot be set from a |modeline| or in the |sandbox|, for
9312 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009313
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009314 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009315'undofile' 'udf' boolean (default off)
9316 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009317 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009318 When on, Vim automatically saves undo history to an undo file when
9319 writing a buffer to a file, and restores undo history from the same
9320 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009321 The directory where the undo file is stored is specified by 'undodir'.
9322 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009323 The undo file is not read when 'undoreload' causes the buffer from
9324 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009325 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009326 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009327
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009329'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009330 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009332 is kept in memory, higher numbers will cause more memory to be used.
9333 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9335 itself: >
9336 set ul=0
9337< But you can also get Vi compatibility by including the 'u' flag in
9338 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009339 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009340 Set to -1 for no undo at all. You might want to do this only for the
9341 current buffer: >
9342 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009344
9345 The local value is set to -123456 when the global value is to be used.
9346
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009347 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009349 *'undoreload'* *'ur'*
9350'undoreload' 'ur' number (default 10000)
9351 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009352 Save the whole buffer for undo when reloading it. This applies to the
9353 ":e!" command and reloading for when the buffer changed outside of
9354 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009355 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009356 of lines is smaller than the value of this option.
9357 Set this option to zero to disable undo for a reload.
9358
9359 When saving undo for a reload, any undo file is not read.
9360
9361 Note that this causes the whole buffer to be stored in memory. Set
9362 this option to a lower value if you run out of memory.
9363
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 *'updatecount'* *'uc'*
9365'updatecount' 'uc' number (default: 200)
9366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 After typing this many characters the swap file will be written to
9368 disk. When zero, no swap file will be created at all (see chapter on
9369 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9370 Vim with the "-n" option, see |startup|. When editing in readonly
9371 mode this option will be initialized to 10000.
9372 The swapfile can be disabled per buffer with |'swapfile'|.
9373 When 'updatecount' is set from zero to non-zero, swap files are
9374 created for all buffers that have 'swapfile' set. When 'updatecount'
9375 is set to zero, existing swap files are not deleted.
9376 Also see |'swapsync'|.
9377 This option has no meaning in buffers where |'buftype'| is "nofile"
9378 or "nowrite".
9379
9380 *'updatetime'* *'ut'*
9381'updatetime' 'ut' number (default 4000)
9382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 If this many milliseconds nothing is typed the swap file will be
9384 written to disk (see |crash-recovery|). Also used for the
9385 |CursorHold| autocommand event.
9386
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009387 *'varsofttabstop'* *'vsts'*
9388'varsofttabstop' 'vsts' string (default "")
9389 local to buffer
9390 {only available when compiled with the |+vartabs|
9391 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009392 Defines variable-width soft tab stops. The value is a comma-separated
9393 list of widths in columns. Each width defines the number of columns
9394 before the next soft tab stop. The last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009395
9396 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009397 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009398 to use the following: >
9399 :set varsofttabstop=8,32,8
Damien Lejay91af4c42025-06-12 21:56:19 +02009400< This sets soft tab stops at column 8, then at column 40 (8 + 32), and
9401 every 8 columns thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009402
Damien Lejay91af4c42025-06-12 21:56:19 +02009403 Note: this setting overrides 'softtabstop'.
9404 See section |30.5| of the user manual for detailed explanations on how
9405 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009406
9407 *'vartabstop'* *'vts'*
9408'vartabstop' 'vts' string (default "")
9409 local to buffer
9410 {only available when compiled with the |+vartabs|
9411 feature}
Damien Lejay91af4c42025-06-12 21:56:19 +02009412 Defines variable-width tab stops. The value is a comma-separated list
9413 of widths in columns. Each width defines the number of columns
9414 before the next tab stop; the last value repeats indefinitely.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009415
Damien Lejay91af4c42025-06-12 21:56:19 +02009416 For example: >
9417 :set vartabstop=4,8
9418< This places the first tab stop 4 columns from the start of the line
9419 and each subsequent tab stop 8 columns apart.
9420
9421 Note: this setting overrides 'tabstop'.
9422 On UNIX, it is recommended to keep the default tabstop value of 8.
9423 Consider setting 'varsofttabstop' instead.
9424 See section |30.5| of the user manual for detailed explanations on how
9425 Vim works with tabs and spaces.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009426
Bram Moolenaar071d4272004-06-13 20:20:40 +00009427 *'verbose'* *'vbs'*
9428'verbose' 'vbs' number (default 0)
9429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430 When bigger than zero, Vim will give messages about what it is doing.
9431 Currently, these messages are given:
9432 >= 1 When the viminfo file is read or written.
9433 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009434 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009435 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436 >= 8 Files for which a group of autocommands is executed.
9437 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009438 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 >= 12 Every executed function.
9440 >= 13 When an exception is thrown, caught, finished, or discarded.
9441 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009442 >= 15 Every executed Ex command from a script (truncated at 200
9443 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009444 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009445
9446 This option can also be set with the "-V" argument. See |-V|.
9447 This option is also set by the |:verbose| command.
9448
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009449 When the 'verbosefile' option is set then the verbose messages are not
9450 displayed.
9451
9452 *'verbosefile'* *'vfile'*
9453'verbosefile' 'vfile' string (default empty)
9454 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009455 When not empty all messages are written in a file with this name.
9456 When the file exists messages are appended.
9457 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009458 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009459 Setting 'verbosefile' to a new value is like making it empty first.
9460 The difference with |:redir| is that verbose messages are not
9461 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009462 This option cannot be set from a |modeline| or in the |sandbox|, for
9463 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009464
Bram Moolenaar071d4272004-06-13 20:20:40 +00009465 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009466'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009467 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009468 for Unix: "$HOME/.vim/view" or
9469 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009470 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009471 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009472 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009473 feature}
9474 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009475 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009476 This option cannot be set from a |modeline| or in the |sandbox|, for
9477 security reasons.
9478
9479 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009480'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009481 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009482 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009483 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009484 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009485 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009486 word save and restore ~
9487 cursor cursor position in file and in window
9488 folds manually created folds, opened/closed folds and local
9489 fold options
9490 options options and mappings local to a window or buffer (not
9491 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009492 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 slash backslashes in file names replaced with forward
9494 slashes
9495 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009496 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009497 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009498
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009499 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009500 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009501 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009502
9503 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009504'viminfo' 'vi' string (Vi default: "", Vim default for
9505 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009506 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9507 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009509 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009510 feature}
9511 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009512 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9513 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009514 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009515 consisting of a single character identifying the particular parameter,
9516 followed by a number or string which specifies the value of that
9517 parameter. If a particular character is left out, then the default
9518 value is used for that parameter. The following is a list of the
9519 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009521 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009522 ! When included, save and restore global variables that start
9523 with an uppercase letter, and don't contain a lowercase
9524 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009525 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009526 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009527 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009528 " Maximum number of lines saved for each register. Old name of
9529 the '<' item, with the disadvantage that you need to put a
9530 backslash before the ", otherwise it will be recognized as the
9531 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009532 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009533 % When included, save and restore the buffer list. If Vim is
9534 started with a file name argument, the buffer list is not
9535 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009536 buffer list is restored from the viminfo file. Quickfix
9537 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9538 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009539 When followed by a number, the number specifies the maximum
9540 number of buffers that are stored. Without a number all
9541 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009542 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009543 ' Maximum number of previously edited files for which the marks
9544 are remembered. This parameter must always be included when
9545 'viminfo' is non-empty.
9546 Including this item also means that the |jumplist| and the
9547 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009548 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009549 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009550 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009551 patterns are also saved. When not included, the value of
9552 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009553 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009555 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009556 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 < Maximum number of lines saved for each register. If zero then
9558 registers are not saved. When not included, all lines are
9559 saved. '"' is the old name for this item.
9560 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009561 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009562 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009563 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009564 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565 c When included, convert the text in the viminfo file from the
9566 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009567 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009568 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009569 f Whether file marks need to be stored. If zero, file marks ('0
9570 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009571 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009572 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009573 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009574 h Disable the effect of 'hlsearch' when loading the viminfo
9575 file. When not included, it depends on whether ":nohlsearch"
9576 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009577 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009579 the 'n'. Must be at the end of the option! If the
9580 'viminfofile' option is set, that file name overrides the one
9581 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009582 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009583 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009584 r Removable media. The argument is a string (up to the next
9585 ','). This parameter can be given several times. Each
9586 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009587 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9589 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9590 ignored. Maximum length of each 'r' argument is 50
9591 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009592 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009593 s Maximum size of an item in Kbyte. If zero then registers are
9594 not saved. Currently only applies to registers. The default
9595 "s10" will exclude registers with more than 10 Kbyte of text.
9596 Also see the '<' item above: line count limit.
9597
9598 Example: >
9599 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9600<
9601 '50 Marks will be remembered for the last 50 files you
9602 edited.
9603 <1000 Contents of registers (up to 1000 lines each) will be
9604 remembered.
9605 s100 Registers with more than 100 Kbyte text are skipped.
9606 :0 Command-line history will not be saved.
9607 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9608 no / Since '/' is not specified, the default will be used,
9609 that is, save all of the search history, and also the
9610 previous search and substitute patterns.
9611 no % The buffer list will not be saved nor read back.
9612 no h 'hlsearch' highlighting will be restored.
9613
9614 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9615 load the contents of the file, this is not done automatically.
9616
9617 This option cannot be set from a |modeline| or in the |sandbox|, for
9618 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009619 NOTE: This option is set to the Vim default value when 'compatible'
9620 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009621
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009622 *'viminfofile'* *'vif'*
9623'viminfofile' 'vif' string (default: "")
9624 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009625 {not available when compiled without the |+viminfo|
9626 feature}
9627 When non-empty, overrides the file name used for viminfo.
9628 When equal to "NONE" no viminfo file will be read or written.
9629 This option can be set with the |-i| command line flag. The |--clean|
9630 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009631 This option cannot be set from a |modeline| or in the |sandbox|, for
9632 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009633
Bram Moolenaar071d4272004-06-13 20:20:40 +00009634 *'virtualedit'* *'ve'*
9635'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009636 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009637 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638 block Allow virtual editing in Visual block mode.
9639 insert Allow virtual editing in Insert mode.
9640 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009641 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009642 none When used as the local value, do not allow virtual
9643 editing even when the global value is set. When used
9644 as the global value, "none" is the same as "".
9645 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009646
Bram Moolenaar071d4272004-06-13 20:20:40 +00009647 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009648 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009649 of the line. Useful for selecting a rectangle in Visual mode and
9650 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009651 "onemore" is not the same, it will only allow moving the cursor just
9652 after the last character of the line. This makes some commands more
9653 consistent. Previously the cursor was always past the end of the line
9654 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009655 break some plugins or Vim scripts. For example because |l| can move
9656 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009657 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009658 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009659 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009660 It doesn't make sense to combine "all" with "onemore", but you will
9661 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009662 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009663 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009664
9665 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9666'visualbell' 'vb' boolean (default off)
9667 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009668 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009669 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009670 use: >
9671 :set vb t_vb=
9672< If you want a short flash, you can use this on many terminals: >
9673 :set vb t_vb=[?5h$<100>[?5l
9674< Here $<100> specifies the time, you can use a smaller or bigger value
9675 to get a shorter or longer flash.
9676
9677 Note: Vim will limit the bell to once per half a second. This avoids
9678 having to wait for the flashing to finish when there are lots of
9679 bells, e.g. on key repeat. This also happens without 'visualbell'
9680 set.
9681
Bram Moolenaar071d4272004-06-13 20:20:40 +00009682 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9683 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9684 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009685
9686 Note: When the GUI starts, 't_vb' is reset to its default value. You
9687 might want to set it again in your |gvimrc|.
9688
Bram Moolenaar071d4272004-06-13 20:20:40 +00009689 Does not work on the Amiga, you always get a screen flash.
9690 Also see 'errorbells'.
9691
9692 *'warn'* *'nowarn'*
9693'warn' boolean (default on)
9694 global
9695 Give a warning message when a shell command is used while the buffer
9696 has been changed.
9697
9698 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9699'weirdinvert' 'wiv' boolean (default off)
9700 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009701 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009702 It is provided for backwards compatibility with version 4.x.
9703 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9704 vice versa. Has no effect when the GUI is running.
9705
9706 *'whichwrap'* *'ww'*
9707'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009709 Allow specified keys that move the cursor left/right to move to the
9710 previous/next line when the cursor is on the first/last character in
9711 the line. Concatenate characters to allow this for these keys:
9712 char key mode ~
9713 b <BS> Normal and Visual
9714 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009715 h "h" Normal and Visual (not recommended)
9716 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009717 < <Left> Normal and Visual
9718 > <Right> Normal and Visual
9719 ~ "~" Normal
9720 [ <Left> Insert and Replace
9721 ] <Right> Insert and Replace
9722 For example: >
9723 :set ww=<,>,[,]
9724< allows wrap only when cursor keys are used.
9725 When the movement keys are used in combination with a delete or change
9726 operator, the <EOL> also counts for a character. This makes "3h"
9727 different from "3dh" when the cursor crosses the end of a line. This
9728 is also true for "x" and "X", because they do the same as "dl" and
9729 "dh". If you use this, you may also want to use the mapping
9730 ":map <BS> X" to make backspace delete the character in front of the
9731 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009732 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009733 line (not an empty line) then it will not move to the next line. This
9734 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009735 NOTE: This option is set to the Vi default value when 'compatible' is
9736 set and to the Vim default value when 'compatible' is reset.
9737
9738 *'wildchar'* *'wc'*
9739'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009741 Character you have to type to start wildcard expansion in the
9742 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009743 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009744 The character is not recognized when used inside a macro. See
9745 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009746 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009747 <Esc> can be used, but hitting it twice in a row will still exit
9748 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009749 Although 'wc' is a number option, it can be specified as a number, a
9750 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9751 preceded with a caret (e.g. `^F` is CTRL-F): >
9752 :set wc=27
9753 :set wc=X
9754 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009755 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009756< NOTE: This option is set to the Vi default value when 'compatible' is
9757 set and to the Vim default value when 'compatible' is reset.
9758
9759 *'wildcharm'* *'wcm'*
9760'wildcharm' 'wcm' number (default: none (0))
9761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009762 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009763 recognized when used inside a macro. You can find "spare" command-line
9764 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009765 you'll never actually type 'wildcharm', just use it in mappings that
9766 automatically invoke completion mode, e.g.: >
9767 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009768 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009769< Then after typing :ss you can use CTRL-P & CTRL-N.
9770
9771 *'wildignore'* *'wig'*
9772'wildignore' 'wig' string (default "")
9773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009774 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009775 patterns is ignored when expanding |wildcards|, completing file or
9776 directory names, and influences the result of |expand()|, |glob()| and
9777 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009778 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9779 Also see 'suffixes'.
9780 Example: >
9781 :set wildignore=*.o,*.obj
9782< The use of |:set+=| and |:set-=| is preferred when adding or removing
9783 a pattern from the list. This avoids problems when a future version
9784 uses another default.
9785
h_east596a9f22023-11-21 21:24:23 +09009786 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009787'wildignorecase' 'wic' boolean (default off)
9788 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009789 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009790 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009791 Does not apply when the shell is used to expand wildcards, which
9792 happens when there are special characters.
9793
Bram Moolenaar071d4272004-06-13 20:20:40 +00009794 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009795'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009797 When 'wildmenu' is on, command-line completion operates in an enhanced
9798 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009799 the possible matches are shown.
9800 When 'wildoptions' contains "pum", then the completion matches are
9801 shown in a popup menu. Otherwise they are displayed just above the
9802 command line, with the first match highlighted (overwriting the status
9803 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009804 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009805 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9806 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9807 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009808 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009809 If there are more matches than can fit in the line, a ">" is shown on
9810 the right and/or a "<" is shown on the left. The status line scrolls
9811 as needed.
9812 The "wildmenu" mode is abandoned when a key is hit that is not used
9813 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009814 While the "wildmenu" is active, the following keys have special
9815 meanings:
9816 CTRL-P - go to the previous entry
9817 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009818 <CR> - in menu completion, when the cursor is just after a
9819 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009820 CTRL-E - end completion, go back to what was there before
9821 selecting a match.
9822 CTRL-Y - accept the currently selected match and stop
9823 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009824
9825 When not using the popup menu for command line completion, the
9826 following keys have special meanings:
9827 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009828 <Up> - in filename/menu name completion: move up into
9829 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009830 <Down> - in filename/menu name completion: move into a
9831 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009832
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009833 When using the popup menu for command line completion, the following
9834 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009835 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009836 <PageUp> - select a match several entries back
9837 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009838 <Left> - in filename/menu name completion: move up into
9839 parent directory or parent menu.
9840 <Right> - in filename/menu name completion: move into a
9841 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009842
Bram Moolenaar071d4272004-06-13 20:20:40 +00009843 This makes the menus accessible from the console |console-menus|.
9844
9845 If you prefer the <Left> and <Right> keys to move the cursor instead
9846 of selecting a different match, use this: >
9847 :cnoremap <Left> <Space><BS><Left>
9848 :cnoremap <Right> <Space><BS><Right>
9849<
9850 The "WildMenu" highlighting is used for displaying the current match
9851 |hl-WildMenu|.
9852
9853 *'wildmode'* *'wim'*
9854'wildmode' 'wim' string (Vim default: "full")
9855 global
Girish Palyaeded3362025-04-12 18:03:32 +02009856 Completion mode used for the character specified with 'wildchar'.
9857 This option is a comma-separated list of up to four parts,
9858 corresponding to the first, second, third, and fourth presses of
9859 'wildchar'. Each part is a colon-separated list of completion
9860 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009861
Girish Palyaeded3362025-04-12 18:03:32 +02009862 The possible behavior values are:
9863 "" Only complete (insert) the first match. No further
9864 matches are cycled or listed.
9865 "full" Complete the next full match. Cycles through all
9866 matches, returning to the original input after the
9867 last match. If 'wildmenu' is enabled, it will be
9868 shown.
9869 "longest" Complete to the longest common substring. If this
9870 doesn't extend the input, the next 'wildmode' part is
9871 used.
9872 "list" If multiple matches are found, list all of them.
9873 "lastused" When completing buffer names, sort them by most
9874 recently used (excluding the current buffer). Only
9875 applies to buffer name completion.
9876 "noselect" If 'wildmenu' is enabled, show the menu but do not
9877 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009878 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009879 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009880
Girish Palyaeded3362025-04-12 18:03:32 +02009881 Some useful combinations of colon-separated values:
9882 "longest:full" Start with the longest common string and show
9883 'wildmenu' (if enabled). Does not cycle
9884 through full matches.
9885 "list:full" List all matches and complete first match.
9886 "list:longest" List all matches and complete till the longest
9887 common prefix.
9888 "list:lastused" List all matches. When completing buffers,
9889 sort them by most recently used (excluding the
9890 current buffer).
9891 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9892 if it is active. When completing buffers,
9893 sort them by most recently used (excluding the
9894 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009895
9896 Examples: >
9897 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009898< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009899 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009900< First press: longest common substring
9901 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009902 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009903< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009904 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009905< First press: list matches only
9906 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009907 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009908< First press: longest common substring
9909 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009910 :set wildmode=noselect:full
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02009911< First press: show 'wildmenu' without completing or selecting
9912 Second press: cycle full matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009913 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009914< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009915 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009916
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009917 *'wildoptions'* *'wop'*
9918'wildoptions' 'wop' string (default "")
9919 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009920 A list of words that change how |cmdline-completion| is done.
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009921
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009922 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009923 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009924 this value is specified, wildcard expansion will not
9925 be used for completion. The matches will be sorted by
9926 the "best match" rather than alphabetically sorted.
9927 This will find more matches than the wildcard
9928 expansion. Currently fuzzy matching based completion
9929 is not supported for file and directory names and
9930 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009931 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009932 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009933 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009934 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009935 is displayed per line. Often used tag kinds are:
9936 d #define
9937 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009938
Ilya Grigoriev053aee02025-06-11 21:07:35 +02009939 This option does not apply to |ins-completion|. See 'completeopt' for
9940 that.
9941
Bram Moolenaar071d4272004-06-13 20:20:40 +00009942 *'winaltkeys'* *'wak'*
9943'winaltkeys' 'wak' string (default "menu")
9944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009945 {only used in Win32, Motif, GTK and Photon GUI}
9946 Some GUI versions allow the access to menu entries by using the ALT
9947 key in combination with a character that appears underlined in the
9948 menu. This conflicts with the use of the ALT key for mappings and
9949 entering special characters. This option tells what to do:
9950 no Don't use ALT keys for menus. ALT key combinations can be
9951 mapped, but there is no automatic handling. This can then be
9952 done with the |:simalt| command.
9953 yes ALT key handling is done by the windowing system. ALT key
9954 combinations cannot be mapped.
9955 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009956 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009957 keys can be mapped.
9958 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9959 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009960 This option is not used for <F10>; on Win32 and with GTK <F10> will
9961 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009962
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009963 *'wincolor'* *'wcr'*
9964'wincolor' 'wcr' string (default empty)
9965 local to window
9966 Highlight group name to use for this window instead of the Normal
9967 color |hl-Normal|.
9968
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009969 *'window'* *'wi'*
9970'window' 'wi' number (default screen height - 1)
9971 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009972 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9973 window and the value is smaller than 'lines' minus one. The screen
9974 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009975 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9976 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009977 When resizing the Vim window, and the value is smaller than 1 or more
9978 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009979 Note: Do not confuse this with the height of the Vim window, use
9980 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009981
Doug Kearns002548b2025-06-05 21:18:09 +02009982 *'winfixbuf'* *'wfb'*
Colin Kennedy21570352024-03-03 16:16:47 +01009983'winfixbuf' 'wfb' boolean (default off)
9984 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009985 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009986 For example, attempting to change the buffer with |:edit| will fail.
9987 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009988 also skip any window with 'winfixbuf' enabled. However if an Ex
9989 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009990
laburnumT3f7855a2023-12-05 18:37:03 +01009991 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9992'winfixheight' 'wfh' boolean (default off)
9993 local to window |local-noglobal|
9994 Keep the window height when windows are opened or closed and
9995 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9996 |preview-window| and |quickfix-window|.
9997 The height may be changed anyway when running out of room.
9998
9999 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
10000'winfixwidth' 'wfw' boolean (default off)
10001 local to window |local-noglobal|
10002 Keep the window width when windows are opened or closed and
10003 'equalalways' is set. Also for |CTRL-W_=|.
10004 The width may be changed anyway when running out of room.
10005
Bram Moolenaar071d4272004-06-13 20:20:40 +000010006 *'winheight'* *'wh'* *E591*
10007'winheight' 'wh' number (default 1)
10008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010009 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010010 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +000010011 focus goes to a window that is smaller, its size is increased, at the
10012 cost of the height of other windows.
10013 Set 'winheight' to a small number for normal editing.
10014 Set it to 999 to make the current window fill most of the screen.
10015 Other windows will be only 'winminheight' high. This has the drawback
10016 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
10017 to create only two windows, set the option after startup is done,
10018 using the |VimEnter| event: >
10019 au VimEnter * set winheight=999
10020< Minimum value is 1.
10021 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010022 height of the current window.
10023 'winheight' applies to the current window. Use 'winminheight' to set
10024 the minimal height for other windows.
10025
Bram Moolenaar071d4272004-06-13 20:20:40 +000010026 *'winminheight'* *'wmh'*
10027'winminheight' 'wmh' number (default 1)
10028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010029 The minimal height of a window, when it's not the current window.
10030 This is a hard minimum, windows will never become smaller.
10031 When set to zero, windows may be "squashed" to zero lines (i.e. just a
10032 status bar) if necessary. They will return to at least one line when
10033 they become active (since the cursor has to have somewhere to go.)
10034 Use 'winheight' to set the minimal height of the current window.
10035 This option is only checked when making a window smaller. Don't use a
10036 large number, it will cause errors when opening more than a few
10037 windows. A value of 0 to 3 is reasonable.
10038
10039 *'winminwidth'* *'wmw'*
10040'winminwidth' 'wmw' number (default 1)
10041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010042 The minimal width of a window, when it's not the current window.
10043 This is a hard minimum, windows will never become smaller.
10044 When set to zero, windows may be "squashed" to zero columns (i.e. just
10045 a vertical separator) if necessary. They will return to at least one
10046 line when they become active (since the cursor has to have somewhere
10047 to go.)
10048 Use 'winwidth' to set the minimal width of the current window.
10049 This option is only checked when making a window smaller. Don't use a
10050 large number, it will cause errors when opening more than a few
10051 windows. A value of 0 to 12 is reasonable.
10052
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010053 *'winptydll'*
10054'winptydll' string (default "winpty32.dll" or "winpty64.dll")
10055 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010056 {only available when compiled with the |terminal|
10057 feature on MS-Windows}
10058 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +020010059 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +020010060 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +020010061 a fallback.
10062 Environment variables are expanded |:set_env|.
10063 This option cannot be set from a |modeline| or in the |sandbox|, for
10064 security reasons.
10065
Bram Moolenaar071d4272004-06-13 20:20:40 +000010066 *'winwidth'* *'wiw'* *E592*
10067'winwidth' 'wiw' number (default 20)
10068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010069 Minimal number of columns for the current window. This is not a hard
10070 minimum, Vim will use fewer columns if there is not enough room. If
10071 the current window is smaller, its size is increased, at the cost of
10072 the width of other windows. Set it to 999 to make the current window
10073 always fill the screen. Set it to a small number for normal editing.
10074 The width is not adjusted after one of the commands to change the
10075 width of the current window.
10076 'winwidth' applies to the current window. Use 'winminwidth' to set
10077 the minimal width for other windows.
10078
Foxe Chenb90c2392025-06-27 21:10:35 +020010079 *'wlseat'* *'wse'*
10080'wlseat' 'wse' string (default "")
10081 global
10082 {only when the |+wayland| feature is included}
10083 Specifies the Wayland seat to use for Wayland functionality,
10084 specifically the clipboard. If the seat does not exist, then the
10085 option will still be set to the new value, with the Wayland clipboard
10086 being unavailable as a result. If an empty value is passed then Vim
10087 will attempt to use the value of $XDG_SEAT if it exists, if not then
10088 it resorts to using the first seat found available. Updating this
10089 option will also update |v:clipmethod|.
10090
10091 *'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
10092'wlsteal' 'wst' boolean (default off)
10093 global
10094 {only when the |+wayland_clipboard| feature is included}
10095 When enabled, then allow Vim to steal focus by creating a temporary
10096 surface, in order to access the clipboard. For more information see
10097 |wayland-focus-steal|.
10098
10099 *'wltimeoutlen'* *'wtm'*
10100'wltimeoutlen' 'wtm' number (default 500)
10101 global
10102 {only when the |+wayland| feature is included}
10103 The timeout in milliseconds before Vim gives up on waiting for the
10104 Wayland compositor. While Vim waits on the compositor, it is
10105 unresponsive to input and does not update the screen. Therefore
10106 setting this to a lower value may make Vim feel more responsive in
10107 some cases. On the other hand, it may also mean you receive errors
10108 when the compositor takes more time to respond than usual.
10109
10110 Additionally, this option is also used as the maximum timeout when
10111 waiting for a surface to gain focus, see |wayland-focus-steal|.
10112
Bram Moolenaar071d4272004-06-13 20:20:40 +000010113 *'wrap'* *'nowrap'*
10114'wrap' boolean (default on)
10115 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +000010116 This option changes how text is displayed. It doesn't change the text
10117 in the buffer, see 'textwidth' for that.
10118 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010119 displaying continues on the next line. When off lines will not wrap
10120 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +000010121 moved to a part that is not shown, the screen will scroll
10122 horizontally.
10123 The line will be broken in the middle of a word if necessary. See
10124 'linebreak' to get the break at a word boundary.
10125 To make scrolling horizontally a bit more useful, try this: >
10126 :set sidescroll=5
10127 :set listchars+=precedes:<,extends:>
10128< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010129 This option can't be set from a |modeline| when the 'diff' option is
10130 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010131
10132 *'wrapmargin'* *'wm'*
10133'wrapmargin' 'wm' number (default 0)
10134 local to buffer
10135 Number of characters from the right window border where wrapping
10136 starts. When typing text beyond this limit, an <EOL> will be inserted
10137 and inserting continues on the next line.
10138 Options that add a margin, such as 'number' and 'foldcolumn', cause
10139 the text width to be further reduced. This is Vi compatible.
10140 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +020010141 This option is set to 0 when 'paste' is set and restored when 'paste'
10142 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +020010143 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010144
10145 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
10146'wrapscan' 'ws' boolean (default on) *E384* *E385*
10147 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +000010148 Searches wrap around the end of the file. Also applies to |]s| and
10149 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010150
10151 *'write'* *'nowrite'*
10152'write' boolean (default on)
10153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010154 Allows writing files. When not set, writing a file is not allowed.
10155 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000010156 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +000010157 argument. Filtering text is still possible, even though this requires
10158 writing a temporary file.
10159
10160 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
10161'writeany' 'wa' boolean (default off)
10162 global
10163 Allows writing to any file with no need for "!" override.
10164
10165 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
10166'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
10167 otherwise)
10168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +000010169 Make a backup before overwriting a file. The backup is removed after
10170 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +020010171 also on.
10172 WARNING: Switching this option off means that when Vim fails to write
10173 your buffer correctly and then, for whatever reason, Vim exits, you
10174 lose both the original file and what you were writing. Only reset
10175 this option if your file system is almost full and it makes the write
10176 fail (and make sure not to exit Vim until the write was successful).
10177 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010178 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +010010179 Depending on 'backupcopy' the backup is a new file or the original
10180 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010181 NOTE: This option is set to the default value when 'compatible' is
10182 set.
10183
10184 *'writedelay'* *'wd'*
10185'writedelay' 'wd' number (default 0)
10186 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +020010187 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010188 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010010189 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010190
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010191 *'xtermcodes'* *'noxtermcodes'*
10192'xtermcodes' boolean (default on)
10193 global
10194 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +000010195 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +000010196 key codes and number of colors from the terminal. This takes care of
10197 various configuration options of the terminal that cannot be obtained
10198 from the termlib/terminfo entry, see |xterm-codes|.
10199 A side effect may be that t_Co changes and Vim will redraw the
10200 display.
10201
10202
Bram Moolenaar91f84f62018-07-29 15:07:52 +020010203 vim:tw=78:ts=8:noet:ft=help:norl: