blob: d1a069110805fecdf7d57b3edb79db8086f50a7e [file] [log] [blame]
Millya9c6f902024-10-06 16:47:02 +02001*options.txt* For Vim version 9.1. Last change: 2024 Oct 06
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
215 :set tags=tags\\,file results in "tags,file"
216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
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*
442Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000443'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000444a function name or a function reference or a lambda function. When using a
445lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000446>
447 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000448 set opfunc=function('MyOpFunc')
449 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000450 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000451
452Set to a script-local function: >
453 set opfunc=s:MyLocalFunc
454 set opfunc=<SID>MyLocalFunc
455In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
456the script: >
457 set opfunc=MyLocalFunc
458
459Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000460 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000461 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000462
463Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000464 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000465
466Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000467 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000468 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000469
470In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300471closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000472context of where it was defined.
473
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475Setting the filetype
476
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200477:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478 Set the 'filetype' option to {filetype}, but only if
479 not done yet in a sequence of (nested) autocommands.
480 This is short for: >
481 :if !did_filetype()
482 : setlocal filetype={filetype}
483 :endif
484< This command is used in a filetype.vim file to avoid
485 setting the 'filetype' option twice, causing different
486 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200487
488 When the optional FALLBACK argument is present, a
489 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100490 'filetype'. This is to be used for filetype
491 detections that are just a guess. |did_filetype()|
492 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200493
Bram Moolenaard58e9292011-02-09 17:07:58 +0100494 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
496:opt[ions] Open a window for viewing and setting all options.
497 Options are grouped by function.
498 Offers short help for each option. Hit <CR> on the
499 short help to open a help window with more help for
500 the option.
501 Modify the value of the option and hit <CR> on the
502 "set" line to set the new value. For window and
503 buffer specific options, the last accessed window is
504 used to set the option value in, unless this is a help
505 window, in which case the window below help window is
506 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100507 {not available when compiled without the |+eval|
508 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
510 *$HOME*
511Using "~" is like using "$HOME", but it is only recognized at the start of an
512option and after a space or comma.
513
514On Unix systems "~user" can be used too. It is replaced by the home directory
515of user "user". Example: >
516 :set path=~mool/include,/usr/include,.
517
518On Unix systems the form "${HOME}" can be used too. The name between {} can
519contain non-id characters then. Note that if you want to use this for the
520"gf" command, you need to add the '{' and '}' characters to 'isfname'.
521
522NOTE: expanding environment variables and "~/" is only done with the ":set"
523command, not when assigning a value to an option with ":let".
524
Bram Moolenaarc572da52017-08-27 16:52:01 +0200525 *$HOME-windows*
526On MS-Windows, if $HOME is not defined as an environment variable, then
527at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200528If $HOMEDRIVE is not set then $USERPROFILE is used.
529
530This expanded value is not exported to the environment, this matters when
531running an external command: >
532 :echo system('set | findstr ^HOME=')
533and >
534 :echo luaeval('os.getenv("HOME")')
535should echo nothing (an empty string) despite exists('$HOME') being true.
536When setting $HOME to a non-empty string it will be exported to the
537subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200538
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
540Note the maximum length of an expanded option is limited. How much depends on
541the system, mostly it is something like 256 or 1024 characters.
542
543 *:fix* *:fixdel*
544:fix[del] Set the value of 't_kD':
545 't_kb' is 't_kD' becomes ~
546 CTRL-? CTRL-H
547 not CTRL-? CTRL-?
548
Bram Moolenaar82be4842021-01-11 19:40:15 +0100549 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551 If your delete key terminal code is wrong, but the
552 code for backspace is alright, you can put this in
553 your .vimrc: >
554 :fixdel
555< This works no matter what the actual code for
556 backspace is.
557
558 If the backspace key terminal code is wrong you can
559 use this: >
560 :if &term == "termname"
561 : set t_kb=^V<BS>
562 : fixdel
563 :endif
564< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000565 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 with your terminal name.
567
568 If your <Delete> key sends a strange key sequence (not
569 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
570 :if &term == "termname"
571 : set t_kD=^V<Delete>
572 :endif
573< Where "^V" is CTRL-V and "<Delete>" is the delete key
574 (don't type eight characters!). Replace "termname"
575 with your terminal name.
576
577 *Linux-backspace*
578 Note about Linux: By default the backspace key
579 produces CTRL-?, which is wrong. You can fix it by
580 putting this line in your rc.local: >
581 echo "keycode 14 = BackSpace" | loadkeys
582<
583 *NetBSD-backspace*
584 Note about NetBSD: If your backspace doesn't produce
585 the right code, try this: >
586 xmodmap -e "keycode 22 = BackSpace"
587< If this works, add this in your .Xmodmap file: >
588 keysym 22 = BackSpace
589< You need to restart for this to take effect.
590
591==============================================================================
5922. Automatically setting options *auto-setting*
593
594Besides changing options with the ":set" command, there are three alternatives
595to set options automatically for one or more files:
596
5971. When starting Vim initializations are read from various places. See
598 |initialization|. Most of them are performed for all editing sessions,
599 and some of them depend on the directory where Vim is started.
600 You can create an initialization file with |:mkvimrc|, |:mkview| and
601 |:mksession|.
6022. If you start editing a new file, the automatic commands are executed.
603 This can be used to set options for files matching a particular pattern and
604 many other things. See |autocommand|.
6053. If you start editing a new file, and the 'modeline' option is on, a
606 number of lines at the beginning and end of the file are checked for
607 modelines. This is explained here.
608
609 *modeline* *vim:* *vi:* *ex:* *E520*
610There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100611 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100613[text{white}] empty or any text followed by at least one blank
614 character (<Space> or <Tab>); "ex:" always requires at
615 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200616{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200617[white] optional white space
618{options} a list of option settings, separated with white space
619 or ':', where each part between ':' is the argument
620 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
Bram Moolenaar14b69452013-06-29 23:05:20 +0200622Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000623 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200624 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626The second form (this is compatible with some versions of Vi):
627
Bram Moolenaarade0d392020-01-21 22:33:58 +0100628 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629
Bram Moolenaarade0d392020-01-21 22:33:58 +0100630[text{white}] empty or any text followed by at least one blank
631 character (<Space> or <Tab>); "ex:" always requires at
632 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200633{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
634[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200635se[t] the string "set " or "se " (note the space); When
636 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200637{options} a list of options, separated with white space, which
638 is the argument for a ":set" command
639: a colon
640[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641
Bram Moolenaar14b69452013-06-29 23:05:20 +0200642Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000643 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200644 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200646The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
647chance that a normal word like "lex:" is caught. There is one exception:
648"vi:" and "vim:" can also be at the start of the line (for compatibility with
649version 3.0). Using "ex:" at the start of the line will be ignored (this
650could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Hu Jialun9dcd3492021-08-28 20:42:50 +0200652If the modeline is disabled within a modeline, subsequent modelines will be
653ignored. This is to allow turning off modeline on a per-file basis. This is
654useful when a line looks like a modeline but isn't. For example, it would be
655good to start a YAML file containing strings like "vim:" with
656 # vim: nomodeline ~
657so as to avoid modeline misdetection. Following options on the same line
658after modeline deactivation, if any, are still evaluated (but you would
659normally not have any).
660
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 *modeline-local*
662The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000663buffer and window that contain the file. Although it's possible to set global
664options from a modeline, this is unusual. If you have two windows open and
665the files in it set the same global option to a different value, the result
666depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000668When editing a file that was already loaded, only the window-local options
669from the modeline are used. Thus if you manually changed a buffer-local
670option after opening the file, it won't be changed if you edit the same buffer
671in another window. But window-local options will be set.
672
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 *modeline-version*
674If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200675number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 vim{vers}: version {vers} or later
677 vim<{vers}: version before {vers}
678 vim={vers}: version {vers}
679 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100680{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
681For example, to use a modeline only for Vim 7.0:
682 /* vim700: set foldmethod=marker */ ~
683To use a modeline for Vim after version 7.2:
684 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685There can be no blanks between "vim" and the ":".
686
687
688The number of lines that are checked can be set with the 'modelines' option.
689If 'modeline' is off or 'modelines' is 0 no lines are checked.
690
691Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000692like:
693 /* vi:ts=4: */ ~
694will give an error message for the trailing "*/". This line is OK:
695 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696
697If an error is detected the rest of the line is skipped.
698
699If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000700backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100701 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
702This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
703before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200704 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000706might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200707can be set. For some options a flag is set, so that when the value is used
708the |sandbox| is effective. Some options can only be set from the modeline
709when 'modelineexpr' is set (the default is off).
710
711Still, there is always a small risk that a modeline causes trouble. E.g.,
712when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
713So disable modelines before editing untrusted text. The mail ftplugin does
714this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715
716Hint: If you would like to do something else than setting an option, you could
717define an autocommand that checks the file for a specific string. For
718example: >
719 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
720And define a function SetVar() that does something with the line containing
721"VAR".
722
723==============================================================================
7243. Options summary *option-summary*
725
726In the list below all the options are mentioned with their full name and with
727an abbreviation if there is one. Both forms may be used.
728
729In this document when a boolean option is "set" that means that ":set option"
730is entered. When an option is "reset", ":set nooption" is used.
731
732For some options there are two default values: The "Vim default", which is
733used when 'compatible' is not set, and the "Vi default", which is used when
734'compatible' is set.
735
736Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000737are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738different value in each window. For example the 'list' option can be set in
739one window and reset in another for the same text, giving both types of view
740at the same time. There are a few options that are specific to a certain
741file. These can have a different value for each file or buffer. For example
742the 'textwidth' option can be 78 for a normal text file and 0 for a C
743program.
744
745 global one option for all buffers and windows
746 local to window each window has its own copy of this option
747 local to buffer each buffer has its own copy of this option
748
749When creating a new window the option values from the currently active window
750are used as a default value for the window-specific options. For the
751buffer-specific options this depends on the 's' and 'S' flags in the
752'cpoptions' option. If 's' is included (which is the default) the values for
753buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000754first entered. If 'S' is present the options are copied each time the buffer
755is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756present, the options are copied from the currently active buffer when the
757buffer is created.
758
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000759Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000761Not all options are supported in all versions. This depends on the supported
762features and sometimes on the system. A remark about this is in curly braces
763below. When an option is not supported it may still be set without getting an
764error, this is called a hidden option. You can't get the value of a hidden
765option though, it is not stored.
766
767To test if option "foo" can be used with ":set" use something like this: >
768 if exists('&foo')
769This also returns true for a hidden option. To test if option "foo" is really
770supported use something like this: >
771 if exists('+foo')
772<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 *E355*
774A jump table for the options with a short description can be found at |Q_op|.
775
776 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100777'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 {only available when compiled with the |+rightleft|
780 feature}
781 The ASCII code for the first letter of the Hebrew alphabet. The
782 routine that maps the keyboard in Hebrew mode, both in Insert mode
783 (when hkmap is set) and on the command-line (when hitting CTRL-_)
784 outputs the Hebrew characters in the range [aleph..aleph+26].
785 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
786 See |rileft.txt|.
787
788 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
789'allowrevins' 'ari' boolean (default off)
790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 {only available when compiled with the |+rightleft|
792 feature}
793 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
794 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
795 into reverse Insert mode, and don't know how to get out. See
796 'revins'.
797 NOTE: This option is reset when 'compatible' is set.
798
799 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
800'altkeymap' 'akm' boolean (default off)
801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 {only available when compiled with the |+farsi|
803 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100804 This option was for using Farsi, which has been removed. See
805 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'ambiwidth'* *'ambw'*
808'ambiwidth' 'ambw' string (default: "single")
809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
811 Tells Vim what to do with characters with East Asian Width Class
812 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
813 letters, Cyrillic letters).
814
815 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000816 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 expected by most users.
818 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200819 *E834* *E835*
820 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100821 contains a character that would be double width. These errors may
822 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200823
824 The values are overruled for characters specified with
825 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 There are a number of CJK fonts for which the width of glyphs for
828 those characters are solely based on how many octets they take in
829 legacy/traditional CJK encodings. In those encodings, Euro,
830 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000831 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000833 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 Vim is running inside a terminal (emulators) that uses a CJK font
835 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
836 this option should be set to "double" to match the width perceived
837 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100838 to be set to "double" under CJK MS-Windows when the system locale is
839 set to one of CJK locales. See Unicode Standard Annex #11
840 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100842 Vim may set this option automatically at startup time when Vim is
843 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200844 escape sequence to request cursor position report. The response can
845 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100846
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
848'antialias' 'anti' boolean (default: off)
849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200851 on macOS}
852 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
854 which can be easier to read at certain sizes on certain displays.
855 Setting this option can sometimes cause problems if 'guifont' is set
856 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100857 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
860'arabic' 'arab' boolean (default off)
861 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 {only available when compiled with the |+arabic|
863 feature}
864 This option can be set to start editing Arabic text.
865 Setting this option will:
866 - Set the 'rightleft' option, unless 'termbidi' is set.
867 - Set the 'arabicshape' option, unless 'termbidi' is set.
868 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
869 between typing English and Arabic key mapping.
870 - Set the 'delcombine' option
871 Note that 'encoding' must be "utf-8" for working with Arabic text.
872
873 Resetting this option will:
874 - Reset the 'rightleft' option.
875 - Disable the use of 'keymap' (without changing its value).
876 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200877 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100878 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Also see |arabic.txt|.
880
881 *'arabicshape'* *'arshape'*
882 *'noarabicshape'* *'noarshape'*
883'arabicshape' 'arshape' boolean (default on)
884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 {only available when compiled with the |+arabic|
886 feature}
887 When on and 'termbidi' is off, the required visual character
888 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200889 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 one which encompasses:
891 a) the changing/morphing of characters based on their location
892 within a word (initial, medial, final and stand-alone).
893 b) the enabling of the ability to compose characters
894 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100895 When disabled the display shows each character's true stand-alone
896 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 Arabic is a complex language which requires other settings, for
898 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100899 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
laburnumT3f7855a2023-12-05 18:37:03 +0100901 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
902'autochdir' 'acd' boolean (default off)
903 global
904 {only available when compiled with it, use
905 exists("+autochdir") to check}
906 When on, Vim will change the current working directory whenever you
907 open a file, switch buffers, delete a buffer or open/close a window.
908 It will change to the directory containing the file which was opened
909 or selected. When a buffer has no name it also has no directory, thus
910 the current directory won't change when navigating to it.
911 Note: When this option is on some plugins may not work.
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
914'autoindent' 'ai' boolean (default off)
915 local to buffer
916 Copy indent from current line when starting a new line (typing <CR>
917 in Insert mode or when using the "o" or "O" command). If you do not
918 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000919 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
920 to another line has the same effect, unless the 'I' flag is included
921 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 When autoindent is on, formatting (with the "gq" command or when you
923 reach 'textwidth' in Insert mode) uses the indentation of the first
924 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 When 'smartindent' or 'cindent' is on the indent is changed in
926 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200927 The 'autoindent' option is reset when the 'paste' option is set and
928 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 *'autoread'* *'ar'* *'noautoread'* *'noar'*
931'autoread' 'ar' boolean (default off)
932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 When a file has been detected to have been changed outside of Vim and
934 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200935 When the file has been deleted this is not done, so you have the text
936 from before it was deleted. When it appears again then it is read.
937 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 If this option has a local value, use this command to switch back to
939 using the global value: >
940 :set autoread<
941<
laburnumT3f7855a2023-12-05 18:37:03 +0100942
943 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
944'autoshelldir' 'asd' boolean (default off)
945 global
946 When on, Vim will change the current working directory whenever you
947 change the directory of the shell running in a terminal window. You
948 need proper setting-up, so whenever the shell's pwd changes an OSC 7
949 escape sequence will be emitted. For example, on Linux, you can
950 source /etc/profile.d/vte.sh in your shell profile if you use bash or
951 zsh. For bash this should work (put it in a bash init file): >
952 if [[ -n "$VIM_TERMINAL" ]]; then
953 PROMPT_COMMAND='_vim_sync_PWD'
954 function _vim_sync_PWD() {
955 printf '\033]7;file://%s\033\\' "$PWD"
956 }
957 fi
958<
959 Or, in a zsh init file: >
960 if [[ -n "$VIM_TERMINAL" ]]; then
961 autoload -Uz add-zsh-hook
962 add-zsh-hook -Uz chpwd _vim_sync_PWD
963 function _vim_sync_PWD() {
964 printf '\033]7;file://%s\033\\' "$PWD"
965 }
966 fi
967<
968 In a fish init file: >
969 if test -n "$VIM_TERMINAL"
970 function _vim_sync_PWD --on-variable=PWD
971 printf '\033]7;file://%s\033\\' "$PWD"
972 end
973 end
974<
975 You can find an alternative method at |terminal-autoshelldir|.
976 When the parsing of the OSC sequence fails you get *E1179* .
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
979'autowrite' 'aw' boolean (default off)
980 global
981 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000982 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000983 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
984 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000985 to another file.
986 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000987 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Note that for some commands the 'autowrite' option is not used, see
989 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200990 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200991 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100992 USE WITH CARE: If you make temporary changes to a buffer that you
993 don't want to be saved this option may cause it to be saved anyway.
994 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
996 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
997'autowriteall' 'awa' boolean (default off)
998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1000 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1001 Setting this option also implies that Vim behaves like 'autowrite' has
1002 been set.
1003
1004 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001005'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 When set to "dark", Vim will try to use colors that look good on a
1008 dark background. When set to "light", Vim will try to use colors that
1009 look good on a light background. Any other value is illegal.
1010 Vim tries to set the default value according to the terminal used.
1011 This will not always be correct.
1012 Setting this option does not change the background color, it tells Vim
1013 what the background color looks like. For changing the background
1014 color, see |:hi-normal|.
1015
Gregory Anders83ad2722024-01-03 19:48:51 +01001016 When 'background' is changed Vim will adjust the default color groups
1017 for the new value. But the colors used for syntax highlighting will
1018 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001019 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001020 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 the color scheme adjusts to the value of 'background' this will work.
1022 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 When setting 'background' to the default value with: >
1026 :set background&
1027< Vim will guess the value. In the GUI this should work correctly,
1028 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001029 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001030 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001032 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001033 color from the terminal. If the returned RGB value is dark/light and
1034 'background' is not dark/light, 'background' will be set and the
1035 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001036 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001037 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001038
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 When starting the GUI, the default value for 'background' will be
1040 "light". When the value is not set in the .gvimrc, and Vim detects
1041 that the background is actually quite dark, 'background' is set to
1042 "dark". But this happens only AFTER the .gvimrc file has been read
1043 (because the window needs to be opened to find the actual background
1044 color). To get around this, force the GUI window to be opened by
1045 putting a ":gui" command in the .gvimrc file, before where the value
1046 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001048 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001049 For other systems "dark" is used when 'term' is "linux",
1050 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1051 background. Otherwise the default is "light".
1052
Bram Moolenaarc572da52017-08-27 16:52:01 +02001053 The |:terminal| command and the |term_start()| function use the
1054 'background' value to decide whether the terminal window will start
1055 with a white or black background.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 Normally this option would be set in the .vimrc file. Possibly
1058 depending on the terminal name. Example: >
1059 :if &term == "pcterm"
1060 : set background=dark
1061 :endif
1062< When this option is set, the default settings for the highlight groups
1063 will change. To use other settings, place ":highlight" commands AFTER
1064 the setting of the 'background' option.
1065 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1066 to select the colors for syntax highlighting. After changing this
1067 option, you must load syntax.vim again to see the result. This can be
1068 done with ":syntax on".
1069
1070 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001071'backspace' 'bs' string (default "", set to "indent,eol,start"
1072 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1075 mode. This is a list of items, separated by commas. Each item allows
1076 a way to backspace over something:
1077 value effect ~
1078 indent allow backspacing over autoindent
1079 eol allow backspacing over line breaks (join lines)
1080 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1081 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001082 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1083 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar46eea442022-03-30 10:51:39 +01001085 When the value is empty, Vi compatible backspacing is used, none of
1086 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
1088 For backwards compatibility with version 5.4 and earlier:
1089 value effect ~
1090 0 same as ":set backspace=" (Vi compatible)
1091 1 same as ":set backspace=indent,eol"
1092 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001093 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
1095 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1096 NOTE: This option is set to "" when 'compatible' is set.
1097
1098 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1099'backup' 'bk' boolean (default off)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 Make a backup before overwriting a file. Leave it around after the
1102 file has been successfully written. If you do not want to keep the
1103 backup file, but you do want a backup while the file is being
1104 written, reset this option and set the 'writebackup' option (this is
1105 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001106 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 |backup-table| for more explanations.
1108 When the 'backupskip' pattern matches, a backup is not made anyway.
1109 When 'patchmode' is set, the backup may be renamed to become the
1110 oldest version of a file.
1111 NOTE: This option is reset when 'compatible' is set.
1112
1113 *'backupcopy'* *'bkc'*
1114'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001115 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001117 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119 The main values are:
1120 "yes" make a copy of the file and overwrite the original one
1121 "no" rename the file and write a new one
1122 "auto" one of the previous, what works best
1123
1124 Extra values that can be combined with the ones above are:
1125 "breaksymlink" always break symlinks when writing
1126 "breakhardlink" always break hardlinks when writing
1127
1128 Making a copy and overwriting the original file:
1129 - Takes extra time to copy the file.
1130 + When the file has special attributes, is a (hard/symbolic) link or
1131 has a resource fork, all this is preserved.
1132 - When the file is a link the backup will have the name of the link,
1133 not of the real file.
1134
1135 Renaming the file and writing a new one:
1136 + It's fast.
1137 - Sometimes not all attributes of the file can be copied to the new
1138 file.
1139 - When the file is a link the new file will not be a link.
1140
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 The "auto" value is the middle way: When Vim sees that renaming the
1142 file is possible without side effects (the attributes can be passed on
1143 and the file is not a link) that is used. When problems are expected,
1144 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145
1146 The "breaksymlink" and "breakhardlink" values can be used in
1147 combination with any of "yes", "no" and "auto". When included, they
1148 force Vim to always break either symbolic or hard links by doing
1149 exactly what the "no" option does, renaming the original file to
1150 become the backup and writing a new file in its place. This can be
1151 useful for example in source trees where all the files are symbolic or
1152 hard links and any changes should stay in the local source tree, not
1153 be propagated back to the original source.
1154 *crontab*
1155 One situation where "no" and "auto" will cause problems: A program
1156 that opens a file, invokes Vim to edit that file, and then tests if
1157 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001158 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 example.
1160
1161 When a copy is made, the original file is truncated and then filled
1162 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001163 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001164 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 group of the backup is set to the group of the original file. If this
1166 fails, the protection bits for the group are made the same as for
1167 others.
1168
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001169 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 the same attributes of the original file, and the newly written file
1171 is owned by the current user. When the file was a (hard/symbolic)
1172 link, the new file will not! That's why the "auto" value doesn't
1173 rename when the file is a link. The owner and group of the newly
1174 written file will be set to the same ones as the original file, but
1175 the system may refuse to do this. In that case the "auto" value will
1176 again not rename the file.
1177
Bram Moolenaar036986f2017-03-16 17:41:02 +01001178 NOTE: This option is set to the Vi default value when 'compatible' is
1179 set and to the Vim default value when 'compatible' is reset.
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 *'backupdir'* *'bdir'*
1182'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001183 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 for Unix: ".,~/tmp,~/")
1185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 List of directories for the backup file, separated with commas.
1187 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001188 where this is possible. The directory must exist, Vim will not
1189 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001190 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 impossible!). Writing may fail because of this.
1192 - A directory "." means to put the backup file in the same directory
1193 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001194 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1195 the backup file relative to where the edited file is. The leading
1196 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 ("." inside a directory name has no special meaning).
1198 - Spaces after the comma are ignored, other spaces are considered part
1199 of the directory name. To have a space at the start of a directory
1200 name, precede it with a backslash.
1201 - To include a comma in a directory name precede it with a backslash.
1202 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001203 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001204 the backup file name will be built from the complete path to the
1205 file with all path separators changed to percent '%' signs. This
1206 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001207 On Win32, it is also possible to end with "\\". However, When a
1208 separating comma is following, you must use "//", since "\\" will
1209 include the comma in the file name. Therefore it is recommended to
1210 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 - Environment variables are expanded |:set_env|.
1212 - Careful with '\' characters, type one before a space, type two to
1213 get one in the option (see |option-backslash|), for example: >
1214 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1215< - For backwards compatibility with Vim version 3.0 a '>' at the start
1216 of the option is removed.
1217 See also 'backup' and 'writebackup' options.
1218 If you want to hide your backup files on Unix, consider this value: >
1219 :set backupdir=./.backup,~/.backup,.,/tmp
1220< You must create a ".backup" directory in each directory and in your
1221 home directory for this to work properly.
1222 The use of |:set+=| and |:set-=| is preferred when adding or removing
1223 directories from the list. This avoids problems when a future version
1224 uses another default.
1225 This option cannot be set from a |modeline| or in the |sandbox|, for
1226 security reasons.
1227
1228 *'backupext'* *'bex'* *E589*
1229'backupext' 'bex' string (default "~", for VMS: "_")
1230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 String which is appended to a file name to make the name of the
1232 backup file. The default is quite unusual, because this avoids
1233 accidentally overwriting existing files with a backup file. You might
1234 prefer using ".bak", but make sure that you don't have files with
1235 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001236 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001238 If you like to keep a lot of backups, you could use a BufWritePre
1239 autocommand to change 'backupext' just before writing the file to
1240 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001241 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001242< Use 'backupdir' to put the backup in a different directory.
1243
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001245'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1246 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1247 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 A list of file patterns. When one of the patterns matches with the
1250 name of the file which is written, no backup file is created. Both
1251 the specified file name and the full path name of the file are used.
1252 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1253 Watch out for special characters, see |option-backslash|.
1254 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001255 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001256
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001257 WARNING: Not having a backup file means that when Vim fails to write
1258 your buffer correctly and then, for whatever reason, Vim exits, you
1259 lose both the original file and what you were writing. Only disable
1260 backups if you don't care about losing the file.
1261
Bram Moolenaar02467872007-05-06 13:22:01 +00001262 Note that environment variables are not expanded. If you want to use
1263 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001264 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001265
1266< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001267 backup would be made by renaming the original file crontab won't see
1268 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269
1270 *'balloondelay'* *'bdlay'*
1271'balloondelay' 'bdlay' number (default: 600)
1272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 {only available when compiled with the |+balloon_eval|
1274 feature}
1275 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1276
1277 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1278'ballooneval' 'beval' boolean (default off)
1279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001281 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001282 Switch on the |balloon-eval| functionality for the GUI.
1283
1284 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1285 *'nobevalterm'*
1286'balloonevalterm' 'bevalterm' boolean (default off)
1287 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001288 {only available when compiled with the
1289 |+balloon_eval_term| feature}
1290 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001292 *'balloonexpr'* *'bexpr'*
1293'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001294 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001295 {only available when compiled with the |+balloon_eval|
1296 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001297 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001298 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1299 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001300
1301 v:beval_bufnr number of the buffer in which balloon is going to show
1302 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001303 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001304 v:beval_lnum line number
1305 v:beval_col column number (byte index)
1306 v:beval_text word under or after the mouse pointer
1307
Bram Moolenaar54775062019-07-31 21:07:14 +02001308 Instead of showing a balloon, which is limited to plain text, consider
1309 using a popup window, see |popup_beval_example|. A popup window can
1310 use highlighting and show a border.
1311
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001312 The evaluation of the expression must not have side effects!
1313 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001314 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001315 return 'Cursor is at line ' .. v:beval_lnum ..
1316 \ ', column ' .. v:beval_col ..
1317 \ ' of file ' .. bufname(v:beval_bufnr) ..
1318 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001319 endfunction
1320 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001321 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001322<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001323 Also see |balloon_show()|, it can be used if the content of the balloon
1324 is to be fetched asynchronously. In that case evaluating
1325 'balloonexpr' should result in an empty string. If you get a balloon
1326 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001327
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001328 NOTE: The balloon is displayed only if the cursor is on a text
1329 character. If the result of evaluating 'balloonexpr' is not empty,
1330 Vim does not try to send a message to an external debugger (Netbeans
1331 or Sun Workshop).
1332
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001333 If the expression starts with s: or |<SID>|, then it is replaced with
1334 the script ID (|local-function|). Example: >
1335 set bexpr=s:MyBalloonExpr()
1336 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001337< Otherwise, the expression is evaluated in the context of the script
1338 where the option was set, thus script-local items are available.
1339
Bram Moolenaar30b65812012-07-12 22:01:11 +02001340 The expression will be evaluated in the |sandbox| when set from a
1341 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001342 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001343
1344 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001345 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001346
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001347 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001348 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001349< When they are supported "\n" characters will start a new line. If the
1350 expression evaluates to a |List| this is equal to using each List item
1351 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001352 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001353
Bram Moolenaar165bc692015-07-21 17:53:25 +02001354 *'belloff'* *'bo'*
1355'belloff' 'bo' string (default "")
1356 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001357 Specifies for which events the bell will not be rung. It is a comma
1358 separated list of items. For each item that is present, the bell
1359 will be silenced. This is most useful to specify specific events in
1360 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001361 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001362
1363 item meaning when present ~
1364 all All events.
1365 backspace When hitting <BS> or <Del> and deleting results in an
1366 error.
1367 cursor Fail to move around using the cursor keys or
1368 <PageUp>/<PageDown> in |Insert-mode|.
1369 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1370 |i_CTRL-X_CTRL-T|.
1371 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1372 |i_CTRL-E|.
1373 ctrlg Unknown Char after <C-G> in Insert mode.
1374 error Other Error occurred (e.g. try to join last line)
1375 (mostly used in |Normal-mode| or |Cmdline-mode|).
1376 esc hitting <Esc> in |Normal-mode|.
1377 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001378 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001379 insertmode Pressing <Esc> in 'insertmode'.
1380 lang Calling the beep module for Lua/Mzscheme/TCL.
1381 mess No output available for |g<|.
1382 showmatch Error occurred for 'showmatch' function.
1383 operator Empty region error |cpo-E|.
1384 register Unknown register after <C-R> in |Insert-mode|.
1385 shell Bell from shell output |:!|.
1386 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001387 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001388 wildmode More matches in |cmdline-completion| available
1389 (depends on the 'wildmode' setting).
1390
Bram Moolenaar036986f2017-03-16 17:41:02 +01001391 This is most useful to fine tune when in Insert mode the bell should
1392 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001393 indicate that an error occurred. It can be silenced by adding the
1394 "error" keyword.
1395
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1397'binary' 'bin' boolean (default off)
1398 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 This option should be set before editing a binary file. You can also
1400 use the |-b| Vim argument. When this option is switched on a few
1401 options will be changed (also when it already was on):
1402 'textwidth' will be set to 0
1403 'wrapmargin' will be set to 0
1404 'modeline' will be off
1405 'expandtab' will be off
1406 Also, 'fileformat' and 'fileformats' options will not be used, the
1407 file is read and written like 'fileformat' was "unix" (a single <NL>
1408 separates lines).
1409 The 'fileencoding' and 'fileencodings' options will not be used, the
1410 file is read without conversion.
1411 NOTE: When you start editing a(nother) file while the 'bin' option is
1412 on, settings from autocommands may change the settings again (e.g.,
1413 'textwidth'), causing trouble when editing. You might want to set
1414 'bin' again when the file has been loaded.
1415 The previous values of these options are remembered and restored when
1416 'bin' is switched from on to off. Each buffer has its own set of
1417 saved option values.
1418 To edit a file with 'binary' set you can use the |++bin| argument.
1419 This avoids you have to do ":set bin", which would have effect for all
1420 files you edit.
1421 When writing a file the <EOL> for the last line is only written if
1422 there was one in the original file (normally Vim appends an <EOL> to
1423 the last line if there is none; this would make the file longer). See
1424 the 'endofline' option.
1425
1426 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1427'bioskey' 'biosk' boolean (default on)
1428 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001429 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001430 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431
1432 *'bomb'* *'nobomb'*
1433'bomb' boolean (default off)
1434 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 When writing a file and the following conditions are met, a BOM (Byte
1436 Order Mark) is prepended to the file:
1437 - this option is on
1438 - the 'binary' option is off
1439 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1440 endian variants.
1441 Some applications use the BOM to recognize the encoding of the file.
1442 Often used for UCS-2 files on MS-Windows. For other applications it
1443 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001444 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1446 check for the presence of the BOM is done and 'bomb' set accordingly.
1447 Unless 'binary' is set, it is removed from the first line, so that you
1448 don't see it when editing. When you don't change the options, the BOM
1449 will be restored when writing the file.
1450
1451 *'breakat'* *'brk'*
1452'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1453 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001454 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 feature}
1456 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001457 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1458 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001460 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001461'breakindent' 'bri' boolean (default off)
1462 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463 {not available when compiled without the |+linebreak|
1464 feature}
1465 Every wrapped line will continue visually indented (same amount of
1466 space as the beginning of that line), thus preserving horizontal blocks
1467 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001468 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001469
1470 *'breakindentopt'* *'briopt'*
1471'breakindentopt' 'briopt' string (default empty)
1472 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001473 {not available when compiled without the |+linebreak|
1474 feature}
1475 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001476 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001477 min:{n} Minimum text width that will be kept after
1478 applying 'breakindent', even if the resulting
1479 text should normally be narrower. This prevents
1480 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001481 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001482 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001483 shift:{n} After applying 'breakindent', the wrapped line's
1484 beginning will be shifted by the given number of
1485 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001486 indentation (negative) or emphasizing the line
1487 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001488 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001489 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001490 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001491 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001492 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001493 numbered or bulleted list (using the
1494 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001495 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001496 list:-1 Uses the width of a match with 'formatlistpat' for
1497 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001498 column:{n} Indent at column {n}. Will overrule the other
1499 sub-options. Note: an additional indent may be
1500 added for the 'showbreak' setting.
1501 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001502
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001504'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001506 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001508 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001509 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 buffer Use the directory of the related buffer.
1511 current Use the current directory.
1512 {path} Use the specified directory
1513
1514 *'bufhidden'* *'bh'*
1515'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001516 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 This option specifies what happens when a buffer is no longer
1518 displayed in a window:
1519 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001520 hide hide the buffer (don't unload it), even if 'hidden' is
1521 not set
1522 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001523 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001524 delete delete the buffer from the buffer list, even if
1525 'hidden' is set; the |:hide| command will also delete
1526 the buffer, making it behave like |:bdelete|
1527 wipe wipe the buffer from the buffer list, even if
1528 'hidden' is set; the |:hide| command will also wipe
1529 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001531 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001532 are lost without a warning. Also, these values may break autocommands
1533 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 This option is used together with 'buftype' and 'swapfile' to specify
1535 special kinds of buffers. See |special-buffers|.
1536
1537 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1538'buflisted' 'bl' boolean (default: on)
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 When this option is set, the buffer shows up in the buffer list. If
1541 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1542 This option is reset by Vim for buffers that are only used to remember
1543 a file name or marks. Vim sets it when starting to edit a buffer.
1544 But not when moving to a buffer with ":buffer".
1545
1546 *'buftype'* *'bt'* *E382*
1547'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001548 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 The value of this option specifies the type of a buffer:
1550 <empty> normal buffer
1551 nofile buffer which is not related to a file and will not be
1552 written
1553 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001554 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001555 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001557 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 help help buffer (you are not supposed to set this
1559 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001560 terminal buffer for a |terminal| (you are not supposed to set
1561 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001562 prompt buffer where only the last line can be edited, meant
1563 to be used by a plugin, see |prompt-buffer|
1564 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001565 popup buffer used in a popup window, see |popup|.
1566 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567
1568 This option is used together with 'bufhidden' and 'swapfile' to
1569 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001570 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571
1572 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001573 One such effect is that Vim will not check the timestamp of the file,
1574 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575
Bram Moolenaar280f1262006-01-30 00:14:18 +00001576 A "quickfix" buffer is only used for the error list and the location
1577 list. This value is set by the |:cwindow| and |:lwindow| commands and
1578 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579
1580 "nofile" and "nowrite" buffers are similar:
1581 both: The buffer is not to be written to disk, ":w" doesn't
1582 work (":w filename" does work though).
1583 both: The buffer is never considered to be |'modified'|.
1584 There is no warning when the changes will be lost, for
1585 example when you quit Vim.
1586 both: A swap file is only created when using too much memory
1587 (when 'swapfile' has been reset there is never a swap
1588 file).
1589 nofile only: The buffer name is fixed, it is not handled like a
1590 file name. It is not modified in response to a |:cd|
1591 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001592 both: When using ":e bufname" and already editing "bufname"
1593 the buffer is made empty and autocommands are
1594 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001595 *E676*
1596 "acwrite" implies that the buffer name is not related to a file, like
1597 "nofile", but it will be written. Thus, in contrast to "nofile" and
1598 "nowrite", ":w" does work and a modified buffer can't be abandoned
1599 without saving. For writing there must be matching |BufWriteCmd|,
1600 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
1602 *'casemap'* *'cmp'*
1603'casemap' 'cmp' string (default: "internal,keepascii")
1604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 Specifies details about changing the case of letters. It may contain
1606 these words, separated by a comma:
1607 internal Use internal case mapping functions, the current
1608 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001609 matters when 'encoding' is a Unicode encoding,
1610 "latin1" or "iso-8859-15". When "internal" is
1611 omitted, the towupper() and towlower() system library
1612 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1614 case mapping, the current locale is not effective.
1615 This probably only matters for Turkish.
1616
Bram Moolenaar938ae282023-02-20 20:44:55 +00001617 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001618'cdhome' 'cdh' boolean (default: off)
1619 global
1620 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1621 current working directory to the |$HOME| directory like in Unix.
1622 When off, those commands just print the current directory name.
1623 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001624 This option cannot be set from a |modeline| or in the |sandbox|, for
1625 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001626 NOTE: This option is reset when 'compatible' is set.
1627
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 *'cdpath'* *'cd'* *E344* *E346*
1629'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001632 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1633 searched for has a relative path, not an absolute part starting with
1634 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 The 'cdpath' option's value has the same form and semantics as
1636 |'path'|. Also see |file-searching|.
1637 The default value is taken from $CDPATH, with a "," prepended to look
1638 in the current directory first.
1639 If the default value taken from $CDPATH is not what you want, include
1640 a modified version of the following command in your vimrc file to
1641 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001642 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643< This option cannot be set from a |modeline| or in the |sandbox|, for
1644 security reasons.
1645 (parts of 'cdpath' can be passed to the shell to expand file names).
1646
1647 *'cedit'*
1648'cedit' string (Vi default: "", Vim default: CTRL-F)
1649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 The key used in Command-line Mode to open the command-line window.
1651 The default is CTRL-F when 'compatible' is off.
1652 Only non-printable keys are allowed.
1653 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001654 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1655 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1656 :set cedit=^Y
1657 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658< |Nvi| also has this option, but it only uses the first character.
1659 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001660 NOTE: This option is set to the Vim default value when 'compatible'
1661 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662
1663 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1664'charconvert' 'ccv' string (default "")
1665 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001666 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 An expression that is used for character encoding conversion. It is
1668 evaluated when a file that is to be read or has been written has a
1669 different encoding from what is desired.
1670 'charconvert' is not used when the internal iconv() function is
1671 supported and is able to do the conversion. Using iconv() is
1672 preferred, because it is much faster.
1673 'charconvert' is not used when reading stdin |--|, because there is no
1674 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001675 The expression must return zero, false or an empty string for success,
1676 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 The possible encoding names encountered are in 'encoding'.
1678 Additionally, names given in 'fileencodings' and 'fileencoding' are
1679 used.
1680 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1681 is done internally by Vim, 'charconvert' is not used for this.
1682 'charconvert' is also used to convert the viminfo file, if the 'c'
1683 flag is present in 'viminfo'. Also used for Unicode conversion.
1684 Example: >
1685 set charconvert=CharConvert()
1686 fun CharConvert()
1687 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001688 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1689 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 return v:shell_error
1691 endfun
1692< The related Vim variables are:
1693 v:charconvert_from name of the current encoding
1694 v:charconvert_to name of the desired encoding
1695 v:fname_in name of the input file
1696 v:fname_out name of the output file
1697 Note that v:fname_in and v:fname_out will never be the same.
1698 Note that v:charconvert_from and v:charconvert_to may be different
1699 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001700
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001701 The advantage of using a function call without arguments is that it is
1702 faster, see |expr-option-function|.
1703
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 Encryption is not done by Vim when using 'charconvert'. If you want
1705 to encrypt the file after conversion, 'charconvert' should take care
1706 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001707
1708 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1709 replaced with the script ID (|local-function|). Example: >
1710 set charconvert=s:MyConvert()
1711 set charconvert=<SID>SomeConvert()
1712< Otherwise the expression is evaluated in the context of the script
1713 where the option was set, thus script-local items are available.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 This option cannot be set from a |modeline| or in the |sandbox|, for
1716 security reasons.
1717
1718 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1719'cindent' 'cin' boolean (default off)
1720 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001721 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 that trigger reindenting in insert mode and 'cinoptions' to set your
1723 preferred indent style.
1724 If 'indentexpr' is not empty, it overrules 'cindent'.
1725 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1726 the "=" operator indents using this algorithm rather than calling an
1727 external program.
1728 See |C-indenting|.
1729 When you don't like the way 'cindent' works, try the 'smartindent'
1730 option or 'indentexpr'.
1731 This option is not used when 'paste' is set.
1732 NOTE: This option is reset when 'compatible' is set.
1733
1734 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001735'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 A list of keys that, when typed in Insert mode, cause reindenting of
1738 the current line. Only used if 'cindent' is on and 'indentexpr' is
1739 empty.
1740 For the format of this option see |cinkeys-format|.
1741 See |C-indenting|.
1742
1743 *'cinoptions'* *'cino'*
1744'cinoptions' 'cino' string (default "")
1745 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1747 program. See |cinoptions-values| for the values of this option, and
1748 |C-indenting| for info on C indenting in general.
1749
laburnumT3f7855a2023-12-05 18:37:03 +01001750 *'cinscopedecls'* *'cinsd'*
1751'cinscopedecls' 'cinsd' string (default "public,protected,private")
1752 local to buffer
1753 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1754 Useful e.g. for working with the Qt framework that defines additional
1755 scope declarations "signals", "public slots" and "private slots": >
1756 set cinscopedecls+=signals,public\ slots,private\ slots
1757<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 *'cinwords'* *'cinw'*
1759'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 These keywords start an extra indent in the next line when
1762 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1763 an appropriate place (inside {}).
1764 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1765 matter, include the keyword both the uppercase and lowercase:
1766 "if,If,IF".
1767
laburnumT3f7855a2023-12-05 18:37:03 +01001768 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1770 for X-windows, "" otherwise)
1771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 {only in GUI versions or when the |+xterm_clipboard|
1773 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001774 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001775 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001776 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 prepend, e.g.: >
1778 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001779< When using the GUI see |'go-A'|.
1780 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001782 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 unnamed When included, Vim will use the clipboard register '*'
1784 for all yank, delete, change and put operations which
1785 would normally go to the unnamed register. When a
1786 register is explicitly specified, it will always be
1787 used regardless of whether "unnamed" is in 'clipboard'
1788 or not. The clipboard register can always be
1789 explicitly accessed using the "* notation. Also see
1790 |gui-clipboard|.
1791
Bram Moolenaar30b65812012-07-12 22:01:11 +02001792 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001793 unnamedplus A variant of the "unnamed" flag which uses the
1794 clipboard register '+' (|quoteplus|) instead of
1795 register '*' for all yank, delete, change and put
1796 operations which would normally go to the unnamed
1797 register. When "unnamed" is also included to the
1798 option, yank operations (but not delete, change or
1799 put) will additionally copy the text into register
1800 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001801 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001802 Availability can be checked with: >
1803 if has('unnamedplus')
1804<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001805 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 autoselect Works like the 'a' flag in 'guioptions': If present,
1807 then whenever Visual mode is started, or the Visual
1808 area extended, Vim tries to become the owner of the
1809 windowing system's global selection or put the
1810 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001811 register "*. See |'go-a'| and |quotestar| for details.
1812 When the GUI is active, the 'a' flag in 'guioptions'
1813 is used, when the GUI is not active, this "autoselect"
1814 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 Also applies to the modeless selection.
1816
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001817 *clipboard-autoselectplus*
1818 autoselectplus Like "autoselect" but using the + register instead of
1819 the * register. Compare to the 'P' flag in
1820 'guioptions'.
1821
1822 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 autoselectml Like "autoselect", but for the modeless selection
1824 only. Compare to the 'A' flag in 'guioptions'.
1825
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001826 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001827 html When the clipboard contains HTML, use this when
1828 pasting. When putting text on the clipboard, mark it
1829 as HTML. This works to copy rendered HTML from
1830 Firefox, paste it as raw HTML in Vim, select the HTML
1831 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001832 You probably want to add this only temporarily,
1833 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001834 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001835
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001836 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 exclude:{pattern}
1838 Defines a pattern that is matched against the name of
1839 the terminal 'term'. If there is a match, no
1840 connection will be made to the X server. This is
1841 useful in this situation:
1842 - Running Vim in a console.
1843 - $DISPLAY is set to start applications on another
1844 display.
1845 - You do not want to connect to the X server in the
1846 console, but do want this in a terminal emulator.
1847 To never connect to the X server use: >
1848 exclude:.*
1849< This has the same effect as using the |-X| argument.
1850 Note that when there is no connection to the X server
1851 the window title won't be restored and the clipboard
1852 cannot be accessed.
1853 The value of 'magic' is ignored, {pattern} is
1854 interpreted as if 'magic' was on.
1855 The rest of the option value will be used for
1856 {pattern}, this must be the last entry.
1857
1858 *'cmdheight'* *'ch'*
1859'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001860 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001861 Number of screen lines to use for the command-line. A larger value
1862 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001863 The value of this option is stored with the tab page, so that each tab
1864 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
1866 *'cmdwinheight'* *'cwh'*
1867'cmdwinheight' 'cwh' number (default 7)
1868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 Number of screen lines to use for the command-line window. |cmdwin|
1870
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001871 *'colorcolumn'* *'cc'*
1872'colorcolumn' 'cc' string (default "")
1873 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001874 {not available when compiled without the |+syntax|
1875 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001876 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001877 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1878 text. Will make screen redrawing slower.
1879 The screen column can be an absolute number, or a number preceded with
1880 '+' or '-', which is added to or subtracted from 'textwidth'. >
1881
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001882 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001883 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1884 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1885<
1886 When 'textwidth' is zero then the items with '-' and '+' are not used.
1887 A maximum of 256 columns are highlighted.
1888
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 *'columns'* *'co'* *E594*
1890'columns' 'co' number (default 80 or terminal width)
1891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001893 initialization and does not have to be set by hand. Also see
1894 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 When Vim is running in the GUI or in a resizable window, setting this
1896 option will cause the window size to be changed. When you only want
1897 to use the size for the GUI, put the command in your |gvimrc| file.
1898 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001899 number of columns of the display, the display may be messed up. For
1900 the GUI it is always possible and Vim limits the number of columns to
1901 what fits on the screen. You can use this command to get the widest
1902 window possible: >
1903 :set columns=9999
1904< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905
1906 *'comments'* *'com'* *E524* *E525*
1907'comments' 'com' string (default
1908 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1909 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001910 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 |format-comments|. See |option-backslash| about using backslashes to
1912 insert a space.
1913
1914 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001915'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 {not available when compiled without the |+folding|
1918 feature}
1919 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001920 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001921 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001922 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923
1924 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001925'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001926 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 This option has the effect of making Vim either more Vi-compatible, or
1929 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001930
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932 other options are also changed as a side effect.
1933 NOTE: Setting or resetting this option can have a lot of unexpected
1934 effects: Mappings are interpreted in another way, undo behaves
1935 differently, etc. If you set this option in your vimrc file, you
1936 should probably put it at the very start.
1937
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 By default this option is on and the Vi defaults are used for the
1939 options. This default was chosen for those people who want to use Vim
1940 just like Vi, and don't even (want to) know about the 'compatible'
1941 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001942 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001943 this option is switched off, and all options that have not been
1944 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001945 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001946 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001947 happen for the system-wide vimrc or gvimrc file, nor for a file given
1948 with the |-u| argument). Also see |compatible-default| and
1949 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 You can also set this option with the "-C" argument, and reset it with
1951 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001952 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 When this option is set, numerous other options are set to make Vim as
1955 Vi-compatible as possible. When this option is unset, various options
1956 are set to make Vim more useful. The table below lists all the
1957 options affected.
1958 The {?} column indicates when the options are affected:
1959 + Means that the option is set to the value given in {set value} when
1960 'compatible' is set.
1961 & Means that the option is set to the value given in {set value} when
1962 'compatible' is set AND is set to its Vim default value when
1963 'compatible' is unset.
1964 - Means the option is NOT changed when setting 'compatible' but IS
1965 set to its Vim default when 'compatible' is unset.
1966 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967
Bram Moolenaar036986f2017-03-16 17:41:02 +01001968 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969
1970 'allowrevins' + off no CTRL-_ command
1971 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001972 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001973 'arabicshape' + on correct character shapes
1974 'backspace' + "" normal backspace
1975 'backup' + off no backup file
1976 'backupcopy' & Unix: "yes" backup file is a copy
1977 else: "auto" copy or rename backup file
1978 'balloonexpr' + "" text to show in evaluation balloon
1979 'breakindent' + off don't indent when wrapping lines
1980 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001981 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001982 'cindent' + off no C code indentation
1983 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1984 'copyindent' + off don't copy indent structure
1985 'cpoptions' & (all flags) Vi-compatible flags
1986 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001987 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001988 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001989 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopeverbose' + off see |cscopeverbose|
1991 'delcombine' + off unicode: delete whole char combination
1992 'digraph' + off no digraphs
1993 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001994 this also disables |modifyOtherKeys|
1995 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001996 'expandtab' + off tabs not expanded to spaces
1997 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001998 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001999 'formatexpr' + "" use 'formatprg' for auto-formatting
2000 'formatoptions' & "vt" Vi compatible formatting
2001 'gdefault' + off no default 'g' flag for ":s"
2002 'history' & 0 no commandline history
2003 'hkmap' + off no Hebrew keyboard mapping
2004 'hkmapp' + off no phonetic Hebrew keyboard mapping
2005 'hlsearch' + off no highlighting of search matches
2006 'incsearch' + off no incremental searching
2007 'indentexpr' + "" no indenting by expression
2008 'insertmode' + off do not start in Insert mode
2009 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002011 'joinspaces' + on insert 2 spaces after period
2012 'modeline' & off no modelines
2013 'more' & off no pauses in listings
2014 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2015 'numberwidth' & 8 min number of columns for line number
2016 'preserveindent'+ off don't preserve current indent structure
2017 when changing it
2018 'revins' + off no reverse insert
2019 'ruler' + off no ruler
2020 'scrolljump' + 1 no jump scroll
2021 'scrolloff' + 0 no scroll offset
2022 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2023 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002024 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002025 'showcmd' & off command characters not shown
2026 'showmode' & off current mode not shown
2027 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2028 'smartcase' + off no automatic ignore case switch
2029 'smartindent' + off no smart indentation
2030 'smarttab' + off no smart tab size
2031 'softtabstop' + 0 tabs are always 'tabstop' positions
2032 'startofline' + on goto startofline with some commands
2033 'tagcase' & "followic" 'ignorecase' when searching tags file
2034 'tagrelative' & off tag file names are not relative
2035 'termguicolors' + off don't use highlight-(guifg|guibg)
2036 'textauto' & off no automatic textmode detection
2037 'textwidth' + 0 no automatic line wrap
2038 'tildeop' + off tilde is not an operator
2039 'ttimeout' + off no terminal timeout
2040 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002041 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002042 'virtualedit' + "" cursor can only be placed on characters
2043 'whichwrap' & "" left-right movements don't wrap
2044 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002046 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047
2048 *'complete'* *'cpt'* *E535*
2049'complete' 'cpt' string (default: ".,w,b,u,t,i")
2050 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 This option specifies how keyword completion |ins-completion| works
2052 when CTRL-P or CTRL-N are used. It is also used for whole-line
2053 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002054 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002055 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 w scan buffers from other windows
2057 b scan other loaded buffers that are in the buffer list
2058 u scan the unloaded buffers that are in the buffer list
2059 U scan the buffers that are not in the buffer list
2060 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002061 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 k{dict} scan the file {dict}. Several "k" flags can be given,
2063 patterns are valid too. For example: >
2064 :set cpt=k/usr/dict/*,k~/spanish
2065< s scan the files given with the 'thesaurus' option
2066 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2067 are valid too.
2068 i scan current and included files
2069 d scan current and included files for defined name or macro
2070 |i_CTRL-X_CTRL-D|
2071 ] tag completion
2072 t same as "]"
2073
2074 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2075 not executed, this may lead to unexpected completions from some files
2076 (gzipped files for example). Unloaded buffers are not scanned for
2077 whole-line completion.
2078
2079 The default is ".,w,b,u,t,i", which means to scan:
2080 1. the current buffer
2081 2. buffers in other windows
2082 3. other loaded buffers
2083 4. unloaded buffers
2084 5. tags
2085 6. included files
2086
2087 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002088 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2089 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002091 *'completefunc'* *'cfu'*
2092'completefunc' 'cfu' string (default: empty)
2093 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002094 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002095 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002096 This option specifies a function to be used for Insert mode completion
2097 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002098 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002099 invoked and what it should return. The value can be the name of a
2100 function, a |lambda| or a |Funcref|. See |option-value-function| for
2101 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002102 This option cannot be set from a |modeline| or in the |sandbox|, for
2103 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002104
glepnir6a89c942024-10-01 20:32:12 +02002105 *'completeitemalign'* *'cia'*
2106'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2107 global
2108 A comma-separated list of |complete-items| that controls the alignment
2109 and display order of items in the popup menu during Insert mode
2110 completion. The supported values are abbr, kind, and menu. These
2111 options allow to customize how the completion items are shown in the
2112 popup menu. Note: must always contain those three values in any
2113 order.
2114
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002115 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002116'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002117 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002118 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002119 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002120
2121 menu Use a popup menu to show the possible completions. The
2122 menu is only shown when there is more than one match and
2123 sufficient colors are available. |ins-completion-menu|
2124
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002125 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002126 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002127 match, e.g., what file it comes from.
2128
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002129 longest Only insert the longest common text of the matches. If
2130 the menu is displayed you can use CTRL-L to add more
2131 characters. Whether case is ignored depends on the kind
2132 of completion. For buffer text the 'ignorecase' option is
2133 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002134
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002135 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002136 completion in the preview window. Only works in
2137 combination with "menu" or "menuone".
2138
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002139 popup Show extra information about the currently selected
2140 completion in a popup window. Only works in combination
2141 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002142 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002143 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002144
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002145 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002146 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002147 |CompleteChanged| autocommand to fetch the info and call
2148 |popup_show()| once the popup has been filled.
2149 See the example at |complete-popuphidden|.
2150 {only works when compiled with the |+textprop| feature}
2151
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002152 noinsert Do not insert any text for a match until the user selects
2153 a match from the menu. Only works in combination with
2154 "menu" or "menuone". No effect if "longest" is present.
2155
2156 noselect Do not select a match in the menu, force the user to
2157 select one from the menu. Only works in combination with
2158 "menu" or "menuone".
2159
glepnira218cc62024-06-03 19:32:39 +02002160 fuzzy Enable |fuzzy-matching| for completion candidates. This
2161 allows for more flexible and intuitive matching, where
2162 characters can be skipped and matches can be found even
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002163 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002164
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002165 *'completepopup'* *'cpp'*
2166'completepopup' 'cpp' string (default empty)
2167 global
2168 {not available when compiled without the |+textprop|
2169 or |+quickfix| feature}
2170 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002171 properties of the info popup when it is created. If an info popup
2172 window already exists it is closed, so that the option value is
2173 applied when it is created again.
2174 You can also use |popup_findinfo()| and then set properties for an
2175 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002176
laburnumT3f7855a2023-12-05 18:37:03 +01002177 *'completeslash'* *'csl'*
2178'completeslash' 'csl' string (default: "")
2179 local to buffer
2180 {only for MS-Windows}
2181 When this option is set it overrules 'shellslash' for completion:
2182 - When this option is set to "slash", a forward slash is used for path
2183 completion in insert mode. This is useful when editing HTML tag, or
2184 Makefile with 'noshellslash' on MS-Windows.
2185 - When this option is set to "backslash", backslash is used. This is
2186 useful when editing a batch file with 'shellslash' set on MS-Windows.
2187 - When this option is empty, same character is used as for
2188 'shellslash'.
2189 For Insert mode completion the buffer-local value is used. For
2190 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002191
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002192 *'concealcursor'* *'cocu'*
2193'concealcursor' 'cocu' string (default: "")
2194 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002195 {not available when compiled without the |+conceal|
2196 feature}
2197 Sets the modes in which text in the cursor line can also be concealed.
2198 When the current mode is listed then concealing happens just like in
2199 other lines.
2200 n Normal mode
2201 v Visual mode
2202 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002203 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002204
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002205 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002206 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002207 are moving around text is concealed, but when starting to insert text
2208 or selecting a Visual area the concealed text is displayed, so that
2209 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002210 Keep in mind that the cursor position is not always where it's
2211 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002212
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002213 *'conceallevel'* *'cole'*
2214'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002215 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002216 {not available when compiled without the |+conceal|
2217 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002218 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2219 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002220
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002221 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002222 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002223 1 Each block of concealed text is replaced with one
2224 character. If the syntax item does not have a custom
2225 replacement character defined (see |:syn-cchar|) the
2226 character defined in 'listchars' is used (default is a
2227 space).
2228 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002229 2 Concealed text is completely hidden unless it has a
2230 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002231 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002232 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002233
Bram Moolenaara7781e02010-07-19 20:13:22 +02002234 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002235 edit and copy the text. This can be changed with the 'concealcursor'
2236 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002237
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2239'confirm' 'cf' boolean (default off)
2240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 When 'confirm' is on, certain operations that would normally
2242 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2243 instead raise a |dialog| asking if you wish to save the current
2244 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2245 If 'confirm' is off you can still activate confirmation for one
2246 command only (this is most useful in mappings) with the |:confirm|
2247 command.
2248 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2249
2250 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2251'conskey' 'consk' boolean (default off)
2252 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002253 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254
2255 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2256'copyindent' 'ci' boolean (default off)
2257 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 Copy the structure of the existing lines indent when autoindenting a
2259 new line. Normally the new indent is reconstructed by a series of
2260 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2261 in which case only spaces are used). Enabling this option makes the
2262 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002263 existing line. 'expandtab' has no effect on these characters, a Tab
2264 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002266 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 Also see 'preserveindent'.
2268
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002269 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002270'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2271 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002272 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002275 this indicates Vi-compatible behavior. This is used for things where
2276 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 'cpoptions' stands for "compatible-options".
2278 Commas can be added for readability.
2279 To avoid problems with flags that are added in the future, use the
2280 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002281
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 NOTE: This option is set to the Vi default value when 'compatible' is
2283 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002284
2285 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2286 is saved, 'cpoptions' is set to the Vim default, and the saved value
2287 is restored at the end of the script. Changes to the value of
2288 'cpoptions' will be applied to the saved value, but keep in mind that
2289 removing a flag that is not present when 'cpoptions' is changed has no
2290 effect. In the |.vimrc| file the value is not restored, thus using
2291 `vim9script` in the |.vimrc| file results in using the Vim default.
2292
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002293 NOTE: This option is set to the POSIX default value at startup when
2294 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002295 variable exists |posix|. This means Vim tries to behave like the
2296 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297
2298 contains behavior ~
2299 *cpo-a*
2300 a When included, a ":read" command with a file name
2301 argument will set the alternate file name for the
2302 current window.
2303 *cpo-A*
2304 A When included, a ":write" command with a file name
2305 argument will set the alternate file name for the
2306 current window.
2307 *cpo-b*
2308 b "\|" in a ":map" command is recognized as the end of
2309 the map command. The '\' is included in the mapping,
2310 the text after the '|' is interpreted as the next
2311 command. Use a CTRL-V instead of a backslash to
2312 include the '|' in the mapping. Applies to all
2313 mapping, abbreviation, menu and autocmd commands.
2314 See also |map_bar|.
2315 *cpo-B*
2316 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002317 abbreviations, user commands and the "to" part of the
2318 menu commands. Remove this flag to be able to use a
2319 backslash like a CTRL-V. For example, the command
2320 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 'B' included: "\^[" (^[ is a real <Esc>)
2322 'B' excluded: "<Esc>" (5 characters)
2323 ('<' excluded in both cases)
2324 *cpo-c*
2325 c Searching continues at the end of any match at the
2326 cursor position, but not further than the start of the
2327 next line. When not present searching continues
2328 one character from the cursor position. With 'c'
2329 "abababababab" only gets three matches when repeating
2330 "/abab", without 'c' there are five matches.
2331 *cpo-C*
2332 C Do not concatenate sourced lines that start with a
2333 backslash. See |line-continuation|.
2334 *cpo-d*
2335 d Using "./" in the 'tags' option doesn't mean to use
2336 the tags file relative to the current file, but the
2337 tags file in the current directory.
2338 *cpo-D*
2339 D Can't use CTRL-K to enter a digraph after Normal mode
2340 commands with a character argument, like |r|, |f| and
2341 |t|.
2342 *cpo-e*
2343 e When executing a register with ":@r", always add a
2344 <CR> to the last line, also when the register is not
2345 linewise. If this flag is not present, the register
2346 is not linewise and the last line does not end in a
2347 <CR>, then the last line is put on the command-line
2348 and can be edited before hitting <CR>.
2349 *cpo-E*
2350 E It is an error when using "y", "d", "c", "g~", "gu" or
2351 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002352 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 This makes "y0" fail in the first column.
2354 *cpo-f*
2355 f When included, a ":read" command with a file name
2356 argument will set the file name for the current buffer,
2357 if the current buffer doesn't have a file name yet.
2358 *cpo-F*
2359 F When included, a ":write" command with a file name
2360 argument will set the file name for the current
2361 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002362 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 *cpo-g*
2364 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002365 *cpo-H*
2366 H When using "I" on a line with only blanks, insert
2367 before the last blank. Without this flag insert after
2368 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 *cpo-i*
2370 i When included, interrupting the reading of a file will
2371 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002372 *cpo-I*
2373 I When moving the cursor up or down just after inserting
2374 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 *cpo-j*
2376 j When joining lines, only add two spaces after a '.',
2377 not after '!' or '?'. Also see 'joinspaces'.
2378 *cpo-J*
2379 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002380 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 white space.
2382 *cpo-k*
2383 k Disable the recognition of raw key codes in
2384 mappings, abbreviations, and the "to" part of menu
2385 commands. For example, if <Key> sends ^[OA (where ^[
2386 is <Esc>), the command ":map X ^[OA" results in X
2387 being mapped to:
2388 'k' included: "^[OA" (3 characters)
2389 'k' excluded: "<Key>" (one key code)
2390 Also see the '<' flag below.
2391 *cpo-K*
2392 K Don't wait for a key code to complete when it is
2393 halfway a mapping. This breaks mapping <F1><F1> when
2394 only part of the second <F1> has been read. It
2395 enables cancelling the mapping by typing <F1><Esc>.
2396 *cpo-l*
2397 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002398 literally, only "\]", "\^", "\-" and "\\" are special.
2399 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2401 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002402 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 *cpo-L*
2404 L When the 'list' option is set, 'wrapmargin',
2405 'textwidth', 'softtabstop' and Virtual Replace mode
2406 (see |gR|) count a <Tab> as two characters, instead of
2407 the normal behavior of a <Tab>.
2408 *cpo-m*
2409 m When included, a showmatch will always wait half a
2410 second. When not included, a showmatch will wait half
2411 a second or until a character is typed. |'showmatch'|
2412 *cpo-M*
2413 M When excluded, "%" matching will take backslashes into
2414 account. Thus in "( \( )" and "\( ( \)" the outer
2415 parenthesis match. When included "%" ignores
2416 backslashes, which is Vi compatible.
2417 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002418 n When included, the column used for 'number' and
2419 'relativenumber' will also be used for text of wrapped
2420 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421 *cpo-o*
2422 o Line offset to search command is not remembered for
2423 next search.
2424 *cpo-O*
2425 O Don't complain if a file is being overwritten, even
2426 when it didn't exist when editing it. This is a
2427 protection against a file unexpectedly created by
2428 someone else. Vi didn't complain about this.
2429 *cpo-p*
2430 p Vi compatible Lisp indenting. When not present, a
2431 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002432 *cpo-P*
2433 P When included, a ":write" command that appends to a
2434 file will set the file name for the current buffer, if
2435 the current buffer doesn't have a file name yet and
2436 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002437 *cpo-q*
2438 q When joining multiple lines leave the cursor at the
2439 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 *cpo-r*
2441 r Redo ("." command) uses "/" to repeat a search
2442 command, instead of the actually used search string.
2443 *cpo-R*
2444 R Remove marks from filtered lines. Without this flag
2445 marks are kept like |:keepmarks| was used.
2446 *cpo-s*
2447 s Set buffer options when entering the buffer for the
2448 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 set when the buffer is created.
2451 *cpo-S*
2452 S Set buffer options always when entering a buffer
2453 (except 'readonly', 'fileformat', 'filetype' and
2454 'syntax'). This is the (most) Vi compatible setting.
2455 The options are set to the values in the current
2456 buffer. When you change an option and go to another
2457 buffer, the value is copied. Effectively makes the
2458 buffer options global to all buffers.
2459
2460 's' 'S' copy buffer options
2461 no no when buffer created
2462 yes no when buffer first entered (default)
2463 X yes each time when buffer entered (vi comp.)
2464 *cpo-t*
2465 t Search pattern for the tag command is remembered for
2466 "n" command. Otherwise Vim only puts the pattern in
2467 the history for search pattern, but doesn't change the
2468 last used search pattern.
2469 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002470 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 *cpo-v*
2472 v Backspaced characters remain visible on the screen in
2473 Insert mode. Without this flag the characters are
2474 erased from the screen right away. With this flag the
2475 screen newly typed text overwrites backspaced
2476 characters.
2477 *cpo-w*
2478 w When using "cw" on a blank character, only change one
2479 character and not all blanks until the start of the
2480 next word.
2481 *cpo-W*
2482 W Don't overwrite a readonly file. When omitted, ":w!"
2483 overwrites a readonly file, if possible.
2484 *cpo-x*
2485 x <Esc> on the command-line executes the command-line.
2486 The default in Vim is to abandon the command-line,
2487 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002488 *cpo-X*
2489 X When using a count with "R" the replaced text is
2490 deleted only once. Also when repeating "R" with "."
2491 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002493 y A yank command can be redone with ".". Think twice if
2494 you really want to use this, it may break some
2495 plugins, since most people expect "." to only repeat a
2496 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002497 *cpo-Z*
2498 Z When using "w!" while the 'readonly' option is set,
2499 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002500 *cpo-z*
2501 z Special casing the "cw" and "d" command (see |cw| and
2502 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 *cpo-!*
2504 ! When redoing a filter command, use the last used
2505 external command, whatever it was. Otherwise the last
2506 used -filter- command is used.
2507 *cpo-$*
2508 $ When making a change to one line, don't redisplay the
2509 line, but put a '$' at the end of the changed text.
2510 The changed text will be overwritten when you type the
2511 new text. The line is redisplayed if you type any
2512 command that moves the cursor from the insertion
2513 point.
2514 *cpo-%*
2515 % Vi-compatible matching is done for the "%" command.
2516 Does not recognize "#if", "#endif", etc.
2517 Does not recognize "/*" and "*/".
2518 Parens inside single and double quotes are also
2519 counted, causing a string that contains a paren to
2520 disturb the matching. For example, in a line like
2521 "if (strcmp("foo(", s))" the first paren does not
2522 match the last one. When this flag is not included,
2523 parens inside single and double quotes are treated
2524 specially. When matching a paren outside of quotes,
2525 everything inside quotes is ignored. When matching a
2526 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002528 This flag is also used for other features, such as
2529 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002530 *cpo--*
2531 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002532 it would go above the first line or below the last
2533 line. Without it the cursor moves to the first or
2534 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002535 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002536 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002537 *cpo-+*
2538 + When included, a ":write file" command will reset the
2539 'modified' flag of the buffer, even though the buffer
2540 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002541 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 * Use ":*" in the same way as ":@". When not included,
2543 ":*" is an alias for ":'<,'>", select the Visual area.
2544 *cpo-<*
2545 < Disable the recognition of special key codes in |<>|
2546 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002547 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 ":map X <Tab>" results in X being mapped to:
2549 '<' included: "<Tab>" (5 characters)
2550 '<' excluded: "^I" (^I is a real <Tab>)
2551 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002552 *cpo->*
2553 > When appending to a register, put a line break before
2554 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002555 *cpo-;*
2556 ; When using |,| or |;| to repeat the last |t| search
2557 and the cursor is right in front of the searched
2558 character, the cursor won't move. When not included,
2559 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002560 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002561
2562 POSIX flags. These are not included in the Vi default value, except
2563 when $VIM_POSIX was set on startup. |posix|
2564
2565 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002566 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002567 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002568 *cpo-&*
2569 & When ":preserve" was used keep the swap file when
2570 exiting normally while this buffer is still loaded.
2571 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002572 *cpo-\*
2573 \ Backslash in a [] range in a search pattern is taken
2574 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002575 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2576 '\' excluded: "/[ \-]" finds <Space> and '-'
2577 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002578 *cpo-/*
2579 / When "%" is used as the replacement string in a |:s|
2580 command, use the previous replacement string. |:s%|
2581 *cpo-{*
2582 { The |{| and |}| commands also stop at a "{" character
2583 at the start of a line.
2584 *cpo-.*
2585 . The ":chdir" and ":cd" commands fail if the current
2586 buffer is modified, unless ! is used. Vim doesn't
2587 need this, since it remembers the full path of an
2588 opened file.
2589 *cpo-bar*
2590 | The value of the $LINES and $COLUMNS environment
2591 variables overrule the terminal size values obtained
2592 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002593
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002594 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002595'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002596 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002597 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002598 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002599 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002600 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002601 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002602 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002603 blowfish Blowfish method. Medium strong encryption but it has
2604 an implementation flaw. Requires Vim 7.3 or later,
2605 files can NOT be read by Vim 7.2 and older. This adds
2606 a "seed" to the file, every time you write the file
2607 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002608 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002609 *blowfish2*
2610 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002611 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002612 and older. This adds a "seed" to the file, every time
2613 you write the file the encrypted bytes will be
2614 different. The whole undo file is encrypted, not just
2615 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002616 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002617 *E1197* *E1198* *E1199* *E1200* *E1201*
2618 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2619 Code. Medium strong till strong encryption.
2620 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002621 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002622 It adds a seed and a message authentication code (MAC)
2623 to the file. This needs at least a Vim 8.2.3022 to
2624 read the encrypted file.
2625 Encryption of swap files is not supported, therefore
2626 no swap file will be used when xchacha20 encryption is
2627 enabled.
2628 Encryption of undo files is not yet supported,
2629 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002630 CAREFUL: Files written with this method might have to
2631 be read back with the same version of Vim if the
2632 binary format changes later.
2633 Obsolete, please do no longer use.
2634 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2635 stores the key derivation parameters together with the
2636 encrypted file. Should work better in case the
2637 parameters in the libsodium library ever change.
2638 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002639 might have to be read back with the same version of
2640 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002641
Christian Brabandtaae58342023-04-23 17:50:22 +01002642 You should use "blowfish2", also to re-encrypt older files. The
2643 "xchacha20" method provides better encryption, but it does not work
2644 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002645
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002646 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002647 to the detected method of the file being read. Thus if you write it
2648 without changing 'cryptmethod' the same method will be used.
2649 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002650 explicitly write it, you don't get a warning unless there are other
2651 modifications. Also see |:X|.
2652
2653 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002654 the value "blowfish2". When setting the local value to an empty
2655 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002656
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002657 When a new encryption method is added in a later version of Vim, and
2658 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002659 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002660
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 *'cscopepathcomp'* *'cspc'*
2662'cscopepathcomp' 'cspc' number (default 0)
2663 global
2664 {not available when compiled without the |+cscope|
2665 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 Determines how many components of the path to show in a list of tags.
2667 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002668 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669
2670 *'cscopeprg'* *'csprg'*
2671'cscopeprg' 'csprg' string (default "cscope")
2672 global
2673 {not available when compiled without the |+cscope|
2674 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 Specifies the command to execute cscope. See |cscopeprg|.
2676 This option cannot be set from a |modeline| or in the |sandbox|, for
2677 security reasons.
2678
2679 *'cscopequickfix'* *'csqf'*
2680'cscopequickfix' 'csqf' string (default "")
2681 global
2682 {not available when compiled without the |+cscope|
2683 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 Specifies whether to use quickfix window to show cscope results.
2685 See |cscopequickfix|.
2686
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002687 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002688'cscoperelative' 'csre' boolean (default off)
2689 global
2690 {not available when compiled without the |+cscope|
2691 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002692 In the absence of a prefix (-P) for cscope. setting this option enables
2693 to use the basename of cscope.out path as the prefix.
2694 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002695 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2698'cscopetag' 'cst' boolean (default off)
2699 global
2700 {not available when compiled without the |+cscope|
2701 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 Use cscope for tag commands. See |cscope-options|.
2703 NOTE: This option is reset when 'compatible' is set.
2704
2705 *'cscopetagorder'* *'csto'*
2706'cscopetagorder' 'csto' number (default 0)
2707 global
2708 {not available when compiled without the |+cscope|
2709 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 Determines the order in which ":cstag" performs a search. See
2711 |cscopetagorder|.
2712 NOTE: This option is set to 0 when 'compatible' is set.
2713
2714 *'cscopeverbose'* *'csverb'*
2715 *'nocscopeverbose'* *'nocsverb'*
2716'cscopeverbose' 'csverb' boolean (default off)
2717 global
2718 {not available when compiled without the |+cscope|
2719 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 Give messages when adding a cscope database. See |cscopeverbose|.
2721 NOTE: This option is reset when 'compatible' is set.
2722
Bram Moolenaar860cae12010-06-05 23:22:07 +02002723 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2724'cursorbind' 'crb' boolean (default off)
2725 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002726 When this option is set, as the cursor in the current
2727 window moves other cursorbound windows (windows that also have
2728 this option set) move their cursors to the corresponding line and
2729 column. This option is useful for viewing the
2730 differences between two versions of a file (see 'diff'); in diff mode,
2731 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002732 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002733
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002734 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2735'cursorcolumn' 'cuc' boolean (default off)
2736 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002737 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002738 feature}
2739 Highlight the screen column of the cursor with CursorColumn
2740 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2741 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002742 If you only want the highlighting in the current window you can use
2743 these autocommands: >
2744 au WinLeave * set nocursorline nocursorcolumn
2745 au WinEnter * set cursorline cursorcolumn
2746<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002747
2748 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2749'cursorline' 'cul' boolean (default off)
2750 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002751 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002752 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002753 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2754 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002755 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002756 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002757
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002758 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002759'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002760 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002761 {not available when compiled without the |+syntax|
2762 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002763 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002764 Valid values:
2765 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002766 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002767 "screenline" Highlight only the screen line of the cursor with
2768 CursorLine |hl-CursorLine|.
2769 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002770 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002771
2772 Special value:
2773 "both" Alias for the values "line,number".
2774
2775 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002776
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 *'debug'*
2778'debug' string (default "")
2779 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002780 These values can be used:
2781 msg Error messages that would otherwise be omitted will be given
2782 anyway.
2783 throw Error messages that would otherwise be omitted will be given
2784 anyway and also throw an exception and set |v:errmsg|.
2785 beep A message will be given when otherwise only a beep would be
2786 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002787 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002788 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2789 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790
2791 *'define'* *'def'*
2792'define' 'def' string (default "^\s*#\s*define")
2793 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002794 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 pattern, just like for the "/" command. This option is used for the
2796 commands like "[i" and "[d" |include-search|. The 'isident' option is
2797 used to recognize the defined name after the match:
2798 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2799 See |option-backslash| about inserting backslashes to include a space
2800 or backslash.
2801 The default value is for C programs. For C++ this value would be
2802 useful, to include const type declarations: >
2803 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002804< You can also use "\ze" just before the name and continue the pattern
2805 to check what is following. E.g. for Javascript, if a function is
2806 defined with "func_name = function(args)": >
2807 ^\s*\ze\i\+\s*=\s*function(
2808< If the function is defined with "func_name : function() {...": >
2809 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002811 To avoid that use `:let` with a single quote string: >
2812 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002813<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2816'delcombine' 'deco' boolean (default off)
2817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 If editing Unicode and this option is set, backspace and Normal mode
2819 "x" delete each combining character on its own. When it is off (the
2820 default) the character along with its combining characters are
2821 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002822 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823
2824 This is useful for Arabic, Hebrew and many other languages where one
2825 may have combining characters overtop of base characters, and want
2826 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002827 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828
2829 *'dictionary'* *'dict'*
2830'dictionary' 'dict' string (default "")
2831 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 List of file names, separated by commas, that are used to lookup words
2833 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2834 contain a list of words. This can be one word per line, or several
2835 words per line, separated by non-keyword characters (white space is
2836 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002837
2838 When this option is empty or an entry "spell" is present, and spell
2839 checking is enabled, words in the word lists for the currently active
2840 'spelllang' are used. See |spell|.
2841
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002842 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 after a comma are ignored, otherwise spaces are included in the file
2844 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002845 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 Where to find a list of words?
2847 - On FreeBSD, there is the file "/usr/share/dict/words".
2848 - In the Simtel archive, look in the "msdos/linguist" directory.
2849 - In "miscfiles" of the GNU collection.
2850 The use of |:set+=| and |:set-=| is preferred when adding or removing
2851 directories from the list. This avoids problems when a future version
2852 uses another default.
2853 Backticks cannot be used in this option for security reasons.
2854
2855 *'diff'* *'nodiff'*
2856'diff' boolean (default off)
2857 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 {not available when compiled without the |+diff|
2859 feature}
2860 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002861 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862
2863 *'dex'* *'diffexpr'*
2864'diffexpr' 'dex' string (default "")
2865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 {not available when compiled without the |+diff|
2867 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002868 Expression which is evaluated to obtain a diff file (either ed-style
2869 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 This option cannot be set from a |modeline| or in the |sandbox|, for
2871 security reasons.
2872
2873 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002874'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 {not available when compiled without the |+diff|
2877 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002878 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 All are optional. Items must be separated by a comma.
2880
2881 filler Show filler lines, to keep the text
2882 synchronized with a window that has inserted
2883 lines at the same position. Mostly useful
2884 when windows are side-by-side and 'scrollbind'
2885 is set.
2886
2887 context:{n} Use a context of {n} lines between a change
2888 and a fold that contains unchanged lines.
2889 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002890 When using zero the context is actually one,
2891 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002892 for a deleted line. Set it to a very large
2893 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 See |fold-diff|.
2895
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002896 iblank Ignore changes where lines are all blank. Adds
2897 the "-B" flag to the "diff" command if
2898 'diffexpr' is empty. Check the documentation
2899 of the "diff" command for what this does
2900 exactly.
2901 NOTE: the diff windows will get out of sync,
2902 because no differences between blank lines are
2903 taken into account.
2904
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 icase Ignore changes in case of text. "a" and "A"
2906 are considered the same. Adds the "-i" flag
2907 to the "diff" command if 'diffexpr' is empty.
2908
2909 iwhite Ignore changes in amount of white space. Adds
2910 the "-b" flag to the "diff" command if
2911 'diffexpr' is empty. Check the documentation
2912 of the "diff" command for what this does
2913 exactly. It should ignore adding trailing
2914 white space, but not leading white space.
2915
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002916 iwhiteall Ignore all white space changes. Adds
2917 the "-w" flag to the "diff" command if
2918 'diffexpr' is empty. Check the documentation
2919 of the "diff" command for what this does
2920 exactly.
2921
2922 iwhiteeol Ignore white space changes at end of line.
2923 Adds the "-Z" flag to the "diff" command if
2924 'diffexpr' is empty. Check the documentation
2925 of the "diff" command for what this does
2926 exactly.
2927
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002928 horizontal Start diff mode with horizontal splits (unless
2929 explicitly specified otherwise).
2930
2931 vertical Start diff mode with vertical splits (unless
2932 explicitly specified otherwise).
2933
Bram Moolenaarc8234772019-11-10 21:00:27 +01002934 closeoff When a window is closed where 'diff' is set
2935 and there is only one window remaining in the
2936 same tab page with 'diff' set, execute
2937 `:diffoff` in that window. This undoes a
2938 `:diffsplit` command.
2939
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002940 hiddenoff Do not use diff mode for a buffer when it
2941 becomes hidden.
2942
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002943 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2944 starting diff mode. Without this 2 is used.
2945
Bram Moolenaar4223d432021-02-10 13:18:17 +01002946 followwrap Follow the 'wrap' option and leave as it is.
2947
Bram Moolenaare828b762018-09-10 17:51:58 +02002948 internal Use the internal diff library. This is
2949 ignored when 'diffexpr' is set. *E960*
2950 When running out of memory when writing a
2951 buffer this item will be ignored for diffs
2952 involving that buffer. Set the 'verbose'
2953 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
Bram Moolenaare828b762018-09-10 17:51:58 +02002955 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002956 Use the indent heuristic for the internal
2957 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002958
zeertzjqd086b8f2024-02-25 15:42:52 +08002959 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002960 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002961 algorithms are:
2962 myers the default algorithm
2963 minimal spend extra time to generate the
2964 smallest possible diff
2965 patience patience diff algorithm
2966 histogram histogram diff algorithm
2967
2968 Examples: >
2969 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002971 :set diffopt=internal,filler,foldcolumn:3
2972 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973<
2974 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2975'digraph' 'dg' boolean (default off)
2976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 {not available when compiled without the |+digraphs|
2978 feature}
2979 Enable the entering of digraphs in Insert mode with {char1} <BS>
2980 {char2}. See |digraphs|.
2981 NOTE: This option is reset when 'compatible' is set.
2982
2983 *'directory'* *'dir'*
2984'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002985 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 for Unix: ".,~/tmp,/var/tmp,/tmp")
2987 global
2988 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002989 Recommended value: ".,~/vimswap//" - this will put the swap file next
2990 to the edited file if possible, and in your personal swap directory
2991 otherwise. Make sure "~/vimswap//" is only readable for you.
2992
2993 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 - The swap file will be created in the first directory where this is
2995 possible.
2996 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002997 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 - A directory "." means to put the swap file in the same directory as
2999 the edited file. On Unix, a dot is prepended to the file name, so
3000 it doesn't show in a directory listing. On MS-Windows the "hidden"
3001 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003002 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3003 the swap file relative to where the edited file is. The leading "."
3004 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003005 - For Unix and Win32, if a directory ends in two path separators "//",
3006 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003007 with all path separators replaced by percent '%' signs (including
3008 the colon following the drive letter on Win32). This will ensure
3009 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003010 On Win32, it is also possible to end with "\\". However, When a
3011 separating comma is following, you must use "//", since "\\" will
3012 include the comma in the file name. Therefore it is recommended to
3013 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 - Spaces after the comma are ignored, other spaces are considered part
3015 of the directory name. To have a space at the start of a directory
3016 name, precede it with a backslash.
3017 - To include a comma in a directory name precede it with a backslash.
3018 - A directory name may end in an ':' or '/'.
3019 - Environment variables are expanded |:set_env|.
3020 - Careful with '\' characters, type one before a space, type two to
3021 get one in the option (see |option-backslash|), for example: >
3022 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3023< - For backwards compatibility with Vim version 3.0 a '>' at the start
3024 of the option is removed.
3025 Using "." first in the list is recommended. This means that editing
3026 the same file twice will result in a warning. Using "/tmp" on Unix is
3027 discouraged: When the system crashes you lose the swap file.
3028 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003029 choice than "/tmp". But others on the computer may be able to see the
3030 files, and it can contain a lot of files, your swap files get lost in
3031 the crowd. That is why a "tmp" directory in your home directory is
3032 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 The use of |:set+=| and |:set-=| is preferred when adding or removing
3034 directories from the list. This avoids problems when a future version
3035 uses another default.
3036 This option cannot be set from a |modeline| or in the |sandbox|, for
3037 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038
3039 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003040'display' 'dy' string (default "", set to "truncate" in
3041 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003043 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 flags:
3045 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003046 in a window will be displayed. "@@@" is put in the
3047 last columns of the last screen line to indicate the
3048 rest of the line is not displayed.
3049 truncate Like "lastline", but "@@@" is displayed in the first
3050 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 uhex Show unprintable characters hexadecimal as <xx>
3052 instead of using ^C and ~C.
3053
Bram Moolenaard0796902016-09-16 20:02:31 +02003054 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003055 doesn't fit is replaced with "@" lines.
3056
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003057 The "@" character can be changed by setting the "lastline" item in
3058 'fillchars'. The character is highlighted with |hl-NonText|.
3059
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 *'eadirection'* *'ead'*
3061'eadirection' 'ead' string (default "both")
3062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 Tells when the 'equalalways' option applies:
3064 ver vertically, width of windows is not affected
3065 hor horizontally, height of windows is not affected
3066 both width and height of windows is affected
3067
3068 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3069'edcompatible' 'ed' boolean (default off)
3070 global
3071 Makes the 'g' and 'c' flags of the ":substitute" command to be
3072 toggled each time the flag is given. See |complex-change|. See
3073 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003074 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003075 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
Bram Moolenaar03413f42016-04-12 21:07:15 +02003077 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003078'emoji' 'emo' boolean (default: on)
3079 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003080 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003081 This excludes "text emoji" characters, which are normally displayed as
3082 single width. Unfortunately there is no good specification for this
3083 and it has been determined on trial-and-error basis. Use the
3084 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003085
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003087'encoding' 'enc' string (default for MS-Windows: "utf-8",
3088 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 Sets the character encoding used inside Vim. It applies to text in
3091 the buffers, registers, Strings in expressions, text stored in the
3092 viminfo file, etc. It sets the kind of characters which Vim can work
3093 with. See |encoding-names| for the possible values.
3094
3095 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003096 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003098 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099
Bram Moolenaar865242e2010-07-14 21:12:05 +02003100 This option cannot be set from a |modeline|. It would most likely
3101 corrupt the text.
3102
Bram Moolenaar3df01732017-02-17 22:47:16 +01003103 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3104 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 'encoding', "utf-8" is the natural choice for the environment and
3106 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 versions, and to avoid changing the encoding of newly created files
3109 without your knowledge (in case 'fileencodings' is empty).
3110
3111 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003112 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 iconv() or as specified with 'charconvert'.
3114
Bram Moolenaar207f0092020-08-30 17:20:20 +02003115 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003116 can use: >
3117 if has("multi_byte_encoding")
3118<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 Normally 'encoding' will be equal to your current locale. This will
3120 be the default if Vim recognizes your environment settings. If
3121 'encoding' is not set to the current locale, 'termencoding' must be
3122 set to convert typed and displayed text. See |encoding-table|.
3123
3124 When you set this option, it fires the |EncodingChanged| autocommand
3125 event so that you can set up fonts if necessary.
3126
3127 When the option is set, the value is converted to lowercase. Thus
3128 you can set it with uppercase values too. Underscores are translated
3129 to '-' signs.
3130 When the encoding is recognized, it is changed to the standard name.
3131 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3132 "iso-8859-2" and "utf8" becomes "utf-8".
3133
3134 Note: "latin1" is also used when the encoding could not be detected.
3135 This only works when editing files in the same encoding! When the
3136 actual character set is not latin1, make sure 'fileencoding' and
3137 'fileencodings' are empty. When conversion is needed, switch to using
3138 utf-8.
3139
3140 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3141 You don't notice this while editing, but it does matter for the
3142 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3143 setting 'encoding' to one of these values instead of utf-8 only has
3144 effect for encoding used for files when 'fileencoding' is empty.
3145
Bram Moolenaar661b1822005-07-28 22:36:45 +00003146 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3147 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003149 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003150'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003152 Indicates that a CTRL-Z character was found at the end of the file
3153 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003155 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003156 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003157 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003158
3159 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3160'endofline' 'eol' boolean (default on)
3161 local to buffer
3162 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003163 is on, or 'fixeol' option is off, no <EOL> will be written for the
3164 last line in the file. This option is automatically set or reset when
3165 starting to edit a new file, depending on whether file has an <EOL>
3166 for the last line in the file. Normally you don't have to set or
3167 reset this option.
3168 When 'binary' is off and 'fixeol' is on the value is not used when
3169 writing the file. When 'binary' is on or 'fixeol' is off it is used
3170 to remember the presence of a <EOL> for the last line in the file, so
3171 that when you write the file the situation from the original file can
3172 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003173 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174
3175 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3176'equalalways' 'ea' boolean (default on)
3177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003179 splitting or closing a window. This also happens the moment the
3180 option is switched on. When off, splitting a window will reduce the
3181 size of the current window and leave the other windows the same. When
3182 closing a window the extra lines are given to the window next to it
3183 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 When mixing vertically and horizontally split windows, a minimal size
3185 is computed and some windows may be larger if there is room. The
3186 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003187 Changing the height and width of a window can be avoided by setting
3188 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003189 If a window size is specified when creating a new window sizes are
3190 currently not equalized (it's complicated, but may be implemented in
3191 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192
3193 *'equalprg'* *'ep'*
3194'equalprg' 'ep' string (default "")
3195 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003197 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003198 or 'indentexpr'. When Vim was compiled without internal formatting,
3199 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003200 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 about including spaces and backslashes.
3202 This option cannot be set from a |modeline| or in the |sandbox|, for
3203 security reasons.
3204
3205 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3206'errorbells' 'eb' boolean (default off)
3207 global
3208 Ring the bell (beep or screen flash) for error messages. This only
3209 makes a difference for error messages, the bell will be used always
3210 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003211 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003212 screen flash or do nothing. See 'belloff' to finetune when to ring the
3213 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214
3215 *'errorfile'* *'ef'*
3216'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3217 others: "errors.err")
3218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 {not available when compiled without the |+quickfix|
3220 feature}
3221 Name of the errorfile for the QuickFix mode (see |:cf|).
3222 When the "-q" command-line argument is used, 'errorfile' is set to the
3223 following argument. See |-q|.
3224 NOT used for the ":make" command. See 'makeef' for that.
3225 Environment variables are expanded |:set_env|.
3226 See |option-backslash| about including spaces and backslashes.
3227 This option cannot be set from a |modeline| or in the |sandbox|, for
3228 security reasons.
3229
3230 *'errorformat'* *'efm'*
3231'errorformat' 'efm' string (default is very long)
3232 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 {not available when compiled without the |+quickfix|
3234 feature}
3235 Scanf-like description of the format for the lines in the error file
3236 (see |errorformat|).
3237
3238 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3239'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 Function keys that start with an <Esc> are recognized in Insert
3242 mode. When this option is off, the cursor and function keys cannot be
3243 used in Insert mode if they start with an <Esc>. The advantage of
3244 this is that the single <Esc> is recognized immediately, instead of
3245 after one second. Instead of resetting this option, you might want to
3246 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3247 when 'esckeys' is off, you can still map anything, but the cursor keys
3248 won't work by default.
3249 NOTE: This option is set to the Vi default value when 'compatible' is
3250 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003251 NOTE: when this option is off then the |modifyOtherKeys| and
3252 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3253 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254
3255 *'eventignore'* *'ei'*
3256'eventignore' 'ei' string (default "")
3257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003259 When set to "all" or when "all" is one of the items, all autocommand
3260 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003261 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 :set ei=WinEnter,WinLeave
3263<
3264 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3265'expandtab' 'et' boolean (default off)
3266 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003268 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3270 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003271 This option is reset when the 'paste' option is set and restored when
3272 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 NOTE: This option is reset when 'compatible' is set.
3274
3275 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3276'exrc' 'ex' boolean (default off)
3277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003279 directory.
3280
3281 Setting this option is a potential security leak. E.g., consider
3282 unpacking a package or fetching files from github, a .vimrc in there
3283 might be a trojan horse. BETTER NOT SET THIS OPTION!
3284 Instead, define an autocommand in your .vimrc to set options for a
3285 matching directory.
3286
3287 If you do switch this option on you should also consider setting the
3288 'secure' option (see |initialization|).
3289 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 This option cannot be set from a |modeline| or in the |sandbox|, for
3291 security reasons.
3292
3293 *'fileencoding'* *'fenc'* *E213*
3294'fileencoding' 'fenc' string (default: "")
3295 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003297
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003299 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 When 'fileencoding' is empty, the same value as 'encoding' will be
3301 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003302 No error will be given when the value is set, only when it is used,
3303 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003304 Conversion will also be done when 'encoding' and 'fileencoding' are
3305 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3306 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003308 'encoding' is "utf-8" or another Unicode encoding, conversion
3309 is most likely done in a way that the reverse conversion
3310 results in the same text. When 'encoding' is not "utf-8" some
3311 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003312
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 See 'encoding' for the possible values. Additionally, values may be
3314 specified that can be handled by the converter, see
3315 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003316
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 When reading a file 'fileencoding' will be set from 'fileencodings'.
3318 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003319 'fileencoding', use the |++enc| argument. One exception: when
3320 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003321 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003322
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3324 When the option is set, the value is converted to lowercase. Thus
3325 you can set it with uppercase values too. '_' characters are
3326 replaced with '-'. If a name is recognized from the list for
3327 'encoding', it is replaced by the standard name. For example
3328 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003329
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 When this option is set, after starting to edit a file, the 'modified'
3331 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003332
3333 Keep in mind that changing 'fenc' from a modeline happens
3334 AFTER the text has been read, thus it applies to when the file will be
3335 written. If you do set 'fenc' in a modeline, you might want to set
3336 'nomodified' to avoid not being able to ":q".
3337
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 This option can not be changed when 'modifiable' is off.
3339
3340 *'fe'*
3341 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003342 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 old short name was 'fe', which is no longer used.
3344
3345 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003346'fileencodings' 'fencs' string (default: "ucs-bom",
3347 "ucs-bom,utf-8,default,latin1" when
3348 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 This is a list of character encodings considered when starting to edit
3351 an existing file. When a file is read, Vim tries to use the first
3352 mentioned character encoding. If an error is detected, the next one
3353 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003354 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 an empty string, which means the value of 'encoding' is used.
3356 WARNING: Conversion can cause loss of information! When
3357 'encoding' is "utf-8" (or one of the other Unicode variants)
3358 conversion is most likely done in a way that the reverse
3359 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003360 "utf-8" some non-ASCII characters may be lost! You can use
3361 the |++bad| argument to specify what is done with characters
3362 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 For an empty file or a file with only ASCII characters most encodings
3364 will work and the first entry of 'fileencodings' will be used (except
3365 "ucs-bom", which requires the BOM to be present). If you prefer
3366 another encoding use an BufReadPost autocommand event to test if your
3367 preferred encoding is to be used. Example: >
3368 au BufReadPost * if search('\S', 'w') == 0 |
3369 \ set fenc=iso-2022-jp | endif
3370< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3371 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003372 When the |++enc| argument is used then the value of 'fileencodings' is
3373 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003374 Note that 'fileencodings' is not used for a new file, the global value
3375 of 'fileencoding' is used instead. You can set it with: >
3376 :setglobal fenc=iso-8859-2
3377< This means that a non-existing file may get a different encoding than
3378 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 The special value "ucs-bom" can be used to check for a Unicode BOM
3380 (Byte Order Mark) at the start of the file. It must not be preceded
3381 by "utf-8" or another Unicode encoding for this to work properly.
3382 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3383 because Vim cannot detect an error, thus the encoding is always
3384 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003385 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003386 environment. On MS-Windows this is the system encoding. Otherwise
3387 this is the default value for 'encoding'. It is useful when
3388 'encoding' is set to "utf-8" and your environment uses a non-latin1
3389 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003390 When 'encoding' is "utf-8" and a file contains an illegal byte
3391 sequence it won't be recognized as UTF-8. You can use the |8g8|
3392 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 WRONG VALUES: WHAT'S WRONG:
3394 latin1,utf-8 "latin1" will always be used
3395 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3396 file
3397 cp1250,latin1 "cp1250" will always be used
3398 If 'fileencodings' is empty, 'fileencoding' is not modified.
3399 See 'fileencoding' for the possible values.
3400 Setting this option does not have an effect until the next time a file
3401 is read.
3402
3403 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003404'fileformat' 'ff' string (MS-Windows default: "dos",
3405 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 This gives the <EOL> of the current buffer, which is used for
3408 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003409 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 unix <NL>
3411 mac <CR>
3412 When "dos" is used, CTRL-Z at the end of a file is ignored.
3413 See |file-formats| and |file-read|.
3414 For the character encoding of the file see 'fileencoding'.
3415 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003416 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 This option is set automatically when starting to edit a file and
3418 'fileformats' is not empty and 'binary' is off.
3419 When this option is set, after starting to edit a file, the 'modified'
3420 option is set, because the file would be different when written.
3421 This option can not be changed when 'modifiable' is off.
3422 For backwards compatibility: When this option is set to "dos",
3423 'textmode' is set, otherwise 'textmode' is reset.
3424
3425 *'fileformats'* *'ffs'*
3426'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003427 Vim+Vi MS-Windows: "dos,unix",
3428 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 Vi Cygwin: "unix,dos",
3430 Vi others: "")
3431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 This gives the end-of-line (<EOL>) formats that will be tried when
3433 starting to edit a new buffer and when reading a file into an existing
3434 buffer:
3435 - When empty, the format defined with 'fileformat' will be used
3436 always. It is not set automatically.
3437 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003438 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 'fileformats' name will be used when a file is read into an existing
3440 buffer, no matter what 'fileformat' for that buffer is set to.
3441 - When more than one name is present, separated by commas, automatic
3442 <EOL> detection will be done when reading a file. When starting to
3443 edit a file, a check is done for the <EOL>:
3444 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3445 'fileformat' is set to "dos".
3446 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003447 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003449 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3450 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003451 This means that "mac" is only chosen when:
3452 "unix" is not present or no <NL> is found in the file, and
3453 "dos" is not present or no <CR><NL> is found in the file.
3454 Except: if "unix" was chosen, but there is a <CR> before
3455 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003456 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 4. If 'fileformat' is still not set, the first name from
3458 'fileformats' is used.
3459 When reading a file into an existing buffer, the same is done, but
3460 this happens like 'fileformat' has been set appropriately for that
3461 file only, the option is not changed.
3462 When 'binary' is set, the value of 'fileformats' is not used.
3463
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003464 When Vim starts up with an empty buffer the first item is used. You
3465 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003466
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3468 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3469 done:
3470 - When 'fileformats' is empty, there is no automatic detection. Dos
3471 format will be used.
3472 - When 'fileformats' is set to one or more names, automatic detection
3473 is done. This is based on the first <NL> in the file: If there is a
3474 <CR> in front of it, Dos format is used, otherwise Unix format is
3475 used.
3476 Also see |file-formats|.
3477 For backwards compatibility: When this option is set to an empty
3478 string or one format (no comma is included), 'textauto' is reset,
3479 otherwise 'textauto' is set.
3480 NOTE: This option is set to the Vi default value when 'compatible' is
3481 set and to the Vim default value when 'compatible' is reset.
3482
Bram Moolenaarbf884932013-04-05 22:26:15 +02003483 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3484'fileignorecase' 'fic' boolean (default on for systems where case in file
3485 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003486 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003487 When set case is ignored when using file names and directories.
3488 See 'wildignorecase' for only ignoring case when doing completion.
3489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 *'filetype'* *'ft'*
3491'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003492 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 When this option is set, the FileType autocommand event is triggered.
3494 All autocommands that match with the value of this option will be
3495 executed. Thus the value of 'filetype' is used in place of the file
3496 name.
3497 Otherwise this option does not always reflect the current file type.
3498 This option is normally set when the file type is detected. To enable
3499 this use the ":filetype on" command. |:filetype|
3500 Setting this option to a different value is most useful in a modeline,
3501 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003502 Example, for in an IDL file:
3503 /* vim: set filetype=idl : */ ~
3504 |FileType| |filetypes|
3505 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003506 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003507 /* vim: set filetype=c.doxygen : */ ~
3508 This will use the "c" filetype first, then the "doxygen" filetype.
3509 This works both for filetype plugins and for syntax files. More than
3510 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 This option is not copied to another buffer, independent of the 's' or
3512 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003513 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514
3515 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003516'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003517 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003518 Characters to fill the statuslines, vertical separators and special
3519 lines in the window.
3520 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003521 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003523 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003524 stl ' ' statusline of the current window
3525 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003526 vert '|' vertical separators |:vsplit|
3527 fold '-' filling 'foldtext'
3528 foldopen '-' mark the beginning of a fold
3529 foldclose '+' show a closed fold
3530 foldsep '|' open fold middle character
3531 diff '-' deleted lines of the 'diff' option
3532 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003533 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003535 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536
3537 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003538 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3539<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003540 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3541 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003542 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003543
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003545 item name highlight group ~
3546 stl StatusLine |hl-StatusLine|
3547 stlnc StatusLineNC |hl-StatusLineNC|
3548 vert VertSplit |hl-VertSplit|
3549 fold Folded |hl-Folded|
3550 diff DiffDelete |hl-DiffDelete|
3551 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003552 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003554 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3555'fixendofline' 'fixeol' boolean (default on)
3556 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003557 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003558 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003559 preserve the situation from the original file.
3560 When the 'binary' option is set the value of this option doesn't
3561 matter.
3562 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003563 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003564
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003566'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 {only available when compiled with the |+rightleft|
3569 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003570 This option was for using Farsi, which has been removed. See
3571 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572
3573 *'foldclose'* *'fcl'*
3574'foldclose' 'fcl' string (default "")
3575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 {not available when compiled without the |+folding|
3577 feature}
3578 When set to "all", a fold is closed when the cursor isn't in it and
3579 its level is higher than 'foldlevel'. Useful if you want folds to
3580 automatically close when moving out of them.
3581
3582 *'foldcolumn'* *'fdc'*
3583'foldcolumn' 'fdc' number (default 0)
3584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 {not available when compiled without the |+folding|
3586 feature}
3587 When non-zero, a column with the specified width is shown at the side
3588 of the window which indicates open and closed folds. The maximum
3589 value is 12.
3590 See |folding|.
3591
3592 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3593'foldenable' 'fen' boolean (default on)
3594 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 {not available when compiled without the |+folding|
3596 feature}
3597 When off, all folds are open. This option can be used to quickly
3598 switch between showing all text unfolded and viewing the text with
3599 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003600 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 'foldenable' is off.
3602 This option is set by commands that create a new fold or close a fold.
3603 See |folding|.
3604
3605 *'foldexpr'* *'fde'*
3606'foldexpr' 'fde' string (default: "0")
3607 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003609 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003611 for each line to obtain its fold level. The context is set to the
3612 script where 'foldexpr' was set, script-local items can be accessed.
3613 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003614
Bram Moolenaar30b65812012-07-12 22:01:11 +02003615 The expression will be evaluated in the |sandbox| if set from a
3616 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003617 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003618 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003619
3620 It is not allowed to change text or jump to another window while
3621 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622
3623 *'foldignore'* *'fdi'*
3624'foldignore' 'fdi' string (default: "#")
3625 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 {not available when compiled without the |+folding|
3627 feature}
3628 Used only when 'foldmethod' is "indent". Lines starting with
3629 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 The default "#" works well for C programs. See |fold-indent|.
3632
3633 *'foldlevel'* *'fdl'*
3634'foldlevel' 'fdl' number (default: 0)
3635 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 {not available when compiled without the |+folding|
3637 feature}
3638 Sets the fold level: Folds with a higher level will be closed.
3639 Setting this option to zero will close all folds. Higher numbers will
3640 close fewer folds.
3641 This option is set by commands like |zm|, |zM| and |zR|.
3642 See |fold-foldlevel|.
3643
3644 *'foldlevelstart'* *'fdls'*
3645'foldlevelstart' 'fdls' number (default: -1)
3646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 {not available when compiled without the |+folding|
3648 feature}
3649 Sets 'foldlevel' when starting to edit another buffer in a window.
3650 Useful to always start editing with all folds closed (value zero),
3651 some folds closed (one) or no folds closed (99).
3652 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003653 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 ignores this option and closes all folds.
3655 It is also done before BufReadPre autocommands, to allow an autocmd to
3656 overrule the 'foldlevel' value for specific files.
3657 When the value is negative, it is not used.
3658
3659 *'foldmarker'* *'fmr'* *E536*
3660'foldmarker' 'fmr' string (default: "{{{,}}}")
3661 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {not available when compiled without the |+folding|
3663 feature}
3664 The start and end marker used when 'foldmethod' is "marker". There
3665 must be one comma, which separates the start and end marker. The
3666 marker is a literal string (a regular expression would be too slow).
3667 See |fold-marker|.
3668
3669 *'foldmethod'* *'fdm'*
3670'foldmethod' 'fdm' string (default: "manual")
3671 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 {not available when compiled without the |+folding|
3673 feature}
3674 The kind of folding used for the current window. Possible values:
3675 |fold-manual| manual Folds are created manually.
3676 |fold-indent| indent Lines with equal indent form a fold.
3677 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3678 |fold-marker| marker Markers are used to specify folds.
3679 |fold-syntax| syntax Syntax highlighting items specify folds.
3680 |fold-diff| diff Fold text that is not changed.
3681
3682 *'foldminlines'* *'fml'*
3683'foldminlines' 'fml' number (default: 1)
3684 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 {not available when compiled without the |+folding|
3686 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003687 Sets the number of screen lines above which a fold can be displayed
3688 closed. Also for manually closed folds. With the default value of
3689 one a fold can only be closed if it takes up two or more screen lines.
3690 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003691 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 "zc" to close a fold, which is displayed open because it's smaller
3693 than 'foldminlines', a following "zc" may close a containing fold.
3694
3695 *'foldnestmax'* *'fdn'*
3696'foldnestmax' 'fdn' number (default: 20)
3697 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {not available when compiled without the |+folding|
3699 feature}
3700 Sets the maximum nesting of folds for the "indent" and "syntax"
3701 methods. This avoids that too many folds will be created. Using more
3702 than 20 doesn't work, because the internal limit is 20.
3703
3704 *'foldopen'* *'fdo'*
3705'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3706 search,tag,undo")
3707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 {not available when compiled without the |+folding|
3709 feature}
3710 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003711 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003713 NOTE: When the command is part of a mapping this option is not used.
3714 Add the |zv| command to the mapping to get the same effect.
3715 (rationale: the mapping may want to control opening folds itself)
3716
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 item commands ~
3718 all any
3719 block "(", "{", "[[", "[{", etc.
3720 hor horizontal movements: "l", "w", "fx", etc.
3721 insert any command in Insert mode
3722 jump far jumps: "G", "gg", etc.
3723 mark jumping to a mark: "'m", CTRL-O, etc.
3724 percent "%"
3725 quickfix ":cn", ":crew", ":make", etc.
3726 search search for a pattern: "/", "n", "*", "gd", etc.
3727 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003728 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 tag jumping to a tag: ":ta", CTRL-T, etc.
3730 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 When a movement command is used for an operator (e.g., "dl" or "y%")
3732 this option is not used. This means the operator will include the
3733 whole closed fold.
3734 Note that vertical movements are not here, because it would make it
3735 very difficult to move onto a closed fold.
3736 In insert mode the folds containing the cursor will always be open
3737 when text is inserted.
3738 To close folds you can re-apply 'foldlevel' with the |zx| command or
3739 set the 'foldclose' option to "all".
3740
3741 *'foldtext'* *'fdt'*
3742'foldtext' 'fdt' string (default: "foldtext()")
3743 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 {not available when compiled without the |+folding|
3745 feature}
3746 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003747 fold. The context is set to the script where 'foldexpr' was set,
3748 script-local items can be accessed. See |fold-foldtext| for the
3749 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750
Bram Moolenaar30b65812012-07-12 22:01:11 +02003751 The expression will be evaluated in the |sandbox| if set from a
3752 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003753 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003754
3755 It is not allowed to change text or jump to another window while
3756 evaluating 'foldtext' |textlock|.
3757
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003758 *'formatexpr'* *'fex'*
3759'formatexpr' 'fex' string (default "")
3760 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003761 {not available when compiled without the |+eval|
3762 feature}
3763 Expression which is evaluated to format a range of lines for the |gq|
3764 operator or automatic formatting (see 'formatoptions'). When this
3765 option is empty 'formatprg' is used.
3766
3767 The |v:lnum| variable holds the first line to be formatted.
3768 The |v:count| variable holds the number of lines to be formatted.
3769 The |v:char| variable holds the character that is going to be
3770 inserted if the expression is being evaluated due to
3771 automatic formatting. This can be empty. Don't insert
3772 it yet!
3773
3774 Example: >
3775 :set formatexpr=mylang#Format()
3776< This will invoke the mylang#Format() function in the
3777 autoload/mylang.vim file in 'runtimepath'. |autoload|
3778
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003779 The advantage of using a function call without arguments is that it is
3780 faster, see |expr-option-function|.
3781
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003782 The expression is also evaluated when 'textwidth' is set and adding
3783 text beyond that limit. This happens under the same conditions as
3784 when internal formatting is used. Make sure the cursor is kept in the
3785 same spot relative to the text then! The |mode()| function will
3786 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003787
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003788 When the expression evaluates to non-zero Vim will fall back to using
3789 the internal format mechanism.
3790
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003791 If the expression starts with s: or |<SID>|, then it is replaced with
3792 the script ID (|local-function|). Example: >
3793 set formatexpr=s:MyFormatExpr()
3794 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003795< Otherwise, the expression is evaluated in the context of the script
3796 where the option was set, thus script-local items are available.
3797
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003798 The expression will be evaluated in the |sandbox| when set from a
3799 modeline, see |sandbox-option|. That stops the option from working,
3800 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003801 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003802 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003803
Bram Moolenaar86b68352004-12-27 21:59:20 +00003804 *'formatlistpat'* *'flp'*
3805'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3806 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003807 A pattern that is used to recognize a list header. This is used for
3808 the "n" flag in 'formatoptions'.
3809 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003810 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003811 while still checking more characters. There must be a character
3812 following the pattern, when it matches the whole line it is handled
3813 like there is no match.
3814 The default recognizes a number, followed by an optional punctuation
3815 character and white space.
3816
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003817 *'formatoptions'* *'fo'*
3818'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3819 local to buffer
3820 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003821 formatting is to be done.
3822 See |fo-table| for possible values and |gq| for how to format text.
3823 When the 'paste' option is on, no formatting is done (like
3824 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003825 To avoid problems with flags that are added in the future, use the
3826 "+=" and "-=" feature of ":set" |add-option-flags|.
3827 NOTE: This option is set to the Vi default value when 'compatible' is
3828 set and to the Vim default value when 'compatible' is reset.
3829
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 *'formatprg'* *'fp'*
3831'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003832 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003834 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003836 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003837 If the 'formatexpr' option is not empty it will be used instead.
3838 Otherwise, if 'formatprg' option is an empty string, the internal
3839 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003840 Environment variables are expanded |:set_env|. See |option-backslash|
3841 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003842 This option cannot be set from a |modeline| or in the |sandbox|, for
3843 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844
Bram Moolenaard94464e2015-11-02 15:28:18 +01003845 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003846'fsync' 'fs' boolean (default on)
3847 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003848 When on, the library function fsync() will be called after writing a
3849 file. This will flush a file to disk, ensuring that it is safely
3850 written even on filesystems which do metadata-only journaling. This
3851 will force the harddrive to spin up on Linux systems running in laptop
3852 mode, so it may be undesirable in some situations. Be warned that
3853 turning this off increases the chances of data loss after a crash. On
3854 systems without an fsync() implementation, this variable is always
3855 off.
3856 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003857 'fsync' also applies to |writefile()| (unless a flag is used to
3858 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003859 This option cannot be set from a |modeline| or in the |sandbox|, for
3860 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003861
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3863'gdefault' 'gd' boolean (default off)
3864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 When on, the ":substitute" flag 'g' is default on. This means that
3866 all matches in a line are substituted instead of one. When a 'g' flag
3867 is given to a ":substitute" command, this will toggle the substitution
3868 of all or one match. See |complex-change|.
3869
3870 command 'gdefault' on 'gdefault' off ~
3871 :s/// subst. all subst. one
3872 :s///g subst. one subst. all
3873 :s///gg subst. all subst. one
3874
3875 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003876 Setting this option may break plugins that rely on the default
3877 behavior of the 'g' flag. This will also make the 'g' flag have the
3878 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003879 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880
3881 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003882'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 Format to recognize for the ":grep" command output.
3885 This is a scanf-like string that uses the same format as the
3886 'errorformat' option: see |errorformat|.
3887
3888 *'grepprg'* *'gp'*
3889'grepprg' 'gp' string (default "grep -n ",
3890 Unix: "grep -n $* /dev/null",
3891 Win32: "findstr /n" or "grep -n",
3892 VMS: "SEARCH/NUMBERS ")
3893 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003894 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 and '#' characters, which are expanded like when used in a command-
3896 line. The placeholder "$*" is allowed to specify where the arguments
3897 will be included. Environment variables are expanded |:set_env|. See
3898 |option-backslash| about including spaces and backslashes.
3899 When your "grep" accepts the "-H" argument, use this to make ":grep"
3900 also work well with a single file: >
3901 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003902< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003903 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3904 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003905 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 apply equally to 'grepprg'.
3907 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3908 otherwise it's "grep -n".
3909 This option cannot be set from a |modeline| or in the |sandbox|, for
3910 security reasons.
3911
3912 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3913'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3914 ve:ver35-Cursor,
3915 o:hor50-Cursor,
3916 i-ci:ver25-Cursor/lCursor,
3917 r-cr:hor20-Cursor/lCursor,
3918 sm:block-Cursor
3919 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003920 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 "n-v-c:block,o:hor50,i-ci:hor15,
3922 r-cr:hor30,sm:block")
3923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003925 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003927 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003928 height of the cursor can be changed. This can be done by specifying a
3929 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003930 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3931 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003933 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 mode-list and an argument-list:
3935 mode-list:argument-list,mode-list:argument-list,..
3936 The mode-list is a dash separated list of these modes:
3937 n Normal mode
3938 v Visual mode
3939 ve Visual mode with 'selection' "exclusive" (same as 'v',
3940 if not specified)
3941 o Operator-pending mode
3942 i Insert mode
3943 r Replace mode
3944 c Command-line Normal (append) mode
3945 ci Command-line Insert mode
3946 cr Command-line Replace mode
3947 sm showmatch in Insert mode
3948 a all modes
3949 The argument-list is a dash separated list of these arguments:
3950 hor{N} horizontal bar, {N} percent of the character height
3951 ver{N} vertical bar, {N} percent of the character width
3952 block block cursor, fills the whole character
3953 [only one of the above three should be present]
3954 blinkwait{N} *cursor-blinking*
3955 blinkon{N}
3956 blinkoff{N}
3957 blink times for cursor: blinkwait is the delay before
3958 the cursor starts blinking, blinkon is the time that
3959 the cursor is shown and blinkoff is the time that the
3960 cursor is not shown. The times are in msec. When one
3961 of the numbers is zero, there is no blinking. The
3962 default is: "blinkwait700-blinkon400-blinkoff250".
3963 These numbers are used for a missing entry. This
3964 means that blinking is enabled by default. To switch
3965 blinking off you can use "blinkon0". The cursor only
3966 blinks when Vim is waiting for input, not while
3967 executing a command.
3968 To make the cursor blink in an xterm, see
3969 |xterm-blink|.
3970 {group-name}
3971 a highlight group name, that sets the color and font
3972 for the cursor
3973 {group-name}/{group-name}
3974 Two highlight group names, the first is used when
3975 no language mappings are used, the other when they
3976 are. |language-mapping|
3977
3978 Examples of parts:
3979 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3980 block cursor with colors from the "nCursor"
3981 highlight group
3982 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3983 In Insert and Command-line Insert mode, use a
3984 30% vertical bar cursor with colors from the
3985 "iCursor" highlight group. Blink a bit
3986 faster.
3987
3988 The 'a' mode is different. It will set the given argument-list for
3989 all modes. It does not reset anything to defaults. This can be used
3990 to do a common setting for all modes. For example, to switch off
3991 blinking: "a:blinkon0"
3992
3993 Examples of cursor highlighting: >
3994 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3995 :highlight Cursor gui=NONE guifg=bg guibg=fg
3996<
3997 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003998 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999'guifont' 'gfn' string (default "")
4000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 {only available when compiled with GUI enabled}
4002 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004003 In its simplest form the value is just one font name.
4004 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005
4006 *'guifontset'* *'gfs'*
4007 *E250* *E252* *E234* *E597* *E598*
4008'guifontset' 'gfs' string (default "")
4009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 {only available when compiled with GUI enabled and
4011 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004012 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 When not empty, specifies two (or more) fonts to be used. The first
4014 one for normal English, the second one for your special language. See
4015 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004016
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4018'guifontwide' 'gfw' string (default "")
4019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 {only available when compiled with GUI enabled}
4021 When not empty, specifies a comma-separated list of fonts to be used
4022 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004023 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004024
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 *'guiheadroom'* *'ghr'*
4026'guiheadroom' 'ghr' number (default 50)
4027 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004028 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 The number of pixels subtracted from the screen height when fitting
4030 the GUI window on the screen. Set this before the GUI is started,
4031 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004032 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 lines will be left for window decorations and other items on the
4034 screen. Set it to a negative value to allow windows taller than the
4035 screen.
4036
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004037 *'guiligatures'* *'gli'* *E1243*
4038'guiligatures' 'gli' string (default "")
4039 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004040 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004041 List of ASCII characters that, when combined together, can create more
4042 complex shapes. Each character must be a printable ASCII character
4043 with a value in the 32-127 range.
4044 Example: >
4045 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4046< Changing this option updates screen output immediately. Set it to an
4047 empty string to disable ligatures.
4048
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004050'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4051 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004052 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004053 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004056 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 sequence of letters which describes what components and options of the
4058 GUI should be used.
4059 To avoid problems with flags that are added in the future, use the
4060 "+=" and "-=" feature of ":set" |add-option-flags|.
4061
Bram Moolenaar13568252018-03-16 20:46:58 +01004062 Valid characters are as follows:
4063 *'go-!'*
4064 '!' External commands are executed in a terminal window. Without
4065 this flag the MS-Windows GUI will open a console window to
4066 execute the command. The Unix GUI will simulate a dumb
4067 terminal to list the command output.
4068 The terminal window will be positioned at the bottom, and grow
4069 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004070 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 'a' Autoselect: If present, then whenever VISUAL mode is started,
4072 or the Visual area extended, Vim tries to become the owner of
4073 the windowing system's global selection. This means that the
4074 Visually highlighted text is available for pasting into other
4075 applications as well as into Vim itself. When the Visual mode
4076 ends, possibly due to an operation on the text, or when an
4077 application wants to paste the selection, the highlighted text
4078 is automatically yanked into the "* selection register.
4079 Thus the selection is still available for pasting into other
4080 applications after the VISUAL mode has ended.
4081 If not present, then Vim won't become the owner of the
4082 windowing system's global selection unless explicitly told to
4083 by a yank or delete operation for the "* register.
4084 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004085 *'go-P'*
4086 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004087 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004088 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004089 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 applies to the modeless selection.
4091
4092 'guioptions' autoselect Visual autoselect modeless ~
4093 "" - -
4094 "a" yes yes
4095 "A" - yes
4096 "aA" yes yes
4097
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004098 When using a terminal see the 'clipboard' option.
4099
Bram Moolenaar02467872007-05-06 13:22:01 +00004100 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 'c' Use console dialogs instead of popup dialogs for simple
4102 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004103 *'go-d'*
4104 'd' Use dark theme variant if available. Currently only works for
4105 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004106 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004107 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004108 'guitablabel' can be used to change the text in the labels.
4109 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004110 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004111 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004112 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 'f' Foreground: Don't use fork() to detach the GUI from the shell
4114 where it was started. Use this for programs that wait for the
4115 editor to finish (e.g., an e-mail program). Alternatively you
4116 can use "gvim -f" or ":gui -f" to start the GUI in the
4117 foreground. |gui-fork|
4118 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004119 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004120 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4122 corner of the window. It's black&white on non-GTK, because of
4123 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004124 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004126 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004127 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004129 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004131 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004132 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 'g' Grey menu items: Make menu items that are not active grey. If
4134 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004135 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 't' Include tearoff menu items. Currently only works for Win32,
4137 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004138 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004139 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4140 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004141 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004143 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 'R' Right-hand scrollbar is present when there is a vertically
4145 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004146 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004148 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 'L' Left-hand scrollbar is present when there is a vertically
4150 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004151 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4153 the longest visible line, or on the cursor line if the 'h'
4154 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004155 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 'h' Limit horizontal scrollbar size to the length of the cursor
4157 line. Reduces computations. |gui-horiz-scroll|
4158
4159 And yes, you may even have scrollbars on the left AND the right if
4160 you really want to :-). See |gui-scrollbars| for more information.
4161
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004162 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 'v' Use a vertical button layout for dialogs. When not included,
4164 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004165 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004166 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 'p' Use Pointer callbacks for X11 GUI. This is required for some
4168 window managers. If the cursor is not blinking or hollow at
4169 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004170 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004172 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004173 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004174 *'go-k'*
4175 'k' Keep the GUI window size when adding/removing a scrollbar, or
4176 toolbar, tabline, etc. Instead, the behavior is similar to
4177 when the window is maximized and will adjust 'lines' and
4178 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004179 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004180 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004181
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 *'guipty'* *'noguipty'*
4183'guipty' boolean (default on)
4184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 {only available when compiled with GUI enabled}
4186 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4187 I/O to/from shell commands. See |gui-pty|.
4188
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004189 *'guitablabel'* *'gtl'*
4190'guitablabel' 'gtl' string (default empty)
4191 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004192 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004193 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004194 pages line. When empty and when the result is empty Vim will use a
4195 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004196
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004197 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004198 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004199 The expression will be evaluated in the |sandbox| when set from a
4200 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004201 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004202
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004203 Only used when the GUI tab pages line is displayed. 'e' must be
4204 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4205 used.
4206
Bram Moolenaar57657d82006-04-21 22:12:41 +00004207 *'guitabtooltip'* *'gtt'*
4208'guitabtooltip' 'gtt' string (default empty)
4209 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004210 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004211 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004212 pages line. When empty Vim will use a default tooltip.
4213 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004214 You can include a line break. Simplest method is to use |:let|: >
4215 :let &guitabtooltip = "line one\nline two"
4216<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004217
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004219'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 (others) "$VIMRUNTIME/doc/help.txt")
4221 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 Name of the main help file. All distributed help files should be
4223 placed together in one directory. Additionally, all "doc" directories
4224 in 'runtimepath' will be used.
4225 Environment variables are expanded |:set_env|. For example:
4226 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004227 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 spaces and backslashes.
4229 This option cannot be set from a |modeline| or in the |sandbox|, for
4230 security reasons.
4231
4232 *'helpheight'* *'hh'*
4233'helpheight' 'hh' number (default 20)
4234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 Minimal initial height of the help window when it is opened with the
4236 ":help" command. The initial height of the help window is half of the
4237 current window, or (when the 'ea' option is on) the same as other
4238 windows. When the height is less than 'helpheight', the height is
4239 set to 'helpheight'. Set to zero to disable.
4240
4241 *'helplang'* *'hlg'*
4242'helplang' 'hlg' string (default: messages language or empty)
4243 global
4244 {only available when compiled with the |+multi_lang|
4245 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004246 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 for which the desired help can be found. The English help will always
4248 be used as a last resort. You can add "en" to prefer English over
4249 another language, but that will only find tags that exist in that
4250 language and not in the English help.
4251 Example: >
4252 :set helplang=de,it
4253< This will first search German, then Italian and finally English help
4254 files.
4255 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4256 try to find the tag in the current language before using this option.
4257 See |help-translated|.
4258
4259 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4260'hidden' 'hid' boolean (default off)
4261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 When off a buffer is unloaded when it is |abandon|ed. When on a
4263 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4264 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004265
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004267 hidden even if the 'hidden' option is off when these three are true:
4268 - the buffer is modified
4269 - 'autowrite' is off or writing is not possible
4270 - the '!' flag was used
4271 Also see |windows.txt|.
4272
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004273 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 This option is set for one command with ":hide {command}" |:hide|.
4275 WARNING: It's easy to forget that you have changes in hidden buffers.
4276 Think twice when using ":q!" or ":qa!".
4277
4278 *'highlight'* *'hl'*
4279'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004280 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4281 d:Directory,e:ErrorMsg,i:IncSearch,
4282 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004283 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004284 N:CursorLineNr,r:Question,s:StatusLine,
4285 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004286 v:Visual,V:VisualNOS,w:WarningMsg,
4287 W:WildMenu,f:Folded,F:FoldColumn,
4288 A:DiffAdd,C:DiffChange,D:DiffDelete,
4289 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004290 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004291 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004292 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004293 [:PmenuKind,]:PmenuKindSel,
4294 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004295 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4296 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004297 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004298 z:StatusLineTerm,Z:StatusLineTermNC,
4299 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004302 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004304 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004306 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4307 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 characters from 'showbreak'
4309 |hl-Directory| d directories in CTRL-D listing and other special
4310 things in listings
4311 |hl-ErrorMsg| e error messages
4312 h (obsolete, ignored)
4313 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004314 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4316 |hl-MoreMsg| m |more-prompt|
4317 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004318 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004319 |hl-LineNr| n line number for ":number" and ":#" commands, and
4320 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004321 |hl-LineNrAbove| a line number above the cursor for when the
4322 'relativenumber' option is set.
4323 |hl-LineNrBelow| b line number below the cursor for when the
4324 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004325 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4326 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 |hl-Question| r |hit-enter| prompt and yes/no questions
4328 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004329 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4331 |hl-VertSplit| c column used to separate vertically split windows
4332 |hl-Visual| v Visual mode
4333 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4334 Selection" Only X11 Gui's |gui-x11| and
4335 |xterm-clipboard|.
4336 |hl-WarningMsg| w warning messages
4337 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4338 |hl-Folded| f line used for closed folds
4339 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004340 |hl-DiffAdd| A added line in diff mode
4341 |hl-DiffChange| C changed line in diff mode
4342 |hl-DiffDelete| D deleted line in diff mode
4343 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004345 |hl-Conceal| - the placeholders used for concealed characters
4346 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004347 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004348 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004349 |hl-SpellRare| R rare word |spell|
4350 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004351 |hl-Pmenu| + popup menu normal line
4352 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004353 |hl-PmenuKind| [ popup menu "kind" normal line
4354 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004355 |hl-PmenuExtra| { popup menu "extra" normal line
4356 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004357 |hl-PmenuSbar| x popup menu scrollbar
4358 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004359 |hl-PmenuMatch| k popup menu matched text
4360 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361
4362 The display modes are:
4363 r reverse (termcap entry "mr" and "me")
4364 i italic (termcap entry "ZH" and "ZR")
4365 b bold (termcap entry "md" and "me")
4366 s standout (termcap entry "so" and "se")
4367 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004368 c undercurl (termcap entry "Us" and "Ce")
4369 2 double underline (termcap entry "Ds" and "Ce")
4370 d dotted underline (termcap entry "ds" and "Ce")
4371 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004372 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 n no highlighting
4374 - no highlighting
4375 : use a highlight group
4376 The default is used for occasions that are not included.
4377 If you want to change what the display modes do, see |dos-colors|
4378 for an example.
4379 When using the ':' display mode, this must be followed by the name of
4380 a highlight group. A highlight group can be used to define any type
4381 of highlighting, including using color. See |:highlight| on how to
4382 define one. The default uses a different group for each occasion.
4383 See |highlight-default| for the default highlight groups.
4384
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004386'history' 'hi' number (Vim default: 50, Vi default: 0,
4387 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004390 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004392 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 NOTE: This option is set to the Vi default value when 'compatible' is
4394 set and to the Vim default value when 'compatible' is reset.
4395
4396 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4397'hkmap' 'hk' boolean (default off)
4398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 {only available when compiled with the |+rightleft|
4400 feature}
4401 When on, the keyboard is mapped for the Hebrew character set.
4402 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4403 toggle this option. See |rileft.txt|.
4404 NOTE: This option is reset when 'compatible' is set.
4405
4406 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4407'hkmapp' 'hkp' boolean (default off)
4408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 {only available when compiled with the |+rightleft|
4410 feature}
4411 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4412 This is useful if you have a non-Hebrew keyboard.
4413 See |rileft.txt|.
4414 NOTE: This option is reset when 'compatible' is set.
4415
Bram Moolenaar036986f2017-03-16 17:41:02 +01004416 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4417'hlsearch' 'hls' boolean (default off)
4418 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004419 {not available when compiled without the
4420 |+extra_search| feature}
4421 When there is a previous search pattern, highlight all its matches.
4422 The type of highlighting used can be set with the 'l' occasion in the
4423 'highlight' option. This uses the "Search" highlight group by
4424 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004425 are not applied. If the "CurSearch" highlight group is set then the
4426 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004427 See also: 'incsearch' and |:match|.
4428 When you get bored looking at the highlighted matches, you can turn it
4429 off with |:nohlsearch|. This does not change the option value, as
4430 soon as you use a search command, the highlighting comes back.
4431 'redrawtime' specifies the maximum time spent on finding matches.
4432 When the search pattern can match an end-of-line, Vim will try to
4433 highlight all of the matched text. However, this depends on where the
4434 search starts. This will be the first line in the window or the first
4435 line below a closed fold. A match in a previous line which is not
4436 drawn may not continue in a newly drawn line.
4437 You can specify whether the highlight status is restored on startup
4438 with the 'h' flag in 'viminfo' |viminfo-h|.
4439 NOTE: This option is reset when 'compatible' is set.
4440
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 *'icon'* *'noicon'*
4442'icon' boolean (default off, on when title can be restored)
4443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 When on, the icon text of the window will be set to the value of
4445 'iconstring' (if it is not empty), or to the name of the file
4446 currently being edited. Only the last part of the name is used.
4447 Overridden by the 'iconstring' option.
4448 Only works if the terminal supports setting window icons (currently
4449 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4450 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4451 builtin termcap).
4452 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004453 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004455 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456
4457 *'iconstring'*
4458'iconstring' string (default "")
4459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 When this option is not empty, it will be used for the icon text of
4461 the window. This happens only when the 'icon' option is on.
4462 Only works if the terminal supports setting window icon text
4463 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004464 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 When Vim was compiled with HAVE_X11 defined, the original icon will be
4466 restored if possible |X11|.
4467 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004468 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004470 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 {not available when compiled without the |+statusline| feature}
4472
4473 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4474'ignorecase' 'ic' boolean (default off)
4475 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004476 Ignore case in search patterns, |cmdline-completion|, when
4477 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004478 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 Can be overruled by using "\c" or "\C" in the pattern, see
4480 |/ignorecase|.
4481
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004482 *'imactivatefunc'* *'imaf'*
4483'imactivatefunc' 'imaf' string (default "")
4484 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004485 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004486 activate or deactivate the Input Method. The value can be the name of
4487 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4488 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004489 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004490 The expression will be evaluated in the |sandbox| when set from a
4491 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004492
4493 Example: >
4494 function ImActivateFunc(active)
4495 if a:active
4496 ... do something
4497 else
4498 ... do something
4499 endif
4500 " return value is not used
4501 endfunction
4502 set imactivatefunc=ImActivateFunc
4503<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 *'imactivatekey'* *'imak'*
4505'imactivatekey' 'imak' string (default "")
4506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004508 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 Specifies the key that your Input Method in X-Windows uses for
4510 activation. When this is specified correctly, vim can fully control
4511 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4512 You can't use this option to change the activation key, the option
4513 tells Vim what the key is.
4514 Format:
4515 [MODIFIER_FLAG-]KEY_STRING
4516
4517 These characters can be used for MODIFIER_FLAG (case is ignored):
4518 S Shift key
4519 L Lock key
4520 C Control key
4521 1 Mod1 key
4522 2 Mod2 key
4523 3 Mod3 key
4524 4 Mod4 key
4525 5 Mod5 key
4526 Combinations are allowed, for example "S-C-space" or "SC-space" are
4527 both shift+ctrl+space.
4528 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4529
4530 Example: >
4531 :set imactivatekey=S-space
4532< "S-space" means shift+space. This is the activation key for kinput2 +
4533 canna (Japanese), and ami (Korean).
4534
4535 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4536'imcmdline' 'imc' boolean (default off)
4537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 When set the Input Method is always on when starting to edit a command
4539 line, unless entering a search pattern (see 'imsearch' for that).
4540 Setting this option is useful when your input method allows entering
4541 English characters directly, e.g., when it's used to type accented
4542 characters with dead keys.
4543
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004544 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 When set the Input Method is never used. This is useful to disable
4548 the IM when it doesn't work properly.
4549 Currently this option is on by default for SGI/IRIX machines. This
4550 may change in later releases.
4551
4552 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004553'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 Specifies whether :lmap or an Input Method (IM) is to be used in
4556 Insert mode. Valid values:
4557 0 :lmap is off and IM is off
4558 1 :lmap is ON and IM is off
4559 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 To always reset the option to zero when leaving Insert mode with <Esc>
4561 this can be used: >
4562 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4563< This makes :lmap and IM turn off automatically when leaving Insert
4564 mode.
4565 Note that this option changes when using CTRL-^ in Insert mode
4566 |i_CTRL-^|.
4567 The value is set to 1 when setting 'keymap' to a valid keymap name.
4568 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004569 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 methods. Use 'imdisable' to disable XIM then.
4571
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004572 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004573 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004574 |+multi_byte_ime| or |global-ime|.
4575
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004577'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 Specifies whether :lmap or an Input Method (IM) is to be used when
4580 entering a search pattern. Valid values:
4581 -1 the value of 'iminsert' is used, makes it look like
4582 'iminsert' is also used when typing a search pattern
4583 0 :lmap is off and IM is off
4584 1 :lmap is ON and IM is off
4585 2 :lmap is off and IM is ON
4586 Note that this option changes when using CTRL-^ in Command-line mode
4587 |c_CTRL-^|.
4588 The value is set to 1 when it is not -1 and setting the 'keymap'
4589 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004590 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 methods. Use 'imdisable' to disable XIM then.
4592
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004593 *'imstatusfunc'* *'imsf'*
4594'imstatusfunc' 'imsf' string (default "")
4595 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004596 This option specifies a function that is called to obtain the status
4597 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004598 The value can be the name of a function, a |lambda| or a |Funcref|.
4599 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004600 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004601
4602 Example: >
4603 function ImStatusFunc()
4604 let is_active = ...do something
4605 return is_active ? 1 : 0
4606 endfunction
4607 set imstatusfunc=ImStatusFunc
4608<
4609 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004610 The expression will be evaluated in the |sandbox| when set from a
4611 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004612
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004613 *'imstyle'* *'imst'*
4614'imstyle' 'imst' number (default 1)
4615 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004616 {only available when compiled with |+xim| and
4617 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004618 This option specifies the input style of Input Method:
4619 0 use on-the-spot style
4620 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004621 See: |xim-input-style|
4622
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004623 For a long time on-the-spot style had been used in the GTK version of
4624 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004625 |single-repeat|, etc. Therefore over-the-spot style becomes the
4626 default now. This should work fine for most people, however if you
4627 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004628 The expression will be evaluated in the |sandbox| when set from a
4629 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004630
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 *'include'* *'inc'*
4632'include' 'inc' string (default "^\s*#\s*include")
4633 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 {not available when compiled without the
4635 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004636 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 pattern, just like for the "/" command (See |pattern|). The default
4638 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004639 "]I", "[d", etc.
4640 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004641 comes after the matched pattern. But if "\zs" appears in the pattern
4642 then the text matched from "\zs" to the end, or until "\ze" if it
4643 appears, is used as the file name. Use this to include characters
4644 that are not in 'isfname', such as a space. You can then use
4645 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004646 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647
4648 *'includeexpr'* *'inex'*
4649'includeexpr' 'inex' string (default "")
4650 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004652 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004654 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004655 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004657 Note the double backslash: the `:set` command first halves them, then
4658 one remains it the value, where "\." matches a dot literally. For
4659 simple character replacements `tr()` avoids the need for escaping: >
4660 :setlocal includeexpr=tr(v:fname,'.','/')
4661<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004663 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 Also used for |<cfile>|.
4665
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004666 If the expression starts with s: or |<SID>|, then it is replaced with
4667 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004668 setlocal includeexpr=s:MyIncludeExpr()
4669 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004670< Otherwise, the expression is evaluated in the context of the script
4671 where the option was set, thus script-local items are available.
4672
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004673 It is more efficient if the value is just a function call without
4674 arguments, see |expr-option-function|.
4675
Bram Moolenaar30b65812012-07-12 22:01:11 +02004676 The expression will be evaluated in the |sandbox| when set from a
4677 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004678 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004679
4680 It is not allowed to change text or jump to another window while
4681 evaluating 'includeexpr' |textlock|.
4682
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004684'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004685 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004688 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004689 While typing a search command, show where the pattern, as it was typed
4690 so far, matches. The matched string is highlighted. If the pattern
4691 is invalid or not found, nothing is shown. The screen will be updated
4692 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004693 Also applies to the pattern in commands: >
4694 :global
4695 :lvimgrep
4696 :lvimgrepadd
4697 :smagic
4698 :snomagic
4699 :sort
4700 :substitute
4701 :vglobal
4702 :vimgrep
4703 :vimgrepadd
4704< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004705 original position when no match is found and when pressing <Esc>. You
4706 still need to finish the search command with <Enter> to move the
4707 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004708 You can use the CTRL-G and CTRL-T keys to move to the next and
4709 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004710 When compiled with the |+reltime| feature Vim only searches for about
4711 half a second. With a complicated pattern and/or a lot of text the
4712 match may not be found. This is to avoid that Vim hangs while you
4713 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004714 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004715 When 'hlsearch' is on, all matched strings are highlighted too while
4716 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004717 If you don't want to turn 'hlsearch' on, but want to highlight all
4718 matches while searching, you can turn on and off 'hlsearch' with
4719 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004720 augroup vimrc-incsearch-highlight
4721 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004722 autocmd CmdlineEnter /,\? :set hlsearch
4723 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004724 augroup END
4725<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004726 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004727 to the command line. If 'ignorecase' and 'smartcase' are set and the
4728 command line has no uppercase characters, the added character is
4729 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004730 CTRL-R CTRL-W can be used to add the word at the end of the current
4731 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 NOTE: This option is reset when 'compatible' is set.
4733
4734 *'indentexpr'* *'inde'*
4735'indentexpr' 'inde' string (default "")
4736 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004737 {not available when compiled without the |+eval|
4738 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 Expression which is evaluated to obtain the proper indent for a line.
4740 It is used when a new line is created, for the |=| operator and
4741 in Insert mode as specified with the 'indentkeys' option.
4742 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004743 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004744 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 When 'paste' is set this option is not used for indenting.
4746 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004747 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004749
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004750 If the expression starts with s: or |<SID>|, then it is replaced with
4751 the script ID (|local-function|). Example: >
4752 set indentexpr=s:MyIndentExpr()
4753 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004754< Otherwise, the expression is evaluated in the context of the script
4755 where the option was set, thus script-local items are available.
4756
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004757 The advantage of using a function call without arguments is that it is
4758 faster, see |expr-option-function|.
4759
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 The expression must return the number of spaces worth of indent. It
4761 can return "-1" to keep the current indent (this means 'autoindent' is
4762 used for the indent).
4763 Functions useful for computing the indent are |indent()|, |cindent()|
4764 and |lispindent()|.
4765 The evaluation of the expression must not have side effects! It must
4766 not change the text, jump to another window, etc. Afterwards the
4767 cursor position is always restored, thus the cursor may be moved.
4768 Normally this option would be set to call a function: >
4769 :set indentexpr=GetMyIndent()
4770< Error messages will be suppressed, unless the 'debug' option contains
4771 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004772 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004773 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774
Bram Moolenaar30b65812012-07-12 22:01:11 +02004775 The expression will be evaluated in the |sandbox| when set from a
4776 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004777 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004778
4779 It is not allowed to change text or jump to another window while
4780 evaluating 'indentexpr' |textlock|.
4781
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004783'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 A list of keys that, when typed in Insert mode, cause reindenting of
4786 the current line. Only happens if 'indentexpr' isn't empty.
4787 The format is identical to 'cinkeys', see |indentkeys-format|.
4788 See |C-indenting| and |indent-expression|.
4789
4790 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4791'infercase' 'inf' boolean (default off)
4792 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004794 'ignorecase' is also on, the case of the match is adjusted depending
4795 on the typed text. If the typed text contains a lowercase letter
4796 where the match has an upper case letter, the completed part is made
4797 lowercase. If the typed text has no lowercase letters and the match
4798 has a lowercase letter where the typed text has an uppercase letter,
4799 and there is a letter before it, the completed part is made uppercase.
4800 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801
4802 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4803'insertmode' 'im' boolean (default off)
4804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 Makes Vim work in a way that Insert mode is the default mode. Useful
4806 if you want to use Vim as a modeless editor. Used for |evim|.
4807 These Insert mode commands will be useful:
4808 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004809 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 this is a mapping, it is executed as if 'insertmode' was off.
4811 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004813 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4814 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
4816 These items change when 'insertmode' is set:
4817 - when starting to edit of a file, Vim goes to Insert mode.
4818 - <Esc> in Insert mode is a no-op and beeps.
4819 - <Esc> in Normal mode makes Vim go to Insert mode.
4820 - CTRL-L in Insert mode is a command, it is not inserted.
4821 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4822 However, when <Esc> is used inside a mapping, it behaves like
4823 'insertmode' was not set. This was done to be able to use the same
4824 mappings with 'insertmode' set or not set.
4825 When executing commands with |:normal| 'insertmode' is not used.
4826
4827 NOTE: This option is reset when 'compatible' is set.
4828
4829 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004830'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4832 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4833 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4834 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4835 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 The characters specified by this option are included in file names and
4838 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004839 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 Multi-byte characters 256 and above are always included, only the
4841 characters up to 255 are specified with this option.
4842 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004843 Think twice before adding white space to this option. Although a
4844 space may appear inside a file name, the effect will be that Vim
4845 doesn't know where a file name starts or ends when doing completion.
4846 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
4848 Note that on systems using a backslash as path separator, Vim tries to
4849 do its best to make it work as you would expect. That is a bit
4850 tricky, since Vi originally used the backslash to escape special
4851 characters. Vim will not remove a backslash in front of a normal file
4852 name character on these systems, but it will on Unix and alikes. The
4853 '&' and '^' are not included by default, because these are special for
4854 cmd.exe.
4855
4856 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004857 Each part can be a single character number or a range. A range is two
4858 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 decimal number between 0 and 255 or the ASCII character itself (does
4860 not work for digits). Example:
4861 "_,-,128-140,#-43" (include '_' and '-' and the range
4862 128 to 140 and '#' to 43)
4863 If a part starts with '^', the following character number or range
4864 will be excluded from the option. The option is interpreted from left
4865 to right. Put the excluded character after the range where it is
4866 included. To include '^' itself use it as the last character of the
4867 option or the end of a range. Example:
4868 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4869 If the character is '@', all characters where isalpha() returns TRUE
4870 are included. Normally these are the characters a to z and A to Z,
4871 plus accented characters. To include '@' itself use "@-@". Examples:
4872 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004873 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 "a-z,A-Z,@-@" All letters plus the '@' character.
4875 A comma can be included by using it where a character number is
4876 expected. Example:
4877 "48-57,,,_" Digits, comma and underscore.
4878 A comma can be excluded by prepending a '^'. Example:
4879 " -~,^,,9" All characters from space to '~', excluding
4880 comma, plus <Tab>.
4881 See |option-backslash| about including spaces and backslashes.
4882
4883 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004884'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 "@,48-57,_,128-167,224-235"
4886 otherwise: "@,48-57,_,192-255")
4887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 The characters given by this option are included in identifiers.
4889 Identifiers are used in recognizing environment variables and after a
4890 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004891 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004892 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004894 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4896
4897 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004898'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 "@,48-57,_,128-167,224-235"
4900 otherwise: "@,48-57,_,192-255"
4901 Vi default: "@,48-57,_")
4902 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004904 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004905 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004906 characters above 255 check the "word" character class (any character
4907 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004908 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 For a help file it is set to all non-blank printable characters except
4910 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4911 command).
4912 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004913 This option also influences syntax highlighting, unless the syntax
4914 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 NOTE: This option is set to the Vi default value when 'compatible' is
4916 set and to the Vim default value when 'compatible' is reset.
4917
4918 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004919'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 "@,~-255"; otherwise: "@,161-255")
4921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 The characters given by this option are displayed directly on the
4923 screen. It is also used for "\p" in a |pattern|. The characters from
4924 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4925 even when they are not included in 'isprint' or excluded. See
4926 'isfname' for a description of the format of this option.
4927
4928 Non-printable characters are displayed with two characters:
4929 0 - 31 "^@" - "^_"
4930 32 - 126 always single characters
4931 127 "^?"
4932 128 - 159 "~@" - "~_"
4933 160 - 254 "| " - "|~"
4934 255 "~?"
4935 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4936 displayed as <xx>, with the hexadecimal value of the byte.
4937 When 'display' contains "uhex" all unprintable characters are
4938 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004939 The SpecialKey highlighting will be used for unprintable characters.
4940 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941
4942 Multi-byte characters 256 and above are always included, only the
4943 characters up to 255 are specified with this option. When a character
4944 is printable but it is not available in the current font, a
4945 replacement character will be shown.
4946 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4947 There is no option to specify these characters.
4948
4949 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4950'joinspaces' 'js' boolean (default on)
4951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 Insert two spaces after a '.', '?' and '!' with a join command.
4953 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4954 Otherwise only one space is inserted.
4955 NOTE: This option is set when 'compatible' is set.
4956
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004957 *'jumpoptions'* *'jop'*
4958'jumpoptions' 'jop' string (default "")
4959 global
4960 List of words that change the behavior of the |jumplist|.
4961 stack Make the jumplist behave like the tagstack.
4962 Relative location of entries in the jumplist is
4963 preserved at the cost of discarding subsequent entries
4964 when navigating backwards in the jumplist and then
4965 jumping to a location. |jumplist-stack|
4966
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 *'key'*
4968'key' string (default "")
4969 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004970 {only available when compiled with the |+cryptv|
4971 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004973 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 Careful: Do not set the key value by hand, someone might see the typed
4975 key. Use the |:X| command. But you can make 'key' empty: >
4976 :set key=
4977< It is not possible to get the value of this option with ":set key" or
4978 "echo &key". This is to avoid showing it to someone who shouldn't
4979 know. It also means you cannot see it yourself once you have set it,
4980 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004981 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4982 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004983 You can use "&key" in an expression to detect whether encryption is
4984 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
4986 *'keymap'* *'kmp'* *E544*
4987'keymap' 'kmp' string (default "")
4988 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 {only available when compiled with the |+keymap|
4990 feature}
4991 Name of a keyboard mapping. See |mbyte-keymap|.
4992 Setting this option to a valid keymap name has the side effect of
4993 setting 'iminsert' to one, so that the keymap becomes effective.
4994 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02004995 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996
4997 *'keymodel'* *'km'*
4998'keymodel' 'km' string (default "")
4999 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005000 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 can do. These values can be used:
5002 startsel Using a shifted special key starts selection (either
5003 Select mode or Visual mode, depending on "key" being
5004 present in 'selectmode').
5005 stopsel Using a not-shifted special key stops selection.
5006 Special keys in this context are the cursor keys, <End>, <Home>,
5007 <PageUp> and <PageDown>.
5008 The 'keymodel' option is set by the |:behave| command.
5009
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005010 *'keyprotocol'* *'kpc'*
5011'keyprotocol' 'kpc' string (default: see below)
5012 global
5013 Specifies what keyboard protocol to use depending on the value of
5014 'term'. The supported keyboard protocols names are:
5015 none whatever the terminal uses
5016 mok2 modifyOtherKeys level 2, as supported by xterm
5017 kitty Kitty keyboard protocol, as supported by Kitty
5018
Bram Moolenaara87749e2022-11-30 10:23:17 +00005019 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005020 a pattern that is matched against the 'term' option, a colon and the
5021 protocol name to be used. To illustrate this, the default value would
5022 be set with: >
5023 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5024
5025< This means that when 'term' contains "kitty, "foot" or "wezterm"
5026 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005027 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005028
5029 The first match is used, thus if you want to have "kitty" use the
5030 kitty protocol, but "badkitty" not, then you should match "badkitty"
5031 first and use the "none" value: >
5032 set keyprotocol=badkitty:none,kitty:kitty
5033<
5034 The option is used after 'term' has been changed. First the termcap
5035 entries are set, possibly using the builtin list, see |builtin-terms|.
5036 Then this option is inspected and if there is a match and a protocol
5037 is specified the following happens:
5038 none Nothing, the regular t_TE and t_TI values remain
5039
5040 mok2 The t_TE value is changed to:
5041 CSI >4;m disables modifyOtherKeys
5042 The t_TI value is changed to:
5043 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005044 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005045
5046 kitty The t_TE value is changed to:
5047 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005048 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005049 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005050 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005051 CSI ?u request kitty keyboard protocol state
5052 CSI >c request the termresponse
5053
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005054 If you notice problems, such as characters being displayed that
5055 disappear after `CTRL-L`, you might want to try making this option
5056 empty. Then set the 'term' option to have it take effect: >
5057 set keyprotocol=
5058 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005059<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005060
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 *'keywordprg'* *'kp'*
5062'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005063 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 Program to use for the |K| command. Environment variables are
5066 expanded |:set_env|. ":help" may be used to access the Vim internal
5067 help. (Note that previously setting the global option to the empty
5068 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005069 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005070 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005071 When "man", "man -s" or an Ex command is used, Vim will automatically
5072 translate a count for the "K" command and pass it as the first
5073 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 See |option-backslash| about including spaces and backslashes.
5075 Example: >
5076 :set keywordprg=man\ -s
5077< This option cannot be set from a |modeline| or in the |sandbox|, for
5078 security reasons.
5079
5080 *'langmap'* *'lmap'* *E357* *E358*
5081'langmap' 'lmap' string (default "")
5082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 {only available when compiled with the |+langmap|
5084 feature}
5085 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005086 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005087 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 care of translating these special characters to the original meaning
5089 of the key. This means you don't have to change the keyboard mode to
5090 be able to execute Normal mode commands.
5091 This is the opposite of the 'keymap' option, where characters are
5092 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005093 Also consider setting 'langremap' to off, to prevent 'langmap' from
5094 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005095 This option cannot be set from a |modeline| or in the |sandbox|, for
5096 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005098 Example (for Greek, in UTF-8): *greek* >
5099 :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 +00005100< Example (exchanges meaning of z and y for commands): >
5101 :set langmap=zy,yz,ZY,YZ
5102<
5103 The 'langmap' option is a list of parts, separated with commas. Each
5104 part can be in one of two forms:
5105 1. A list of pairs. Each pair is a "from" character immediately
5106 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005107 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 characters. Example: "abc;ABC"
5109 Example: "aA,fgh;FGH,cCdDeE"
5110 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005111 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112
5113 This will allow you to activate vim actions without having to switch
5114 back and forth between the languages. Your language characters will
5115 be understood as normal vim English characters (according to the
5116 langmap mappings) in the following cases:
5117 o Normal/Visual mode (commands, buffer/register names, user mappings)
5118 o Insert/Replace Mode: Register names after CTRL-R
5119 o Insert/Replace Mode: Mappings
5120 Characters entered in Command-line mode will NOT be affected by
5121 this option. Note that this option can be changed at any time
5122 allowing to switch between mappings for different languages/encodings.
5123 Use a mapping to avoid having to type it each time!
5124
5125 *'langmenu'* *'lm'*
5126'langmenu' 'lm' string (default "")
5127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 {only available when compiled with the |+menu| and
5129 |+multi_lang| features}
5130 Language to use for menu translation. Tells which file is loaded
5131 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005132 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133< (without the spaces). For example, to always use the Dutch menus, no
5134 matter what $LANG is set to: >
5135 :set langmenu=nl_NL.ISO_8859-1
5136< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005137 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 If your $LANG is set to a non-English language but you do want to use
5139 the English menus: >
5140 :set langmenu=none
5141< This option must be set before loading menus, switching on filetype
5142 detection or syntax highlighting. Once the menus are defined setting
5143 this option has no effect. But you could do this: >
5144 :source $VIMRUNTIME/delmenu.vim
5145 :set langmenu=de_DE.ISO_8859-1
5146 :source $VIMRUNTIME/menu.vim
5147< Warning: This deletes all menus that you defined yourself!
5148
Bram Moolenaard94464e2015-11-02 15:28:18 +01005149 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005150'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005151 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005152 {only available when compiled with the |+langmap|
5153 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005154 This is just like 'langremap' but with the value inverted. It only
5155 exists for backwards compatibility. When setting 'langremap' then
5156 'langnoremap' is set to the inverted value, and the other way around.
5157
5158 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005159'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005160 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005161 {only available when compiled with the |+langmap|
5162 feature}
5163 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005164 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005165 'langmap' disables some of your mappings, try resetting this option.
5166 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005167 that works for you to avoid mappings to break.
5168
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 *'laststatus'* *'ls'*
5170'laststatus' 'ls' number (default 1)
5171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 The value of this option influences when the last window will have a
5173 status line:
5174 0: never
5175 1: only if there are at least two windows
5176 2: always
5177 The screen looks nicer with a status line if you have several
5178 windows, but it takes another screen line. |status-line|
5179
5180 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5181'lazyredraw' 'lz' boolean (default off)
5182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 When this option is set, the screen will not be redrawn while
5184 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005185 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005187 This may occasionally cause display errors. It is only meant to be set
5188 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005189 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190
5191 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5192'linebreak' 'lbr' boolean (default off)
5193 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005194 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005196 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 than at the last character that fits on the screen. Unlike
5198 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005199 it only affects the way the file is displayed, not its contents.
5200 If 'breakindent' is set, line is visually indented. Then, the value
5201 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005202 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 Note that <Tab> characters after an <EOL> are mostly not displayed
5204 with the right amount of white space.
5205
5206 *'lines'* *E593*
5207'lines' number (default 24 or terminal height)
5208 global
5209 Number of lines of the Vim window.
5210 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005211 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 When Vim is running in the GUI or in a resizable window, setting this
5213 option will cause the window size to be changed. When you only want
5214 to use the size for the GUI, put the command in your |gvimrc| file.
5215 Vim limits the number of lines to what fits on the screen. You can
5216 use this command to get the tallest window possible: >
5217 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005218< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005219 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 When you set this option and Vim is unable to change the physical
5221 number of lines of the display, the display may be messed up.
5222
5223 *'linespace'* *'lsp'*
5224'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {only in the GUI}
5227 Number of pixel lines inserted between characters. Useful if the font
5228 uses the full character cell height, making lines touch each other.
5229 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005230 With some fonts there can be too much room between lines (to have
5231 space for ascents and descents). Then it makes sense to set
5232 'linespace' to a negative value. This may cause display problems
5233 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234
5235 *'lisp'* *'nolisp'*
5236'lisp' boolean (default off)
5237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 Lisp mode: When <Enter> is typed in insert mode set the indent for
5239 the next line to Lisp standards (well, sort of). Also happens with
5240 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5241 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5242 better. Also see 'lispwords'.
5243 The '-' character is included in keyword characters. Redefines the
5244 "=" operator to use this same indentation algorithm rather than
5245 calling an external program if 'equalprg' is empty.
5246 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005248 *'lispoptions'* *'lop'*
5249'lispoptions' 'lop' string (default "")
5250 local to buffer
5251 Comma-separated list of items that influence the Lisp indenting when
5252 enabled with the |'lisp'| option. Currently only one item is
5253 supported:
5254 expr:1 use 'indentexpr' for Lisp indenting when it is set
5255 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5256 Note that when using 'indentexpr' the `=` operator indents all the
5257 lines, otherwise the first line is not indented (Vi-compatible).
5258
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 *'lispwords'* *'lw'*
5260'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005261 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005262 Comma-separated list of words that influence the Lisp indenting when
5263 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
5265 *'list'* *'nolist'*
5266'list' boolean (default off)
5267 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005268 List mode: By default show tabs as CTRL-I is displayed, display $
5269 after end of line. Useful to see the difference between tabs and
5270 spaces and for trailing blanks. Further changed by the 'listchars'
5271 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005272
5273 The cursor is displayed at the start of the space a Tab character
5274 occupies, not at the end as usual in Normal mode. To get this cursor
5275 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005276 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005277<
5278 Note that list mode will also affect formatting (set with 'textwidth'
5279 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 changing the way tabs are displayed.
5281
5282 *'listchars'* *'lcs'*
5283'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005284 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005285 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005286 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005287 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 eol:c Character to show at the end of each line. When
5289 omitted, there is no extra character at the end of the
5290 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005291 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005292 tab:xy[z] Two or three characters to be used to show a tab.
5293 The third character is optional.
5294
5295 tab:xy The 'x' is always used, then 'y' as many times as will
5296 fit. Thus "tab:>-" displays:
5297 >
5298 >-
5299 >--
5300 etc.
5301
5302 tab:xyz The 'z' is always used, then 'x' is prepended, and
5303 then 'y' is used as many times as will fit. Thus
5304 "tab:<->" displays:
5305 >
5306 <>
5307 <->
5308 <-->
5309 etc.
5310
5311 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005312 *lcs-space*
5313 space:c Character to show for a space. When omitted, spaces
5314 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005315 *lcs-multispace*
5316 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005317 One or more characters to use cyclically to show for
5318 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005319 setting, except for single spaces. When omitted, the
5320 "space" setting is used. For example,
5321 `:set listchars=multispace:---+` shows ten consecutive
5322 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005323 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005324 *lcs-lead*
5325 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005326 leading spaces are blank. Overrides the "space" and
5327 "multispace" settings for leading spaces. You can
5328 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005329 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005330< *lcs-leadmultispace*
5331 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005332 Like the |lcs-multispace| value, but for leading
5333 spaces only. Also overrides |lcs-lead| for leading
5334 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005335 `:set listchars=leadmultispace:---+` shows ten
5336 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005337 ---+---+--XXX ~
5338 Where "XXX" denotes the first non-blank characters in
5339 the line.
5340 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005341 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005342 trailing spaces are blank. Overrides the "space" and
5343 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005344 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 extends:c Character to show in the last column, when 'wrap' is
5346 off and the line continues beyond the right of the
5347 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005348 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005349 precedes:c Character to show in the first visible column of the
5350 physical line, when there is text preceding the
5351 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005352 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005353 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005354 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005355 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005356 nbsp:c Character to show for a non-breakable space character
5357 (0xA0 (160 decimal) and U+202F). Left blank when
5358 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005360 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005362 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005364 Each character can be specified as hex: >
5365 set listchars=eol:\\x24
5366 set listchars=eol:\\u21b5
5367 set listchars=eol:\\U000021b5
5368< Note that a double backslash is used. The number of hex characters
5369 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5370
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 Examples: >
5372 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005373 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 :set lcs=extends:>,precedes:<
5375< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005376 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5377 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005378 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5381'loadplugins' 'lpl' boolean (default on)
5382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 When on the plugin scripts are loaded when starting up |load-plugins|.
5384 This option can be reset in your |vimrc| file to disable the loading
5385 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005386 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5387 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388
Bram Moolenaard94464e2015-11-02 15:28:18 +01005389 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005390'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005391 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005392 {only available when compiled with the |+lua/dyn|
5393 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005394 Specifies the name of the Lua shared library. The default is
5395 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005396 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005397 This option cannot be set from a |modeline| or in the |sandbox|, for
5398 security reasons.
5399
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005400 *'macatsui'* *'nomacatsui'*
5401'macatsui' boolean (default on)
5402 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005403 {not supported}
5404 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005405
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 *'magic'* *'nomagic'*
5407'magic' boolean (default on)
5408 global
5409 Changes the special characters that can be used in search patterns.
5410 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005411 WARNING: Switching this option off most likely breaks plugins! That
5412 is because many patterns assume it's on and will fail when it's off.
5413 Only switch it off when working with old Vi scripts. In any other
5414 situation write patterns that work when 'magic' is on. Include "\M"
5415 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005416 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5417 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418
5419 *'makeef'* *'mef'*
5420'makeef' 'mef' string (default: "")
5421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 {not available when compiled without the |+quickfix|
5423 feature}
5424 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5425 and the |:grep| command.
5426 When it is empty, an internally generated temp file will be used.
5427 When "##" is included, it is replaced by a number to make the name
5428 unique. This makes sure that the ":make" command doesn't overwrite an
5429 existing file.
5430 NOT used for the ":cf" command. See 'errorfile' for that.
5431 Environment variables are expanded |:set_env|.
5432 See |option-backslash| about including spaces and backslashes.
5433 This option cannot be set from a |modeline| or in the |sandbox|, for
5434 security reasons.
5435
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005436 *'makeencoding'* *'menc'*
5437'makeencoding' 'menc' string (default "")
5438 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005439 Encoding used for reading the output of external commands. When empty,
5440 encoding is not converted.
5441 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5442 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5443 and `:laddfile`.
5444
5445 This would be mostly useful when you use MS-Windows and set 'encoding'
5446 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5447 'makeencoding' to "char" has the same effect as setting to the system
5448 locale encoding. Example: >
5449 :set encoding=utf-8
5450 :set makeencoding=char " system locale is used
5451<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 *'makeprg'* *'mp'*
5453'makeprg' 'mp' string (default "make", VMS: "MMS")
5454 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005455 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005456 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5457 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005458 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005459 Environment variables are expanded |:set_env|. See |option-backslash|
5460 about including spaces and backslashes.
5461 Note that a '|' must be escaped twice: once for ":set" and once for
5462 the interpretation of a command. When you use a filter called
5463 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 :set makeprg=gmake\ \\\|\ myfilter
5465< The placeholder "$*" can be given (even multiple times) to specify
5466 where the arguments will be included, for example: >
5467 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5468< This option cannot be set from a |modeline| or in the |sandbox|, for
5469 security reasons.
5470
5471 *'matchpairs'* *'mps'*
5472'matchpairs' 'mps' string (default "(:),{:},[:]")
5473 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005475 other.
5476 Only character pairs are allowed that are different, thus you cannot
5477 jump between two double quotes.
5478 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005479 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005480 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 :set mps+=<:>
5482
5483< A more exotic example, to jump between the '=' and ';' in an
5484 assignment, useful for languages like C and Java: >
5485 :au FileType c,cpp,java set mps+==:;
5486
5487< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005488 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489
5490 *'matchtime'* *'mat'*
5491'matchtime' 'mat' number (default 5)
5492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 Tenths of a second to show the matching paren, when 'showmatch' is
5494 set. Note that this is not in milliseconds, like other options that
5495 set a time. This is to be compatible with Nvi.
5496
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005497 *'maxcombine'* *'mco'*
5498'maxcombine' 'mco' number (default 2)
5499 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005500 The maximum number of combining characters supported for displaying.
5501 Only used when 'encoding' is "utf-8".
5502 The default is OK for most languages. Hebrew may require 4.
5503 Maximum value is 6.
5504 Even when this option is set to 2 you can still edit text with more
5505 combining characters, you just can't see them. Use |g8| or |ga|.
5506 See |mbyte-combining|.
5507
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 *'maxfuncdepth'* *'mfd'*
5509'maxfuncdepth' 'mfd' number (default 100)
5510 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005511 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005512 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 Maximum depth of function calls for user functions. This normally
5514 catches endless recursion. When using a recursive function with
5515 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5516 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005517 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005518 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005520 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521
5522 *'maxmapdepth'* *'mmd'* *E223*
5523'maxmapdepth' 'mmd' number (default 1000)
5524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 Maximum number of times a mapping is done without resulting in a
5526 character to be used. This normally catches endless mappings, like
5527 ":map x y" with ":map y x". It still does not catch ":map g wg",
5528 because the 'w' is used before the next mapping is done. See also
5529 |key-mapping|.
5530
5531 *'maxmem'* *'mm'*
5532'maxmem' 'mm' number (default between 256 to 5120 (system
5533 dependent) or half the amount of memory
5534 available)
5535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5537 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005538 other memory to be freed.
5539 The maximum usable value is about 2000000. Use this to work without a
5540 limit.
5541 The value is ignored when 'swapfile' is off.
5542 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005544 *'maxmempattern'* *'mmp'*
5545'maxmempattern' 'mmp' number (default 1000)
5546 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005547 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005548 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005549 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005550 When Vim runs into the limit it gives an error message and mostly
5551 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005552 Running into the limit often means that the pattern is very
5553 inefficient or too complex. This may already happen with the pattern
5554 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005555 Might also happen on redraw, when syntax rules try to match a complex
5556 text structure.
5557 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5558 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005559
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 *'maxmemtot'* *'mmt'*
5561'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5562 dependent) or half the amount of memory
5563 available)
5564 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005565 Maximum amount of memory in Kbyte to use for all buffers together.
5566 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005567 without a limit.
5568 On 64 bit machines higher values might work. But hey, do you really
5569 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005570 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005571 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005572 Buffers with 'swapfile' off still count to the total amount of memory
5573 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005574 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575
5576 *'menuitems'* *'mis'*
5577'menuitems' 'mis' number (default 25)
5578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 {not available when compiled without the |+menu|
5580 feature}
5581 Maximum number of items to use in a menu. Used for menus that are
5582 generated from a list of items, e.g., the Buffers menu. Changing this
5583 option has no direct effect, the menu must be refreshed first.
5584
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005585 *'mkspellmem'* *'msm'*
5586'mkspellmem' 'msm' string (default "460000,2000,500")
5587 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005588 {not available when compiled without the |+syntax|
5589 feature}
5590 Parameters for |:mkspell|. This tunes when to start compressing the
5591 word tree. Compression can be slow when there are many words, but
5592 it's needed to avoid running out of memory. The amount of memory used
5593 per word depends very much on how similar the words are, that's why
5594 this tuning is complicated.
5595
5596 There are three numbers, separated by commas:
5597 {start},{inc},{added}
5598
5599 For most languages the uncompressed word tree fits in memory. {start}
5600 gives the amount of memory in Kbyte that can be used before any
5601 compression is done. It should be a bit smaller than the amount of
5602 memory that is available to Vim.
5603
5604 When going over the {start} limit the {inc} number specifies the
5605 amount of memory in Kbyte that can be allocated before another
5606 compression is done. A low number means compression is done after
5607 less words are added, which is slow. A high number means more memory
5608 will be allocated.
5609
5610 After doing compression, {added} times 1024 words can be added before
5611 the {inc} limit is ignored and compression is done when any extra
5612 amount of memory is needed. A low number means there is a smaller
5613 chance of hitting the {inc} limit, less memory is used but it's
5614 slower.
5615
5616 The languages for which these numbers are important are Italian and
5617 Hungarian. The default works for when you have about 512 Mbyte. If
5618 you have 1 Gbyte you could use: >
5619 :set mkspellmem=900000,3000,800
5620< If you have less than 512 Mbyte |:mkspell| may fail for some
5621 languages, no matter what you set 'mkspellmem' to.
5622
dkearns8ebdbc92023-10-29 06:26:19 +11005623 This option cannot be set from a |modeline| or in the |sandbox|, for
5624 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005625
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005627'modeline' 'ml' boolean (Vim default: on (off for root),
5628 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005630 If 'modeline' is on 'modelines' gives the number of lines that is
5631 checked for set commands. If 'modeline' is off or 'modelines' is zero
5632 no lines are checked. See |modeline|.
5633
5634 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5635'modelineexpr' 'mle' boolean (default: off)
5636 global
5637 When on allow some options that are an expression to be set in the
5638 modeline. Check the option for whether it is affected by
5639 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005640 This option cannot be set from a |modeline| or in the |sandbox|, for
5641 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005642
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 *'modelines'* *'mls'*
5644'modelines' 'mls' number (default 5)
5645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 If 'modeline' is on 'modelines' gives the number of lines that is
5647 checked for set commands. If 'modeline' is off or 'modelines' is zero
5648 no lines are checked. See |modeline|.
5649 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5650 set and to the Vim default value when 'compatible' is reset.
5651
5652 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005653 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654'modifiable' 'ma' boolean (default on)
5655 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 When off the buffer contents cannot be changed. The 'fileformat' and
5657 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005658 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659
5660 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5661'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005662 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 When on, the buffer is considered to be modified. This option is set
5664 when:
5665 1. A change was made to the text since it was last written. Using the
5666 |undo| command to go back to the original text will reset the
5667 option. But undoing changes that were made before writing the
5668 buffer will set the option again, since the text is different from
5669 when it was written.
5670 2. 'fileformat' or 'fileencoding' is different from its original
5671 value. The original value is set when the buffer is read or
5672 written. A ":set nomodified" command also resets the original
5673 values to the current values and the 'modified' option will be
5674 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005675 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005676 This option is not set when a change is made to the buffer as the
5677 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5678 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5679 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5681 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005682 Note that the text may actually be the same, e.g. 'modified' is set
5683 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684
5685 *'more'* *'nomore'*
5686'more' boolean (Vim default: on, Vi default: off)
5687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 When on, listings pause when the whole screen is filled. You will get
5689 the |more-prompt|. When this option is off there are no pauses, the
5690 listing continues until finished.
5691 NOTE: This option is set to the Vi default value when 'compatible' is
5692 set and to the Vim default value when 'compatible' is reset.
5693
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005694 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005695'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005696 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005698 Enable the use of the mouse. Works for most terminals (xterm, Win32
5699 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5700 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5701 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005702 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 v Visual mode
5704 i Insert mode
5705 c Command-line mode
5706 h all previous modes when editing a help file
5707 a all previous modes
5708 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005709 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005711< If your terminal can't overrule the mouse events going to the
5712 application, use: >
5713 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005714< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005715 back to Vim using the mouse events.
5716 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5717 "xterm".
5718
5719 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 modeless selection. This doesn't move the text cursor.
5721
5722 See |mouse-using|. Also see |'clipboard'|.
5723
5724 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005725 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 the mouse buttons can still be used by keeping the shift key pressed.
5727 Also see the 'clipboard' option.
5728
5729 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5730'mousefocus' 'mousef' boolean (default off)
5731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 {only works in the GUI}
5733 The window that the mouse pointer is on is automatically activated.
5734 When changing the window layout or window focus in another way, the
5735 mouse pointer is moved to the window with keyboard focus. Off is the
5736 default because it makes using the pull down menus a little goofy, as
5737 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005738 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005739 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740
5741 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5742'mousehide' 'mh' boolean (default on)
5743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 {only works in the GUI}
5745 When on, the mouse pointer is hidden when characters are typed.
5746 The mouse pointer is restored when the mouse is moved.
5747
5748 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005749'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 Sets the model to use for the mouse. The name mostly specifies what
5752 the right mouse button is used for:
5753 extend Right mouse button extends a selection. This works
5754 like in an xterm.
5755 popup Right mouse button pops up a menu. The shifted left
5756 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005757 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 popup_setpos Like "popup", but the cursor will be moved to the
5759 position where the mouse was clicked, and thus the
5760 selected operation will act upon the clicked object.
5761 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005762 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 course, that right clicking outside a selection will
5764 end Visual mode.
5765 Overview of what button does what for each model:
5766 mouse extend popup(_setpos) ~
5767 left click place cursor place cursor
5768 left drag start selection start selection
5769 shift-left search word extend selection
5770 right click extend selection popup menu (place cursor)
5771 right drag extend selection -
5772 middle click paste paste
5773
5774 In the "popup" model the right mouse button produces a pop-up menu.
5775 You need to define this first, see |popup-menu|.
5776
5777 Note that you can further refine the meaning of buttons with mappings.
5778 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5779 selection (because that's handled in the GUI code directly).
5780
5781 The 'mousemodel' option is set by the |:behave| command.
5782
h_east59858792023-10-25 22:47:05 +09005783 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005784'mousemoveevent' 'mousemev' boolean (default off)
5785 global
5786 {only works in the GUI}
5787 When on, mouse move events are delivered to the input queue and are
5788 available for mapping. The default, off, avoids the mouse movement
5789 overhead except when needed. See |gui-mouse-mapping|.
5790 Warning: Setting this option can make pending mappings to be aborted
5791 when the mouse is moved.
5792 Currently only works in the GUI, may be made to work in a terminal
5793 later.
5794
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005796'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5797 vs:leftright,vd:lrsizing,m:no,
5798 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 {only available when compiled with the |+mouseshape|
5801 feature}
5802 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005803 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 like used for 'guicursor'. Each part consist of a mode/location-list
5805 and an argument-list:
5806 mode-list:shape,mode-list:shape,..
5807 The mode-list is a dash separated list of these modes/locations:
5808 In a normal window: ~
5809 n Normal mode
5810 v Visual mode
5811 ve Visual mode with 'selection' "exclusive" (same as 'v',
5812 if not specified)
5813 o Operator-pending mode
5814 i Insert mode
5815 r Replace mode
5816
5817 Others: ~
5818 c appending to the command-line
5819 ci inserting in the command-line
5820 cr replacing in the command-line
5821 m at the 'Hit ENTER' or 'More' prompts
5822 ml idem, but cursor in the last line
5823 e any mode, pointer below last window
5824 s any mode, pointer on a status line
5825 sd any mode, while dragging a status line
5826 vs any mode, pointer on a vertical separator line
5827 vd any mode, while dragging a vertical separator line
5828 a everywhere
5829
5830 The shape is one of the following:
5831 avail name looks like ~
5832 w x arrow Normal mouse pointer
5833 w x blank no pointer at all (use with care!)
5834 w x beam I-beam
5835 w x updown up-down sizing arrows
5836 w x leftright left-right sizing arrows
5837 w x busy The system's usual busy pointer
5838 w x no The system's usual 'no input' pointer
5839 x udsizing indicates up-down resizing
5840 x lrsizing indicates left-right resizing
5841 x crosshair like a big thin +
5842 x hand1 black hand
5843 x hand2 white hand
5844 x pencil what you write with
5845 x question big ?
5846 x rightup-arrow arrow pointing right-up
5847 w x up-arrow arrow pointing up
5848 x <number> any X11 pointer number (see X11/cursorfont.h)
5849
5850 The "avail" column contains a 'w' if the shape is available for Win32,
5851 x for X11.
5852 Any modes not specified or shapes not available use the normal mouse
5853 pointer.
5854
5855 Example: >
5856 :set mouseshape=s:udsizing,m:no
5857< will make the mouse turn to a sizing arrow over the status lines and
5858 indicate no input when the hit-enter prompt is displayed (since
5859 clicking the mouse has no effect in this state.)
5860
5861 *'mousetime'* *'mouset'*
5862'mousetime' 'mouset' number (default 500)
5863 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005864 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 time in msec between two mouse clicks for the second click to be
5866 recognized as a multi click.
5867
laburnumT3f7855a2023-12-05 18:37:03 +01005868 *'mzquantum'* *'mzq'*
5869'mzquantum' 'mzq' number (default 100)
5870 global
5871 {not available when compiled without the |+mzscheme|
5872 feature}
5873 The number of milliseconds between polls for MzScheme threads.
5874 Negative or zero value means no thread scheduling.
5875 NOTE: This option is set to the Vim default value when 'compatible'
5876 is reset.
5877
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005878 *'mzschemedll'*
5879'mzschemedll' string (default depends on the build)
5880 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005881 {only available when compiled with the |+mzscheme/dyn|
5882 feature}
5883 Specifies the name of the MzScheme shared library. The default is
5884 DYNAMIC_MZSCH_DLL which was specified at compile time.
5885 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005886 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005887 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005888 This option cannot be set from a |modeline| or in the |sandbox|, for
5889 security reasons.
5890
5891 *'mzschemegcdll'*
5892'mzschemegcdll' string (default depends on the build)
5893 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005894 {only available when compiled with the |+mzscheme/dyn|
5895 feature}
5896 Specifies the name of the MzScheme GC shared library. The default is
5897 DYNAMIC_MZGC_DLL which was specified at compile time.
5898 The value can be equal to 'mzschemedll' if it includes the GC code.
5899 Environment variables are expanded |:set_env|.
5900 This option cannot be set from a |modeline| or in the |sandbox|, for
5901 security reasons.
5902
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005904'nrformats' 'nf' string (default "bin,octal,hex",
5905 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 This defines what bases Vim will consider for numbers when using the
5908 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5909 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005910 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005912 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005913 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005915 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 considered to be hexadecimal. Example: Using CTRL-X on
5917 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005918 bin If included, numbers starting with "0b" or "0B" will be
5919 considered to be binary. Example: Using CTRL-X on
5920 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005921 unsigned If included, numbers are recognized as unsigned. Thus a
5922 leading dash or negative sign won't be considered as part of
5923 the number. Examples:
5924 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5925 (without "unsigned" it would become "9-2021").
5926 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5927 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005928 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5929 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005930 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02005931 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02005932 dash immediately preceded by a non-whitespace character (i.e.,
5933 not a tab or a " "), the negative sign won't be considered as
5934 part of the number. For example:
5935 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5936 (without "blank" it would become "Carbon-13").
5937 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02005938 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02005939 set, it would result in "Carbon -7").
5940 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02005941 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02005942 included, "unsigned" will take precedence.
5943
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 Numbers which simply begin with a digit in the range 1-9 are always
5945 considered decimal. This also happens for numbers that are not
5946 recognized as octal or hex.
5947
5948 *'number'* *'nu'* *'nonumber'* *'nonu'*
5949'number' 'nu' boolean (default off)
5950 local to window
5951 Print the line number in front of each line. When the 'n' option is
5952 excluded from 'cpoptions' a wrapped line will not use the column of
5953 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005954 The 'numberwidth' option can be used to set the room used for the line
5955 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956 When a long, wrapped line doesn't start with the first character, '-'
5957 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005958 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5959 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005960 *number_relativenumber*
5961 The 'relativenumber' option changes the displayed number to be
5962 relative to the cursor. Together with 'number' there are these
5963 four combinations (cursor in line 3):
5964
Bram Moolenaar3848e002016-03-19 18:42:29 +01005965 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005966 'nornu' 'nornu' 'rnu' 'rnu'
5967
5968 |apple | 1 apple | 2 apple | 2 apple
5969 |pear | 2 pear | 1 pear | 1 pear
5970 |nobody | 3 nobody | 0 nobody |3 nobody
5971 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005973 *'numberwidth'* *'nuw'*
5974'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5975 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005976 {only available when compiled with the |+linebreak|
5977 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005978 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005979 when the 'number' or 'relativenumber' option is set or printing lines
5980 with a line number. Since one space is always between the number and
5981 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005982 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005983 fit the highest line number in the buffer respectively the number of
5984 rows in the window, depending on whether 'number' or 'relativenumber'
5985 is set. Thus with the Vim default of 4 there is room for a line number
5986 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005987 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005988 NOTE: This option is set to the Vi default value when 'compatible' is
5989 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005990
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005991 *'omnifunc'* *'ofu'*
5992'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005993 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005994 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005995 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005996 This option specifies a function to be used for Insert mode omni
5997 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005998 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005999 invoked and what it should return. The value can be the name of a
6000 function, a |lambda| or a |Funcref|. See |option-value-function| for
6001 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006002 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006003 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006004 This option cannot be set from a |modeline| or in the |sandbox|, for
6005 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006006
Bram Moolenaar02467872007-05-06 13:22:01 +00006007 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006008'opendevice' 'odev' boolean (default off)
6009 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006010 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006011 Enable reading and writing from devices. This may get Vim stuck on a
6012 device that can be opened but doesn't actually do the I/O. Therefore
6013 it is off by default.
6014 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6015 result in editing a device.
6016
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006017 *'operatorfunc'* *'opfunc'*
6018'operatorfunc' 'opfunc' string (default: empty)
6019 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006020 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006021 See |:map-operator| for more info and an example. The value can be
6022 the name of a function, a |lambda| or a |Funcref|. See
6023 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006024
6025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
6027
Bram Moolenaar251e1912011-06-19 05:09:16 +02006028 *'osfiletype'* *'oft'*
6029'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006031 This option was supported on RISC OS, which has been removed.
6032
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006033 *'packpath'* *'pp'*
6034'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006035 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006036 This option cannot be set from a |modeline| or in the |sandbox|, for
6037 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006038
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006040'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 global
6042 Specifies the nroff macros that separate paragraphs. These are pairs
6043 of two letters (see |object-motions|).
6044
6045 *'paste'* *'nopaste'*
6046'paste' boolean (default off)
6047 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006048 Put Vim in Paste mode. This is useful if you want to cut or copy
6049 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 unexpected effects.
6051 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006052 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 knows about pasting and will mostly do the right thing without 'paste'
6054 being set. The same is true for a terminal where Vim handles the
6055 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006056 This option is reset when starting the GUI. Thus if you set it in
6057 your .vimrc it will work in a terminal, but not in the GUI. Setting
6058 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6059 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 When the 'paste' option is switched on (also when it was already on):
6061 - mapping in Insert mode and Command-line mode is disabled
6062 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006064 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006065 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 - 'revins' is reset
6067 - 'ruler' is reset
6068 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006069 - 'smarttab' is reset
6070 - 'softtabstop' is set to 0
6071 - 'textwidth' is set to 0
6072 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006073 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006076 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006077 - 'indentexpr'
6078 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006079 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 NOTE: When you start editing another file while the 'paste' option is
6081 on, settings from the modelines or autocommands may change the
6082 settings again, causing trouble when pasting text. You might want to
6083 set the 'paste' option again.
6084 When the 'paste' option is reset the mentioned options are restored to
6085 the value before the moment 'paste' was switched from off to on.
6086 Resetting 'paste' before ever setting it does not have any effect.
6087 Since mapping doesn't work while 'paste' is active, you need to use
6088 the 'pastetoggle' option to toggle the 'paste' option with some key.
6089
6090 *'pastetoggle'* *'pt'*
6091'pastetoggle' 'pt' string (default "")
6092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 When non-empty, specifies the key sequence that toggles the 'paste'
6094 option. This is like specifying a mapping: >
6095 :map {keys} :set invpaste<CR>
6096< Where {keys} is the value of 'pastetoggle'.
6097 The difference is that it will work even when 'paste' is set.
6098 'pastetoggle' works in Insert mode and Normal mode, but not in
6099 Command-line mode.
6100 Mappings are checked first, thus overrule 'pastetoggle'. However,
6101 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6102 this: >
6103 :map <F10> :set paste<CR>
6104 :map <F11> :set nopaste<CR>
6105 :imap <F10> <C-O>:set paste<CR>
6106 :imap <F11> <nop>
6107 :set pastetoggle=<F11>
6108< This will make <F10> start paste mode and <F11> stop paste mode.
6109 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6110 mode everything is inserted literally, except the 'pastetoggle' key
6111 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006112 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113
6114 *'pex'* *'patchexpr'*
6115'patchexpr' 'pex' string (default "")
6116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 {not available when compiled without the |+diff|
6118 feature}
6119 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006120 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006121 This option cannot be set from a |modeline| or in the |sandbox|, for
6122 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123
Bram Moolenaardbc28022014-07-26 13:40:44 +02006124 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125'patchmode' 'pm' string (default "")
6126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 When non-empty the oldest version of a file is kept. This can be used
6128 to keep the original version of a file if you are changing files in a
6129 source distribution. Only the first time that a file is written a
6130 copy of the original file will be kept. The name of the copy is the
6131 name of the original file with the string in the 'patchmode' option
6132 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006133 ".orig" or ".org". 'backupdir' must not be empty for this to work
6134 (Detail: The backup file is renamed to the patchmode file after the
6135 new file has been successfully written, that's why it must be possible
6136 to write a backup file). If there was no file to be backed up, an
6137 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 When the 'backupskip' pattern matches, a patchmode file is not made.
6139 Using 'patchmode' for compressed files appends the extension at the
6140 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6141 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006142 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006144 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 other systems: ".,,")
6147 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006149 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6150 provided that the file being searched for has a relative path (not
6151 starting with "/", "./" or "../"). The directories in the 'path'
6152 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 - Use commas to separate directory names: >
6154 :set path=.,/usr/local/include,/usr/include
6155< - Spaces can also be used to separate directory names (for backwards
6156 compatibility with version 3.0). To have a space in a directory
6157 name, precede it with an extra backslash, and escape the space: >
6158 :set path=.,/dir/with\\\ space
6159< - To include a comma in a directory name precede it with an extra
6160 backslash: >
6161 :set path=.,/dir/with\\,comma
6162< - To search relative to the directory of the current file, use: >
6163 :set path=.
6164< - To search in the current directory use an empty string between two
6165 commas: >
6166 :set path=,,
6167< - A directory name may end in a ':' or '/'.
6168 - Environment variables are expanded |:set_env|.
6169 - When using |netrw.vim| URLs can be used. For example, adding
6170 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006171 - Search upwards and downwards in a directory tree using "*", "**" and
6172 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 - Careful with '\' characters, type two to get one in the option: >
6174 :set path=.,c:\\include
6175< Or just use '/' instead: >
6176 :set path=.,c:/include
6177< Don't forget "." or files won't even be found in the same directory as
6178 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006179 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 it is something like 256 or 1024 characters.
6181 You can check if all the include files are found, using the value of
6182 'path', see |:checkpath|.
6183 The use of |:set+=| and |:set-=| is preferred when adding or removing
6184 directories from the list. This avoids problems when a future version
6185 uses another default. To remove the current directory use: >
6186 :set path-=
6187< To add the current directory use: >
6188 :set path+=
6189< To use an environment variable, you probably need to replace the
6190 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006191 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006192 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193< Replace the ';' with a ':' or whatever separator is used. Note that
6194 this doesn't work when $INCL contains a comma or white space.
6195
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006196 *'perldll'*
6197'perldll' string (default depends on the build)
6198 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006199 {only available when compiled with the |+perl/dyn|
6200 feature}
6201 Specifies the name of the Perl shared library. The default is
6202 DYNAMIC_PERL_DLL, which was specified at compile time.
6203 Environment variables are expanded |:set_env|.
6204 This option cannot be set from a |modeline| or in the |sandbox|, for
6205 security reasons.
6206
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6208'preserveindent' 'pi' boolean (default off)
6209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 When changing the indent of the current line, preserve as much of the
6211 indent structure as possible. Normally the indent is replaced by a
6212 series of tabs followed by spaces as required (unless |'expandtab'| is
6213 enabled, in which case only spaces are used). Enabling this option
6214 means the indent will preserve as many existing characters as possible
6215 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006216 'expandtab' does not apply to the preserved white space, a Tab remains
6217 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 NOTE: When using ">>" multiple times the resulting indent is a mix of
6219 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006220 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 Also see 'copyindent'.
6222 Use |:retab| to clean up white space.
6223
6224 *'previewheight'* *'pvh'*
6225'previewheight' 'pvh' number (default 12)
6226 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006227 {not available when compiled without the |+quickfix|
6228 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006230 commands. Used for |CTRL-W_}| when no count is given. Not used when
6231 'previewpopup' is set.
6232
6233 *'previewpopup'* *'pvp'*
6234'previewpopup' 'pvp' string (default empty)
6235 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006236 {not available when compiled without the |+textprop|
6237 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006238 When not empty a popup window is used for commands that would open a
6239 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006240 Not used for the insert completion info, add "popup" to
6241 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242
6243 *'previewwindow'* *'nopreviewwindow'*
6244 *'pvw'* *'nopvw'* *E590*
6245'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006246 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006247 {not available when compiled without the |+quickfix|
6248 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006249 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 set. It's normally not set directly, but by using one of the commands
6251 |:ptag|, |:pedit|, etc.
6252
6253 *'printdevice'* *'pdev'*
6254'printdevice' 'pdev' string (default empty)
6255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 {only available when compiled with the |+printer|
6257 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006258 The name of the printer to be used for |:hardcopy|.
6259 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006260 This option cannot be set from a |modeline| or in the |sandbox|, for
6261 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262
Bram Moolenaar8299df92004-07-10 09:47:34 +00006263 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006264'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 {only available when compiled with the |+printer|
6267 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006268 Sets the character encoding used when printing.
6269 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270
6271 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006272'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 {only available when compiled with the |+printer|
6275 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006276 Expression used to print the PostScript produced with |:hardcopy|.
6277 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006278 This option cannot be set from a |modeline| or in the |sandbox|, for
6279 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280
Bram Moolenaar8299df92004-07-10 09:47:34 +00006281 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282'printfont' 'pfn' string (default "courier")
6283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 {only available when compiled with the |+printer|
6285 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006286 The name of the font that will be used for |:hardcopy|.
6287 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288
6289 *'printheader'* *'pheader'*
6290'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 {only available when compiled with the |+printer|
6293 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006294 The format of the header produced in |:hardcopy| output.
6295 See |pheader-option|.
6296
6297 *'printmbcharset'* *'pmbcs'*
6298'printmbcharset' 'pmbcs' string (default "")
6299 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006300 {only available when compiled with the |+printer|
6301 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006302 The CJK character set to be used for CJK output from |:hardcopy|.
6303 See |pmbcs-option|.
6304
6305 *'printmbfont'* *'pmbfn'*
6306'printmbfont' 'pmbfn' string (default "")
6307 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006308 {only available when compiled with the |+printer|
6309 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006310 List of font names to be used for CJK output from |:hardcopy|.
6311 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312
6313 *'printoptions'* *'popt'*
6314'printoptions' 'popt' string (default "")
6315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006317 List of items that control the format of the output of |:hardcopy|.
6318 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006320 *'prompt'* *'noprompt'*
6321'prompt' boolean (default on)
6322 global
6323 When on a ":" prompt is used in Ex mode.
6324
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006325 *'pumheight'* *'ph'*
6326'pumheight' 'ph' number (default 0)
6327 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006328 Determines the maximum number of items to show in the popup menu for
6329 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006330 |ins-completion-menu|.
6331
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006332 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006333'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006334 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006335 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006336 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006337
Bram Moolenaard94464e2015-11-02 15:28:18 +01006338 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006339'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006340 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006341 {only available when compiled with the |+python/dyn|
6342 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006343 Specifies the name of the Python 2.x shared library. The default is
6344 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006345 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006346 This option cannot be set from a |modeline| or in the |sandbox|, for
6347 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006348
Bram Moolenaar94073162018-01-31 21:49:05 +01006349 *'pythonhome'*
6350'pythonhome' string (default "")
6351 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006352 {only available when compiled with the |+python/dyn|
6353 feature}
6354 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6355 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6356 which was specified at compile time, will be used for the Python 2.x
6357 home directory.
6358 Environment variables are expanded |:set_env|.
6359 This option cannot be set from a |modeline| or in the |sandbox|, for
6360 security reasons.
6361
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006362 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006363'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006364 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006365 {only available when compiled with the |+python3/dyn|
6366 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006367 Specifies the name of the Python 3 shared library. The default is
6368 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006369 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006370 This option cannot be set from a |modeline| or in the |sandbox|, for
6371 security reasons.
6372
Bram Moolenaar94073162018-01-31 21:49:05 +01006373 *'pythonthreehome'*
6374'pythonthreehome' string (default "")
6375 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006376 {only available when compiled with the |+python3/dyn|
6377 feature}
6378 Specifies the name of the Python 3 home directory. When
6379 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6380 PYTHON3_HOME, which was specified at compile time, will be used for
6381 the Python 3 home directory.
6382 Environment variables are expanded |:set_env|.
6383 This option cannot be set from a |modeline| or in the |sandbox|, for
6384 security reasons.
6385
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006386 *'pyxversion'* *'pyx'*
6387'pyxversion' 'pyx' number (default depends on the build)
6388 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006389 {only available when compiled with the |+python| or
6390 the |+python3| feature}
6391 Specifies the python version used for pyx* functions and commands
6392 |python_x|. The default value is as follows:
6393
6394 Compiled with Default ~
6395 |+python| and |+python3| 0
6396 only |+python| 2
6397 only |+python3| 3
6398
6399 Available values are 0, 2 and 3.
6400 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6401 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6402 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6403 to 2 if Python 2 is available.
6404 See also: |has-pythonx|
6405
6406 If Vim is compiled with only |+python| or |+python3| setting
6407 'pyxversion' has no effect. The pyx* functions and commands are
6408 always the same as the compiled version.
6409
6410 This option cannot be set from a |modeline| or in the |sandbox|, for
6411 security reasons.
6412
Bram Moolenaar858ba062020-05-31 23:11:59 +02006413 *'quickfixtextfunc'* *'qftf'*
6414'quickfixtextfunc' 'qftf' string (default "")
6415 global
6416 {only available when compiled with the |+quickfix|
6417 feature}
6418 This option specifies a function to be used to get the text to display
6419 in the quickfix and location list windows. This can be used to
6420 customize the information displayed in the quickfix or location window
6421 for each entry in the corresponding quickfix or location list. See
6422 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006423 function and an example. The value can be the name of a function, a
6424 |lambda| or a |Funcref|. See |option-value-function| for more
6425 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006426
6427 This option cannot be set from a |modeline| or in the |sandbox|, for
6428 security reasons.
6429
Bram Moolenaar677ee682005-01-27 14:41:15 +00006430 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006431'quoteescape' 'qe' string (default "\")
6432 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006433 The characters that are used to escape quotes in a string. Used for
6434 objects like a', a" and a` |a'|.
6435 When one of the characters in this option is found inside a string,
6436 the following character will be skipped. The default value makes the
6437 text "foo\"bar\\" considered to be one string.
6438
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6440'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006441 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 If on, writes fail unless you use a '!'. Protects you from
6443 accidentally overwriting a file. Default on when Vim is started
6444 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006445 When using ":w!" the 'readonly' option is reset for the current
6446 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006447 When using the ":view" command the 'readonly' option is set for the
6448 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006449 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006451 *'redrawtime'* *'rdt'*
6452'redrawtime' 'rdt' number (default 2000)
6453 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006454 {only available when compiled with the |+reltime|
6455 feature}
6456 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006457 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006458 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006459 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006460 matches will be highlighted.
6461 For syntax highlighting the time applies per window. When over the
6462 limit syntax highlighting is disabled until |CTRL-L| is used.
6463 This is used to avoid that Vim hangs when using a very complicated
6464 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006465
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006466 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006467'regexpengine' 're' number (default 0)
6468 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006469 This selects the default regexp engine. |two-engines|
6470 The possible values are:
6471 0 automatic selection
6472 1 old engine
6473 2 NFA engine
6474 Note that when using the NFA engine and the pattern contains something
6475 that is not supported the pattern will not match. This is only useful
6476 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006477 Using automatic selection enables Vim to switch the engine, if the
6478 default engine becomes too costly. E.g., when the NFA engine uses too
6479 many states. This should prevent Vim from hanging on a combination of
6480 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006481
Bram Moolenaar64486672010-05-16 15:46:46 +02006482 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6483'relativenumber' 'rnu' boolean (default off)
6484 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006485 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006486 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006487 precede some vertical motion commands (e.g. j k + -) with, without
6488 having to calculate it yourself. Especially useful in combination with
6489 other commands (e.g. y d c < > gq gw =).
6490 When the 'n' option is excluded from 'cpoptions' a wrapped
6491 line will not use the column of line numbers (this is the default when
6492 'compatible' isn't set).
6493 The 'numberwidth' option can be used to set the room used for the line
6494 number.
6495 When a long, wrapped line doesn't start with the first character, '-'
6496 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006497 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6498 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006499
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006500 The number in front of the cursor line also depends on the value of
6501 'number', see |number_relativenumber| for all combinations of the two
6502 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006503
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 *'remap'* *'noremap'*
6505'remap' boolean (default on)
6506 global
6507 Allows for mappings to work recursively. If you do not want this for
6508 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006509 NOTE: To avoid portability problems with Vim scripts, always keep
6510 this option at the default "on". Only switch it off when working with
6511 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512
zeertzjqd086b8f2024-02-25 15:42:52 +08006513 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006514'renderoptions' 'rop' string (default: empty)
6515 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006516 {only available when compiled with GUI and DIRECTX on
6517 MS-Windows}
6518 Select a text renderer and set its options. The options depend on the
6519 renderer.
6520
6521 Syntax: >
6522 set rop=type:{renderer}(,{name}:{value})*
6523<
6524 Currently, only one optional renderer is available.
6525
6526 render behavior ~
6527 directx Vim will draw text using DirectX (DirectWrite). It makes
6528 drawn glyphs more beautiful than default GDI.
6529 It requires 'encoding' is "utf-8", and only works on
6530 MS-Windows Vista or newer version.
6531
6532 Options:
6533 name meaning type value ~
6534 gamma gamma float 1.0 - 2.2 (maybe)
6535 contrast enhancedContrast float (unknown)
6536 level clearTypeLevel float (unknown)
6537 geom pixelGeometry int 0 - 2 (see below)
6538 renmode renderingMode int 0 - 6 (see below)
6539 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006540 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006541
Bram Moolenaar92467d32017-12-05 13:22:16 +01006542 See this URL for detail (except for scrlines):
6543 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006544
6545 For geom: structure of a device pixel.
6546 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6547 1 - DWRITE_PIXEL_GEOMETRY_RGB
6548 2 - DWRITE_PIXEL_GEOMETRY_BGR
6549
6550 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006551 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006552
6553 For renmode: method of rendering glyphs.
6554 0 - DWRITE_RENDERING_MODE_DEFAULT
6555 1 - DWRITE_RENDERING_MODE_ALIASED
6556 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6557 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6558 4 - DWRITE_RENDERING_MODE_NATURAL
6559 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6560 6 - DWRITE_RENDERING_MODE_OUTLINE
6561
6562 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006563 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006564
6565 For taamode: antialiasing mode used for drawing text.
6566 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6567 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6568 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6569 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6570
6571 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006572 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6573
Bram Moolenaara338adc2018-01-31 20:51:47 +01006574 For scrlines:
6575 This was used for optimizing scrolling behavior, however this
6576 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006577
6578 Example: >
6579 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006580 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006581 set rop=type:directx
6582<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006583 If select a raster font (Courier, Terminal or FixedSys which
6584 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006585 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006586
6587 NOTE: It is known that some fonts and options combination
6588 causes trouble on drawing glyphs.
6589
Bram Moolenaar92467d32017-12-05 13:22:16 +01006590 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006591 special made fonts (True-Type fonts which includes only
6592 bitmap glyphs).
6593 - 'taamode:3' will not work with some vector fonts.
6594
6595 NOTE: With this option, you can display colored emoji
6596 (emoticon) in Windows 8.1 or later. To display colored emoji,
6597 there are some conditions which you should notice.
6598
6599 - If your font includes non-colored emoji already, it will
6600 be used.
6601 - If your font doesn't have emoji, the system chooses an
6602 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6603 will be used.
6604 - When this alternative font didn't have fixed width glyph,
6605 emoji might be rendered beyond the bounding box of drawing
6606 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006607
6608 Other render types are currently not supported.
6609
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 *'report'*
6611'report' number (default 2)
6612 global
6613 Threshold for reporting number of lines changed. When the number of
6614 changed lines is more than 'report' a message will be given for most
6615 ":" commands. If you want it always, set 'report' to 0.
6616 For the ":substitute" command the number of substitutions is used
6617 instead of the number of lines.
6618
6619 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6620'restorescreen' 'rs' boolean (default on)
6621 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006622 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 When set, the screen contents is restored when exiting Vim. This also
6624 happens when executing external commands.
6625
6626 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6627 options in your .vimrc. To disable restoring:
6628 set t_ti= t_te=
6629 To enable restoring (for an xterm):
6630 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6631 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6632
6633 *'revins'* *'ri'* *'norevins'* *'nori'*
6634'revins' 'ri' boolean (default off)
6635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 {only available when compiled with the |+rightleft|
6637 feature}
6638 Inserting characters in Insert mode will work backwards. See "typing
6639 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6640 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006641 NOTE: This option is reset when 'compatible' is set.
6642 This option is reset when 'paste' is set and restored when 'paste' is
6643 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644
6645 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6646'rightleft' 'rl' boolean (default off)
6647 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 {only available when compiled with the |+rightleft|
6649 feature}
6650 When on, display orientation becomes right-to-left, i.e., characters
6651 that are stored in the file appear from the right to the left.
6652 Using this option, it is possible to edit files for languages that
6653 are written from the right to the left such as Hebrew and Arabic.
6654 This option is per window, so it is possible to edit mixed files
6655 simultaneously, or to view the same file in both ways (this is
6656 useful whenever you have a mixed text file with both right-to-left
6657 and left-to-right strings so that both sets are displayed properly
6658 in different windows). Also see |rileft.txt|.
6659
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006660 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661'rightleftcmd' 'rlc' string (default "search")
6662 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 {only available when compiled with the |+rightleft|
6664 feature}
6665 Each word in this option enables the command line editing to work in
6666 right-to-left mode for a group of commands:
6667
6668 search "/" and "?" commands
6669
6670 This is useful for languages such as Hebrew, Arabic and Farsi.
6671 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6672
Bram Moolenaard94464e2015-11-02 15:28:18 +01006673 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006674'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006675 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006676 {only available when compiled with the |+ruby/dyn|
6677 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006678 Specifies the name of the Ruby shared library. The default is
6679 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006680 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006681 This option cannot be set from a |modeline| or in the |sandbox|, for
6682 security reasons.
6683
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006685'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006688 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 text in the file is shown on the far right:
6690 Top first line is visible
6691 Bot last line is visible
6692 All first and last line are visible
6693 45% relative position in the file
6694 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006695 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006696 ruler is shown there. Otherwise it is shown in the last line of the
6697 screen. If the statusline is given by 'statusline' (i.e. not empty),
6698 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006700 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 the text column (byte number) and the screen column are shown,
6702 separated with a dash.
6703 For an empty line "0-1" is shown.
6704 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006705 This option is reset when 'paste' is set and restored when 'paste' is
6706 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 If you don't want to see the ruler all the time but want to know where
6708 you are, use "g CTRL-G" |g_CTRL-G|.
6709 NOTE: This option is reset when 'compatible' is set.
6710
6711 *'rulerformat'* *'ruf'*
6712'rulerformat' 'ruf' string (default empty)
6713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 {not available when compiled without the |+statusline|
6715 feature}
6716 When this option is not empty, it determines the content of the ruler
6717 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006718 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006719 This option cannot be set in a modeline when 'modelineexpr' is off.
6720
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 The default ruler width is 17 characters. To make the ruler 15
6722 characters wide, put "%15(" at the start and "%)" at the end.
6723 Example: >
6724 :set rulerformat=%15(%c%V\ %p%%%)
6725<
6726 *'runtimepath'* *'rtp'* *vimfiles*
6727'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006728 Unix: "$HOME/.vim or
6729 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 $VIM/vimfiles,
6731 $VIMRUNTIME,
6732 $VIM/vimfiles/after,
6733 $HOME/.vim/after"
6734 Amiga: "home:vimfiles,
6735 $VIM/vimfiles,
6736 $VIMRUNTIME,
6737 $VIM/vimfiles/after,
6738 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006739 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 $VIM/vimfiles,
6741 $VIMRUNTIME,
6742 $VIM/vimfiles/after,
6743 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006744 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 $VIMRUNTIME,
6746 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006747 Haiku: "$BE_USER_SETTINGS/vim,
6748 $VIM/vimfiles,
6749 $VIMRUNTIME,
6750 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006751 $BE_USER_SETTINGS/vim/after"
6752 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 $VIM/vimfiles,
6754 $VIMRUNTIME,
6755 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006756 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 This is a list of directories which will be searched for runtime
6759 files:
6760 filetype.vim filetypes by file name |new-filetype|
6761 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006762 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 colors/ color scheme files |:colorscheme|
6764 compiler/ compiler files |:compiler|
6765 doc/ documentation |write-local-help|
6766 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006767 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 indent/ indent scripts |indent-expression|
6769 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006770 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006772 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 plugin/ plugin scripts |write-plugin|
6774 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006775 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 syntax/ syntax files |mysyntaxfile|
6777 tutor/ files for vimtutor |tutor|
6778
6779 And any other file searched for with the |:runtime| command.
6780
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006781 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6782
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 The defaults for most systems are setup to search five locations:
6784 1. In your home directory, for your personal preferences.
6785 2. In a system-wide Vim directory, for preferences from the system
6786 administrator.
6787 3. In $VIMRUNTIME, for files distributed with Vim.
6788 *after-directory*
6789 4. In the "after" directory in the system-wide Vim directory. This is
6790 for the system administrator to overrule or add to the distributed
6791 defaults (rarely needed)
6792 5. In the "after" directory in your home directory. This is for
6793 personal preferences to overrule or add to the distributed defaults
6794 or system-wide settings (rarely needed).
6795
Bram Moolenaard0796902016-09-16 20:02:31 +02006796 More entries are added when using |packages|. If it gets very long
6797 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6798 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006799
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6801 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006802 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 wildcards.
6804 See |:runtime|.
6805 Example: >
6806 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6807< This will use the directory "~/vimruntime" first (containing your
6808 personal Vim runtime files), then "/mygroup/vim" (shared between a
6809 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6810 files).
6811 You probably should always include $VIMRUNTIME somewhere, to use the
6812 distributed runtime files. You can put a directory before $VIMRUNTIME
6813 to find files which replace a distributed runtime files. You can put
6814 a directory after $VIMRUNTIME to find files which add to distributed
6815 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006816 When Vim is started with |--clean| the home directory entries are not
6817 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 This option cannot be set from a |modeline| or in the |sandbox|, for
6819 security reasons.
6820
6821 *'scroll'* *'scr'*
6822'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006823 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6825 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006826 changes. This may happen when enabling the |status-line| or
6827 'tabline' option after setting the 'scroll' option.
6828 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006829 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006830 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6833'scrollbind' 'scb' boolean (default off)
6834 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006835 See also |scroll-binding|. When this option is set, scrolling the
6836 current window also scrolls other scrollbind windows (windows that
6837 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 differences between two versions of a file, see 'diff'.
6839 See |'scrollopt'| for options that determine how this option should be
6840 interpreted.
6841 This option is mostly reset when splitting a window to edit another
6842 file. This means that ":split | edit file" results in two windows
6843 with scroll-binding, but ":split file" does not.
6844
Bram Moolenaarae20f342019-11-05 21:09:23 +01006845 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6846'scrollfocus' 'scf' boolean (default off)
6847 global
6848 {only for MS-Windows GUI}
6849 When using the scroll wheel and this option is set, the window under
6850 the mouse pointer is scrolled. With this option off the current
6851 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006852 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006853
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 *'scrolljump'* *'sj'*
6855'scrolljump' 'sj' number (default 1)
6856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 Minimal number of lines to scroll when the cursor gets off the
6858 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6859 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006860 When set to a negative number from -1 to -100 this is used as the
6861 percentage of the window height. Thus -50 scrolls half the window
6862 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 NOTE: This option is set to 1 when 'compatible' is set.
6864
6865 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006866'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006867 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 Minimal number of screen lines to keep above and below the cursor.
6869 This will make some context visible around where you are working. If
6870 you set it to a very large value (999) the cursor line will always be
6871 in the middle of the window (except at the start or end of the file or
6872 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006873 After using the local value, go back the global value with one of
6874 these two: >
6875 setlocal scrolloff<
6876 setlocal scrolloff=-1
6877< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 NOTE: This option is set to 0 when 'compatible' is set.
6879
6880 *'scrollopt'* *'sbo'*
6881'scrollopt' 'sbo' string (default "ver,jump")
6882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006884 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6885 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 The following words are available:
6887 ver Bind vertical scrolling for 'scrollbind' windows
6888 hor Bind horizontal scrolling for 'scrollbind' windows
6889 jump Applies to the offset between two windows for vertical
6890 scrolling. This offset is the difference in the first
6891 displayed line of the bound windows. When moving
6892 around in a window, another 'scrollbind' window may
6893 reach a position before the start or after the end of
6894 the buffer. The offset is not changed though, when
6895 moving back the 'scrollbind' window will try to scroll
6896 to the desired position when possible.
6897 When now making that window the current one, two
6898 things can be done with the relative offset:
6899 1. When "jump" is not included, the relative offset is
6900 adjusted for the scroll position in the new current
6901 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006902 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 2. When "jump" is included, the other windows are
6904 scrolled to keep the same relative offset. When
6905 going back to the other window, it still uses the
6906 same relative offset.
6907 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006908 When 'diff' mode is active there always is vertical scroll binding,
6909 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910
6911 *'sections'* *'sect'*
6912'sections' 'sect' string (default "SHNHH HUnhsh")
6913 global
6914 Specifies the nroff macros that separate sections. These are pairs of
6915 two letters (See |object-motions|). The default makes a section start
6916 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6917
6918 *'secure'* *'nosecure'* *E523*
6919'secure' boolean (default off)
6920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 When on, ":autocmd", shell and write commands are not allowed in
6922 ".vimrc" and ".exrc" in the current directory and map commands are
6923 displayed. Switch it off only if you know that you will not run into
6924 problems, or when the 'exrc' option is off. On Unix this option is
6925 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006926 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 'secure' at the end of your ~/.vimrc then.
6928 This option cannot be set from a |modeline| or in the |sandbox|, for
6929 security reasons.
6930
6931 *'selection'* *'sel'*
6932'selection' 'sel' string (default "inclusive")
6933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 This option defines the behavior of the selection. It is only used
6935 in Visual and Select mode.
6936 Possible values:
6937 value past line inclusive ~
6938 old no yes
6939 inclusive yes yes
6940 exclusive yes no
6941 "past line" means that the cursor is allowed to be positioned one
6942 character past the line.
6943 "inclusive" means that the last character of the selection is included
6944 in an operation. For example, when "x" is used to delete the
6945 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006946 When "old" is used and 'virtualedit' allows the cursor to move past
6947 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 Note that when "exclusive" is used and selecting from the end
6949 backwards, you cannot include the last character of a line, when
6950 starting in Normal mode and 'virtualedit' empty.
6951
6952 The 'selection' option is set by the |:behave| command.
6953
6954 *'selectmode'* *'slm'*
6955'selectmode' 'slm' string (default "")
6956 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006957 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 Select mode instead of Visual mode, when a selection is started.
6959 Possible values:
6960 mouse when using the mouse
6961 key when using shifted special keys
6962 cmd when using "v", "V" or CTRL-V
6963 See |Select-mode|.
6964 The 'selectmode' option is set by the |:behave| command.
6965
6966 *'sessionoptions'* *'ssop'*
6967'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006968 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006970 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 feature}
6972 Changes the effect of the |:mksession| command. It is a comma
6973 separated list of words. Each word enables saving and restoring
6974 something:
6975 word save and restore ~
6976 blank empty windows
6977 buffers hidden and unloaded buffers, not just those in windows
6978 curdir the current directory
6979 folds manually created folds, opened/closed folds and local
6980 fold options
6981 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006982 and contain at least one lowercase letter. Only
6983 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 help the help window
6985 localoptions options and mappings local to a window or buffer (not
6986 global values for local options)
6987 options all options and mappings (also global values for local
6988 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006989 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 resize size of the Vim window: 'lines' and 'columns'
6991 sesdir the directory in which the session file is located
6992 will become the current directory (useful with
6993 projects accessed over a network from different
6994 systems)
6995 slash backslashes in file names replaced with forward
6996 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006997 tabpages all tab pages; without this only the current tab page
6998 is restored, so that you can make a session for each
6999 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007000 terminal include terminal windows where the command can be
7001 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 unix with Unix end-of-line format (single <NL>), even when
7003 on Windows or DOS
7004 winpos position of the whole Vim window
7005 winsize window sizes
7006
7007 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007008 When neither "curdir" nor "sesdir" is included, file names are stored
7009 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007010 If you leave out "options" many things won't work well after restoring
7011 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 "slash" and "unix" are useful on Windows when sharing session files
7013 with Unix. The Unix version of Vim cannot source dos format scripts,
7014 but the Windows version of Vim can source unix format scripts.
7015
7016 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007017'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 global
7019 Name of the shell to use for ! and :! commands. When changing the
7020 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7021 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007022 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 See |option-backslash| about including spaces and backslashes.
7024 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007025
Bram Moolenaara2baa732022-02-04 16:09:54 +00007026 In |restricted-mode| shell commands will not be possible. This mode
7027 is used if the value of $SHELL ends in "false" or "nologin".
7028
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007029 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007030 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7032< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007035 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007037 Example with escaped space (Vim will do this when initializing the
7038 option from $SHELL): >
7039 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007040< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007041 backslashes are consumed by `:set`.
7042
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 Under MS-Windows, when the executable ends in ".com" it must be
7044 included. Thus setting the shell to "command.com" or "4dos.com"
7045 works, but "command" and "4dos" do not work for all commands (e.g.,
7046 filtering).
7047 For unknown reasons, when using "4dos.com" the current directory is
7048 changed to "C:\". To avoid this set 'shell' like this: >
7049 :set shell=command.com\ /c\ 4dos
7050< This option cannot be set from a |modeline| or in the |sandbox|, for
7051 security reasons.
7052
7053 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007054'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007055 Win32, when 'shell' contains "powershell":
7056 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007057 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007060 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7061 For MS-Windows, the default is set according to the value of 'shell',
7062 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007063 On Unix it can have more than one flag. Each white space separated
7064 part is passed as an argument to the shell command.
7065 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007066 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 This option cannot be set from a |modeline| or in the |sandbox|, for
7068 security reasons.
7069
7070 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007071'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7072 "2>&1| tee", or
7073 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 {not available when compiled without the |+quickfix|
7076 feature}
7077 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007078 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 including spaces and backslashes.
7080 The name of the temporary file can be represented by "%s" if necessary
7081 (the file name is appended automatically if no %s appears in the value
7082 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007083 For the Amiga the default is ">". For MS-Windows using powershell the
7084 default is "2>&1 | Out-File -Encoding default", otherwise the default
7085 is ">%s 2>&1". The output is directly saved in a file and not echoed
7086 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007087 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 in a file and echoed to the screen. If the 'shell' option is "csh" or
7089 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007090 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007091 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7092 means that stderr is also included. Before using the 'shell' option a
7093 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007094 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7095 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 The initialization of this option is done after reading the ".vimrc"
7097 and the other initializations, so that when the 'shell' option is set
7098 there, the 'shellpipe' option changes automatically, unless it was
7099 explicitly set before.
7100 When 'shellpipe' is set to an empty string, no redirection of the
7101 ":make" output will be done. This is useful if you use a 'makeprg'
7102 that writes to 'makeef' by itself. If you want no piping, but do
7103 want to include the 'makeef', set 'shellpipe' to a single space.
7104 Don't forget to precede the space with a backslash: ":set sp=\ ".
7105 In the future pipes may be used for filtering and this option will
7106 become obsolete (at least for Unix).
7107 This option cannot be set from a |modeline| or in the |sandbox|, for
7108 security reasons.
7109
7110 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007111'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 Quoting character(s), put around the command passed to the shell, for
7114 the "!" and ":!" commands. The redirection is kept outside of the
7115 quoting. See 'shellxquote' to include the redirection. It's
7116 probably not useful to set both options.
7117 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007118 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007119 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 This option cannot be set from a |modeline| or in the |sandbox|, for
7121 security reasons.
7122
7123 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007124'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7125 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 String to be used to put the output of a filter command in a temporary
7128 file. See also |:!|. See |option-backslash| about including spaces
7129 and backslashes.
7130 The name of the temporary file can be represented by "%s" if necessary
7131 (the file name is appended automatically if no %s appears in the value
7132 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007133 The default is ">". For Unix, if the 'shell' option is "csh" or
7134 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007135 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007136 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7137 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007138 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7139 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007140 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7141 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 The initialization of this option is done after reading the ".vimrc"
7143 and the other initializations, so that when the 'shell' option is set
7144 there, the 'shellredir' option changes automatically unless it was
7145 explicitly set before.
7146 In the future pipes may be used for filtering and this option will
7147 become obsolete (at least for Unix).
7148 This option cannot be set from a |modeline| or in the |sandbox|, for
7149 security reasons.
7150
7151 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7152'shellslash' 'ssl' boolean (default off)
7153 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007154 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007156 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007157 powershell.exe. Backward slashes can still be typed, but they are
7158 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 Note that setting or resetting this option has no effect for some
7160 existing file names, thus this option needs to be set before opening
7161 any file for best results. This might change in the future.
7162 'shellslash' only works when a backslash can be used as a path
7163 separator. To test if this is so use: >
7164 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007165< Also see 'completeslash'.
7166
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007167 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7168'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7169 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007170 When on, use temp files for shell commands. When off use a pipe.
7171 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007172 Currently a pipe is only supported on Unix and MS-Windows 2K and
7173 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007174 :if has("filterpipe")
7175< The advantage of using a pipe is that nobody can read the temp file
7176 and the 'shell' command does not need to support redirection.
7177 The advantage of using a temp file is that the file type and encoding
7178 can be detected.
7179 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7180 |FilterWritePost| autocommands event are not triggered when
7181 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007182 The `system()` function does not respect this option and always uses
7183 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007184 NOTE: This option is set to the Vim default value when 'compatible'
7185 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007186
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 *'shelltype'* *'st'*
7188'shelltype' 'st' number (default 0)
7189 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007190 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 On the Amiga this option influences the way how the commands work
7192 which use a shell.
7193 0 and 1: always use the shell
7194 2 and 3: use the shell only to filter lines
7195 4 and 5: use shell only for ':sh' command
7196 When not using the shell, the command is executed directly.
7197
7198 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7199 1 and 3: use "shell cmd" to start external commands
7200
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007201 *'shellxescape'* *'sxe'*
7202'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007203 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007204 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007205 When 'shellxquote' is set to "(" then the characters listed in this
7206 option will be escaped with a '^' character. This makes it possible
7207 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007208 This option cannot be set from a |modeline| or in the |sandbox|, for
7209 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007210
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 *'shellxquote'* *'sxq'*
7212'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007213 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007214 for Win32, when 'shell' is
7215 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007216 for Win32, when 'shell' contains "sh"
7217 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 for Unix, when using system(): "\"")
7219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 Quoting character(s), put around the command passed to the shell, for
7221 the "!" and ":!" commands. Includes the redirection. See
7222 'shellquote' to exclude the redirection. It's probably not useful
7223 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007224 When the value is '(' then ')' is appended. When the value is '"('
7225 then ')"' is appended.
7226 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007227 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007228 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7229 pwsh.exe which automatically strips off the first and last quote on a
7230 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7231 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007232 'shell', to reduce the need to set this option by the user. See
7233 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 This option cannot be set from a |modeline| or in the |sandbox|, for
7235 security reasons.
7236
7237 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7238'shiftround' 'sr' boolean (default off)
7239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 Round indent to multiple of 'shiftwidth'. Applies to > and <
7241 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7242 a multiple of 'shiftwidth' (this is Vi compatible).
7243 NOTE: This option is reset when 'compatible' is set.
7244
7245 *'shiftwidth'* *'sw'*
7246'shiftwidth' 'sw' number (default 8)
7247 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007248 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007250 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007251 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252
7253 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007254'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7255 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007256 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007258 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 It is a list of flags:
7260 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007261 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7262 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7263 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7264 m use "[+]" instead of "[Modified]" *shm-m*
7265 n use "[New]" instead of "[New File]" *shm-n*
7266 r use "[RO]" instead of "[readonly]" *shm-r*
7267 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007269 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7270 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007271 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007272 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007274 o overwrite message for writing a file with subsequent *shm-o*
7275 message for reading a file (useful for ":wn" or when
7276 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007277 O message for reading a file overwrites any previous *shm-O*
7278 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007279 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7280 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007281 the search count do not show "W" before the count message
7282 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007283 t truncate file message at the start if it is too long *shm-t*
7284 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007285 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007286 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007287 long to fit on the command line; "..." will appear in the
7288 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007289 W don't give "written" or "[w]" when writing a file *shm-W*
7290 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007291 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007292 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007293 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007294 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007295 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7296 match", "Pattern not found", "Back at original", etc.
7297 C don't give messages while scanning for ins-completion *shm-C*
7298 items, for instance "scanning tags"
7299 q use "recording" instead of "recording @a" *shm-q*
7300 F don't give the file info when editing a file, like *shm-F*
7301 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007302 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007303 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007304 "[1/5]". When the "S" flag is not present (e.g. search count
7305 is shown), the "search hit BOTTOM, continuing at TOP" and
7306 "search hit TOP, continuing at BOTTOM" messages are only
7307 indicated by a "W" (Mnemonic: Wrapped) letter before the
7308 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309
7310 This gives you the opportunity to avoid that a change between buffers
7311 requires you to hit <Enter>, but still gives as useful a message as
7312 possible for the space available. To get the whole message that you
7313 would have got with 'shm' empty, use ":file!"
7314 Useful values:
7315 shm= No abbreviation of message.
7316 shm=a Abbreviation, but no loss of information.
7317 shm=at Abbreviation, and truncate message when necessary.
7318
7319 NOTE: This option is set to the Vi default value when 'compatible' is
7320 set and to the Vim default value when 'compatible' is reset.
7321
7322 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7323'shortname' 'sn' boolean (default off)
7324 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 Filenames are assumed to be 8 characters plus one extension of 3
7326 characters. Multiple dots in file names are not allowed. When this
7327 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007328 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007330 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331
7332 *'showbreak'* *'sbr'* *E595*
7333'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007334 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007335 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 feature}
7337 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007338 values are "> " or "+++ ": >
7339 :set showbreak=>\
7340< Note the backslash to escape the trailing space. It's easier like
7341 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007342 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007343< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 comma (in a future version the comma might be used to separate the
7345 part that is shown at the end and at the start of a line).
7346 The characters are highlighted according to the '@' flag in
7347 'highlight'.
7348 Note that tabs after the showbreak will be displayed differently.
7349 If you want the 'showbreak' to appear in between line numbers, add the
7350 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007351 A window-local value overrules a global value. If the global value is
7352 set and you want no value in the current window use NONE: >
7353 :setlocal showbreak=NONE
7354<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007356'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7357 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007359 Show (partial) command in the last line of the screen. Set this
7360 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 In Visual mode the size of the selected area is shown:
7362 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007363 If the number of bytes is different it is also displayed: "2-6"
7364 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007366 - When selecting a block, the size in screen characters:
7367 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007368 This information can be displayed in an alternative location using the
7369 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 NOTE: This option is set to the Vi default value when 'compatible' is
7371 set and to the Vim default value when 'compatible' is reset.
7372
Luuk van Baalba936f62022-12-15 13:15:39 +00007373 *'showcmdloc'* *'sloc'*
7374'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007375 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007376 This option can be used to display the (partially) entered command in
7377 another location. Possible values are:
7378 last Last line of the screen (default).
7379 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007380 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007381 Setting this option to "statusline" or "tabline" means that these will
7382 be redrawn whenever the command changes, which can be on every key
7383 pressed.
7384 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7385 place the text. Without a custom 'statusline' or 'tabline' it will be
7386 displayed in a convenient location.
7387
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7389'showfulltag' 'sft' boolean (default off)
7390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 When completing a word in insert mode (see |ins-completion|) from the
7392 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007393 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 matched a C function, you can see a template for what arguments are
7395 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007396 Note that this doesn't work well together with having "longest" in
7397 'completeopt', because the completion from the search pattern may not
7398 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399
7400 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7401'showmatch' 'sm' boolean (default off)
7402 global
7403 When a bracket is inserted, briefly jump to the matching one. The
7404 jump is only done if the match can be seen on the screen. The time to
7405 show the match can be set with 'matchtime'.
7406 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007407 seen or not).
7408 This option is reset when 'paste' is set and restored when 'paste' is
7409 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 When the 'm' flag is not included in 'cpoptions', typing a character
7411 will immediately move the cursor back to where it belongs.
7412 See the "sm" field in 'guicursor' for setting the cursor shape and
7413 blinking when showing the match.
7414 The 'matchpairs' option can be used to specify the characters to show
7415 matches for. 'rightleft' and 'revins' are used to look for opposite
7416 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007417 Also see the matchparen plugin for highlighting the match when moving
7418 around |pi_paren.txt|.
7419 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420
7421 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7422'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7423 global
7424 If in Insert, Replace or Visual mode put a message on the last line.
7425 Use the 'M' flag in 'highlight' to set the type of highlighting for
7426 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007427 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 doesn't mean XIM is really active, especially when 'imactivatekey' is
7429 not set.
7430 NOTE: This option is set to the Vi default value when 'compatible' is
7431 set and to the Vim default value when 'compatible' is reset.
7432
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007433 *'showtabline'* *'stal'*
7434'showtabline' 'stal' number (default 1)
7435 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007436 The value of this option specifies when the line with tab page labels
7437 will be displayed:
7438 0: never
7439 1: only if there are at least two tab pages
7440 2: always
7441 This is both for the GUI and non-GUI implementation of the tab pages
7442 line.
7443 See |tab-page| for more information about tab pages.
7444
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 *'sidescroll'* *'ss'*
7446'sidescroll' 'ss' number (default 0)
7447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 The minimal number of columns to scroll horizontally. Used only when
7449 the 'wrap' option is off and the cursor is moved off of the screen.
7450 When it is zero the cursor will be put in the middle of the screen.
7451 When using a slow terminal set it to a large number or 0. When using
7452 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7453 commands.
7454
7455 *'sidescrolloff'* *'siso'*
7456'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007457 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007459 right of the cursor if 'nowrap' is set. Setting this option to a
7460 value greater than 0 while having |'sidescroll'| also at a non-zero
7461 value makes some context visible in the line you are scrolling in
7462 horizontally (except at beginning of the line). Setting this option
7463 to a large value (like 999) has the effect of keeping the cursor
7464 horizontally centered in the window, as long as one does not come too
7465 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007466 After using the local value, go back the global value with one of
7467 these two: >
7468 setlocal sidescrolloff<
7469 setlocal sidescrolloff=-1
7470< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
7472 Example: Try this together with 'sidescroll' and 'listchars' as
7473 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007474 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475
7476 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7477 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007478<
7479 *'signcolumn'* *'scl'*
7480'signcolumn' 'scl' string (default "auto")
7481 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007482 {not available when compiled without the |+signs|
7483 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007484 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007485 "auto" only when there is a sign to display
7486 "no" never
7487 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007488 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007489 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7492'smartcase' 'scs' boolean (default off)
7493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 Override the 'ignorecase' option if the search pattern contains upper
7495 case characters. Only used when the search pattern is typed and
7496 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007497 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7499 recalling the search pattern from history and hitting <Enter>.
7500 NOTE: This option is reset when 'compatible' is set.
7501
7502 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7503'smartindent' 'si' boolean (default off)
7504 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 Do smart autoindenting when starting a new line. Works for C-like
7506 programs, but can also be used for other languages. 'cindent' does
7507 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007508 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007509 setting 'si' has no effect. 'indentexpr' is a more advanced
7510 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 Normally 'autoindent' should also be on when using 'smartindent'.
7512 An indent is automatically inserted:
7513 - After a line ending in '{'.
7514 - After a line starting with a keyword from 'cinwords'.
7515 - Before a line starting with '}' (only with the "O" command).
7516 When typing '}' as the first character in a new line, that line is
7517 given the same indent as the matching '{'.
7518 When typing '#' as the first character in a new line, the indent for
7519 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007520 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7522 When using the ">>" command, lines starting with '#' are not shifted
7523 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007524 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007525 This option is reset when 'paste' is set and restored when 'paste' is
7526 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527
7528 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7529'smarttab' 'sta' boolean (default off)
7530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007532 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7533 <BS> will delete a 'shiftwidth' worth of space at the start of the
7534 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007535 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007536 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7537 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007538 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007540 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007541 This option is reset when 'paste' is set and restored when 'paste' is
7542 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 NOTE: This option is reset when 'compatible' is set.
7544
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007545 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7546'smoothscroll' 'sms' boolean (default off)
7547 local to window
7548 Scrolling works with screen lines. When 'wrap' is set and the first
7549 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007550 above the window. "<<<" is displayed at the start of the first line,
7551 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007552 You may also want to add "lastline" to the 'display' option to show as
7553 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007554 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007555
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 *'softtabstop'* *'sts'*
7557'softtabstop' 'sts' number (default 0)
7558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 Number of spaces that a <Tab> counts for while performing editing
7560 operations, like inserting a <Tab> or using <BS>. It "feels" like
7561 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7562 used. This is useful to keep the 'ts' setting at its standard value
7563 of 8, while being able to edit like it is set to 'sts'. However,
7564 commands like "x" still work on the actual characters.
7565 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007566 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007567 'softtabstop' is set to 0 when the 'paste' option is set and restored
7568 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7570 spaces is minimized by using <Tab>s.
7571 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7572 set.
7573 NOTE: This option is set to 0 when 'compatible' is set.
7574
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007575 If Vim is compiled with the |+vartabs| feature then the value of
7576 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7577 anything other than an empty string.
7578
Bram Moolenaar217ad922005-03-20 22:37:15 +00007579 *'spell'* *'nospell'*
7580'spell' boolean (default off)
7581 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007582 {not available when compiled without the |+syntax|
7583 feature}
7584 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007585 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007586
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007587 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007588'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007589 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007590 {not available when compiled without the |+syntax|
7591 feature}
7592 Pattern to locate the end of a sentence. The following word will be
7593 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007594 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007595 When this check is not wanted make this option empty.
7596 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007597 Be careful with special characters, see |option-backslash| about
7598 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007599 To set this option automatically depending on the language, see
7600 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007601
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007602 *'spellfile'* *'spf'*
7603'spellfile' 'spf' string (default empty)
7604 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007605 {not available when compiled without the |+syntax|
7606 feature}
7607 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007608 commands. It must end in ".{encoding}.add". You need to include the
7609 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007610 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007611 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007612 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007613 |zg| and |zw| commands can be used to access each. This allows using
7614 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007615 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007616 you: Using the first directory in 'runtimepath' that is writable. If
7617 there is no "spell" directory yet it will be created. For the file
7618 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007619 ignoring the region.
7620 The resulting ".spl" file will be used for spell checking, it does not
7621 have to appear in 'spelllang'.
7622 Normally one file is used for all regions, but you can add the region
7623 name if you want to. However, it will then only be used when
7624 'spellfile' is set to it, for entries in 'spelllang' only files
7625 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007626 This option cannot be set from a |modeline| or in the |sandbox|, for
7627 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007628
Bram Moolenaar217ad922005-03-20 22:37:15 +00007629 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007630'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007631 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007632 {not available when compiled without the |+syntax|
7633 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007634 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007635 on spellchecking will be done for these languages. Example: >
7636 set spelllang=en_us,nl,medical
7637< This means US English, Dutch and medical words are recognized. Words
7638 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007639 The word list name must consist of alphanumeric characters, a dash or
7640 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007641 recommended to separate the two letter language name from a
7642 specification. Thus "en-rare" is used for rare English words.
7643 A region name must come last and have the form "_xx", where "xx" is
7644 the two-letter, lower case region name. You can use more than one
7645 region by listing them: "en_us,en_ca" supports both US and Canadian
7646 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007647 Britain. (Note: currently en_au and en_nz dictionaries are older than
7648 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007649 If the name "cjk" is included East Asian characters are excluded from
7650 spell checking. This is useful when editing text that also has Asian
7651 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007652 Note that the "medical" dictionary does not exist, it is just an
7653 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007654 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007655 As a special case the name of a .spl file can be given as-is. The
7656 first "_xx" in the name is removed and used as the region name
7657 (_xx is an underscore, two letters and followed by a non-letter).
7658 This is mainly for testing purposes. You must make sure the correct
7659 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007660 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007661 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7662 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007663 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007664
Bram Moolenaar98692072006-02-04 00:57:42 +00007665 If the |spellfile.vim| plugin is active and you use a language name
7666 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7667 will ask you if you want to download the file.
7668
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007669 After this option has been set successfully, Vim will source the files
7670 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007671 up to the first character that is not an ASCII letter or number and
7672 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007673
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007674 *'spelloptions'* *'spo'*
7675'spelloptions' 'spo' string (default "")
7676 local to buffer
7677 {not available when compiled without the |+syntax|
7678 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007679 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007680 camel When a word is CamelCased, assume "Cased" is a
7681 separate word: every upper-case character in a word
7682 that comes after a lower case character indicates the
7683 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007684
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007685 *'spellsuggest'* *'sps'*
7686'spellsuggest' 'sps' string (default "best")
7687 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007688 {not available when compiled without the |+syntax|
7689 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007690 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007691 the |spellsuggest()| function. This is a comma-separated list of
7692 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007693
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007694 best Internal method that works best for English. Finds
7695 changes like "fast" and uses a bit of sound-a-like
7696 scoring to improve the ordering.
7697
7698 double Internal method that uses two methods and mixes the
7699 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007700 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007701 word. That only works when the language specifies
7702 sound folding. Can be slow and doesn't always give
7703 better results.
7704
7705 fast Internal method that only checks for simple changes:
7706 character inserts/deletes/swaps. Works well for
7707 simple typing mistakes.
7708
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007709 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007710 Not used for |spellsuggest()|. The number of
7711 suggestions is never more than the value of 'lines'
7712 minus two.
7713
Bram Moolenaar585ee072022-01-29 11:22:17 +00007714 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007715 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007716 methods. When omitted the limit is 5000. When
7717 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007718 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007719
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007720 file:{filename} Read file {filename}, which must have two columns,
7721 separated by a slash. The first column contains the
7722 bad word, the second column the suggested good word.
7723 Example:
7724 theribal/terrible ~
7725 Use this for common mistakes that do not appear at the
7726 top of the suggestion list with the internal methods.
7727 Lines without a slash are ignored, use this for
7728 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007729 The word in the second column must be correct,
7730 otherwise it will not be used. Add the word to an
7731 ".add" file if it is currently flagged as a spelling
7732 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007733 The file is used for all languages.
7734
7735 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007736 trouble with spaces. Best is to call a function
7737 without arguments, see |expr-option-function|.
7738 |v:val| holds the badly spelled word. The expression
7739 must evaluate to a List of Lists, each with a
7740 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007741 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007742 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007743 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007744 internal methods use. A lower score is better.
7745 This may invoke |spellsuggest()| if you temporarily
7746 set 'spellsuggest' to exclude the "expr:" part.
7747 Errors are silently ignored, unless you set the
7748 'verbose' option to a non-zero value.
7749
7750 Only one of "best", "double" or "fast" may be used. The others may
7751 appear several times in any order. Example: >
7752 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7753<
7754 This option cannot be set from a |modeline| or in the |sandbox|, for
7755 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007756
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7758'splitbelow' 'sb' boolean (default off)
7759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 When on, splitting a window will put the new window below the current
7761 one. |:split|
7762
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007763 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007764'splitkeep' 'spk' string (default "cursor")
7765 global
7766 The value of this option determines the scroll behavior when opening,
7767 closing or resizing horizontal splits.
7768
7769 Possible values are:
7770 cursor Keep the same relative cursor position.
7771 screen Keep the text on the same screen line.
7772 topline Keep the topline the same.
7773
7774 For the "screen" and "topline" values, the cursor position will be
7775 changed when necessary. In this case, the jumplist will be populated
7776 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007777 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007778
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7780'splitright' 'spr' boolean (default off)
7781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 When on, splitting a window will put the new window right of the
7783 current one. |:vsplit|
7784
7785 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7786'startofline' 'sol' boolean (default on)
7787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007789 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007790 (if possible). This applies to the commands:
7791 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7792 - "d", "<<" and ">>" with a linewise operator
7793 - "%" with a count
7794 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7795 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 In case of buffer changing commands the cursor is placed at the column
7797 where it was the last time the buffer was edited.
7798 NOTE: This option is set when 'compatible' is set.
7799
Bram Moolenaar00654022011-02-25 14:42:19 +01007800 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007802 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 {not available when compiled without the |+statusline|
7804 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007805 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 Also see |status-line|.
7807
7808 The option consists of printf style '%' items interspersed with
7809 normal text. Each status line item is of the form:
7810 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007811 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007812 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813
Bram Moolenaar238a5642006-02-21 22:12:05 +00007814 When the option starts with "%!" then it is used as an expression,
7815 evaluated and the result is used as the option value. Example: >
7816 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007817< The *g:statusline_winid* variable will be set to the |window-ID| of the
7818 window that the status line belongs to.
7819 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007820 Note that the "%!" expression is evaluated in the context of the
7821 current window and buffer, while %{} items are evaluated in the
7822 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007823
7824 When there is error while evaluating the option then it will be made
7825 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007826 When the result contains unprintable characters the result is
7827 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007828
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 Note that the only effect of 'ruler' when this option is set (and
7830 'laststatus' is 2) is controlling the output of |CTRL-G|.
7831
7832 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007833 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007835 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 minwid Minimum width of the item, padding as set by '-' & '0'.
7837 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007838 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 on the left for text items. Numeric items will be
7840 shifted down to maxwid-2 digits followed by '>'number
7841 where number is the amount of missing digits, much like
7842 an exponential notation.
7843 item A one letter code as described below.
7844
7845 Following is a description of the possible statusline items. The
7846 second character in "item" is the type:
7847 N for number
7848 S for string
7849 F for flags as described below
7850 - not applicable
7851
7852 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007853 f S Path to the file in the buffer, as typed or relative to current
7854 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 F S Full path to the file in the buffer.
7856 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007857 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007859 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007861 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007863 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007865 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007867 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7869 being used: "<keymap>"
7870 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007871 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 B N As above, in hexadecimal.
7873 o N Byte number in file of byte under cursor, first byte is 1.
7874 Mnemonic: Offset from start of file (with one added)
7875 {not available when compiled without |+byte_offset| feature}
7876 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007877 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 l N Line number.
7879 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007880 c N Column number (byte index).
7881 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007882 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 p N Percentage through file in lines as in |CTRL-G|.
7884 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007885 percentage described for 'ruler'. Always 3 in length, unless
7886 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007887 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007888 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007890 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007891 Note that there is no '%' before the closing '}'. The
7892 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007893 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007894 {% - This is almost same as { except the result of the expression is
7895 re-evaluated as a statusline format string. Thus if the
7896 return value of expr contains % items they will get expanded.
7897 The expression can contain the } character, the end of
7898 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007899 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007900 func! Stl_filename() abort
7901 return "%t"
7902 endfunc
7903< `stl=%{Stl_filename()}` results in `"%t"`
7904 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007905 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 ( - Start of item group. Can be used for setting the width and
7907 alignment of a section. Must be followed by %) somewhere.
7908 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007909 T N For 'tabline': start of tab page N label. Use %T after the last
7910 label. This information is used for mouse clicks.
7911 X N For 'tabline': start of close tab N label. Use %X after the
7912 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7913 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 < - Where to truncate line if too long. Default is at the start.
7915 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007916 = - Separation point between alignment sections. Each section will
7917 be separated by an equal number of spaces. With one %= what
7918 comes after it will be right-aligned. With two %= there is a
7919 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007921 # - Set highlight group. The name must follow and then a # again.
7922 Thus use %#HLname# for highlight group HLname. The same
7923 highlighting is used, also for the statusline of non-current
7924 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007926 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007927 The difference between User{N} and StatusLine will be applied to
7928 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 The number N must be between 1 and 9. See |hl-User1..9|
7930
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007931 When displaying a flag, Vim removes the leading comma, if any, when
7932 that flag comes right after plaintext. This will make a nice display
7933 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934
Bram Moolenaar582fd852005-03-28 20:58:01 +00007935 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 not set) and a minwid is not set for the group, the whole group will
7937 become empty. This will make a group like the following disappear
7938 completely from the statusline when none of the flags are set. >
7939 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007940< Beware that an expression is evaluated each and every time the status
7941 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007942 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007943 While evaluating %{} the current buffer and current window will be set
7944 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007945 currently being drawn. The expression will evaluate in this context.
7946 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7947 real current buffer and "g:actual_curwin" to the |window-ID| of the
7948 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007949
Bram Moolenaar30b65812012-07-12 22:01:11 +02007950 The 'statusline' option will be evaluated in the |sandbox| if set from
7951 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007952 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007953
7954 It is not allowed to change text or jump to another window while
7955 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956
7957 If the statusline is not updated when you want it (e.g., after setting
7958 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007959 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007961 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 Otherwise the result is taken as flag text and applied to the rules
7963 described above.
7964
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007965 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007967 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968
7969 Examples:
7970 Emulate standard status line with 'ruler' set >
7971 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7972< Similar, but add ASCII value of char under the cursor (like "ga") >
7973 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7974< Display byte count and byte value, modified flag in red. >
7975 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7976 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7977< Display a ,GZ flag if a compressed file is loaded >
7978 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7979< In the |:autocmd|'s: >
7980 :let b:gzflag = 1
7981< And: >
7982 :unlet b:gzflag
7983< And define this function: >
7984 :function VarExists(var, val)
7985 : if exists(a:var) | return a:val | else | return '' | endif
7986 :endfunction
7987<
7988 *'suffixes'* *'su'*
7989'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 Files with these suffixes get a lower priority when multiple files
7992 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007993 suffixes. Spaces after the comma are ignored. A dot is also seen as
7994 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 separator, precede it with a backslash (see |option-backslash| about
7996 including spaces and backslashes).
7997 See 'wildignore' for completely ignoring files.
7998 The use of |:set+=| and |:set-=| is preferred when adding or removing
7999 suffixes from the list. This avoids problems when a future version
8000 uses another default.
8001
8002 *'suffixesadd'* *'sua'*
8003'suffixesadd' 'sua' string (default "")
8004 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008005 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 file for the "gf", "[I", etc. commands. Example: >
8007 :set suffixesadd=.java
8008<
8009 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8010'swapfile' 'swf' boolean (default on)
8011 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008012 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 swapfile is not wanted for a specific buffer. For example, with
8014 confidential information that even root must not be able to access.
8015 Careful: All text will be in memory:
8016 - Don't use this for big files.
8017 - Recovery will be impossible!
8018 A swapfile will only be present when |'updatecount'| is non-zero and
8019 'swapfile' is set.
8020 When 'swapfile' is reset, the swap file for the current buffer is
8021 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8022 non-zero, a swap file is immediately created.
8023 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008024 If you want to open a new buffer without creating a swap file for it,
8025 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008026 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027
8028 This option is used together with 'bufhidden' and 'buftype' to
8029 specify special kinds of buffers. See |special-buffers|.
8030
8031 *'swapsync'* *'sws'*
8032'swapsync' 'sws' string (default "fsync")
8033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008035 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 When this option is empty parts of the swap file may be in memory and
8037 not written to disk. When the system crashes you may lose more work.
8038 On Unix the system does a sync now and then without Vim asking for it,
8039 so the disadvantage of setting this option off is small. On some
8040 systems the swap file will not be written at all. For a unix system
8041 setting it to "sync" will use the sync() call instead of the default
8042 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008043 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044
8045 *'switchbuf'* *'swb'*
8046'switchbuf' 'swb' string (default "")
8047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008049 This option is checked, when
8050 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008051 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008052 - jumping to a tag using the |:stag| command.
8053 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8054 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8055 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008056 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008057 useopen If included, jump to the first open window in the
8058 current tab page that contains the specified buffer
8059 (if there is one). Otherwise: Do not examine other
8060 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008061 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008062 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008064 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008065 Otherwise: do not split, use current window (when used
8066 in the quickfix window: the previously used window or
8067 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008068 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008069 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008070 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008071 uselast If included, jump to the previously used window when
8072 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008073 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8074 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008076 *'synmaxcol'* *'smc'*
8077'synmaxcol' 'smc' number (default 3000)
8078 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008079 {not available when compiled without the |+syntax|
8080 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008081 Maximum column in which to search for syntax items. In long lines the
8082 text after this column is not highlighted and following lines may not
8083 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008084 This helps to avoid very slow redrawing for an XML file that is one
8085 long line.
8086 Set to zero to remove the limit.
8087
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 *'syntax'* *'syn'*
8089'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008090 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 {not available when compiled without the |+syntax|
8092 feature}
8093 When this option is set, the syntax with this name is loaded, unless
8094 syntax highlighting has been switched off with ":syntax off".
8095 Otherwise this option does not always reflect the current syntax (the
8096 b:current_syntax variable does).
8097 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008098 not automatically recognized. Example, in an IDL file:
8099 /* vim: set syntax=idl : */ ~
8100 When a dot appears in the value then this separates two filetype
8101 names. Example:
8102 /* vim: set syntax=c.doxygen : */ ~
8103 This will use the "c" syntax first, then the "doxygen" syntax.
8104 Note that the second one must be prepared to be loaded as an addition,
8105 otherwise it will be skipped. More than one dot may appear.
8106 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 :set syntax=OFF
8108< To switch syntax highlighting on according to the current value of the
8109 'filetype' option: >
8110 :set syntax=ON
8111< What actually happens when setting the 'syntax' option is that the
8112 Syntax autocommand event is triggered with the value as argument.
8113 This option is not copied to another buffer, independent of the 's' or
8114 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008115 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116
LemonBoy5247b0b2024-07-12 19:30:58 +02008117 *'tabclose'* *'tcl'*
8118'tabclose' 'tcl' string (default "")
8119 global
8120 This option controls the behavior when closing tab pages (e.g., using
8121 |:tabclose|). When empty Vim goes to the next (right) tab page.
8122
8123 Possible values (comma-separated list):
8124 left If included, go to the previous tab page instead of
8125 the next one.
8126 uselast If included, go to the previously used tab page if
8127 possible. This option takes precedence over the
8128 others.
8129
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008130 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008131'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008132 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008133 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008134 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008135 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008136
8137 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008138 option and only when there is no GUI tab line. When 'e' is in
8139 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008140 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008141
8142 The value is evaluated like with 'statusline'. You can use
8143 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008144 the text to be displayed. Use "%1T" for the first label, "%2T" for
8145 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008146
Bram Moolenaare12bab32019-01-08 22:02:56 +01008147 When changing something that is used in 'tabline' that does not
8148 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008149 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008150
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008151 Keep in mind that only one of the tab pages is the current one, others
8152 are invisible and you can't jump to their windows.
8153
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008154 *'tabpagemax'* *'tpm'*
8155'tabpagemax' 'tpm' number (default 10)
8156 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008157 Maximum number of tab pages to be opened by the |-p| command line
8158 argument or the ":tab all" command. |tabpage|
8159
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008160 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161'tabstop' 'ts' number (default 8)
8162 local to buffer
8163 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008164 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165
8166 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008167 appear wrong in many places, e.g., when printing it.
8168 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008170 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8172 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008173 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008175 This is the recommended way, the file will look the same with other
8176 tools and when listing it in a terminal.
8177 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8178 'expandtab'. This way you will always insert spaces. The
8179 formatting will never be messed up when 'tabstop' is changed (leave
8180 it at 8 just in case). The file will be a bit larger.
8181 You do need to check if no Tabs exist in the file. You can get rid
8182 of them by first setting 'expandtab' and using `%retab!`, making
8183 sure the value of 'tabstop' is set correctly.
8184 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 'expandtab'. This way you will always insert spaces. The
8186 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008187 You do need to check if no Tabs exist in the file, just like in the
8188 item just above.
8189 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008190 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008191 works when using Vim to edit the file, other tools assume a tabstop
8192 is worth 8 spaces.
8193 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 'noexpandtab'. This should then work (for initial indents only)
8195 for any tabstop setting that people use. It might be nice to have
8196 tabs after the first non-blank inserted as spaces if you do this
8197 though. Otherwise aligned comments will be wrong when 'tabstop' is
8198 changed.
8199
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008200 If Vim is compiled with the |+vartabs| feature then the value of
8201 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8202 than an empty string.
8203
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8205'tagbsearch' 'tbs' boolean (default on)
8206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008208 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 searching makes searching for a tag a LOT faster, but a linear search
8210 will find more tags if the tags file wasn't properly sorted.
8211 Vim normally assumes that your tags files are sorted, or indicate that
8212 they are not sorted. Only when this is not the case does the
8213 'tagbsearch' option need to be switched off.
8214
8215 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008216 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 certain files, or retry all files with a linear search. When
8218 'tagbsearch' is off, only a linear search is done.
8219
8220 Linear searching is done anyway, for one file, when Vim finds a line
8221 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008222 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223< [The whitespace before and after the '0' must be a single <Tab>]
8224
8225 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008226 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 instead of a normal tag name, a retry is done with a linear search.
8228 Tags in unsorted tags files, and matches with different case will only
8229 be found in the retry.
8230
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008231 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008232 linear search can be avoided when case is ignored. Use a value of '2'
8233 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8234 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008235 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8236 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8237 used for this as well. Note that case must be folded to uppercase for
8238 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008239
8240 By default, tag searches are case-sensitive. Case is ignored when
8241 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8242 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008243 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8244 'tagcase' is "smart", and the pattern contains only lowercase
8245 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246
8247 When 'tagbsearch' is off, tags searching is slower when a full match
8248 exists, but faster when no full match exists. Tags in unsorted tags
8249 files may only be found with 'tagbsearch' off.
8250 When the tags file is not sorted, or sorted in a wrong way (not on
8251 ASCII byte value), 'tagbsearch' should be off, or the line given above
8252 must be included in the tags file.
8253 This option doesn't affect commands that find all matching tags (e.g.,
8254 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008256 *'tagcase'* *'tc'*
8257'tagcase' 'tc' string (default "followic")
8258 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008259 This option specifies how case is handled when searching the tags
8260 file:
8261 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008262 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008263 ignore Ignore case
8264 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008265 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008266 NOTE: This option is set to the Vi default value when 'compatible' is
8267 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008268
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008269 *'tagfunc'* *'tfu'*
8270'tagfunc' 'tfu' string (default: empty)
8271 local to buffer
8272 {not available when compiled without the |+eval|
8273 feature}
8274 This option specifies a function to be used to perform tag searches.
8275 The function gets the tag pattern and should return a List of matching
8276 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008277 function and an example. The value can be the name of a function, a
8278 |lambda| or a |Funcref|. See |option-value-function| for more
8279 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008280 This option cannot be set from a |modeline| or in the |sandbox|, for
8281 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008282
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 *'taglength'* *'tl'*
8284'taglength' 'tl' number (default 0)
8285 global
8286 If non-zero, tags are significant up to this number of characters.
8287
8288 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8289'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8290 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008291 If on and using a tags file in another directory, file names in that
8292 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 NOTE: This option is set to the Vi default value when 'compatible' is
8294 set and to the Vim default value when 'compatible' is reset.
8295
8296 *'tags'* *'tag'* *E433*
8297'tags' 'tag' string (default "./tags,tags", when compiled with
8298 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8299 global or local to buffer |global-local|
8300 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008301 include a space or comma in a file name, precede it with backslashes
8302 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 When a file name starts with "./", the '.' is replaced with the path
8304 of the current file. But only when the 'd' flag is not included in
8305 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8306 |tags-option|.
8307 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008308 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8309 find all files named "tags" below "/lib". The filename itself cannot
8310 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008311 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008312 The |tagfiles()| function can be used to get a list of the file names
8313 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8315 files are also supported. They are automatically recognized. The
8316 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8317 differences are ignored (MS-Windows). |emacs-tags|
8318 The use of |:set+=| and |:set-=| is preferred when adding or removing
8319 file names from the list. This avoids problems when a future version
8320 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321
8322 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8323'tagstack' 'tgst' boolean (default on)
8324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 When on, the |tagstack| is used normally. When off, a ":tag" or
8326 ":tselect" command with an argument will not push the tag onto the
8327 tagstack. A following ":tag" without an argument, a ":pop" command or
8328 any other command that uses the tagstack will use the unmodified
8329 tagstack, but does change the pointer to the active entry.
8330 Resetting this option is useful when using a ":tag" command in a
8331 mapping which should not change the tagstack.
8332
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008333 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008334'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008335 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008336 {only available when compiled with the |+tcl/dyn|
8337 feature}
8338 Specifies the name of the Tcl shared library. The default is
8339 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008340 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008341 This option cannot be set from a |modeline| or in the |sandbox|, for
8342 security reasons.
8343
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 *'term'* *E529* *E530* *E531*
8345'term' string (default is $TERM, if that fails:
8346 in the GUI: "builtin_gui"
8347 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008348 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 on Unix: "ansi"
8351 on VMS: "ansi"
8352 on Win 32: "win32")
8353 global
8354 Name of the terminal. Used for choosing the terminal control
8355 characters. Environment variables are expanded |:set_env|.
8356 For example: >
8357 :set term=$TERM
8358< See |termcap|.
8359
8360 *'termbidi'* *'tbidi'*
8361 *'notermbidi'* *'notbidi'*
8362'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 {only available when compiled with the |+arabic|
8365 feature}
8366 The terminal is in charge of Bi-directionality of text (as specified
8367 by Unicode). The terminal is also expected to do the required shaping
8368 that some languages (such as Arabic) require.
8369 Setting this option implies that 'rightleft' will not be set when
8370 'arabic' is set and the value of 'arabicshape' will be ignored.
8371 Note that setting 'termbidi' has the immediate effect that
8372 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8373 This option is reset when the GUI is started.
8374 For further details see |arabic.txt|.
8375
8376 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008377'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 Encoding used for the terminal. This specifies what character
8380 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008381 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008382 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008383 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008384 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8386 Any attempts to set a different value will be rejected, and an error
8387 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008388 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 because the Win32 system always passes Unicode characters.
8390 When empty, the same encoding is used as for the 'encoding' option.
8391 This is the normal value.
8392 Not all combinations for 'termencoding' and 'encoding' are valid. See
8393 |encoding-table|.
8394 The value for this option must be supported by internal conversions or
8395 iconv(). When this is not possible no conversion will be done and you
8396 will probably experience problems with non-ASCII characters.
8397 Example: You are working with the locale set to euc-jp (Japanese) and
8398 want to edit a UTF-8 file: >
8399 :let &termencoding = &encoding
8400 :set encoding=utf-8
8401< You need to do this when your system has no locale support for UTF-8.
8402
Bram Moolenaar938ae282023-02-20 20:44:55 +00008403 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008404'termguicolors' 'tgc' boolean (default off)
8405 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008406 {not available when compiled without the
8407 |+termguicolors| feature}
8408 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008409 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008410
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008411 Requires a ISO-8613-3 compatible terminal. If setting this option
8412 does not work (produces a colorless UI) reading |xterm-true-color|
8413 might help.
8414
8415 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8416 is required. Use this check to find out: >
8417 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008418< This requires Vim to be built with the |+vtp| feature.
8419
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008420 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008421
8422 When using Vim with Windows Terminal, the background of Windows
8423 Terminal is normally filled with the Vim background color. Setting
8424 'termguicolors' and the guibg of the Normal highlight group to NONE
8425 will make the background transparent: >
8426 :hi Normal guibg=NONE
8427<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008428 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008429
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008430 *'termwinkey'* *'twk'*
8431'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008432 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008433 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008434 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008435 The key can be specified as a single character, a |key-notation| (e.g.
8436 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8437 :set twk=X
8438 :set twk=^I
8439 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008440< The string must be one key stroke but can be multiple bytes.
8441 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008442 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008443 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008444
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008445 *'termwinscroll'* *'twsl'*
8446'termwinscroll' 'twsl' number (default 10000)
8447 local to buffer
8448 {not available when compiled without the
8449 |+terminal| feature}
8450 Number of scrollback lines to keep. When going over this limit the
8451 first 10% of the scrollback lines are deleted. This is just to reduce
8452 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008453 Also used as a limit for text sent to the terminal in one write,
8454 multiplied by the number of columns times 3 (average number of bytes
8455 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008456
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008457 *'termwinsize'* *'tws'*
8458'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008459 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008460 Size used when opening the |terminal| window. Format:
8461 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008462 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008463 - When set with a "x" (e.g., "24x80") the terminal size is not
8464 adjusted to the window size. If the window is smaller only the
8465 top-left part is displayed.
8466 - When set with a "*" (e.g., "10*50") the terminal size follows the
8467 window size, but will not be smaller than the specified rows and/or
8468 columns.
8469 - When rows is zero then use the height of the window.
8470 - When columns is zero then use the width of the window.
8471 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008472 - Can be overruled in the |term_start()| options with "term_rows" and
8473 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008474
8475 Examples:
8476 "30x0" uses 30 rows and the current window width.
8477 "20*0" uses at least 20 rows and the current window width.
8478 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008479 Note that the command running in the terminal window may still change
8480 the size of the terminal. In that case the Vim window will be
8481 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008482
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008483 *'termwintype'* *'twt'*
8484'termwintype' 'twt' string (default "")
8485 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008486 {only available when compiled with the |terminal|
8487 feature on MS-Windows}
8488 Specify the virtual console (pty) used when opening the terminal
8489 window.
8490
8491 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008492 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008493 "winpty" use winpty, fail if not supported
8494 "conpty" use |ConPTY|, fail if not supported
8495
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008496 |ConPTY| support depends on the platform. Windows 10 October 2018
8497 Update is the first version that supports ConPTY, however it is still
8498 considered unstable. ConPTY might become stable in the next release
8499 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008500 supported then you cannot open a terminal window.
8501
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 *'terse'* *'noterse'*
8503'terse' boolean (default off)
8504 global
8505 When set: Add 's' flag to 'shortmess' option (this makes the message
8506 for a search that hits the start or end of the file not being
8507 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8508 shortens a lot of messages}
8509
8510 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8511'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 This option is obsolete. Use 'fileformats'.
8514 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8515 set to the default value for the current system. When 'textauto' is
8516 reset, 'fileformats' is made empty.
8517 NOTE: This option is set to the Vi default value when 'compatible' is
8518 set and to the Vim default value when 'compatible' is reset.
8519
8520 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008521'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 others: default off)
8523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 This option is obsolete. Use 'fileformat'.
8525 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8526 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8527 "unix".
8528
8529 *'textwidth'* *'tw'*
8530'textwidth' 'tw' number (default 0)
8531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 Maximum width of text that is being inserted. A longer line will be
8533 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008534 this.
8535 'textwidth' is set to 0 when the 'paste' option is set and restored
8536 when 'paste' is reset.
8537 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008539 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 NOTE: This option is set to 0 when 'compatible' is set.
8541
8542 *'thesaurus'* *'tsr'*
8543'thesaurus' 'tsr' string (default "")
8544 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008546 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8547 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008548
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008549 This option is not used if 'thesaurusfunc' is set, either for the
8550 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008551
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008552 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008554 name. See |option-backslash| about using backslashes. The use of
8555 |:set+=| and |:set-=| is preferred when adding or removing directories
8556 from the list. This avoids problems when a future version uses
8557 another default. Backticks cannot be used in this option for security
8558 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008560 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008561'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008562 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008563 {not available when compiled without the |+eval|
8564 feature}
8565 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008566 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008567 The value can be the name of a function, a |lambda| or a |Funcref|.
8568 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008569
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008570 This option cannot be set from a |modeline| or in the |sandbox|, for
8571 security reasons.
8572
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8574'tildeop' 'top' boolean (default off)
8575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 When on: The tilde command "~" behaves like an operator.
8577 NOTE: This option is reset when 'compatible' is set.
8578
8579 *'timeout'* *'to'* *'notimeout'* *'noto'*
8580'timeout' 'to' boolean (default on)
8581 global
laburnumT3f7855a2023-12-05 18:37:03 +01008582
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008584'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 These two options together determine the behavior when part of a
8587 mapped key sequence or keyboard code has been received:
8588
8589 'timeout' 'ttimeout' action ~
8590 off off do not time out
8591 on on or off time out on :mappings and key codes
8592 off on time out on key codes
8593
8594 If both options are off, Vim will wait until either the complete
8595 mapping or key sequence has been received, or it is clear that there
8596 is no mapping or key sequence for the received characters. For
8597 example: if you have mapped "vl" and Vim has received 'v', the next
8598 character is needed to see if the 'v' is followed by an 'l'.
8599 When one of the options is on, Vim will wait for about 1 second for
8600 the next character to arrive. After that the already received
8601 characters are interpreted as single characters. The waiting time can
8602 be changed with the 'timeoutlen' option.
8603 On slow terminals or very busy systems timing out may cause
8604 malfunctioning cursor keys. If both options are off, Vim waits
8605 forever after an entered <Esc> if there are key codes that start
8606 with <Esc>. You will have to type <Esc> twice. If you do not have
8607 problems with key codes, but would like to have :mapped key
8608 sequences not timing out in 1 second, set the 'ttimeout' option and
8609 reset the 'timeout' option.
8610
8611 NOTE: 'ttimeout' is reset when 'compatible' is set.
8612
8613 *'timeoutlen'* *'tm'*
8614'timeoutlen' 'tm' number (default 1000)
8615 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008616
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008618'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 The time in milliseconds that is waited for a key code or mapped key
8621 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8622 when part of a command has been typed.
8623 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8624 different timeout value for key codes is desired set 'ttimeoutlen' to
8625 a non-negative number.
8626
8627 ttimeoutlen mapping delay key code delay ~
8628 < 0 'timeoutlen' 'timeoutlen'
8629 >= 0 'timeoutlen' 'ttimeoutlen'
8630
8631 The timeout only happens when the 'timeout' and 'ttimeout' options
8632 tell so. A useful setting would be >
8633 :set timeout timeoutlen=3000 ttimeoutlen=100
8634< (time out on mapping after three seconds, time out on key codes after
8635 a tenth of a second).
8636
8637 *'title'* *'notitle'*
8638'title' boolean (default off, on when title can be restored)
8639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 When on, the title of the window will be set to the value of
8641 'titlestring' (if it is not empty), or to:
8642 filename [+=-] (path) - VIM
8643 Where:
8644 filename the name of the file being edited
8645 - indicates the file cannot be modified, 'ma' off
8646 + indicates the file was modified
8647 = indicates the file is read-only
8648 =+ indicates the file is read-only and modified
8649 (path) is the path of the file being edited
8650 - VIM the server name |v:servername| or "VIM"
8651 Only works if the terminal supports setting window titles
8652 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008653 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8655 *X11*
8656 When Vim was compiled with HAVE_X11 defined, the original title will
8657 be restored if possible. The output of ":version" will include "+X11"
8658 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8659 works for the icon name |'icon'|.
8660 But: When Vim was started with the |-X| argument, restoring the title
8661 will not work (except in the GUI).
8662 If the title cannot be restored, it is set to the value of 'titleold'.
8663 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008664 When using an xterm from a remote machine you can use this command: >
8665
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008667 ssh -X machine_name xterm &
8668<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 then the WINDOWID environment variable should be inherited and the
8670 title of the window should change back to what it should be after
8671 exiting Vim.
8672
8673 *'titlelen'*
8674'titlelen' number (default 85)
8675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008677 title. When the title is longer, only the end of the path name is
8678 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 Using a percentage makes this adapt to the width of the window. But
8680 it won't work perfectly, because the actual number of characters
8681 available also depends on the font used and other things in the title
8682 bar. When 'titlelen' is zero the full path is used. Otherwise,
8683 values from 1 to 30000 percent can be used.
8684 'titlelen' is also used for the 'titlestring' option.
8685
8686 *'titleold'*
8687'titleold' string (default "Thanks for flying Vim")
8688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 This option will be used for the window title when exiting Vim if the
8690 original title cannot be restored. Only happens if 'title' is on or
8691 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008692 This option cannot be set from a |modeline| or in the |sandbox|, for
8693 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 *'titlestring'*
8695'titlestring' string (default "")
8696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 When this option is not empty, it will be used for the title of the
8698 window. This happens only when the 'title' option is on.
8699 Only works if the terminal supports setting window titles (currently
8700 Amiga console, Win32 console, all GUI versions and terminals with a
8701 non-empty 't_ts' option).
8702 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008703 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008704
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 When this option contains printf-style '%' items, they will be
8706 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008707 This option cannot be set in a modeline when 'modelineexpr' is off.
8708
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008710 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8712< The value of 'titlelen' is used to align items in the middle or right
8713 of the available space.
8714 Some people prefer to have the file name first: >
8715 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8716< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008717 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 separating space only when needed.
8719 NOTE: Use of special characters in 'titlestring' may cause the display
8720 to be garbled (e.g., when it contains a CR or NL character).
8721 {not available when compiled without the |+statusline| feature}
8722
8723 *'toolbar'* *'tb'*
8724'toolbar' 'tb' string (default "icons,tooltips")
8725 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008726 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008727 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 possible values are:
8729 icons Toolbar buttons are shown with icons.
8730 text Toolbar buttons shown with text.
8731 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008732 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 tooltips Tooltips are active for toolbar buttons.
8734 Tooltips refer to the popup help text which appears after the mouse
8735 cursor is placed over a toolbar button for a brief moment.
8736
8737 If you want the toolbar to be shown with icons as well as text, do the
8738 following: >
8739 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008740< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 will show icons if both are requested.
8742
8743 If none of the strings specified in 'toolbar' are valid or if
8744 'toolbar' is empty, this option is ignored. If you want to disable
8745 the toolbar, you need to set the 'guioptions' option. For example: >
8746 :set guioptions-=T
8747< Also see |gui-toolbar|.
8748
8749 *'toolbariconsize'* *'tbis'*
8750'toolbariconsize' 'tbis' string (default "small")
8751 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008752 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008754 tiny Use tiny icons.
8755 small Use small icons (default).
8756 medium Use medium-sized icons.
8757 large Use large icons.
8758 huge Use even larger icons.
8759 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008761 the current theme. Common dimensions are giant=48x48, huge=32x32,
8762 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763
8764 If 'toolbariconsize' is empty, the global default size as determined
8765 by user preferences or the current theme is used.
8766
8767 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8768'ttybuiltin' 'tbi' boolean (default on)
8769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 When on, the builtin termcaps are searched before the external ones.
8771 When off the builtin termcaps are searched after the external ones.
8772 When this option is changed, you should set the 'term' option next for
8773 the change to take effect, for example: >
8774 :set notbi term=$TERM
8775< See also |termcap|.
8776 Rationale: The default for this option is "on", because the builtin
8777 termcap entries are generally better (many systems contain faulty
8778 xterm entries...).
8779
8780 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008781'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 Indicates a fast terminal connection. More characters will be sent to
8784 the screen for redrawing, instead of using insert/delete line
8785 commands. Improves smoothness of redrawing when there are multiple
8786 windows and the terminal does not support a scrolling region.
8787 Also enables the extra writing of characters at the end of each screen
8788 line for lines that wrap. This helps when using copy/paste with the
8789 mouse in an xterm and other terminals.
8790
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008791 The default used to be set only for some terminal names, but these
8792 days nearly all terminals are fast, therefore the default is now "on".
8793 If you have a slow connection you may want to set this option off,
8794 e.g. depending on the host name: >
8795 if hostname() =~ 'faraway'
8796 set nottyfast
8797 endif
8798<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 *'ttymouse'* *'ttym'*
8800'ttymouse' 'ttym' string (default depends on 'term')
8801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 {only in Unix and VMS, doesn't work in the GUI; not
8803 available when compiled without |+mouse|}
8804 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008805 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 *xterm-mouse*
8807 xterm xterm-like mouse handling. The mouse generates
8808 "<Esc>[Mscr", where "scr" is three bytes:
8809 "s" = button state
8810 "c" = column plus 33
8811 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008812 This only works up to 223 columns! See "dec",
8813 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 xterm2 Works like "xterm", but with the xterm reporting the
8815 mouse position while the mouse is dragged. This works
8816 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008817 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 work. See below for how Vim detects this
8819 automatically.
8820 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008821 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008823 for the row and column. No other mouse events are
8824 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 *dec-mouse*
8826 dec DEC terminal mouse handling. The mouse generates a
8827 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008828 This is also available for an Xterm, if it was
8829 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 *jsbterm-mouse*
8831 jsbterm JSB term mouse handling.
8832 *pterm-mouse*
8833 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008834 *urxvt-mouse*
8835 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008836 The mouse works only if the terminal supports this
8837 encoding style, but it does not have 223 columns limit
8838 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008839 *sgr-mouse*
8840 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008841 mouse reporting. The mouse works even in columns
8842 beyond 223. This option is backward compatible with
8843 "xterm2" because it can also decode "xterm2" style
8844 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845
8846 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008847 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8848 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8850 recognized, if enabled at compile time. DEC terminal mouse codes
8851 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008852 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8853 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008855 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8856 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8857 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008858 If the terminfo/termcap entry "XM" exists and the first number is
8859 "1006" then 'ttymouse' will be set to "sgr". This works for many
8860 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008861 Additionally, if vim is compiled with the |+termresponse| feature and
8862 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008863 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008865 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8866 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8867 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008868 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8869 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 :set t_RV=
8871<
8872 *'ttyscroll'* *'tsl'*
8873'ttyscroll' 'tsl' number (default 999)
8874 global
8875 Maximum number of lines to scroll the screen. If there are more lines
8876 to scroll the window is redrawn. For terminals where scrolling is
8877 very slow and redrawing is not slow this can be set to a small number,
8878 e.g., 3, to speed up displaying.
8879
8880 *'ttytype'* *'tty'*
8881'ttytype' 'tty' string (default from $TERM)
8882 global
8883 Alias for 'term', see above.
8884
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008885 *'undodir'* *'udir'*
8886'undodir' 'udir' string (default ".")
8887 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008888 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008889 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008890 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008891 "." means using the directory of the file. The undo file name for
8892 "file.txt" is ".file.txt.un~".
8893 For other directories the file name is the full path of the edited
8894 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008895 When writing: The first directory that exists is used. "." always
8896 works, no directories after "." will be used for writing.
8897 When reading all entries are tried to find an undo file. The first
8898 undo file that exists is used. When it cannot be read an error is
8899 given, no further entry is used.
8900 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008901 This option cannot be set from a |modeline| or in the |sandbox|, for
8902 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008903
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008904 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008905'undofile' 'udf' boolean (default off)
8906 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008907 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008908 When on, Vim automatically saves undo history to an undo file when
8909 writing a buffer to a file, and restores undo history from the same
8910 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008911 The directory where the undo file is stored is specified by 'undodir'.
8912 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008913 The undo file is not read when 'undoreload' causes the buffer from
8914 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008915 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008916 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008917
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008919'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008920 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008922 is kept in memory, higher numbers will cause more memory to be used.
8923 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8925 itself: >
8926 set ul=0
8927< But you can also get Vi compatibility by including the 'u' flag in
8928 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008929 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008930 Set to -1 for no undo at all. You might want to do this only for the
8931 current buffer: >
8932 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008934
8935 The local value is set to -123456 when the global value is to be used.
8936
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008937 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008939 *'undoreload'* *'ur'*
8940'undoreload' 'ur' number (default 10000)
8941 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008942 Save the whole buffer for undo when reloading it. This applies to the
8943 ":e!" command and reloading for when the buffer changed outside of
8944 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008945 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008946 of lines is smaller than the value of this option.
8947 Set this option to zero to disable undo for a reload.
8948
8949 When saving undo for a reload, any undo file is not read.
8950
8951 Note that this causes the whole buffer to be stored in memory. Set
8952 this option to a lower value if you run out of memory.
8953
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 *'updatecount'* *'uc'*
8955'updatecount' 'uc' number (default: 200)
8956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 After typing this many characters the swap file will be written to
8958 disk. When zero, no swap file will be created at all (see chapter on
8959 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8960 Vim with the "-n" option, see |startup|. When editing in readonly
8961 mode this option will be initialized to 10000.
8962 The swapfile can be disabled per buffer with |'swapfile'|.
8963 When 'updatecount' is set from zero to non-zero, swap files are
8964 created for all buffers that have 'swapfile' set. When 'updatecount'
8965 is set to zero, existing swap files are not deleted.
8966 Also see |'swapsync'|.
8967 This option has no meaning in buffers where |'buftype'| is "nofile"
8968 or "nowrite".
8969
8970 *'updatetime'* *'ut'*
8971'updatetime' 'ut' number (default 4000)
8972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 If this many milliseconds nothing is typed the swap file will be
8974 written to disk (see |crash-recovery|). Also used for the
8975 |CursorHold| autocommand event.
8976
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008977 *'varsofttabstop'* *'vsts'*
8978'varsofttabstop' 'vsts' string (default "")
8979 local to buffer
8980 {only available when compiled with the |+vartabs|
8981 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008982 A list of the number of spaces that a <Tab> counts for while editing,
8983 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8984 width <Tab>s are being inserted, while in fact a mixture of spaces
8985 and <Tab>s is used. Tab widths are separated with commas, with the
8986 final value applying to all subsequent tabs.
8987
8988 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008989 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008990 to use the following: >
8991 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008992< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8993 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008994
8995 Note that the value of |'softtabstop'| will be ignored while
8996 'varsofttabstop' is set.
8997
8998 *'vartabstop'* *'vts'*
8999'vartabstop' 'vts' string (default "")
9000 local to buffer
9001 {only available when compiled with the |+vartabs|
9002 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009003 A list of the number of spaces that a <Tab> in the file counts for,
9004 separated by commas. Each value corresponds to one tab, with the
9005 final value applying to all subsequent tabs. For example: >
9006 :set vartabstop=4,20,10,8
9007< This will make the first tab 4 spaces wide, the second 20 spaces,
9008 the third 10 spaces, and all following tabs 8 spaces.
9009
9010 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9011 is set.
9012
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 *'verbose'* *'vbs'*
9014'verbose' 'vbs' number (default 0)
9015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 When bigger than zero, Vim will give messages about what it is doing.
9017 Currently, these messages are given:
9018 >= 1 When the viminfo file is read or written.
9019 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009020 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009021 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 >= 8 Files for which a group of autocommands is executed.
9023 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009024 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 >= 12 Every executed function.
9026 >= 13 When an exception is thrown, caught, finished, or discarded.
9027 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009028 >= 15 Every executed Ex command from a script (truncated at 200
9029 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009030 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031
9032 This option can also be set with the "-V" argument. See |-V|.
9033 This option is also set by the |:verbose| command.
9034
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009035 When the 'verbosefile' option is set then the verbose messages are not
9036 displayed.
9037
9038 *'verbosefile'* *'vfile'*
9039'verbosefile' 'vfile' string (default empty)
9040 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009041 When not empty all messages are written in a file with this name.
9042 When the file exists messages are appended.
9043 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009044 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009045 Setting 'verbosefile' to a new value is like making it empty first.
9046 The difference with |:redir| is that verbose messages are not
9047 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009048 This option cannot be set from a |modeline| or in the |sandbox|, for
9049 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009050
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009052'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009053 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009054 for Unix: "$HOME/.vim/view" or
9055 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009056 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009057 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009059 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 feature}
9061 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009062 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 This option cannot be set from a |modeline| or in the |sandbox|, for
9064 security reasons.
9065
9066 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009067'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009069 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009071 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009072 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 word save and restore ~
9074 cursor cursor position in file and in window
9075 folds manually created folds, opened/closed folds and local
9076 fold options
9077 options options and mappings local to a window or buffer (not
9078 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009079 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 slash backslashes in file names replaced with forward
9081 slashes
9082 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009083 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009084 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009086 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009088 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089
9090 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009091'viminfo' 'vi' string (Vi default: "", Vim default for
9092 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009093 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9094 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009096 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 feature}
9098 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009099 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9100 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009101 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009102 consisting of a single character identifying the particular parameter,
9103 followed by a number or string which specifies the value of that
9104 parameter. If a particular character is left out, then the default
9105 value is used for that parameter. The following is a list of the
9106 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009108 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 ! When included, save and restore global variables that start
9110 with an uppercase letter, and don't contain a lowercase
9111 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009112 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009113 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009114 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 " Maximum number of lines saved for each register. Old name of
9116 the '<' item, with the disadvantage that you need to put a
9117 backslash before the ", otherwise it will be recognized as the
9118 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009119 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 % When included, save and restore the buffer list. If Vim is
9121 started with a file name argument, the buffer list is not
9122 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009123 buffer list is restored from the viminfo file. Quickfix
9124 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9125 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009126 When followed by a number, the number specifies the maximum
9127 number of buffers that are stored. Without a number all
9128 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009129 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 ' Maximum number of previously edited files for which the marks
9131 are remembered. This parameter must always be included when
9132 'viminfo' is non-empty.
9133 Including this item also means that the |jumplist| and the
9134 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009135 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009137 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 patterns are also saved. When not included, the value of
9139 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009140 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009142 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009143 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 < Maximum number of lines saved for each register. If zero then
9145 registers are not saved. When not included, all lines are
9146 saved. '"' is the old name for this item.
9147 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009148 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009150 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009151 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 c When included, convert the text in the viminfo file from the
9153 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009154 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009155 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 f Whether file marks need to be stored. If zero, file marks ('0
9157 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009158 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009160 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 h Disable the effect of 'hlsearch' when loading the viminfo
9162 file. When not included, it depends on whether ":nohlsearch"
9163 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009164 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009166 the 'n'. Must be at the end of the option! If the
9167 'viminfofile' option is set, that file name overrides the one
9168 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009169 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009170 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 r Removable media. The argument is a string (up to the next
9172 ','). This parameter can be given several times. Each
9173 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009174 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9176 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9177 ignored. Maximum length of each 'r' argument is 50
9178 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009179 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 s Maximum size of an item in Kbyte. If zero then registers are
9181 not saved. Currently only applies to registers. The default
9182 "s10" will exclude registers with more than 10 Kbyte of text.
9183 Also see the '<' item above: line count limit.
9184
9185 Example: >
9186 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9187<
9188 '50 Marks will be remembered for the last 50 files you
9189 edited.
9190 <1000 Contents of registers (up to 1000 lines each) will be
9191 remembered.
9192 s100 Registers with more than 100 Kbyte text are skipped.
9193 :0 Command-line history will not be saved.
9194 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9195 no / Since '/' is not specified, the default will be used,
9196 that is, save all of the search history, and also the
9197 previous search and substitute patterns.
9198 no % The buffer list will not be saved nor read back.
9199 no h 'hlsearch' highlighting will be restored.
9200
9201 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9202 load the contents of the file, this is not done automatically.
9203
9204 This option cannot be set from a |modeline| or in the |sandbox|, for
9205 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009206 NOTE: This option is set to the Vim default value when 'compatible'
9207 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009209 *'viminfofile'* *'vif'*
9210'viminfofile' 'vif' string (default: "")
9211 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009212 {not available when compiled without the |+viminfo|
9213 feature}
9214 When non-empty, overrides the file name used for viminfo.
9215 When equal to "NONE" no viminfo file will be read or written.
9216 This option can be set with the |-i| command line flag. The |--clean|
9217 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009218 This option cannot be set from a |modeline| or in the |sandbox|, for
9219 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009220
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 *'virtualedit'* *'ve'*
9222'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009223 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009224 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 block Allow virtual editing in Visual block mode.
9226 insert Allow virtual editing in Insert mode.
9227 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009228 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009229 none When used as the local value, do not allow virtual
9230 editing even when the global value is set. When used
9231 as the global value, "none" is the same as "".
9232 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009233
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009235 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009236 of the line. Useful for selecting a rectangle in Visual mode and
9237 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009238 "onemore" is not the same, it will only allow moving the cursor just
9239 after the last character of the line. This makes some commands more
9240 consistent. Previously the cursor was always past the end of the line
9241 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009242 break some plugins or Vim scripts. For example because |l| can move
9243 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009244 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009245 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009246 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009247 It doesn't make sense to combine "all" with "onemore", but you will
9248 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009249 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009250 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251
9252 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9253'visualbell' 'vb' boolean (default off)
9254 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009255 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009257 use: >
9258 :set vb t_vb=
9259< If you want a short flash, you can use this on many terminals: >
9260 :set vb t_vb=[?5h$<100>[?5l
9261< Here $<100> specifies the time, you can use a smaller or bigger value
9262 to get a shorter or longer flash.
9263
9264 Note: Vim will limit the bell to once per half a second. This avoids
9265 having to wait for the flashing to finish when there are lots of
9266 bells, e.g. on key repeat. This also happens without 'visualbell'
9267 set.
9268
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9270 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9271 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009272
9273 Note: When the GUI starts, 't_vb' is reset to its default value. You
9274 might want to set it again in your |gvimrc|.
9275
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 Does not work on the Amiga, you always get a screen flash.
9277 Also see 'errorbells'.
9278
9279 *'warn'* *'nowarn'*
9280'warn' boolean (default on)
9281 global
9282 Give a warning message when a shell command is used while the buffer
9283 has been changed.
9284
9285 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9286'weirdinvert' 'wiv' boolean (default off)
9287 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009288 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 It is provided for backwards compatibility with version 4.x.
9290 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9291 vice versa. Has no effect when the GUI is running.
9292
9293 *'whichwrap'* *'ww'*
9294'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 Allow specified keys that move the cursor left/right to move to the
9297 previous/next line when the cursor is on the first/last character in
9298 the line. Concatenate characters to allow this for these keys:
9299 char key mode ~
9300 b <BS> Normal and Visual
9301 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009302 h "h" Normal and Visual (not recommended)
9303 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304 < <Left> Normal and Visual
9305 > <Right> Normal and Visual
9306 ~ "~" Normal
9307 [ <Left> Insert and Replace
9308 ] <Right> Insert and Replace
9309 For example: >
9310 :set ww=<,>,[,]
9311< allows wrap only when cursor keys are used.
9312 When the movement keys are used in combination with a delete or change
9313 operator, the <EOL> also counts for a character. This makes "3h"
9314 different from "3dh" when the cursor crosses the end of a line. This
9315 is also true for "x" and "X", because they do the same as "dl" and
9316 "dh". If you use this, you may also want to use the mapping
9317 ":map <BS> X" to make backspace delete the character in front of the
9318 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009319 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009320 line (not an empty line) then it will not move to the next line. This
9321 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009322 NOTE: This option is set to the Vi default value when 'compatible' is
9323 set and to the Vim default value when 'compatible' is reset.
9324
9325 *'wildchar'* *'wc'*
9326'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 Character you have to type to start wildcard expansion in the
9329 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009330 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 The character is not recognized when used inside a macro. See
9332 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009333 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009334 <Esc> can be used, but hitting it twice in a row will still exit
9335 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009336 Although 'wc' is a number option, it can be specified as a number, a
9337 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9338 preceded with a caret (e.g. `^F` is CTRL-F): >
9339 :set wc=27
9340 :set wc=X
9341 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009342 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343< NOTE: This option is set to the Vi default value when 'compatible' is
9344 set and to the Vim default value when 'compatible' is reset.
9345
9346 *'wildcharm'* *'wcm'*
9347'wildcharm' 'wcm' number (default: none (0))
9348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009350 recognized when used inside a macro. You can find "spare" command-line
9351 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352 you'll never actually type 'wildcharm', just use it in mappings that
9353 automatically invoke completion mode, e.g.: >
9354 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009355 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356< Then after typing :ss you can use CTRL-P & CTRL-N.
9357
9358 *'wildignore'* *'wig'*
9359'wildignore' 'wig' string (default "")
9360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009362 patterns is ignored when expanding |wildcards|, completing file or
9363 directory names, and influences the result of |expand()|, |glob()| and
9364 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009365 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9366 Also see 'suffixes'.
9367 Example: >
9368 :set wildignore=*.o,*.obj
9369< The use of |:set+=| and |:set-=| is preferred when adding or removing
9370 a pattern from the list. This avoids problems when a future version
9371 uses another default.
9372
h_east596a9f22023-11-21 21:24:23 +09009373 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009374'wildignorecase' 'wic' boolean (default off)
9375 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009376 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009377 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009378 Does not apply when the shell is used to expand wildcards, which
9379 happens when there are special characters.
9380
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009382'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009384 When 'wildmenu' is on, command-line completion operates in an enhanced
9385 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009386 the possible matches are shown.
9387 When 'wildoptions' contains "pum", then the completion matches are
9388 shown in a popup menu. Otherwise they are displayed just above the
9389 command line, with the first match highlighted (overwriting the status
9390 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009391 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009392 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9393 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9394 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009395 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009396 If there are more matches than can fit in the line, a ">" is shown on
9397 the right and/or a "<" is shown on the left. The status line scrolls
9398 as needed.
9399 The "wildmenu" mode is abandoned when a key is hit that is not used
9400 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009401 While the "wildmenu" is active, the following keys have special
9402 meanings:
9403 CTRL-P - go to the previous entry
9404 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 <CR> - in menu completion, when the cursor is just after a
9406 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009407 CTRL-E - end completion, go back to what was there before
9408 selecting a match.
9409 CTRL-Y - accept the currently selected match and stop
9410 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009411
9412 When not using the popup menu for command line completion, the
9413 following keys have special meanings:
9414 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009415 <Up> - in filename/menu name completion: move up into
9416 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009417 <Down> - in filename/menu name completion: move into a
9418 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009419
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009420 When using the popup menu for command line completion, the following
9421 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009422 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009423 <PageUp> - select a match several entries back
9424 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009425 <Left> - in filename/menu name completion: move up into
9426 parent directory or parent menu.
9427 <Right> - in filename/menu name completion: move into a
9428 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009429
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430 This makes the menus accessible from the console |console-menus|.
9431
9432 If you prefer the <Left> and <Right> keys to move the cursor instead
9433 of selecting a different match, use this: >
9434 :cnoremap <Left> <Space><BS><Left>
9435 :cnoremap <Right> <Space><BS><Right>
9436<
9437 The "WildMenu" highlighting is used for displaying the current match
9438 |hl-WildMenu|.
9439
9440 *'wildmode'* *'wim'*
9441'wildmode' 'wim' string (Vim default: "full")
9442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009443 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009444 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009445 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009446 first part specifies the behavior for the first use of 'wildchar',
9447 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009448
9449 Each part consists of a colon separated list consisting of the
9450 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009451 "" Complete only the first match.
9452 "full" Complete the next full match. After the last match,
9453 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009454 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009455 "longest" Complete till longest common string. If this doesn't
9456 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009458 "lastused" When completing buffer names and more than one buffer
9459 matches, sort buffers by time last used (other than
9460 the current buffer).
9461 When there is only a single match, it is fully completed in all cases.
9462
9463 Examples of useful colon-separated values:
9464 "longest:full" Like "longest", but also start 'wildmenu' if it is
9465 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466 "list:full" When more than one match, list all matches and
9467 complete first match.
9468 "list:longest" When more than one match, list all matches and
9469 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009470 "list:lastused" When more than one buffer matches, list all matches
9471 and sort buffers by time last used (other than the
9472 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009473
9474 Examples: >
9475 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009476< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 :set wildmode=longest,full
9478< Complete longest common string, then each full match >
9479 :set wildmode=list:full
9480< List all matches and complete each full match >
9481 :set wildmode=list,full
9482< List all matches without completing, then each full match >
9483 :set wildmode=longest,list
9484< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009485 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009486
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009487 *'wildoptions'* *'wop'*
9488'wildoptions' 'wop' string (default "")
9489 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009490 A list of words that change how |cmdline-completion| is done.
9491 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009492 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009493 this value is specified, wildcard expansion will not
9494 be used for completion. The matches will be sorted by
9495 the "best match" rather than alphabetically sorted.
9496 This will find more matches than the wildcard
9497 expansion. Currently fuzzy matching based completion
9498 is not supported for file and directory names and
9499 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009500 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009501 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009502 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009503 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009504 is displayed per line. Often used tag kinds are:
9505 d #define
9506 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009507
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508 *'winaltkeys'* *'wak'*
9509'winaltkeys' 'wak' string (default "menu")
9510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511 {only used in Win32, Motif, GTK and Photon GUI}
9512 Some GUI versions allow the access to menu entries by using the ALT
9513 key in combination with a character that appears underlined in the
9514 menu. This conflicts with the use of the ALT key for mappings and
9515 entering special characters. This option tells what to do:
9516 no Don't use ALT keys for menus. ALT key combinations can be
9517 mapped, but there is no automatic handling. This can then be
9518 done with the |:simalt| command.
9519 yes ALT key handling is done by the windowing system. ALT key
9520 combinations cannot be mapped.
9521 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009522 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 keys can be mapped.
9524 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9525 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009526 This option is not used for <F10>; on Win32 and with GTK <F10> will
9527 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009528
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009529 *'wincolor'* *'wcr'*
9530'wincolor' 'wcr' string (default empty)
9531 local to window
9532 Highlight group name to use for this window instead of the Normal
9533 color |hl-Normal|.
9534
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009535 *'window'* *'wi'*
9536'window' 'wi' number (default screen height - 1)
9537 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009538 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9539 window and the value is smaller than 'lines' minus one. The screen
9540 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009541 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9542 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009543 When resizing the Vim window, and the value is smaller than 1 or more
9544 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009545 Note: Do not confuse this with the height of the Vim window, use
9546 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009547
Colin Kennedy21570352024-03-03 16:16:47 +01009548 *'winfixbuf'*
9549'winfixbuf' 'wfb' boolean (default off)
9550 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009551 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009552 For example, attempting to change the buffer with |:edit| will fail.
9553 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009554 also skip any window with 'winfixbuf' enabled. However if an Ex
9555 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009556
laburnumT3f7855a2023-12-05 18:37:03 +01009557 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9558'winfixheight' 'wfh' boolean (default off)
9559 local to window |local-noglobal|
9560 Keep the window height when windows are opened or closed and
9561 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9562 |preview-window| and |quickfix-window|.
9563 The height may be changed anyway when running out of room.
9564
9565 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9566'winfixwidth' 'wfw' boolean (default off)
9567 local to window |local-noglobal|
9568 Keep the window width when windows are opened or closed and
9569 'equalalways' is set. Also for |CTRL-W_=|.
9570 The width may be changed anyway when running out of room.
9571
Bram Moolenaar071d4272004-06-13 20:20:40 +00009572 *'winheight'* *'wh'* *E591*
9573'winheight' 'wh' number (default 1)
9574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009576 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009577 focus goes to a window that is smaller, its size is increased, at the
9578 cost of the height of other windows.
9579 Set 'winheight' to a small number for normal editing.
9580 Set it to 999 to make the current window fill most of the screen.
9581 Other windows will be only 'winminheight' high. This has the drawback
9582 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9583 to create only two windows, set the option after startup is done,
9584 using the |VimEnter| event: >
9585 au VimEnter * set winheight=999
9586< Minimum value is 1.
9587 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 height of the current window.
9589 'winheight' applies to the current window. Use 'winminheight' to set
9590 the minimal height for other windows.
9591
Bram Moolenaar071d4272004-06-13 20:20:40 +00009592 *'winminheight'* *'wmh'*
9593'winminheight' 'wmh' number (default 1)
9594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009595 The minimal height of a window, when it's not the current window.
9596 This is a hard minimum, windows will never become smaller.
9597 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9598 status bar) if necessary. They will return to at least one line when
9599 they become active (since the cursor has to have somewhere to go.)
9600 Use 'winheight' to set the minimal height of the current window.
9601 This option is only checked when making a window smaller. Don't use a
9602 large number, it will cause errors when opening more than a few
9603 windows. A value of 0 to 3 is reasonable.
9604
9605 *'winminwidth'* *'wmw'*
9606'winminwidth' 'wmw' number (default 1)
9607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009608 The minimal width of a window, when it's not the current window.
9609 This is a hard minimum, windows will never become smaller.
9610 When set to zero, windows may be "squashed" to zero columns (i.e. just
9611 a vertical separator) if necessary. They will return to at least one
9612 line when they become active (since the cursor has to have somewhere
9613 to go.)
9614 Use 'winwidth' to set the minimal width of the current window.
9615 This option is only checked when making a window smaller. Don't use a
9616 large number, it will cause errors when opening more than a few
9617 windows. A value of 0 to 12 is reasonable.
9618
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009619 *'winptydll'*
9620'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9621 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009622 {only available when compiled with the |terminal|
9623 feature on MS-Windows}
9624 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009625 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009626 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009627 a fallback.
9628 Environment variables are expanded |:set_env|.
9629 This option cannot be set from a |modeline| or in the |sandbox|, for
9630 security reasons.
9631
Bram Moolenaar071d4272004-06-13 20:20:40 +00009632 *'winwidth'* *'wiw'* *E592*
9633'winwidth' 'wiw' number (default 20)
9634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009635 Minimal number of columns for the current window. This is not a hard
9636 minimum, Vim will use fewer columns if there is not enough room. If
9637 the current window is smaller, its size is increased, at the cost of
9638 the width of other windows. Set it to 999 to make the current window
9639 always fill the screen. Set it to a small number for normal editing.
9640 The width is not adjusted after one of the commands to change the
9641 width of the current window.
9642 'winwidth' applies to the current window. Use 'winminwidth' to set
9643 the minimal width for other windows.
9644
9645 *'wrap'* *'nowrap'*
9646'wrap' boolean (default on)
9647 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009648 This option changes how text is displayed. It doesn't change the text
9649 in the buffer, see 'textwidth' for that.
9650 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009651 displaying continues on the next line. When off lines will not wrap
9652 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009653 moved to a part that is not shown, the screen will scroll
9654 horizontally.
9655 The line will be broken in the middle of a word if necessary. See
9656 'linebreak' to get the break at a word boundary.
9657 To make scrolling horizontally a bit more useful, try this: >
9658 :set sidescroll=5
9659 :set listchars+=precedes:<,extends:>
9660< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009661 This option can't be set from a |modeline| when the 'diff' option is
9662 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009663
9664 *'wrapmargin'* *'wm'*
9665'wrapmargin' 'wm' number (default 0)
9666 local to buffer
9667 Number of characters from the right window border where wrapping
9668 starts. When typing text beyond this limit, an <EOL> will be inserted
9669 and inserting continues on the next line.
9670 Options that add a margin, such as 'number' and 'foldcolumn', cause
9671 the text width to be further reduced. This is Vi compatible.
9672 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009673 This option is set to 0 when 'paste' is set and restored when 'paste'
9674 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009675 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009676
9677 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9678'wrapscan' 'ws' boolean (default on) *E384* *E385*
9679 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009680 Searches wrap around the end of the file. Also applies to |]s| and
9681 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009682
9683 *'write'* *'nowrite'*
9684'write' boolean (default on)
9685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009686 Allows writing files. When not set, writing a file is not allowed.
9687 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009688 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009689 argument. Filtering text is still possible, even though this requires
9690 writing a temporary file.
9691
9692 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9693'writeany' 'wa' boolean (default off)
9694 global
9695 Allows writing to any file with no need for "!" override.
9696
9697 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9698'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9699 otherwise)
9700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009701 Make a backup before overwriting a file. The backup is removed after
9702 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009703 also on.
9704 WARNING: Switching this option off means that when Vim fails to write
9705 your buffer correctly and then, for whatever reason, Vim exits, you
9706 lose both the original file and what you were writing. Only reset
9707 this option if your file system is almost full and it makes the write
9708 fail (and make sure not to exit Vim until the write was successful).
9709 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009710 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009711 Depending on 'backupcopy' the backup is a new file or the original
9712 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009713 NOTE: This option is set to the default value when 'compatible' is
9714 set.
9715
9716 *'writedelay'* *'wd'*
9717'writedelay' 'wd' number (default 0)
9718 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009719 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009720 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009721 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009722
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009723 *'xtermcodes'* *'noxtermcodes'*
9724'xtermcodes' boolean (default on)
9725 global
9726 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009727 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009728 key codes and number of colors from the terminal. This takes care of
9729 various configuration options of the terminal that cannot be obtained
9730 from the termlib/terminfo entry, see |xterm-codes|.
9731 A side effect may be that t_Co changes and Vim will redraw the
9732 display.
9733
9734
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009735 vim:tw=78:ts=8:noet:ft=help:norl: