blob: 84deecae6fdca8e13e92948a66d992c02e0dab6e [file] [log] [blame]
zeertzjq5a307c32025-03-28 19:01:32 +01001*options.txt* For Vim version 9.1. Last change: 2025 Mar 28
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*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
1720 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1721'cindent' 'cin' boolean (default off)
1722 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001723 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 that trigger reindenting in insert mode and 'cinoptions' to set your
1725 preferred indent style.
1726 If 'indentexpr' is not empty, it overrules 'cindent'.
1727 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1728 the "=" operator indents using this algorithm rather than calling an
1729 external program.
1730 See |C-indenting|.
1731 When you don't like the way 'cindent' works, try the 'smartindent'
1732 option or 'indentexpr'.
1733 This option is not used when 'paste' is set.
1734 NOTE: This option is reset when 'compatible' is set.
1735
1736 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001737'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 A list of keys that, when typed in Insert mode, cause reindenting of
1740 the current line. Only used if 'cindent' is on and 'indentexpr' is
1741 empty.
1742 For the format of this option see |cinkeys-format|.
1743 See |C-indenting|.
1744
1745 *'cinoptions'* *'cino'*
1746'cinoptions' 'cino' string (default "")
1747 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1749 program. See |cinoptions-values| for the values of this option, and
1750 |C-indenting| for info on C indenting in general.
1751
laburnumT3f7855a2023-12-05 18:37:03 +01001752 *'cinscopedecls'* *'cinsd'*
1753'cinscopedecls' 'cinsd' string (default "public,protected,private")
1754 local to buffer
1755 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1756 Useful e.g. for working with the Qt framework that defines additional
1757 scope declarations "signals", "public slots" and "private slots": >
1758 set cinscopedecls+=signals,public\ slots,private\ slots
1759<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *'cinwords'* *'cinw'*
1761'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 These keywords start an extra indent in the next line when
1764 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1765 an appropriate place (inside {}).
1766 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1767 matter, include the keyword both the uppercase and lowercase:
1768 "if,If,IF".
1769
laburnumT3f7855a2023-12-05 18:37:03 +01001770 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1772 for X-windows, "" otherwise)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 {only in GUI versions or when the |+xterm_clipboard|
1775 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001776 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001778 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001779 prepend, e.g.: >
1780 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001781< When using the GUI see |'go-A'|.
1782 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001784 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 unnamed When included, Vim will use the clipboard register '*'
1786 for all yank, delete, change and put operations which
1787 would normally go to the unnamed register. When a
1788 register is explicitly specified, it will always be
1789 used regardless of whether "unnamed" is in 'clipboard'
1790 or not. The clipboard register can always be
1791 explicitly accessed using the "* notation. Also see
1792 |gui-clipboard|.
1793
Bram Moolenaar30b65812012-07-12 22:01:11 +02001794 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001795 unnamedplus A variant of the "unnamed" flag which uses the
1796 clipboard register '+' (|quoteplus|) instead of
1797 register '*' for all yank, delete, change and put
1798 operations which would normally go to the unnamed
1799 register. When "unnamed" is also included to the
1800 option, yank operations (but not delete, change or
1801 put) will additionally copy the text into register
1802 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001803 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001804 Availability can be checked with: >
1805 if has('unnamedplus')
1806<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 autoselect Works like the 'a' flag in 'guioptions': If present,
1809 then whenever Visual mode is started, or the Visual
1810 area extended, Vim tries to become the owner of the
1811 windowing system's global selection or put the
1812 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001813 register "*. See |'go-a'| and |quotestar| for details.
1814 When the GUI is active, the 'a' flag in 'guioptions'
1815 is used, when the GUI is not active, this "autoselect"
1816 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 Also applies to the modeless selection.
1818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-autoselectplus*
1820 autoselectplus Like "autoselect" but using the + register instead of
1821 the * register. Compare to the 'P' flag in
1822 'guioptions'.
1823
1824 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 autoselectml Like "autoselect", but for the modeless selection
1826 only. Compare to the 'A' flag in 'guioptions'.
1827
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001828 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001829 html When the clipboard contains HTML, use this when
1830 pasting. When putting text on the clipboard, mark it
1831 as HTML. This works to copy rendered HTML from
1832 Firefox, paste it as raw HTML in Vim, select the HTML
1833 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001834 You probably want to add this only temporarily,
1835 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001837
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001838 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 exclude:{pattern}
1840 Defines a pattern that is matched against the name of
1841 the terminal 'term'. If there is a match, no
1842 connection will be made to the X server. This is
1843 useful in this situation:
1844 - Running Vim in a console.
1845 - $DISPLAY is set to start applications on another
1846 display.
1847 - You do not want to connect to the X server in the
1848 console, but do want this in a terminal emulator.
1849 To never connect to the X server use: >
1850 exclude:.*
1851< This has the same effect as using the |-X| argument.
1852 Note that when there is no connection to the X server
1853 the window title won't be restored and the clipboard
1854 cannot be accessed.
1855 The value of 'magic' is ignored, {pattern} is
1856 interpreted as if 'magic' was on.
1857 The rest of the option value will be used for
1858 {pattern}, this must be the last entry.
1859
1860 *'cmdheight'* *'ch'*
1861'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001862 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001863 Number of screen lines to use for the command-line. A larger value
1864 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001865 The value of this option is stored with the tab page, so that each tab
1866 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867
1868 *'cmdwinheight'* *'cwh'*
1869'cmdwinheight' 'cwh' number (default 7)
1870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 Number of screen lines to use for the command-line window. |cmdwin|
1872
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001873 *'colorcolumn'* *'cc'*
1874'colorcolumn' 'cc' string (default "")
1875 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001876 {not available when compiled without the |+syntax|
1877 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001878 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001879 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1880 text. Will make screen redrawing slower.
1881 The screen column can be an absolute number, or a number preceded with
1882 '+' or '-', which is added to or subtracted from 'textwidth'. >
1883
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001884 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001885 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1886 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1887<
1888 When 'textwidth' is zero then the items with '-' and '+' are not used.
1889 A maximum of 256 columns are highlighted.
1890
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *'columns'* *'co'* *E594*
1892'columns' 'co' number (default 80 or terminal width)
1893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001895 initialization and does not have to be set by hand. Also see
1896 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 When Vim is running in the GUI or in a resizable window, setting this
1898 option will cause the window size to be changed. When you only want
1899 to use the size for the GUI, put the command in your |gvimrc| file.
1900 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001901 number of columns of the display, the display may be messed up. For
1902 the GUI it is always possible and Vim limits the number of columns to
1903 what fits on the screen. You can use this command to get the widest
1904 window possible: >
1905 :set columns=9999
1906< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907
1908 *'comments'* *'com'* *E524* *E525*
1909'comments' 'com' string (default
1910 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1911 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001912 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 |format-comments|. See |option-backslash| about using backslashes to
1914 insert a space.
1915
1916 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001917'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 {not available when compiled without the |+folding|
1920 feature}
1921 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001922 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001923 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001924 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
1926 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001928 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 This option has the effect of making Vim either more Vi-compatible, or
1931 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 other options are also changed as a side effect.
1935 NOTE: Setting or resetting this option can have a lot of unexpected
1936 effects: Mappings are interpreted in another way, undo behaves
1937 differently, etc. If you set this option in your vimrc file, you
1938 should probably put it at the very start.
1939
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 By default this option is on and the Vi defaults are used for the
1941 options. This default was chosen for those people who want to use Vim
1942 just like Vi, and don't even (want to) know about the 'compatible'
1943 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001944 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001945 this option is switched off, and all options that have not been
1946 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001947 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001948 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001949 happen for the system-wide vimrc or gvimrc file, nor for a file given
1950 with the |-u| argument). Also see |compatible-default| and
1951 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 You can also set this option with the "-C" argument, and reset it with
1953 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 When this option is set, numerous other options are set to make Vim as
1957 Vi-compatible as possible. When this option is unset, various options
1958 are set to make Vim more useful. The table below lists all the
1959 options affected.
1960 The {?} column indicates when the options are affected:
1961 + Means that the option is set to the value given in {set value} when
1962 'compatible' is set.
1963 & Means that the option is set to the value given in {set value} when
1964 'compatible' is set AND is set to its Vim default value when
1965 'compatible' is unset.
1966 - Means the option is NOT changed when setting 'compatible' but IS
1967 set to its Vim default when 'compatible' is unset.
1968 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
Bram Moolenaar036986f2017-03-16 17:41:02 +01001970 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971
1972 'allowrevins' + off no CTRL-_ command
1973 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001974 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001975 'arabicshape' + on correct character shapes
1976 'backspace' + "" normal backspace
1977 'backup' + off no backup file
1978 'backupcopy' & Unix: "yes" backup file is a copy
1979 else: "auto" copy or rename backup file
1980 'balloonexpr' + "" text to show in evaluation balloon
1981 'breakindent' + off don't indent when wrapping lines
1982 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001983 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cindent' + off no C code indentation
1985 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1986 'copyindent' + off don't copy indent structure
1987 'cpoptions' & (all flags) Vi-compatible flags
1988 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001989 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001991 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'cscopeverbose' + off see |cscopeverbose|
1993 'delcombine' + off unicode: delete whole char combination
1994 'digraph' + off no digraphs
1995 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001996 this also disables |modifyOtherKeys|
1997 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001998 'expandtab' + off tabs not expanded to spaces
1999 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002000 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002001 'formatexpr' + "" use 'formatprg' for auto-formatting
2002 'formatoptions' & "vt" Vi compatible formatting
2003 'gdefault' + off no default 'g' flag for ":s"
2004 'history' & 0 no commandline history
2005 'hkmap' + off no Hebrew keyboard mapping
2006 'hkmapp' + off no phonetic Hebrew keyboard mapping
2007 'hlsearch' + off no highlighting of search matches
2008 'incsearch' + off no incremental searching
2009 'indentexpr' + "" no indenting by expression
2010 'insertmode' + off do not start in Insert mode
2011 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002013 'joinspaces' + on insert 2 spaces after period
2014 'modeline' & off no modelines
2015 'more' & off no pauses in listings
2016 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2017 'numberwidth' & 8 min number of columns for line number
2018 'preserveindent'+ off don't preserve current indent structure
2019 when changing it
2020 'revins' + off no reverse insert
2021 'ruler' + off no ruler
2022 'scrolljump' + 1 no jump scroll
2023 'scrolloff' + 0 no scroll offset
2024 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2025 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002026 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002027 'showcmd' & off command characters not shown
2028 'showmode' & off current mode not shown
2029 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2030 'smartcase' + off no automatic ignore case switch
2031 'smartindent' + off no smart indentation
2032 'smarttab' + off no smart tab size
2033 'softtabstop' + 0 tabs are always 'tabstop' positions
2034 'startofline' + on goto startofline with some commands
2035 'tagcase' & "followic" 'ignorecase' when searching tags file
2036 'tagrelative' & off tag file names are not relative
2037 'termguicolors' + off don't use highlight-(guifg|guibg)
2038 'textauto' & off no automatic textmode detection
2039 'textwidth' + 0 no automatic line wrap
2040 'tildeop' + off tilde is not an operator
2041 'ttimeout' + off no terminal timeout
2042 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'virtualedit' + "" cursor can only be placed on characters
2045 'whichwrap' & "" left-right movements don't wrap
2046 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002048 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
2050 *'complete'* *'cpt'* *E535*
2051'complete' 'cpt' string (default: ".,w,b,u,t,i")
2052 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 This option specifies how keyword completion |ins-completion| works
2054 when CTRL-P or CTRL-N are used. It is also used for whole-line
2055 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002056 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002057 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 w scan buffers from other windows
2059 b scan other loaded buffers that are in the buffer list
2060 u scan the unloaded buffers that are in the buffer list
2061 U scan the buffers that are not in the buffer list
2062 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002063 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 k{dict} scan the file {dict}. Several "k" flags can be given,
2065 patterns are valid too. For example: >
2066 :set cpt=k/usr/dict/*,k~/spanish
2067< s scan the files given with the 'thesaurus' option
2068 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2069 are valid too.
2070 i scan current and included files
2071 d scan current and included files for defined name or macro
2072 |i_CTRL-X_CTRL-D|
2073 ] tag completion
2074 t same as "]"
2075
2076 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2077 not executed, this may lead to unexpected completions from some files
2078 (gzipped files for example). Unloaded buffers are not scanned for
2079 whole-line completion.
2080
2081 The default is ".,w,b,u,t,i", which means to scan:
2082 1. the current buffer
2083 2. buffers in other windows
2084 3. other loaded buffers
2085 4. unloaded buffers
2086 5. tags
2087 6. included files
2088
2089 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002090 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2091 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002093 *'completefunc'* *'cfu'*
2094'completefunc' 'cfu' string (default: empty)
2095 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002096 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002097 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002098 This option specifies a function to be used for Insert mode completion
2099 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002100 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002101 invoked and what it should return. The value can be the name of a
2102 function, a |lambda| or a |Funcref|. See |option-value-function| for
2103 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002104 This option cannot be set from a |modeline| or in the |sandbox|, for
2105 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002106
glepnirf31cfa22025-03-06 21:59:13 +01002107 *'completefuzzycollect'* *'cfc'*
2108'completefuzzycollect' 'cfc' string (default: empty)
2109 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002110 A comma-separated list of strings to enable fuzzy collection for
2111 specific |ins-completion| modes, affecting how matches are gathered
2112 during completion. For specified modes, fuzzy matching is used to
2113 find completion candidates instead of the standard prefix-based
2114 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002115
glepnir58760162025-03-13 21:39:51 +01002116 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2117 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2118 "b", "u", "U" and "k{dict}" in 'complete'
2119 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002120
glepnir58760162025-03-13 21:39:51 +01002121 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002122
glepnir58760162025-03-13 21:39:51 +01002123 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002124
Christian Brabandtf22580e2025-03-14 12:05:52 +01002125 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002126 can identify the longest common string among the best fuzzy matches
2127 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002128
glepnir6a89c942024-10-01 20:32:12 +02002129 *'completeitemalign'* *'cia'*
2130'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2131 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002132 A comma-separated list of strings that controls the alignment and
2133 display order of items in the popup menu during Insert mode
2134 completion. The supported values are "abbr", "kind", and "menu".
2135 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002136 popup menu. Note: must always contain those three values in any
2137 order.
2138
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002139 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002140'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002141 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002142 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002143 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002144
glepnira2c55592025-02-28 17:43:42 +01002145 fuzzy Enable |fuzzy-matching| for completion candidates. This
2146 allows for more flexible and intuitive matching, where
2147 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002148 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002149 does not affect the collection of candidate list, it only
2150 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002151 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002152 to gather more alternatives for your candidate list,
2153 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002154
2155 longest Only insert the longest common text of the matches. If
2156 the menu is displayed you can use CTRL-L to add more
2157 characters. Whether case is ignored depends on the kind
2158 of completion. For buffer text the 'ignorecase' option is
2159 used.
2160
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002161 menu Use a popup menu to show the possible completions. The
2162 menu is only shown when there is more than one match and
2163 sufficient colors are available. |ins-completion-menu|
2164
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002165 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002166 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002167 match, e.g., what file it comes from.
2168
glepnira2c55592025-02-28 17:43:42 +01002169 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002170 a match from the menu. Only works in combination with
2171 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002172
glepnira2c55592025-02-28 17:43:42 +01002173 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002174 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002175 present, "noselect" has precedence.
2176
2177 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002178 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002179 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002180
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002181 popup Show extra information about the currently selected
2182 completion in a popup window. Only works in combination
2183 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002184 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002185 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002186
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002187 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002188 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002189 |CompleteChanged| autocommand to fetch the info and call
2190 |popup_show()| once the popup has been filled.
2191 See the example at |complete-popuphidden|.
2192 {only works when compiled with the |+textprop| feature}
2193
glepniredd4ac32025-01-29 18:53:51 +01002194 preinsert
2195 Preinsert the portion of the first candidate word that is
2196 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002197 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002198 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002199
2200 preview Show extra information about the currently selected
2201 completion in the preview window. Only works in
2202 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002203
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002204 *'completepopup'* *'cpp'*
2205'completepopup' 'cpp' string (default empty)
2206 global
2207 {not available when compiled without the |+textprop|
2208 or |+quickfix| feature}
2209 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002210 properties of the info popup when it is created. If an info popup
2211 window already exists it is closed, so that the option value is
2212 applied when it is created again.
2213 You can also use |popup_findinfo()| and then set properties for an
2214 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002215
laburnumT3f7855a2023-12-05 18:37:03 +01002216 *'completeslash'* *'csl'*
2217'completeslash' 'csl' string (default: "")
2218 local to buffer
2219 {only for MS-Windows}
2220 When this option is set it overrules 'shellslash' for completion:
2221 - When this option is set to "slash", a forward slash is used for path
2222 completion in insert mode. This is useful when editing HTML tag, or
2223 Makefile with 'noshellslash' on MS-Windows.
2224 - When this option is set to "backslash", backslash is used. This is
2225 useful when editing a batch file with 'shellslash' set on MS-Windows.
2226 - When this option is empty, same character is used as for
2227 'shellslash'.
2228 For Insert mode completion the buffer-local value is used. For
2229 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002230
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002231 *'concealcursor'* *'cocu'*
2232'concealcursor' 'cocu' string (default: "")
2233 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002234 {not available when compiled without the |+conceal|
2235 feature}
2236 Sets the modes in which text in the cursor line can also be concealed.
2237 When the current mode is listed then concealing happens just like in
2238 other lines.
2239 n Normal mode
2240 v Visual mode
2241 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002242 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002243
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002244 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002245 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002246 are moving around text is concealed, but when starting to insert text
2247 or selecting a Visual area the concealed text is displayed, so that
2248 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002249 Keep in mind that the cursor position is not always where it's
2250 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002251
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002252 *'conceallevel'* *'cole'*
2253'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002254 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002255 {not available when compiled without the |+conceal|
2256 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002257 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2258 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002259
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002260 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002261 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002262 1 Each block of concealed text is replaced with one
2263 character. If the syntax item does not have a custom
2264 replacement character defined (see |:syn-cchar|) the
2265 character defined in 'listchars' is used (default is a
2266 space).
2267 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002268 2 Concealed text is completely hidden unless it has a
2269 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002270 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002271 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002272
Bram Moolenaara7781e02010-07-19 20:13:22 +02002273 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002274 edit and copy the text. This can be changed with the 'concealcursor'
2275 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002276
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2278'confirm' 'cf' boolean (default off)
2279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 When 'confirm' is on, certain operations that would normally
2281 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2282 instead raise a |dialog| asking if you wish to save the current
2283 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2284 If 'confirm' is off you can still activate confirmation for one
2285 command only (this is most useful in mappings) with the |:confirm|
2286 command.
2287 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2288
2289 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2290'conskey' 'consk' boolean (default off)
2291 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002292 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293
2294 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2295'copyindent' 'ci' boolean (default off)
2296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 Copy the structure of the existing lines indent when autoindenting a
2298 new line. Normally the new indent is reconstructed by a series of
2299 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2300 in which case only spaces are used). Enabling this option makes the
2301 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002302 existing line. 'expandtab' has no effect on these characters, a Tab
2303 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002305 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 Also see 'preserveindent'.
2307
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002308 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002309'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2310 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002311 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002314 this indicates Vi-compatible behavior. This is used for things where
2315 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 'cpoptions' stands for "compatible-options".
2317 Commas can be added for readability.
2318 To avoid problems with flags that are added in the future, use the
2319 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002320
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 NOTE: This option is set to the Vi default value when 'compatible' is
2322 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002323
2324 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2325 is saved, 'cpoptions' is set to the Vim default, and the saved value
2326 is restored at the end of the script. Changes to the value of
2327 'cpoptions' will be applied to the saved value, but keep in mind that
2328 removing a flag that is not present when 'cpoptions' is changed has no
2329 effect. In the |.vimrc| file the value is not restored, thus using
2330 `vim9script` in the |.vimrc| file results in using the Vim default.
2331
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002332 NOTE: This option is set to the POSIX default value at startup when
2333 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002334 variable exists |posix|. This means Vim tries to behave like the
2335 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336
2337 contains behavior ~
2338 *cpo-a*
2339 a When included, a ":read" command with a file name
2340 argument will set the alternate file name for the
2341 current window.
2342 *cpo-A*
2343 A When included, a ":write" command with a file name
2344 argument will set the alternate file name for the
2345 current window.
2346 *cpo-b*
2347 b "\|" in a ":map" command is recognized as the end of
2348 the map command. The '\' is included in the mapping,
2349 the text after the '|' is interpreted as the next
2350 command. Use a CTRL-V instead of a backslash to
2351 include the '|' in the mapping. Applies to all
2352 mapping, abbreviation, menu and autocmd commands.
2353 See also |map_bar|.
2354 *cpo-B*
2355 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002356 abbreviations, user commands and the "to" part of the
2357 menu commands. Remove this flag to be able to use a
2358 backslash like a CTRL-V. For example, the command
2359 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 'B' included: "\^[" (^[ is a real <Esc>)
2361 'B' excluded: "<Esc>" (5 characters)
2362 ('<' excluded in both cases)
2363 *cpo-c*
2364 c Searching continues at the end of any match at the
2365 cursor position, but not further than the start of the
2366 next line. When not present searching continues
2367 one character from the cursor position. With 'c'
2368 "abababababab" only gets three matches when repeating
2369 "/abab", without 'c' there are five matches.
2370 *cpo-C*
2371 C Do not concatenate sourced lines that start with a
2372 backslash. See |line-continuation|.
2373 *cpo-d*
2374 d Using "./" in the 'tags' option doesn't mean to use
2375 the tags file relative to the current file, but the
2376 tags file in the current directory.
2377 *cpo-D*
2378 D Can't use CTRL-K to enter a digraph after Normal mode
2379 commands with a character argument, like |r|, |f| and
2380 |t|.
2381 *cpo-e*
2382 e When executing a register with ":@r", always add a
2383 <CR> to the last line, also when the register is not
2384 linewise. If this flag is not present, the register
2385 is not linewise and the last line does not end in a
2386 <CR>, then the last line is put on the command-line
2387 and can be edited before hitting <CR>.
2388 *cpo-E*
2389 E It is an error when using "y", "d", "c", "g~", "gu" or
2390 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002391 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 This makes "y0" fail in the first column.
2393 *cpo-f*
2394 f When included, a ":read" command with a file name
2395 argument will set the file name for the current buffer,
2396 if the current buffer doesn't have a file name yet.
2397 *cpo-F*
2398 F When included, a ":write" command with a file name
2399 argument will set the file name for the current
2400 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002401 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 *cpo-g*
2403 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002404 *cpo-H*
2405 H When using "I" on a line with only blanks, insert
2406 before the last blank. Without this flag insert after
2407 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 *cpo-i*
2409 i When included, interrupting the reading of a file will
2410 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 *cpo-I*
2412 I When moving the cursor up or down just after inserting
2413 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 *cpo-j*
2415 j When joining lines, only add two spaces after a '.',
2416 not after '!' or '?'. Also see 'joinspaces'.
2417 *cpo-J*
2418 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002419 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 white space.
2421 *cpo-k*
2422 k Disable the recognition of raw key codes in
2423 mappings, abbreviations, and the "to" part of menu
2424 commands. For example, if <Key> sends ^[OA (where ^[
2425 is <Esc>), the command ":map X ^[OA" results in X
2426 being mapped to:
2427 'k' included: "^[OA" (3 characters)
2428 'k' excluded: "<Key>" (one key code)
2429 Also see the '<' flag below.
2430 *cpo-K*
2431 K Don't wait for a key code to complete when it is
2432 halfway a mapping. This breaks mapping <F1><F1> when
2433 only part of the second <F1> has been read. It
2434 enables cancelling the mapping by typing <F1><Esc>.
2435 *cpo-l*
2436 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002437 literally, only "\]", "\^", "\-" and "\\" are special.
2438 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2440 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002441 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *cpo-L*
2443 L When the 'list' option is set, 'wrapmargin',
2444 'textwidth', 'softtabstop' and Virtual Replace mode
2445 (see |gR|) count a <Tab> as two characters, instead of
2446 the normal behavior of a <Tab>.
2447 *cpo-m*
2448 m When included, a showmatch will always wait half a
2449 second. When not included, a showmatch will wait half
2450 a second or until a character is typed. |'showmatch'|
2451 *cpo-M*
2452 M When excluded, "%" matching will take backslashes into
2453 account. Thus in "( \( )" and "\( ( \)" the outer
2454 parenthesis match. When included "%" ignores
2455 backslashes, which is Vi compatible.
2456 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002457 n When included, the column used for 'number' and
2458 'relativenumber' will also be used for text of wrapped
2459 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 *cpo-o*
2461 o Line offset to search command is not remembered for
2462 next search.
2463 *cpo-O*
2464 O Don't complain if a file is being overwritten, even
2465 when it didn't exist when editing it. This is a
2466 protection against a file unexpectedly created by
2467 someone else. Vi didn't complain about this.
2468 *cpo-p*
2469 p Vi compatible Lisp indenting. When not present, a
2470 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002471 *cpo-P*
2472 P When included, a ":write" command that appends to a
2473 file will set the file name for the current buffer, if
2474 the current buffer doesn't have a file name yet and
2475 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476 *cpo-q*
2477 q When joining multiple lines leave the cursor at the
2478 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 *cpo-r*
2480 r Redo ("." command) uses "/" to repeat a search
2481 command, instead of the actually used search string.
2482 *cpo-R*
2483 R Remove marks from filtered lines. Without this flag
2484 marks are kept like |:keepmarks| was used.
2485 *cpo-s*
2486 s Set buffer options when entering the buffer for the
2487 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002488 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 set when the buffer is created.
2490 *cpo-S*
2491 S Set buffer options always when entering a buffer
2492 (except 'readonly', 'fileformat', 'filetype' and
2493 'syntax'). This is the (most) Vi compatible setting.
2494 The options are set to the values in the current
2495 buffer. When you change an option and go to another
2496 buffer, the value is copied. Effectively makes the
2497 buffer options global to all buffers.
2498
2499 's' 'S' copy buffer options
2500 no no when buffer created
2501 yes no when buffer first entered (default)
2502 X yes each time when buffer entered (vi comp.)
2503 *cpo-t*
2504 t Search pattern for the tag command is remembered for
2505 "n" command. Otherwise Vim only puts the pattern in
2506 the history for search pattern, but doesn't change the
2507 last used search pattern.
2508 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 *cpo-v*
2511 v Backspaced characters remain visible on the screen in
2512 Insert mode. Without this flag the characters are
2513 erased from the screen right away. With this flag the
2514 screen newly typed text overwrites backspaced
2515 characters.
2516 *cpo-w*
2517 w When using "cw" on a blank character, only change one
2518 character and not all blanks until the start of the
2519 next word.
2520 *cpo-W*
2521 W Don't overwrite a readonly file. When omitted, ":w!"
2522 overwrites a readonly file, if possible.
2523 *cpo-x*
2524 x <Esc> on the command-line executes the command-line.
2525 The default in Vim is to abandon the command-line,
2526 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002527 *cpo-X*
2528 X When using a count with "R" the replaced text is
2529 deleted only once. Also when repeating "R" with "."
2530 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002532 y A yank command can be redone with ".". Think twice if
2533 you really want to use this, it may break some
2534 plugins, since most people expect "." to only repeat a
2535 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002536 *cpo-Z*
2537 Z When using "w!" while the 'readonly' option is set,
2538 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002539 *cpo-z*
2540 z Special casing the "cw" and "d" command (see |cw| and
2541 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 *cpo-!*
2543 ! When redoing a filter command, use the last used
2544 external command, whatever it was. Otherwise the last
2545 used -filter- command is used.
2546 *cpo-$*
2547 $ When making a change to one line, don't redisplay the
2548 line, but put a '$' at the end of the changed text.
2549 The changed text will be overwritten when you type the
2550 new text. The line is redisplayed if you type any
2551 command that moves the cursor from the insertion
2552 point.
2553 *cpo-%*
2554 % Vi-compatible matching is done for the "%" command.
2555 Does not recognize "#if", "#endif", etc.
2556 Does not recognize "/*" and "*/".
2557 Parens inside single and double quotes are also
2558 counted, causing a string that contains a paren to
2559 disturb the matching. For example, in a line like
2560 "if (strcmp("foo(", s))" the first paren does not
2561 match the last one. When this flag is not included,
2562 parens inside single and double quotes are treated
2563 specially. When matching a paren outside of quotes,
2564 everything inside quotes is ignored. When matching a
2565 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002566 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002567 This flag is also used for other features, such as
2568 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002569 *cpo--*
2570 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002571 it would go above the first line or below the last
2572 line. Without it the cursor moves to the first or
2573 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002574 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002575 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002576 *cpo-+*
2577 + When included, a ":write file" command will reset the
2578 'modified' flag of the buffer, even though the buffer
2579 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002580 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 * Use ":*" in the same way as ":@". When not included,
2582 ":*" is an alias for ":'<,'>", select the Visual area.
2583 *cpo-<*
2584 < Disable the recognition of special key codes in |<>|
2585 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 ":map X <Tab>" results in X being mapped to:
2588 '<' included: "<Tab>" (5 characters)
2589 '<' excluded: "^I" (^I is a real <Tab>)
2590 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002591 *cpo->*
2592 > When appending to a register, put a line break before
2593 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002594 *cpo-;*
2595 ; When using |,| or |;| to repeat the last |t| search
2596 and the cursor is right in front of the searched
2597 character, the cursor won't move. When not included,
2598 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002599 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002600
2601 POSIX flags. These are not included in the Vi default value, except
2602 when $VIM_POSIX was set on startup. |posix|
2603
2604 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002605 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002606 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002607 *cpo-&*
2608 & When ":preserve" was used keep the swap file when
2609 exiting normally while this buffer is still loaded.
2610 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002611 *cpo-\*
2612 \ Backslash in a [] range in a search pattern is taken
2613 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002614 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2615 '\' excluded: "/[ \-]" finds <Space> and '-'
2616 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002617 *cpo-/*
2618 / When "%" is used as the replacement string in a |:s|
2619 command, use the previous replacement string. |:s%|
2620 *cpo-{*
2621 { The |{| and |}| commands also stop at a "{" character
2622 at the start of a line.
2623 *cpo-.*
2624 . The ":chdir" and ":cd" commands fail if the current
2625 buffer is modified, unless ! is used. Vim doesn't
2626 need this, since it remembers the full path of an
2627 opened file.
2628 *cpo-bar*
2629 | The value of the $LINES and $COLUMNS environment
2630 variables overrule the terminal size values obtained
2631 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002632
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002633 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002634'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002635 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002636 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002637 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002638 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002639 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002640 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002641 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002642 blowfish Blowfish method. Medium strong encryption but it has
2643 an implementation flaw. Requires Vim 7.3 or later,
2644 files can NOT be read by Vim 7.2 and older. This adds
2645 a "seed" to the file, every time you write the file
2646 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002647 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002648 *blowfish2*
2649 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002650 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002651 and older. This adds a "seed" to the file, every time
2652 you write the file the encrypted bytes will be
2653 different. The whole undo file is encrypted, not just
2654 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002655 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002656 *E1197* *E1198* *E1199* *E1200* *E1201*
2657 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2658 Code. Medium strong till strong encryption.
2659 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002660 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002661 It adds a seed and a message authentication code (MAC)
2662 to the file. This needs at least a Vim 8.2.3022 to
2663 read the encrypted file.
2664 Encryption of swap files is not supported, therefore
2665 no swap file will be used when xchacha20 encryption is
2666 enabled.
2667 Encryption of undo files is not yet supported,
2668 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002669 CAREFUL: Files written with this method might have to
2670 be read back with the same version of Vim if the
2671 binary format changes later.
2672 Obsolete, please do no longer use.
2673 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2674 stores the key derivation parameters together with the
2675 encrypted file. Should work better in case the
2676 parameters in the libsodium library ever change.
2677 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002678 might have to be read back with the same version of
2679 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002680
Christian Brabandtaae58342023-04-23 17:50:22 +01002681 You should use "blowfish2", also to re-encrypt older files. The
2682 "xchacha20" method provides better encryption, but it does not work
2683 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002684
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002685 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002686 to the detected method of the file being read. Thus if you write it
2687 without changing 'cryptmethod' the same method will be used.
2688 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002689 explicitly write it, you don't get a warning unless there are other
2690 modifications. Also see |:X|.
2691
2692 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002693 the value "blowfish2". When setting the local value to an empty
2694 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002695
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002696 When a new encryption method is added in a later version of Vim, and
2697 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002698 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002699
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 *'cscopepathcomp'* *'cspc'*
2701'cscopepathcomp' 'cspc' number (default 0)
2702 global
2703 {not available when compiled without the |+cscope|
2704 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 Determines how many components of the path to show in a list of tags.
2706 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002707 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
2709 *'cscopeprg'* *'csprg'*
2710'cscopeprg' 'csprg' string (default "cscope")
2711 global
2712 {not available when compiled without the |+cscope|
2713 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 Specifies the command to execute cscope. See |cscopeprg|.
2715 This option cannot be set from a |modeline| or in the |sandbox|, for
2716 security reasons.
2717
2718 *'cscopequickfix'* *'csqf'*
2719'cscopequickfix' 'csqf' string (default "")
2720 global
2721 {not available when compiled without the |+cscope|
2722 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Specifies whether to use quickfix window to show cscope results.
2724 See |cscopequickfix|.
2725
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002726 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002727'cscoperelative' 'csre' boolean (default off)
2728 global
2729 {not available when compiled without the |+cscope|
2730 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002731 In the absence of a prefix (-P) for cscope. setting this option enables
2732 to use the basename of cscope.out path as the prefix.
2733 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002734 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002735
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2737'cscopetag' 'cst' boolean (default off)
2738 global
2739 {not available when compiled without the |+cscope|
2740 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 Use cscope for tag commands. See |cscope-options|.
2742 NOTE: This option is reset when 'compatible' is set.
2743
2744 *'cscopetagorder'* *'csto'*
2745'cscopetagorder' 'csto' number (default 0)
2746 global
2747 {not available when compiled without the |+cscope|
2748 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Determines the order in which ":cstag" performs a search. See
2750 |cscopetagorder|.
2751 NOTE: This option is set to 0 when 'compatible' is set.
2752
2753 *'cscopeverbose'* *'csverb'*
2754 *'nocscopeverbose'* *'nocsverb'*
2755'cscopeverbose' 'csverb' boolean (default off)
2756 global
2757 {not available when compiled without the |+cscope|
2758 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 Give messages when adding a cscope database. See |cscopeverbose|.
2760 NOTE: This option is reset when 'compatible' is set.
2761
Bram Moolenaar860cae12010-06-05 23:22:07 +02002762 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2763'cursorbind' 'crb' boolean (default off)
2764 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002765 When this option is set, as the cursor in the current
2766 window moves other cursorbound windows (windows that also have
2767 this option set) move their cursors to the corresponding line and
2768 column. This option is useful for viewing the
2769 differences between two versions of a file (see 'diff'); in diff mode,
2770 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002771 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002772
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002773 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2774'cursorcolumn' 'cuc' boolean (default off)
2775 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002776 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002777 feature}
2778 Highlight the screen column of the cursor with CursorColumn
2779 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2780 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002781 If you only want the highlighting in the current window you can use
2782 these autocommands: >
2783 au WinLeave * set nocursorline nocursorcolumn
2784 au WinEnter * set cursorline cursorcolumn
2785<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002786
2787 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2788'cursorline' 'cul' boolean (default off)
2789 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002790 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002791 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002792 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2793 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002794 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002795 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002796
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002797 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002798'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002799 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002800 {not available when compiled without the |+syntax|
2801 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002802 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002803 Valid values:
2804 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002805 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002806 "screenline" Highlight only the screen line of the cursor with
2807 CursorLine |hl-CursorLine|.
2808 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002809 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002810
2811 Special value:
2812 "both" Alias for the values "line,number".
2813
2814 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002815
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 *'debug'*
2817'debug' string (default "")
2818 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002819 These values can be used:
2820 msg Error messages that would otherwise be omitted will be given
2821 anyway.
2822 throw Error messages that would otherwise be omitted will be given
2823 anyway and also throw an exception and set |v:errmsg|.
2824 beep A message will be given when otherwise only a beep would be
2825 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002826 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002827 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2828 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'define'* *'def'*
2831'define' 'def' string (default "^\s*#\s*define")
2832 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002833 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 pattern, just like for the "/" command. This option is used for the
2835 commands like "[i" and "[d" |include-search|. The 'isident' option is
2836 used to recognize the defined name after the match:
2837 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2838 See |option-backslash| about inserting backslashes to include a space
2839 or backslash.
2840 The default value is for C programs. For C++ this value would be
2841 useful, to include const type declarations: >
2842 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002843< You can also use "\ze" just before the name and continue the pattern
2844 to check what is following. E.g. for Javascript, if a function is
2845 defined with "func_name = function(args)": >
2846 ^\s*\ze\i\+\s*=\s*function(
2847< If the function is defined with "func_name : function() {...": >
2848 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002850 To avoid that use `:let` with a single quote string: >
2851 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002852<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2855'delcombine' 'deco' boolean (default off)
2856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 If editing Unicode and this option is set, backspace and Normal mode
2858 "x" delete each combining character on its own. When it is off (the
2859 default) the character along with its combining characters are
2860 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002861 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862
2863 This is useful for Arabic, Hebrew and many other languages where one
2864 may have combining characters overtop of base characters, and want
2865 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002866 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867
2868 *'dictionary'* *'dict'*
2869'dictionary' 'dict' string (default "")
2870 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 List of file names, separated by commas, that are used to lookup words
2872 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2873 contain a list of words. This can be one word per line, or several
2874 words per line, separated by non-keyword characters (white space is
2875 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002876
2877 When this option is empty or an entry "spell" is present, and spell
2878 checking is enabled, words in the word lists for the currently active
2879 'spelllang' are used. See |spell|.
2880
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 after a comma are ignored, otherwise spaces are included in the file
2883 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002884 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 Where to find a list of words?
2886 - On FreeBSD, there is the file "/usr/share/dict/words".
2887 - In the Simtel archive, look in the "msdos/linguist" directory.
2888 - In "miscfiles" of the GNU collection.
2889 The use of |:set+=| and |:set-=| is preferred when adding or removing
2890 directories from the list. This avoids problems when a future version
2891 uses another default.
2892 Backticks cannot be used in this option for security reasons.
2893
2894 *'diff'* *'nodiff'*
2895'diff' boolean (default off)
2896 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 {not available when compiled without the |+diff|
2898 feature}
2899 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002900 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901
2902 *'dex'* *'diffexpr'*
2903'diffexpr' 'dex' string (default "")
2904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 {not available when compiled without the |+diff|
2906 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002907 Expression which is evaluated to obtain a diff file (either ed-style
2908 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 This option cannot be set from a |modeline| or in the |sandbox|, for
2910 security reasons.
2911
2912 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002913'diffopt' 'dip' string (default
2914 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 {not available when compiled without the |+diff|
2917 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002918 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 All are optional. Items must be separated by a comma.
2920
Jonathon7c7a4e62025-01-12 09:58:00 +01002921 algorithm:{text} Use the specified diff algorithm with the
2922 internal diff engine. Currently supported
2923 algorithms are:
2924 myers the default algorithm
2925 minimal spend extra time to generate the
2926 smallest possible diff
2927 patience patience diff algorithm
2928 histogram histogram diff algorithm
2929
2930 closeoff When a window is closed where 'diff' is set
2931 and there is only one window remaining in the
2932 same tab page with 'diff' set, execute
2933 `:diffoff` in that window. This undoes a
2934 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935
2936 context:{n} Use a context of {n} lines between a change
2937 and a fold that contains unchanged lines.
2938 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002939 When using zero the context is actually one,
2940 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002941 for a deleted line. Set it to a very large
2942 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 See |fold-diff|.
2944
Jonathon7c7a4e62025-01-12 09:58:00 +01002945 filler Show filler lines, to keep the text
2946 synchronized with a window that has inserted
2947 lines at the same position. Mostly useful
2948 when windows are side-by-side and 'scrollbind'
2949 is set.
2950
2951 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2952 starting diff mode. Without this 2 is used.
2953
2954 followwrap Follow the 'wrap' option and leave as it is.
2955
2956 horizontal Start diff mode with horizontal splits (unless
2957 explicitly specified otherwise).
2958
2959 hiddenoff Do not use diff mode for a buffer when it
2960 becomes hidden.
2961
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002962 iblank Ignore changes where lines are all blank. Adds
2963 the "-B" flag to the "diff" command if
2964 'diffexpr' is empty. Check the documentation
2965 of the "diff" command for what this does
2966 exactly.
2967 NOTE: the diff windows will get out of sync,
2968 because no differences between blank lines are
2969 taken into account.
2970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 icase Ignore changes in case of text. "a" and "A"
2972 are considered the same. Adds the "-i" flag
2973 to the "diff" command if 'diffexpr' is empty.
2974
Jonathon7c7a4e62025-01-12 09:58:00 +01002975 indent-heuristic
2976 Use the indent heuristic for the internal
2977 diff library.
2978
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002979 inline:{text} Highlight inline differences within a change.
2980 See |view-diffs|. Supported values are:
2981
2982 none Do not perform inline highlighting.
2983 simple Highlight from first different
2984 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01002985 line. This is the default if no
2986 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002987 char Use internal diff to perform a
2988 character-wise diff and highlight the
2989 difference.
2990 word Use internal diff to perform a
2991 |word|-wise diff and highlight the
2992 difference.
2993
Jonathon7c7a4e62025-01-12 09:58:00 +01002994 internal Use the internal diff library. This is
2995 ignored when 'diffexpr' is set. *E960*
2996 When running out of memory when writing a
2997 buffer this item will be ignored for diffs
2998 involving that buffer. Set the 'verbose'
2999 option to see when this happens.
3000
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 iwhite Ignore changes in amount of white space. Adds
3002 the "-b" flag to the "diff" command if
3003 'diffexpr' is empty. Check the documentation
3004 of the "diff" command for what this does
3005 exactly. It should ignore adding trailing
3006 white space, but not leading white space.
3007
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003008 iwhiteall Ignore all white space changes. Adds
3009 the "-w" flag to the "diff" command if
3010 'diffexpr' is empty. Check the documentation
3011 of the "diff" command for what this does
3012 exactly.
3013
3014 iwhiteeol Ignore white space changes at end of line.
3015 Adds the "-Z" flag to the "diff" command if
3016 'diffexpr' is empty. Check the documentation
3017 of the "diff" command for what this does
3018 exactly.
3019
Jonathon7c7a4e62025-01-12 09:58:00 +01003020 linematch:{n} Align and mark changes between the most
3021 similar lines between the buffers. When the
3022 total number of lines in the diff hunk exceeds
3023 {n}, the lines will not be aligned because for
3024 very large diff hunks there will be a
3025 noticeable lag. A reasonable setting is
3026 "linematch:60", as this will enable alignment
3027 for a 2 buffer diff hunk of 30 lines each,
3028 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003029
3030 vertical Start diff mode with vertical splits (unless
3031 explicitly specified otherwise).
3032
Bram Moolenaare828b762018-09-10 17:51:58 +02003033 Examples: >
3034 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003036 :set diffopt=internal,filler,foldcolumn:3
3037 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038<
3039 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3040'digraph' 'dg' boolean (default off)
3041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 {not available when compiled without the |+digraphs|
3043 feature}
3044 Enable the entering of digraphs in Insert mode with {char1} <BS>
3045 {char2}. See |digraphs|.
3046 NOTE: This option is reset when 'compatible' is set.
3047
3048 *'directory'* *'dir'*
3049'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003050 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 for Unix: ".,~/tmp,/var/tmp,/tmp")
3052 global
3053 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003054 Recommended value: ".,~/vimswap//" - this will put the swap file next
3055 to the edited file if possible, and in your personal swap directory
3056 otherwise. Make sure "~/vimswap//" is only readable for you.
3057
3058 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 - The swap file will be created in the first directory where this is
3060 possible.
3061 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003062 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 - A directory "." means to put the swap file in the same directory as
3064 the edited file. On Unix, a dot is prepended to the file name, so
3065 it doesn't show in a directory listing. On MS-Windows the "hidden"
3066 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003067 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3068 the swap file relative to where the edited file is. The leading "."
3069 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003070 - For Unix and Win32, if a directory ends in two path separators "//",
3071 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003072 with all path separators replaced by percent '%' signs (including
3073 the colon following the drive letter on Win32). This will ensure
3074 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003075 On Win32, it is also possible to end with "\\". However, When a
3076 separating comma is following, you must use "//", since "\\" will
3077 include the comma in the file name. Therefore it is recommended to
3078 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 - Spaces after the comma are ignored, other spaces are considered part
3080 of the directory name. To have a space at the start of a directory
3081 name, precede it with a backslash.
3082 - To include a comma in a directory name precede it with a backslash.
3083 - A directory name may end in an ':' or '/'.
3084 - Environment variables are expanded |:set_env|.
3085 - Careful with '\' characters, type one before a space, type two to
3086 get one in the option (see |option-backslash|), for example: >
3087 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3088< - For backwards compatibility with Vim version 3.0 a '>' at the start
3089 of the option is removed.
3090 Using "." first in the list is recommended. This means that editing
3091 the same file twice will result in a warning. Using "/tmp" on Unix is
3092 discouraged: When the system crashes you lose the swap file.
3093 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003094 choice than "/tmp". But others on the computer may be able to see the
3095 files, and it can contain a lot of files, your swap files get lost in
3096 the crowd. That is why a "tmp" directory in your home directory is
3097 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 The use of |:set+=| and |:set-=| is preferred when adding or removing
3099 directories from the list. This avoids problems when a future version
3100 uses another default.
3101 This option cannot be set from a |modeline| or in the |sandbox|, for
3102 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103
3104 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003105'display' 'dy' string (default "", set to "truncate" in
3106 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003108 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 flags:
3110 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003111 in a window will be displayed. "@@@" is put in the
3112 last columns of the last screen line to indicate the
3113 rest of the line is not displayed.
3114 truncate Like "lastline", but "@@@" is displayed in the first
3115 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 uhex Show unprintable characters hexadecimal as <xx>
3117 instead of using ^C and ~C.
3118
Bram Moolenaard0796902016-09-16 20:02:31 +02003119 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003120 doesn't fit is replaced with "@" lines.
3121
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003122 The "@" character can be changed by setting the "lastline" item in
3123 'fillchars'. The character is highlighted with |hl-NonText|.
3124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 *'eadirection'* *'ead'*
3126'eadirection' 'ead' string (default "both")
3127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 Tells when the 'equalalways' option applies:
3129 ver vertically, width of windows is not affected
3130 hor horizontally, height of windows is not affected
3131 both width and height of windows is affected
3132
3133 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3134'edcompatible' 'ed' boolean (default off)
3135 global
3136 Makes the 'g' and 'c' flags of the ":substitute" command to be
3137 toggled each time the flag is given. See |complex-change|. See
3138 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003139 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003140 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141
Bram Moolenaar03413f42016-04-12 21:07:15 +02003142 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003143'emoji' 'emo' boolean (default: on)
3144 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003145 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003146 This excludes "text emoji" characters, which are normally displayed as
3147 single width. Unfortunately there is no good specification for this
3148 and it has been determined on trial-and-error basis. Use the
3149 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003150
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003152'encoding' 'enc' string (default for MS-Windows: "utf-8",
3153 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 Sets the character encoding used inside Vim. It applies to text in
3156 the buffers, registers, Strings in expressions, text stored in the
3157 viminfo file, etc. It sets the kind of characters which Vim can work
3158 with. See |encoding-names| for the possible values.
3159
3160 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003161 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003163 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
Bram Moolenaar865242e2010-07-14 21:12:05 +02003165 This option cannot be set from a |modeline|. It would most likely
3166 corrupt the text.
3167
Bram Moolenaar3df01732017-02-17 22:47:16 +01003168 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3169 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 'encoding', "utf-8" is the natural choice for the environment and
3171 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003172 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 versions, and to avoid changing the encoding of newly created files
3174 without your knowledge (in case 'fileencodings' is empty).
3175
3176 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003177 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 iconv() or as specified with 'charconvert'.
3179
Bram Moolenaar207f0092020-08-30 17:20:20 +02003180 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003181 can use: >
3182 if has("multi_byte_encoding")
3183<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 Normally 'encoding' will be equal to your current locale. This will
3185 be the default if Vim recognizes your environment settings. If
3186 'encoding' is not set to the current locale, 'termencoding' must be
3187 set to convert typed and displayed text. See |encoding-table|.
3188
3189 When you set this option, it fires the |EncodingChanged| autocommand
3190 event so that you can set up fonts if necessary.
3191
3192 When the option is set, the value is converted to lowercase. Thus
3193 you can set it with uppercase values too. Underscores are translated
3194 to '-' signs.
3195 When the encoding is recognized, it is changed to the standard name.
3196 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3197 "iso-8859-2" and "utf8" becomes "utf-8".
3198
3199 Note: "latin1" is also used when the encoding could not be detected.
3200 This only works when editing files in the same encoding! When the
3201 actual character set is not latin1, make sure 'fileencoding' and
3202 'fileencodings' are empty. When conversion is needed, switch to using
3203 utf-8.
3204
3205 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3206 You don't notice this while editing, but it does matter for the
3207 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3208 setting 'encoding' to one of these values instead of utf-8 only has
3209 effect for encoding used for files when 'fileencoding' is empty.
3210
Bram Moolenaar661b1822005-07-28 22:36:45 +00003211 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3212 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003214 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003215'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003217 Indicates that a CTRL-Z character was found at the end of the file
3218 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003220 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003221 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003222 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003223
3224 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3225'endofline' 'eol' boolean (default on)
3226 local to buffer
3227 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003228 is on, or 'fixeol' option is off, no <EOL> will be written for the
3229 last line in the file. This option is automatically set or reset when
3230 starting to edit a new file, depending on whether file has an <EOL>
3231 for the last line in the file. Normally you don't have to set or
3232 reset this option.
3233 When 'binary' is off and 'fixeol' is on the value is not used when
3234 writing the file. When 'binary' is on or 'fixeol' is off it is used
3235 to remember the presence of a <EOL> for the last line in the file, so
3236 that when you write the file the situation from the original file can
3237 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003238 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239
3240 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3241'equalalways' 'ea' boolean (default on)
3242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003244 splitting or closing a window. This also happens the moment the
3245 option is switched on. When off, splitting a window will reduce the
3246 size of the current window and leave the other windows the same. When
3247 closing a window the extra lines are given to the window next to it
3248 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 When mixing vertically and horizontally split windows, a minimal size
3250 is computed and some windows may be larger if there is room. The
3251 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003252 Changing the height and width of a window can be avoided by setting
3253 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003254 If a window size is specified when creating a new window sizes are
3255 currently not equalized (it's complicated, but may be implemented in
3256 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257
3258 *'equalprg'* *'ep'*
3259'equalprg' 'ep' string (default "")
3260 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003262 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003263 or 'indentexpr'. When Vim was compiled without internal formatting,
3264 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 about including spaces and backslashes.
3267 This option cannot be set from a |modeline| or in the |sandbox|, for
3268 security reasons.
3269
3270 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3271'errorbells' 'eb' boolean (default off)
3272 global
3273 Ring the bell (beep or screen flash) for error messages. This only
3274 makes a difference for error messages, the bell will be used always
3275 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003276 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003277 screen flash or do nothing. See 'belloff' to finetune when to ring the
3278 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279
3280 *'errorfile'* *'ef'*
3281'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3282 others: "errors.err")
3283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 {not available when compiled without the |+quickfix|
3285 feature}
3286 Name of the errorfile for the QuickFix mode (see |:cf|).
3287 When the "-q" command-line argument is used, 'errorfile' is set to the
3288 following argument. See |-q|.
3289 NOT used for the ":make" command. See 'makeef' for that.
3290 Environment variables are expanded |:set_env|.
3291 See |option-backslash| about including spaces and backslashes.
3292 This option cannot be set from a |modeline| or in the |sandbox|, for
3293 security reasons.
3294
3295 *'errorformat'* *'efm'*
3296'errorformat' 'efm' string (default is very long)
3297 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 {not available when compiled without the |+quickfix|
3299 feature}
3300 Scanf-like description of the format for the lines in the error file
3301 (see |errorformat|).
3302
3303 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3304'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 Function keys that start with an <Esc> are recognized in Insert
3307 mode. When this option is off, the cursor and function keys cannot be
3308 used in Insert mode if they start with an <Esc>. The advantage of
3309 this is that the single <Esc> is recognized immediately, instead of
3310 after one second. Instead of resetting this option, you might want to
3311 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3312 when 'esckeys' is off, you can still map anything, but the cursor keys
3313 won't work by default.
3314 NOTE: This option is set to the Vi default value when 'compatible' is
3315 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003316 NOTE: when this option is off then the |modifyOtherKeys| and
3317 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3318 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319
3320 *'eventignore'* *'ei'*
3321'eventignore' 'ei' string (default "")
3322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003324 When set to "all" or when "all" is one of the items, all autocommand
3325 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003326 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 :set ei=WinEnter,WinLeave
3328<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003329 *'eventignorewin'* *'eiw'*
3330'eventignorewin' 'eiw' string (default "")
3331 window-local
3332 Similar to 'eventignore' but applies to a particular window and its
3333 buffers, for which window and buffer related autocommands can be
3334 ignored indefinitely without affecting the global 'eventignore'.
3335
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3337'expandtab' 'et' boolean (default off)
3338 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3342 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003343 This option is reset when the 'paste' option is set and restored when
3344 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 NOTE: This option is reset when 'compatible' is set.
3346
3347 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3348'exrc' 'ex' boolean (default off)
3349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003351 directory.
3352
3353 Setting this option is a potential security leak. E.g., consider
3354 unpacking a package or fetching files from github, a .vimrc in there
3355 might be a trojan horse. BETTER NOT SET THIS OPTION!
3356 Instead, define an autocommand in your .vimrc to set options for a
3357 matching directory.
3358
3359 If you do switch this option on you should also consider setting the
3360 'secure' option (see |initialization|).
3361 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 This option cannot be set from a |modeline| or in the |sandbox|, for
3363 security reasons.
3364
3365 *'fileencoding'* *'fenc'* *E213*
3366'fileencoding' 'fenc' string (default: "")
3367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003369
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003371 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 When 'fileencoding' is empty, the same value as 'encoding' will be
3373 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003374 No error will be given when the value is set, only when it is used,
3375 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003376 Conversion will also be done when 'encoding' and 'fileencoding' are
3377 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3378 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003380 'encoding' is "utf-8" or another Unicode encoding, conversion
3381 is most likely done in a way that the reverse conversion
3382 results in the same text. When 'encoding' is not "utf-8" some
3383 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003384
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 See 'encoding' for the possible values. Additionally, values may be
3386 specified that can be handled by the converter, see
3387 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003388
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 When reading a file 'fileencoding' will be set from 'fileencodings'.
3390 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003391 'fileencoding', use the |++enc| argument. One exception: when
3392 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003393 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003394
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3396 When the option is set, the value is converted to lowercase. Thus
3397 you can set it with uppercase values too. '_' characters are
3398 replaced with '-'. If a name is recognized from the list for
3399 'encoding', it is replaced by the standard name. For example
3400 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003401
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 When this option is set, after starting to edit a file, the 'modified'
3403 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003404
3405 Keep in mind that changing 'fenc' from a modeline happens
3406 AFTER the text has been read, thus it applies to when the file will be
3407 written. If you do set 'fenc' in a modeline, you might want to set
3408 'nomodified' to avoid not being able to ":q".
3409
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 This option can not be changed when 'modifiable' is off.
3411
3412 *'fe'*
3413 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003414 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 old short name was 'fe', which is no longer used.
3416
3417 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003418'fileencodings' 'fencs' string (default: "ucs-bom",
3419 "ucs-bom,utf-8,default,latin1" when
3420 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 This is a list of character encodings considered when starting to edit
3423 an existing file. When a file is read, Vim tries to use the first
3424 mentioned character encoding. If an error is detected, the next one
3425 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003426 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 an empty string, which means the value of 'encoding' is used.
3428 WARNING: Conversion can cause loss of information! When
3429 'encoding' is "utf-8" (or one of the other Unicode variants)
3430 conversion is most likely done in a way that the reverse
3431 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003432 "utf-8" some non-ASCII characters may be lost! You can use
3433 the |++bad| argument to specify what is done with characters
3434 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 For an empty file or a file with only ASCII characters most encodings
3436 will work and the first entry of 'fileencodings' will be used (except
3437 "ucs-bom", which requires the BOM to be present). If you prefer
3438 another encoding use an BufReadPost autocommand event to test if your
3439 preferred encoding is to be used. Example: >
3440 au BufReadPost * if search('\S', 'w') == 0 |
3441 \ set fenc=iso-2022-jp | endif
3442< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3443 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003444 When the |++enc| argument is used then the value of 'fileencodings' is
3445 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003446 Note that 'fileencodings' is not used for a new file, the global value
3447 of 'fileencoding' is used instead. You can set it with: >
3448 :setglobal fenc=iso-8859-2
3449< This means that a non-existing file may get a different encoding than
3450 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 The special value "ucs-bom" can be used to check for a Unicode BOM
3452 (Byte Order Mark) at the start of the file. It must not be preceded
3453 by "utf-8" or another Unicode encoding for this to work properly.
3454 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3455 because Vim cannot detect an error, thus the encoding is always
3456 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003457 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003458 environment. On MS-Windows this is the system encoding. Otherwise
3459 this is the default value for 'encoding'. It is useful when
3460 'encoding' is set to "utf-8" and your environment uses a non-latin1
3461 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003462 When 'encoding' is "utf-8" and a file contains an illegal byte
3463 sequence it won't be recognized as UTF-8. You can use the |8g8|
3464 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 WRONG VALUES: WHAT'S WRONG:
3466 latin1,utf-8 "latin1" will always be used
3467 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3468 file
3469 cp1250,latin1 "cp1250" will always be used
3470 If 'fileencodings' is empty, 'fileencoding' is not modified.
3471 See 'fileencoding' for the possible values.
3472 Setting this option does not have an effect until the next time a file
3473 is read.
3474
3475 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003476'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003477 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 This gives the <EOL> of the current buffer, which is used for
3480 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003481 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 unix <NL>
3483 mac <CR>
3484 When "dos" is used, CTRL-Z at the end of a file is ignored.
3485 See |file-formats| and |file-read|.
3486 For the character encoding of the file see 'fileencoding'.
3487 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003488 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 This option is set automatically when starting to edit a file and
3490 'fileformats' is not empty and 'binary' is off.
3491 When this option is set, after starting to edit a file, the 'modified'
3492 option is set, because the file would be different when written.
3493 This option can not be changed when 'modifiable' is off.
3494 For backwards compatibility: When this option is set to "dos",
3495 'textmode' is set, otherwise 'textmode' is reset.
3496
3497 *'fileformats'* *'ffs'*
3498'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003499 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003500 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 Vi Cygwin: "unix,dos",
3502 Vi others: "")
3503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 This gives the end-of-line (<EOL>) formats that will be tried when
3505 starting to edit a new buffer and when reading a file into an existing
3506 buffer:
3507 - When empty, the format defined with 'fileformat' will be used
3508 always. It is not set automatically.
3509 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003510 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 'fileformats' name will be used when a file is read into an existing
3512 buffer, no matter what 'fileformat' for that buffer is set to.
3513 - When more than one name is present, separated by commas, automatic
3514 <EOL> detection will be done when reading a file. When starting to
3515 edit a file, a check is done for the <EOL>:
3516 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3517 'fileformat' is set to "dos".
3518 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003519 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003521 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3522 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003523 This means that "mac" is only chosen when:
3524 "unix" is not present or no <NL> is found in the file, and
3525 "dos" is not present or no <CR><NL> is found in the file.
3526 Except: if "unix" was chosen, but there is a <CR> before
3527 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003528 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 4. If 'fileformat' is still not set, the first name from
3530 'fileformats' is used.
3531 When reading a file into an existing buffer, the same is done, but
3532 this happens like 'fileformat' has been set appropriately for that
3533 file only, the option is not changed.
3534 When 'binary' is set, the value of 'fileformats' is not used.
3535
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003536 When Vim starts up with an empty buffer the first item is used. You
3537 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003538
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3540 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3541 done:
3542 - When 'fileformats' is empty, there is no automatic detection. Dos
3543 format will be used.
3544 - When 'fileformats' is set to one or more names, automatic detection
3545 is done. This is based on the first <NL> in the file: If there is a
3546 <CR> in front of it, Dos format is used, otherwise Unix format is
3547 used.
3548 Also see |file-formats|.
3549 For backwards compatibility: When this option is set to an empty
3550 string or one format (no comma is included), 'textauto' is reset,
3551 otherwise 'textauto' is set.
3552 NOTE: This option is set to the Vi default value when 'compatible' is
3553 set and to the Vim default value when 'compatible' is reset.
3554
Bram Moolenaarbf884932013-04-05 22:26:15 +02003555 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3556'fileignorecase' 'fic' boolean (default on for systems where case in file
3557 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003558 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003559 When set case is ignored when using file names and directories.
3560 See 'wildignorecase' for only ignoring case when doing completion.
3561
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 *'filetype'* *'ft'*
3563'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003564 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 When this option is set, the FileType autocommand event is triggered.
3566 All autocommands that match with the value of this option will be
3567 executed. Thus the value of 'filetype' is used in place of the file
3568 name.
3569 Otherwise this option does not always reflect the current file type.
3570 This option is normally set when the file type is detected. To enable
3571 this use the ":filetype on" command. |:filetype|
3572 Setting this option to a different value is most useful in a modeline,
3573 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003574 Example, for in an IDL file:
3575 /* vim: set filetype=idl : */ ~
3576 |FileType| |filetypes|
3577 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003578 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003579 /* vim: set filetype=c.doxygen : */ ~
3580 This will use the "c" filetype first, then the "doxygen" filetype.
3581 This works both for filetype plugins and for syntax files. More than
3582 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 This option is not copied to another buffer, independent of the 's' or
3584 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003585 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586
3587 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003588'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003589 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003590 Characters to fill the statuslines, vertical separators and special
3591 lines in the window.
3592 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003593 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003595 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003596 stl ' ' statusline of the current window
3597 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003598 vert '|' vertical separators |:vsplit|
3599 fold '-' filling 'foldtext'
3600 foldopen '-' mark the beginning of a fold
3601 foldclose '+' show a closed fold
3602 foldsep '|' open fold middle character
3603 diff '-' deleted lines of the 'diff' option
3604 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003605 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003607 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608
3609 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003610 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3611<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003612 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3613 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003614 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003615
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003617 item name highlight group ~
3618 stl StatusLine |hl-StatusLine|
3619 stlnc StatusLineNC |hl-StatusLineNC|
3620 vert VertSplit |hl-VertSplit|
3621 fold Folded |hl-Folded|
3622 diff DiffDelete |hl-DiffDelete|
3623 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003624 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003626 *'findfunc'* *'ffu'* *E1514*
3627'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003628 global or local to buffer |global-local|
3629 {not available when compiled without the |+eval|
3630 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003631 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003632 command. When this option is empty, the internal |file-searching|
3633 mechanism is used.
3634
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003635 The value can be the name of a function, a |lambda| or a |Funcref|.
3636 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003637
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003638 The function is called with two arguments. The first argument is a
3639 |String| and is the |:find| command argument. The second argument is
3640 a |Boolean| and is set to |v:true| when the function is called to get
3641 a List of command-line completion matches for the |:find| command.
3642 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003643
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003644 The function is called only once per |:find| command invocation.
3645 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003646
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003647 If a match is found, the function should return a |List| containing
3648 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003649 should return an empty List.
3650
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003651 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003652 empty List is used as the return value.
3653
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003654 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003655 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003656
3657 This option cannot be set from a |modeline| or in the |sandbox|, for
3658 security reasons.
3659
3660 Examples:
3661>
3662 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003663 func FindFuncGlob(cmdarg, cmdcomplete)
3664 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003665 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003666 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003667 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003668
3669 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003670 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003671 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003672 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003673 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003674 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003675<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003676 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3677'fixendofline' 'fixeol' boolean (default on)
3678 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003679 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003680 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003681 preserve the situation from the original file.
3682 When the 'binary' option is set the value of this option doesn't
3683 matter.
3684 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003685 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003686
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003688'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 {only available when compiled with the |+rightleft|
3691 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003692 This option was for using Farsi, which has been removed. See
3693 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694
3695 *'foldclose'* *'fcl'*
3696'foldclose' 'fcl' string (default "")
3697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {not available when compiled without the |+folding|
3699 feature}
3700 When set to "all", a fold is closed when the cursor isn't in it and
3701 its level is higher than 'foldlevel'. Useful if you want folds to
3702 automatically close when moving out of them.
3703
3704 *'foldcolumn'* *'fdc'*
3705'foldcolumn' 'fdc' number (default 0)
3706 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 {not available when compiled without the |+folding|
3708 feature}
3709 When non-zero, a column with the specified width is shown at the side
3710 of the window which indicates open and closed folds. The maximum
3711 value is 12.
3712 See |folding|.
3713
3714 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3715'foldenable' 'fen' boolean (default on)
3716 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 {not available when compiled without the |+folding|
3718 feature}
3719 When off, all folds are open. This option can be used to quickly
3720 switch between showing all text unfolded and viewing the text with
3721 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003722 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 'foldenable' is off.
3724 This option is set by commands that create a new fold or close a fold.
3725 See |folding|.
3726
3727 *'foldexpr'* *'fde'*
3728'foldexpr' 'fde' string (default: "0")
3729 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003731 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003733 for each line to obtain its fold level. The context is set to the
3734 script where 'foldexpr' was set, script-local items can be accessed.
3735 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003736
Bram Moolenaar30b65812012-07-12 22:01:11 +02003737 The expression will be evaluated in the |sandbox| if set from a
3738 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003739 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003740 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003741
3742 It is not allowed to change text or jump to another window while
3743 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
3745 *'foldignore'* *'fdi'*
3746'foldignore' 'fdi' string (default: "#")
3747 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 {not available when compiled without the |+folding|
3749 feature}
3750 Used only when 'foldmethod' is "indent". Lines starting with
3751 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 The default "#" works well for C programs. See |fold-indent|.
3754
3755 *'foldlevel'* *'fdl'*
3756'foldlevel' 'fdl' number (default: 0)
3757 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 {not available when compiled without the |+folding|
3759 feature}
3760 Sets the fold level: Folds with a higher level will be closed.
3761 Setting this option to zero will close all folds. Higher numbers will
3762 close fewer folds.
3763 This option is set by commands like |zm|, |zM| and |zR|.
3764 See |fold-foldlevel|.
3765
3766 *'foldlevelstart'* *'fdls'*
3767'foldlevelstart' 'fdls' number (default: -1)
3768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 {not available when compiled without the |+folding|
3770 feature}
3771 Sets 'foldlevel' when starting to edit another buffer in a window.
3772 Useful to always start editing with all folds closed (value zero),
3773 some folds closed (one) or no folds closed (99).
3774 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003775 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 ignores this option and closes all folds.
3777 It is also done before BufReadPre autocommands, to allow an autocmd to
3778 overrule the 'foldlevel' value for specific files.
3779 When the value is negative, it is not used.
3780
3781 *'foldmarker'* *'fmr'* *E536*
3782'foldmarker' 'fmr' string (default: "{{{,}}}")
3783 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 {not available when compiled without the |+folding|
3785 feature}
3786 The start and end marker used when 'foldmethod' is "marker". There
3787 must be one comma, which separates the start and end marker. The
3788 marker is a literal string (a regular expression would be too slow).
3789 See |fold-marker|.
3790
3791 *'foldmethod'* *'fdm'*
3792'foldmethod' 'fdm' string (default: "manual")
3793 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 {not available when compiled without the |+folding|
3795 feature}
3796 The kind of folding used for the current window. Possible values:
3797 |fold-manual| manual Folds are created manually.
3798 |fold-indent| indent Lines with equal indent form a fold.
3799 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3800 |fold-marker| marker Markers are used to specify folds.
3801 |fold-syntax| syntax Syntax highlighting items specify folds.
3802 |fold-diff| diff Fold text that is not changed.
3803
3804 *'foldminlines'* *'fml'*
3805'foldminlines' 'fml' number (default: 1)
3806 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 {not available when compiled without the |+folding|
3808 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003809 Sets the number of screen lines above which a fold can be displayed
3810 closed. Also for manually closed folds. With the default value of
3811 one a fold can only be closed if it takes up two or more screen lines.
3812 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003813 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 "zc" to close a fold, which is displayed open because it's smaller
3815 than 'foldminlines', a following "zc" may close a containing fold.
3816
3817 *'foldnestmax'* *'fdn'*
3818'foldnestmax' 'fdn' number (default: 20)
3819 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 {not available when compiled without the |+folding|
3821 feature}
3822 Sets the maximum nesting of folds for the "indent" and "syntax"
3823 methods. This avoids that too many folds will be created. Using more
3824 than 20 doesn't work, because the internal limit is 20.
3825
3826 *'foldopen'* *'fdo'*
3827'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3828 search,tag,undo")
3829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 {not available when compiled without the |+folding|
3831 feature}
3832 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003833 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003835 NOTE: When the command is part of a mapping this option is not used.
3836 Add the |zv| command to the mapping to get the same effect.
3837 (rationale: the mapping may want to control opening folds itself)
3838
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 item commands ~
3840 all any
3841 block "(", "{", "[[", "[{", etc.
3842 hor horizontal movements: "l", "w", "fx", etc.
3843 insert any command in Insert mode
3844 jump far jumps: "G", "gg", etc.
3845 mark jumping to a mark: "'m", CTRL-O, etc.
3846 percent "%"
3847 quickfix ":cn", ":crew", ":make", etc.
3848 search search for a pattern: "/", "n", "*", "gd", etc.
3849 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003850 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 tag jumping to a tag: ":ta", CTRL-T, etc.
3852 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 When a movement command is used for an operator (e.g., "dl" or "y%")
3854 this option is not used. This means the operator will include the
3855 whole closed fold.
3856 Note that vertical movements are not here, because it would make it
3857 very difficult to move onto a closed fold.
3858 In insert mode the folds containing the cursor will always be open
3859 when text is inserted.
3860 To close folds you can re-apply 'foldlevel' with the |zx| command or
3861 set the 'foldclose' option to "all".
3862
3863 *'foldtext'* *'fdt'*
3864'foldtext' 'fdt' string (default: "foldtext()")
3865 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 {not available when compiled without the |+folding|
3867 feature}
3868 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003869 fold. The context is set to the script where 'foldexpr' was set,
3870 script-local items can be accessed. See |fold-foldtext| for the
3871 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
Bram Moolenaar30b65812012-07-12 22:01:11 +02003873 The expression will be evaluated in the |sandbox| if set from a
3874 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003875 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003876
3877 It is not allowed to change text or jump to another window while
3878 evaluating 'foldtext' |textlock|.
3879
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003880 *'formatexpr'* *'fex'*
3881'formatexpr' 'fex' string (default "")
3882 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003883 {not available when compiled without the |+eval|
3884 feature}
3885 Expression which is evaluated to format a range of lines for the |gq|
3886 operator or automatic formatting (see 'formatoptions'). When this
3887 option is empty 'formatprg' is used.
3888
3889 The |v:lnum| variable holds the first line to be formatted.
3890 The |v:count| variable holds the number of lines to be formatted.
3891 The |v:char| variable holds the character that is going to be
3892 inserted if the expression is being evaluated due to
3893 automatic formatting. This can be empty. Don't insert
3894 it yet!
3895
3896 Example: >
3897 :set formatexpr=mylang#Format()
3898< This will invoke the mylang#Format() function in the
3899 autoload/mylang.vim file in 'runtimepath'. |autoload|
3900
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003901 The advantage of using a function call without arguments is that it is
3902 faster, see |expr-option-function|.
3903
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003904 The expression is also evaluated when 'textwidth' is set and adding
3905 text beyond that limit. This happens under the same conditions as
3906 when internal formatting is used. Make sure the cursor is kept in the
3907 same spot relative to the text then! The |mode()| function will
3908 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003909
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003910 When the expression evaluates to non-zero Vim will fall back to using
3911 the internal format mechanism.
3912
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003913 If the expression starts with s: or |<SID>|, then it is replaced with
3914 the script ID (|local-function|). Example: >
3915 set formatexpr=s:MyFormatExpr()
3916 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003917< Otherwise, the expression is evaluated in the context of the script
3918 where the option was set, thus script-local items are available.
3919
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003920 The expression will be evaluated in the |sandbox| when set from a
3921 modeline, see |sandbox-option|. That stops the option from working,
3922 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003923 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003924 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003925
Bram Moolenaar86b68352004-12-27 21:59:20 +00003926 *'formatlistpat'* *'flp'*
3927'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3928 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003929 A pattern that is used to recognize a list header. This is used for
3930 the "n" flag in 'formatoptions'.
3931 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003932 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003933 while still checking more characters. There must be a character
3934 following the pattern, when it matches the whole line it is handled
3935 like there is no match.
3936 The default recognizes a number, followed by an optional punctuation
3937 character and white space.
3938
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003939 *'formatoptions'* *'fo'*
3940'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3941 local to buffer
3942 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003943 formatting is to be done.
3944 See |fo-table| for possible values and |gq| for how to format text.
3945 When the 'paste' option is on, no formatting is done (like
3946 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003947 To avoid problems with flags that are added in the future, use the
3948 "+=" and "-=" feature of ":set" |add-option-flags|.
3949 NOTE: This option is set to the Vi default value when 'compatible' is
3950 set and to the Vim default value when 'compatible' is reset.
3951
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 *'formatprg'* *'fp'*
3953'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003954 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003956 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003958 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003959 If the 'formatexpr' option is not empty it will be used instead.
3960 Otherwise, if 'formatprg' option is an empty string, the internal
3961 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003962 Environment variables are expanded |:set_env|. See |option-backslash|
3963 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003964 This option cannot be set from a |modeline| or in the |sandbox|, for
3965 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966
Bram Moolenaard94464e2015-11-02 15:28:18 +01003967 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003968'fsync' 'fs' boolean (default on)
3969 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003970 When on, the library function fsync() will be called after writing a
3971 file. This will flush a file to disk, ensuring that it is safely
3972 written even on filesystems which do metadata-only journaling. This
3973 will force the harddrive to spin up on Linux systems running in laptop
3974 mode, so it may be undesirable in some situations. Be warned that
3975 turning this off increases the chances of data loss after a crash. On
3976 systems without an fsync() implementation, this variable is always
3977 off.
3978 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003979 'fsync' also applies to |writefile()| (unless a flag is used to
3980 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003981 This option cannot be set from a |modeline| or in the |sandbox|, for
3982 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003983
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3985'gdefault' 'gd' boolean (default off)
3986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 When on, the ":substitute" flag 'g' is default on. This means that
3988 all matches in a line are substituted instead of one. When a 'g' flag
3989 is given to a ":substitute" command, this will toggle the substitution
3990 of all or one match. See |complex-change|.
3991
3992 command 'gdefault' on 'gdefault' off ~
3993 :s/// subst. all subst. one
3994 :s///g subst. one subst. all
3995 :s///gg subst. all subst. one
3996
3997 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003998 Setting this option may break plugins that rely on the default
3999 behavior of the 'g' flag. This will also make the 'g' flag have the
4000 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004001 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002
4003 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004004'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 Format to recognize for the ":grep" command output.
4007 This is a scanf-like string that uses the same format as the
4008 'errorformat' option: see |errorformat|.
4009
4010 *'grepprg'* *'gp'*
4011'grepprg' 'gp' string (default "grep -n ",
4012 Unix: "grep -n $* /dev/null",
4013 Win32: "findstr /n" or "grep -n",
4014 VMS: "SEARCH/NUMBERS ")
4015 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004016 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 and '#' characters, which are expanded like when used in a command-
4018 line. The placeholder "$*" is allowed to specify where the arguments
4019 will be included. Environment variables are expanded |:set_env|. See
4020 |option-backslash| about including spaces and backslashes.
4021 When your "grep" accepts the "-H" argument, use this to make ":grep"
4022 also work well with a single file: >
4023 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004024< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004025 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4026 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004027 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 apply equally to 'grepprg'.
4029 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4030 otherwise it's "grep -n".
4031 This option cannot be set from a |modeline| or in the |sandbox|, for
4032 security reasons.
4033
4034 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4035'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4036 ve:ver35-Cursor,
4037 o:hor50-Cursor,
4038 i-ci:ver25-Cursor/lCursor,
4039 r-cr:hor20-Cursor/lCursor,
4040 sm:block-Cursor
4041 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004042 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 "n-v-c:block,o:hor50,i-ci:hor15,
4044 r-cr:hor30,sm:block")
4045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004047 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004049 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004050 height of the cursor can be changed. This can be done by specifying a
4051 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004052 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4053 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004055 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 mode-list and an argument-list:
4057 mode-list:argument-list,mode-list:argument-list,..
4058 The mode-list is a dash separated list of these modes:
4059 n Normal mode
4060 v Visual mode
4061 ve Visual mode with 'selection' "exclusive" (same as 'v',
4062 if not specified)
4063 o Operator-pending mode
4064 i Insert mode
4065 r Replace mode
4066 c Command-line Normal (append) mode
4067 ci Command-line Insert mode
4068 cr Command-line Replace mode
4069 sm showmatch in Insert mode
4070 a all modes
4071 The argument-list is a dash separated list of these arguments:
4072 hor{N} horizontal bar, {N} percent of the character height
4073 ver{N} vertical bar, {N} percent of the character width
4074 block block cursor, fills the whole character
4075 [only one of the above three should be present]
4076 blinkwait{N} *cursor-blinking*
4077 blinkon{N}
4078 blinkoff{N}
4079 blink times for cursor: blinkwait is the delay before
4080 the cursor starts blinking, blinkon is the time that
4081 the cursor is shown and blinkoff is the time that the
4082 cursor is not shown. The times are in msec. When one
4083 of the numbers is zero, there is no blinking. The
4084 default is: "blinkwait700-blinkon400-blinkoff250".
4085 These numbers are used for a missing entry. This
4086 means that blinking is enabled by default. To switch
4087 blinking off you can use "blinkon0". The cursor only
4088 blinks when Vim is waiting for input, not while
4089 executing a command.
4090 To make the cursor blink in an xterm, see
4091 |xterm-blink|.
4092 {group-name}
4093 a highlight group name, that sets the color and font
4094 for the cursor
4095 {group-name}/{group-name}
4096 Two highlight group names, the first is used when
4097 no language mappings are used, the other when they
4098 are. |language-mapping|
4099
4100 Examples of parts:
4101 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4102 block cursor with colors from the "nCursor"
4103 highlight group
4104 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4105 In Insert and Command-line Insert mode, use a
4106 30% vertical bar cursor with colors from the
4107 "iCursor" highlight group. Blink a bit
4108 faster.
4109
4110 The 'a' mode is different. It will set the given argument-list for
4111 all modes. It does not reset anything to defaults. This can be used
4112 to do a common setting for all modes. For example, to switch off
4113 blinking: "a:blinkon0"
4114
4115 Examples of cursor highlighting: >
4116 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4117 :highlight Cursor gui=NONE guifg=bg guibg=fg
4118<
4119 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004120 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121'guifont' 'gfn' string (default "")
4122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 {only available when compiled with GUI enabled}
4124 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004125 In its simplest form the value is just one font name.
4126 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127
4128 *'guifontset'* *'gfs'*
4129 *E250* *E252* *E234* *E597* *E598*
4130'guifontset' 'gfs' string (default "")
4131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 {only available when compiled with GUI enabled and
4133 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004134 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 When not empty, specifies two (or more) fonts to be used. The first
4136 one for normal English, the second one for your special language. See
4137 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004138
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4140'guifontwide' 'gfw' string (default "")
4141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 {only available when compiled with GUI enabled}
4143 When not empty, specifies a comma-separated list of fonts to be used
4144 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004145 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004146
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 *'guiheadroom'* *'ghr'*
4148'guiheadroom' 'ghr' number (default 50)
4149 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004150 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 The number of pixels subtracted from the screen height when fitting
4152 the GUI window on the screen. Set this before the GUI is started,
4153 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004154 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 lines will be left for window decorations and other items on the
4156 screen. Set it to a negative value to allow windows taller than the
4157 screen.
4158
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004159 *'guiligatures'* *'gli'* *E1243*
4160'guiligatures' 'gli' string (default "")
4161 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004162 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004163 List of ASCII characters that, when combined together, can create more
4164 complex shapes. Each character must be a printable ASCII character
4165 with a value in the 32-127 range.
4166 Example: >
4167 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4168< Changing this option updates screen output immediately. Set it to an
4169 empty string to disable ligatures.
4170
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004172'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4173 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004174 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004175 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004178 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 sequence of letters which describes what components and options of the
4180 GUI should be used.
4181 To avoid problems with flags that are added in the future, use the
4182 "+=" and "-=" feature of ":set" |add-option-flags|.
4183
Bram Moolenaar13568252018-03-16 20:46:58 +01004184 Valid characters are as follows:
4185 *'go-!'*
4186 '!' External commands are executed in a terminal window. Without
4187 this flag the MS-Windows GUI will open a console window to
4188 execute the command. The Unix GUI will simulate a dumb
4189 terminal to list the command output.
4190 The terminal window will be positioned at the bottom, and grow
4191 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004192 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 'a' Autoselect: If present, then whenever VISUAL mode is started,
4194 or the Visual area extended, Vim tries to become the owner of
4195 the windowing system's global selection. This means that the
4196 Visually highlighted text is available for pasting into other
4197 applications as well as into Vim itself. When the Visual mode
4198 ends, possibly due to an operation on the text, or when an
4199 application wants to paste the selection, the highlighted text
4200 is automatically yanked into the "* selection register.
4201 Thus the selection is still available for pasting into other
4202 applications after the VISUAL mode has ended.
4203 If not present, then Vim won't become the owner of the
4204 windowing system's global selection unless explicitly told to
4205 by a yank or delete operation for the "* register.
4206 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004207 *'go-P'*
4208 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004209 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004210 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004211 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 applies to the modeless selection.
4213
4214 'guioptions' autoselect Visual autoselect modeless ~
4215 "" - -
4216 "a" yes yes
4217 "A" - yes
4218 "aA" yes yes
4219
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004220 When using a terminal see the 'clipboard' option.
4221
Bram Moolenaar02467872007-05-06 13:22:01 +00004222 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 'c' Use console dialogs instead of popup dialogs for simple
4224 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004225 *'go-d'*
4226 'd' Use dark theme variant if available. Currently only works for
4227 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004228 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004229 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004230 'guitablabel' can be used to change the text in the labels.
4231 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004232 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004233 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004234 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 'f' Foreground: Don't use fork() to detach the GUI from the shell
4236 where it was started. Use this for programs that wait for the
4237 editor to finish (e.g., an e-mail program). Alternatively you
4238 can use "gvim -f" or ":gui -f" to start the GUI in the
4239 foreground. |gui-fork|
4240 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004241 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004242 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4244 corner of the window. It's black&white on non-GTK, because of
4245 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004246 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004248 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004249 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004251 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004253 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004254 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 'g' Grey menu items: Make menu items that are not active grey. If
4256 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004257 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 't' Include tearoff menu items. Currently only works for Win32,
4259 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004260 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004261 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4262 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004263 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004265 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 'R' Right-hand scrollbar is present when there is a vertically
4267 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004268 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004270 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 'L' Left-hand scrollbar is present when there is a vertically
4272 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004273 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4275 the longest visible line, or on the cursor line if the 'h'
4276 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004277 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 'h' Limit horizontal scrollbar size to the length of the cursor
4279 line. Reduces computations. |gui-horiz-scroll|
4280
4281 And yes, you may even have scrollbars on the left AND the right if
4282 you really want to :-). See |gui-scrollbars| for more information.
4283
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004284 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 'v' Use a vertical button layout for dialogs. When not included,
4286 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004287 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004288 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 'p' Use Pointer callbacks for X11 GUI. This is required for some
4290 window managers. If the cursor is not blinking or hollow at
4291 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004292 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004294 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004296 *'go-k'*
4297 'k' Keep the GUI window size when adding/removing a scrollbar, or
4298 toolbar, tabline, etc. Instead, the behavior is similar to
4299 when the window is maximized and will adjust 'lines' and
4300 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004301 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004302 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004303
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 *'guipty'* *'noguipty'*
4305'guipty' boolean (default on)
4306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 {only available when compiled with GUI enabled}
4308 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4309 I/O to/from shell commands. See |gui-pty|.
4310
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004311 *'guitablabel'* *'gtl'*
4312'guitablabel' 'gtl' string (default empty)
4313 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004314 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004315 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004316 pages line. When empty and when the result is empty Vim will use a
4317 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004318
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004319 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004320 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004321 The expression will be evaluated in the |sandbox| when set from a
4322 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004323 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004324
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004325 Only used when the GUI tab pages line is displayed. 'e' must be
4326 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4327 used.
4328
Bram Moolenaar57657d82006-04-21 22:12:41 +00004329 *'guitabtooltip'* *'gtt'*
4330'guitabtooltip' 'gtt' string (default empty)
4331 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004332 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004333 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004334 pages line. When empty Vim will use a default tooltip.
4335 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004336 You can include a line break. Simplest method is to use |:let|: >
4337 :let &guitabtooltip = "line one\nline two"
4338<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004339
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004341'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 (others) "$VIMRUNTIME/doc/help.txt")
4343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 Name of the main help file. All distributed help files should be
4345 placed together in one directory. Additionally, all "doc" directories
4346 in 'runtimepath' will be used.
4347 Environment variables are expanded |:set_env|. For example:
4348 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004349 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 spaces and backslashes.
4351 This option cannot be set from a |modeline| or in the |sandbox|, for
4352 security reasons.
4353
4354 *'helpheight'* *'hh'*
4355'helpheight' 'hh' number (default 20)
4356 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 Minimal initial height of the help window when it is opened with the
4358 ":help" command. The initial height of the help window is half of the
4359 current window, or (when the 'ea' option is on) the same as other
4360 windows. When the height is less than 'helpheight', the height is
4361 set to 'helpheight'. Set to zero to disable.
4362
4363 *'helplang'* *'hlg'*
4364'helplang' 'hlg' string (default: messages language or empty)
4365 global
4366 {only available when compiled with the |+multi_lang|
4367 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004368 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 for which the desired help can be found. The English help will always
4370 be used as a last resort. You can add "en" to prefer English over
4371 another language, but that will only find tags that exist in that
4372 language and not in the English help.
4373 Example: >
4374 :set helplang=de,it
4375< This will first search German, then Italian and finally English help
4376 files.
4377 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4378 try to find the tag in the current language before using this option.
4379 See |help-translated|.
4380
4381 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4382'hidden' 'hid' boolean (default off)
4383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 When off a buffer is unloaded when it is |abandon|ed. When on a
4385 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4386 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004387
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004389 hidden even if the 'hidden' option is off when these three are true:
4390 - the buffer is modified
4391 - 'autowrite' is off or writing is not possible
4392 - the '!' flag was used
4393 Also see |windows.txt|.
4394
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004395 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 This option is set for one command with ":hide {command}" |:hide|.
4397 WARNING: It's easy to forget that you have changes in hidden buffers.
4398 Think twice when using ":q!" or ":qa!".
4399
4400 *'highlight'* *'hl'*
4401'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004402 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4403 d:Directory,e:ErrorMsg,i:IncSearch,
4404 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004405 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004406 N:CursorLineNr,r:Question,s:StatusLine,
4407 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004408 v:Visual,V:VisualNOS,w:WarningMsg,
4409 W:WildMenu,f:Folded,F:FoldColumn,
4410 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004411 T:DiffText,E:DiffTextAdd,>:SignColumn,
4412 -:Conceal,B:SpellBad,P:SpellCap,
4413 R:SpellRare, L:SpellLocal,+:Pmenu,
4414 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004415 [:PmenuKind,]:PmenuKindSel,
4416 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004417 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4418 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004419 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004420 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004421 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004424 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004426 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004428 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4429 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 characters from 'showbreak'
4431 |hl-Directory| d directories in CTRL-D listing and other special
4432 things in listings
4433 |hl-ErrorMsg| e error messages
4434 h (obsolete, ignored)
4435 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004436 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4438 |hl-MoreMsg| m |more-prompt|
4439 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004440 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004441 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004442 |hl-LineNr| n line number for ":number" and ":#" commands, and
4443 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004444 |hl-LineNrAbove| a line number above the cursor for when the
4445 'relativenumber' option is set.
4446 |hl-LineNrBelow| b line number below the cursor for when the
4447 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004448 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4449 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 |hl-Question| r |hit-enter| prompt and yes/no questions
4451 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004452 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4454 |hl-VertSplit| c column used to separate vertically split windows
4455 |hl-Visual| v Visual mode
4456 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4457 Selection" Only X11 Gui's |gui-x11| and
4458 |xterm-clipboard|.
4459 |hl-WarningMsg| w warning messages
4460 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4461 |hl-Folded| f line used for closed folds
4462 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004463 |hl-DiffAdd| A added line in diff mode
4464 |hl-DiffChange| C changed line in diff mode
4465 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004466 |hl-DiffText| T changed text in diff mode
4467 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004469 |hl-Conceal| - the placeholders used for concealed characters
4470 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004471 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004472 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004473 |hl-SpellRare| R rare word |spell|
4474 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004475 |hl-Pmenu| + popup menu normal line
4476 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004477 |hl-PmenuKind| [ popup menu "kind" normal line
4478 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004479 |hl-PmenuExtra| { popup menu "extra" normal line
4480 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004481 |hl-PmenuSbar| x popup menu scrollbar
4482 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004483 |hl-PmenuMatch| k popup menu matched text
4484 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485
4486 The display modes are:
4487 r reverse (termcap entry "mr" and "me")
4488 i italic (termcap entry "ZH" and "ZR")
4489 b bold (termcap entry "md" and "me")
4490 s standout (termcap entry "so" and "se")
4491 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004492 c undercurl (termcap entry "Us" and "Ce")
4493 2 double underline (termcap entry "Ds" and "Ce")
4494 d dotted underline (termcap entry "ds" and "Ce")
4495 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004496 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 n no highlighting
4498 - no highlighting
4499 : use a highlight group
4500 The default is used for occasions that are not included.
4501 If you want to change what the display modes do, see |dos-colors|
4502 for an example.
4503 When using the ':' display mode, this must be followed by the name of
4504 a highlight group. A highlight group can be used to define any type
4505 of highlighting, including using color. See |:highlight| on how to
4506 define one. The default uses a different group for each occasion.
4507 See |highlight-default| for the default highlight groups.
4508
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004510'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004513 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004514 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004515 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004516 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 NOTE: This option is set to the Vi default value when 'compatible' is
4518 set and to the Vim default value when 'compatible' is reset.
4519
4520 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4521'hkmap' 'hk' boolean (default off)
4522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 {only available when compiled with the |+rightleft|
4524 feature}
4525 When on, the keyboard is mapped for the Hebrew character set.
4526 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4527 toggle this option. See |rileft.txt|.
4528 NOTE: This option is reset when 'compatible' is set.
4529
4530 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4531'hkmapp' 'hkp' boolean (default off)
4532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 {only available when compiled with the |+rightleft|
4534 feature}
4535 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4536 This is useful if you have a non-Hebrew keyboard.
4537 See |rileft.txt|.
4538 NOTE: This option is reset when 'compatible' is set.
4539
Bram Moolenaar036986f2017-03-16 17:41:02 +01004540 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4541'hlsearch' 'hls' boolean (default off)
4542 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004543 {not available when compiled without the
4544 |+extra_search| feature}
4545 When there is a previous search pattern, highlight all its matches.
4546 The type of highlighting used can be set with the 'l' occasion in the
4547 'highlight' option. This uses the "Search" highlight group by
4548 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004549 are not applied. If the "CurSearch" highlight group is set then the
4550 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004551 See also: 'incsearch' and |:match|.
4552 When you get bored looking at the highlighted matches, you can turn it
4553 off with |:nohlsearch|. This does not change the option value, as
4554 soon as you use a search command, the highlighting comes back.
4555 'redrawtime' specifies the maximum time spent on finding matches.
4556 When the search pattern can match an end-of-line, Vim will try to
4557 highlight all of the matched text. However, this depends on where the
4558 search starts. This will be the first line in the window or the first
4559 line below a closed fold. A match in a previous line which is not
4560 drawn may not continue in a newly drawn line.
4561 You can specify whether the highlight status is restored on startup
4562 with the 'h' flag in 'viminfo' |viminfo-h|.
4563 NOTE: This option is reset when 'compatible' is set.
4564
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 *'icon'* *'noicon'*
4566'icon' boolean (default off, on when title can be restored)
4567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 When on, the icon text of the window will be set to the value of
4569 'iconstring' (if it is not empty), or to the name of the file
4570 currently being edited. Only the last part of the name is used.
4571 Overridden by the 'iconstring' option.
4572 Only works if the terminal supports setting window icons (currently
4573 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4574 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4575 builtin termcap).
4576 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004577 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004579 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580
4581 *'iconstring'*
4582'iconstring' string (default "")
4583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 When this option is not empty, it will be used for the icon text of
4585 the window. This happens only when the 'icon' option is on.
4586 Only works if the terminal supports setting window icon text
4587 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004588 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 When Vim was compiled with HAVE_X11 defined, the original icon will be
4590 restored if possible |X11|.
4591 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004592 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004594 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 {not available when compiled without the |+statusline| feature}
4596
4597 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4598'ignorecase' 'ic' boolean (default off)
4599 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004600 Ignore case in search patterns, |cmdline-completion|, when
4601 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004602 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 Can be overruled by using "\c" or "\C" in the pattern, see
4604 |/ignorecase|.
4605
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004606 *'imactivatefunc'* *'imaf'*
4607'imactivatefunc' 'imaf' string (default "")
4608 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004609 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004610 activate or deactivate the Input Method. The value can be the name of
4611 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4612 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004613 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004614 The expression will be evaluated in the |sandbox| when set from a
4615 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004616
4617 Example: >
4618 function ImActivateFunc(active)
4619 if a:active
4620 ... do something
4621 else
4622 ... do something
4623 endif
4624 " return value is not used
4625 endfunction
4626 set imactivatefunc=ImActivateFunc
4627<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 *'imactivatekey'* *'imak'*
4629'imactivatekey' 'imak' string (default "")
4630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004632 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 Specifies the key that your Input Method in X-Windows uses for
4634 activation. When this is specified correctly, vim can fully control
4635 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4636 You can't use this option to change the activation key, the option
4637 tells Vim what the key is.
4638 Format:
4639 [MODIFIER_FLAG-]KEY_STRING
4640
4641 These characters can be used for MODIFIER_FLAG (case is ignored):
4642 S Shift key
4643 L Lock key
4644 C Control key
4645 1 Mod1 key
4646 2 Mod2 key
4647 3 Mod3 key
4648 4 Mod4 key
4649 5 Mod5 key
4650 Combinations are allowed, for example "S-C-space" or "SC-space" are
4651 both shift+ctrl+space.
4652 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4653
4654 Example: >
4655 :set imactivatekey=S-space
4656< "S-space" means shift+space. This is the activation key for kinput2 +
4657 canna (Japanese), and ami (Korean).
4658
4659 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4660'imcmdline' 'imc' boolean (default off)
4661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 When set the Input Method is always on when starting to edit a command
4663 line, unless entering a search pattern (see 'imsearch' for that).
4664 Setting this option is useful when your input method allows entering
4665 English characters directly, e.g., when it's used to type accented
4666 characters with dead keys.
4667
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004668 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 When set the Input Method is never used. This is useful to disable
4672 the IM when it doesn't work properly.
4673 Currently this option is on by default for SGI/IRIX machines. This
4674 may change in later releases.
4675
4676 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004677'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 Specifies whether :lmap or an Input Method (IM) is to be used in
4680 Insert mode. Valid values:
4681 0 :lmap is off and IM is off
4682 1 :lmap is ON and IM is off
4683 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 To always reset the option to zero when leaving Insert mode with <Esc>
4685 this can be used: >
4686 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4687< This makes :lmap and IM turn off automatically when leaving Insert
4688 mode.
4689 Note that this option changes when using CTRL-^ in Insert mode
4690 |i_CTRL-^|.
4691 The value is set to 1 when setting 'keymap' to a valid keymap name.
4692 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004693 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 methods. Use 'imdisable' to disable XIM then.
4695
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004696 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004697 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004698 |+multi_byte_ime| or |global-ime|.
4699
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004701'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 Specifies whether :lmap or an Input Method (IM) is to be used when
4704 entering a search pattern. Valid values:
4705 -1 the value of 'iminsert' is used, makes it look like
4706 'iminsert' is also used when typing a search pattern
4707 0 :lmap is off and IM is off
4708 1 :lmap is ON and IM is off
4709 2 :lmap is off and IM is ON
4710 Note that this option changes when using CTRL-^ in Command-line mode
4711 |c_CTRL-^|.
4712 The value is set to 1 when it is not -1 and setting the 'keymap'
4713 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004714 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 methods. Use 'imdisable' to disable XIM then.
4716
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004717 *'imstatusfunc'* *'imsf'*
4718'imstatusfunc' 'imsf' string (default "")
4719 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004720 This option specifies a function that is called to obtain the status
4721 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004722 The value can be the name of a function, a |lambda| or a |Funcref|.
4723 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004724 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004725
4726 Example: >
4727 function ImStatusFunc()
4728 let is_active = ...do something
4729 return is_active ? 1 : 0
4730 endfunction
4731 set imstatusfunc=ImStatusFunc
4732<
4733 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004734 The expression will be evaluated in the |sandbox| when set from a
4735 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004736
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004737 *'imstyle'* *'imst'*
4738'imstyle' 'imst' number (default 1)
4739 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004740 {only available when compiled with |+xim| and
4741 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004742 This option specifies the input style of Input Method:
4743 0 use on-the-spot style
4744 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004745 See: |xim-input-style|
4746
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004747 For a long time on-the-spot style had been used in the GTK version of
4748 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004749 |single-repeat|, etc. Therefore over-the-spot style becomes the
4750 default now. This should work fine for most people, however if you
4751 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004752 The expression will be evaluated in the |sandbox| when set from a
4753 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004754
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 *'include'* *'inc'*
4756'include' 'inc' string (default "^\s*#\s*include")
4757 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 {not available when compiled without the
4759 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004760 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 pattern, just like for the "/" command (See |pattern|). The default
4762 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004763 "]I", "[d", etc.
4764 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004765 comes after the matched pattern. But if "\zs" appears in the pattern
4766 then the text matched from "\zs" to the end, or until "\ze" if it
4767 appears, is used as the file name. Use this to include characters
4768 that are not in 'isfname', such as a space. You can then use
4769 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004770 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771
4772 *'includeexpr'* *'inex'*
4773'includeexpr' 'inex' string (default "")
4774 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004776 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004778 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004779 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004781 Note the double backslash: the `:set` command first halves them, then
4782 one remains it the value, where "\." matches a dot literally. For
4783 simple character replacements `tr()` avoids the need for escaping: >
4784 :setlocal includeexpr=tr(v:fname,'.','/')
4785<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004787 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 Also used for |<cfile>|.
4789
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004790 If the expression starts with s: or |<SID>|, then it is replaced with
4791 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004792 setlocal includeexpr=s:MyIncludeExpr()
4793 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004794< Otherwise, the expression is evaluated in the context of the script
4795 where the option was set, thus script-local items are available.
4796
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004797 It is more efficient if the value is just a function call without
4798 arguments, see |expr-option-function|.
4799
Bram Moolenaar30b65812012-07-12 22:01:11 +02004800 The expression will be evaluated in the |sandbox| when set from a
4801 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004802 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004803
4804 It is not allowed to change text or jump to another window while
4805 evaluating 'includeexpr' |textlock|.
4806
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004808'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004809 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004812 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004813 While typing a search command, show where the pattern, as it was typed
4814 so far, matches. The matched string is highlighted. If the pattern
4815 is invalid or not found, nothing is shown. The screen will be updated
4816 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004817 Also applies to the pattern in commands: >
4818 :global
4819 :lvimgrep
4820 :lvimgrepadd
4821 :smagic
4822 :snomagic
4823 :sort
4824 :substitute
4825 :vglobal
4826 :vimgrep
4827 :vimgrepadd
4828< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004829 original position when no match is found and when pressing <Esc>. You
4830 still need to finish the search command with <Enter> to move the
4831 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004832 You can use the CTRL-G and CTRL-T keys to move to the next and
4833 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004834 When compiled with the |+reltime| feature Vim only searches for about
4835 half a second. With a complicated pattern and/or a lot of text the
4836 match may not be found. This is to avoid that Vim hangs while you
4837 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004838 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004839 When 'hlsearch' is on, all matched strings are highlighted too while
4840 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004841 If you don't want to turn 'hlsearch' on, but want to highlight all
4842 matches while searching, you can turn on and off 'hlsearch' with
4843 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004844 augroup vimrc-incsearch-highlight
4845 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004846 autocmd CmdlineEnter /,\? :set hlsearch
4847 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004848 augroup END
4849<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004850 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004851 to the command line. If 'ignorecase' and 'smartcase' are set and the
4852 command line has no uppercase characters, the added character is
4853 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004854 CTRL-R CTRL-W can be used to add the word at the end of the current
4855 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 NOTE: This option is reset when 'compatible' is set.
4857
4858 *'indentexpr'* *'inde'*
4859'indentexpr' 'inde' string (default "")
4860 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004861 {not available when compiled without the |+eval|
4862 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 Expression which is evaluated to obtain the proper indent for a line.
4864 It is used when a new line is created, for the |=| operator and
4865 in Insert mode as specified with the 'indentkeys' option.
4866 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004867 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004868 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 When 'paste' is set this option is not used for indenting.
4870 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004871 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004873
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004874 If the expression starts with s: or |<SID>|, then it is replaced with
4875 the script ID (|local-function|). Example: >
4876 set indentexpr=s:MyIndentExpr()
4877 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004878< Otherwise, the expression is evaluated in the context of the script
4879 where the option was set, thus script-local items are available.
4880
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004881 The advantage of using a function call without arguments is that it is
4882 faster, see |expr-option-function|.
4883
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 The expression must return the number of spaces worth of indent. It
4885 can return "-1" to keep the current indent (this means 'autoindent' is
4886 used for the indent).
4887 Functions useful for computing the indent are |indent()|, |cindent()|
4888 and |lispindent()|.
4889 The evaluation of the expression must not have side effects! It must
4890 not change the text, jump to another window, etc. Afterwards the
4891 cursor position is always restored, thus the cursor may be moved.
4892 Normally this option would be set to call a function: >
4893 :set indentexpr=GetMyIndent()
4894< Error messages will be suppressed, unless the 'debug' option contains
4895 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004896 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004897 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
Bram Moolenaar30b65812012-07-12 22:01:11 +02004899 The expression will be evaluated in the |sandbox| when set from a
4900 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004901 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004902
4903 It is not allowed to change text or jump to another window while
4904 evaluating 'indentexpr' |textlock|.
4905
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004907'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 A list of keys that, when typed in Insert mode, cause reindenting of
4910 the current line. Only happens if 'indentexpr' isn't empty.
4911 The format is identical to 'cinkeys', see |indentkeys-format|.
4912 See |C-indenting| and |indent-expression|.
4913
4914 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4915'infercase' 'inf' boolean (default off)
4916 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004918 'ignorecase' is also on, the case of the match is adjusted depending
4919 on the typed text. If the typed text contains a lowercase letter
4920 where the match has an upper case letter, the completed part is made
4921 lowercase. If the typed text has no lowercase letters and the match
4922 has a lowercase letter where the typed text has an uppercase letter,
4923 and there is a letter before it, the completed part is made uppercase.
4924 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925
4926 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4927'insertmode' 'im' boolean (default off)
4928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 Makes Vim work in a way that Insert mode is the default mode. Useful
4930 if you want to use Vim as a modeless editor. Used for |evim|.
4931 These Insert mode commands will be useful:
4932 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004933 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 this is a mapping, it is executed as if 'insertmode' was off.
4935 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004937 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4938 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939
4940 These items change when 'insertmode' is set:
4941 - when starting to edit of a file, Vim goes to Insert mode.
4942 - <Esc> in Insert mode is a no-op and beeps.
4943 - <Esc> in Normal mode makes Vim go to Insert mode.
4944 - CTRL-L in Insert mode is a command, it is not inserted.
4945 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4946 However, when <Esc> is used inside a mapping, it behaves like
4947 'insertmode' was not set. This was done to be able to use the same
4948 mappings with 'insertmode' set or not set.
4949 When executing commands with |:normal| 'insertmode' is not used.
4950
4951 NOTE: This option is reset when 'compatible' is set.
4952
4953 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004954'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4956 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4957 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4958 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4959 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 The characters specified by this option are included in file names and
4962 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004963 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 Multi-byte characters 256 and above are always included, only the
4965 characters up to 255 are specified with this option.
4966 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004967 Think twice before adding white space to this option. Although a
4968 space may appear inside a file name, the effect will be that Vim
4969 doesn't know where a file name starts or ends when doing completion.
4970 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971
4972 Note that on systems using a backslash as path separator, Vim tries to
4973 do its best to make it work as you would expect. That is a bit
4974 tricky, since Vi originally used the backslash to escape special
4975 characters. Vim will not remove a backslash in front of a normal file
4976 name character on these systems, but it will on Unix and alikes. The
4977 '&' and '^' are not included by default, because these are special for
4978 cmd.exe.
4979
4980 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004981 Each part can be a single character number or a range. A range is two
4982 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 decimal number between 0 and 255 or the ASCII character itself (does
4984 not work for digits). Example:
4985 "_,-,128-140,#-43" (include '_' and '-' and the range
4986 128 to 140 and '#' to 43)
4987 If a part starts with '^', the following character number or range
4988 will be excluded from the option. The option is interpreted from left
4989 to right. Put the excluded character after the range where it is
4990 included. To include '^' itself use it as the last character of the
4991 option or the end of a range. Example:
4992 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4993 If the character is '@', all characters where isalpha() returns TRUE
4994 are included. Normally these are the characters a to z and A to Z,
4995 plus accented characters. To include '@' itself use "@-@". Examples:
4996 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004997 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 "a-z,A-Z,@-@" All letters plus the '@' character.
4999 A comma can be included by using it where a character number is
5000 expected. Example:
5001 "48-57,,,_" Digits, comma and underscore.
5002 A comma can be excluded by prepending a '^'. Example:
5003 " -~,^,,9" All characters from space to '~', excluding
5004 comma, plus <Tab>.
5005 See |option-backslash| about including spaces and backslashes.
5006
5007 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005008'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 "@,48-57,_,128-167,224-235"
5010 otherwise: "@,48-57,_,192-255")
5011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 The characters given by this option are included in identifiers.
5013 Identifiers are used in recognizing environment variables and after a
5014 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005015 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005016 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005018 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5020
5021 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005022'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 "@,48-57,_,128-167,224-235"
5024 otherwise: "@,48-57,_,192-255"
5025 Vi default: "@,48-57,_")
5026 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005028 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005029 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005030 characters above 255 check the "word" character class (any character
5031 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005032 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 For a help file it is set to all non-blank printable characters except
5034 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5035 command).
5036 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005037 This option also influences syntax highlighting, unless the syntax
5038 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 NOTE: This option is set to the Vi default value when 'compatible' is
5040 set and to the Vim default value when 'compatible' is reset.
5041
5042 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005043'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 "@,~-255"; otherwise: "@,161-255")
5045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 The characters given by this option are displayed directly on the
5047 screen. It is also used for "\p" in a |pattern|. The characters from
5048 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5049 even when they are not included in 'isprint' or excluded. See
5050 'isfname' for a description of the format of this option.
5051
5052 Non-printable characters are displayed with two characters:
5053 0 - 31 "^@" - "^_"
5054 32 - 126 always single characters
5055 127 "^?"
5056 128 - 159 "~@" - "~_"
5057 160 - 254 "| " - "|~"
5058 255 "~?"
5059 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5060 displayed as <xx>, with the hexadecimal value of the byte.
5061 When 'display' contains "uhex" all unprintable characters are
5062 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005063 The SpecialKey highlighting will be used for unprintable characters.
5064 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
5066 Multi-byte characters 256 and above are always included, only the
5067 characters up to 255 are specified with this option. When a character
5068 is printable but it is not available in the current font, a
5069 replacement character will be shown.
5070 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5071 There is no option to specify these characters.
5072
5073 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5074'joinspaces' 'js' boolean (default on)
5075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 Insert two spaces after a '.', '?' and '!' with a join command.
5077 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5078 Otherwise only one space is inserted.
5079 NOTE: This option is set when 'compatible' is set.
5080
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005081 *'jumpoptions'* *'jop'*
5082'jumpoptions' 'jop' string (default "")
5083 global
5084 List of words that change the behavior of the |jumplist|.
5085 stack Make the jumplist behave like the tagstack.
5086 Relative location of entries in the jumplist is
5087 preserved at the cost of discarding subsequent entries
5088 when navigating backwards in the jumplist and then
5089 jumping to a location. |jumplist-stack|
5090
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 *'key'*
5092'key' string (default "")
5093 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005094 {only available when compiled with the |+cryptv|
5095 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005097 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 Careful: Do not set the key value by hand, someone might see the typed
5099 key. Use the |:X| command. But you can make 'key' empty: >
5100 :set key=
5101< It is not possible to get the value of this option with ":set key" or
5102 "echo &key". This is to avoid showing it to someone who shouldn't
5103 know. It also means you cannot see it yourself once you have set it,
5104 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005105 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5106 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005107 You can use "&key" in an expression to detect whether encryption is
5108 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109
5110 *'keymap'* *'kmp'* *E544*
5111'keymap' 'kmp' string (default "")
5112 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 {only available when compiled with the |+keymap|
5114 feature}
5115 Name of a keyboard mapping. See |mbyte-keymap|.
5116 Setting this option to a valid keymap name has the side effect of
5117 setting 'iminsert' to one, so that the keymap becomes effective.
5118 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005119 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
5121 *'keymodel'* *'km'*
5122'keymodel' 'km' string (default "")
5123 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005124 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 can do. These values can be used:
5126 startsel Using a shifted special key starts selection (either
5127 Select mode or Visual mode, depending on "key" being
5128 present in 'selectmode').
5129 stopsel Using a not-shifted special key stops selection.
5130 Special keys in this context are the cursor keys, <End>, <Home>,
5131 <PageUp> and <PageDown>.
5132 The 'keymodel' option is set by the |:behave| command.
5133
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005134 *'keyprotocol'* *'kpc'*
5135'keyprotocol' 'kpc' string (default: see below)
5136 global
5137 Specifies what keyboard protocol to use depending on the value of
5138 'term'. The supported keyboard protocols names are:
5139 none whatever the terminal uses
5140 mok2 modifyOtherKeys level 2, as supported by xterm
5141 kitty Kitty keyboard protocol, as supported by Kitty
5142
Bram Moolenaara87749e2022-11-30 10:23:17 +00005143 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005144 a pattern that is matched against the 'term' option, a colon and the
5145 protocol name to be used. To illustrate this, the default value would
5146 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005147 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5148 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005149
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005150< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005151 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5152 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005153
5154 The first match is used, thus if you want to have "kitty" use the
5155 kitty protocol, but "badkitty" not, then you should match "badkitty"
5156 first and use the "none" value: >
5157 set keyprotocol=badkitty:none,kitty:kitty
5158<
5159 The option is used after 'term' has been changed. First the termcap
5160 entries are set, possibly using the builtin list, see |builtin-terms|.
5161 Then this option is inspected and if there is a match and a protocol
5162 is specified the following happens:
5163 none Nothing, the regular t_TE and t_TI values remain
5164
5165 mok2 The t_TE value is changed to:
5166 CSI >4;m disables modifyOtherKeys
5167 The t_TI value is changed to:
5168 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005169 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005170
5171 kitty The t_TE value is changed to:
5172 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005173 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005174 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005175 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005176 CSI ?u request kitty keyboard protocol state
5177 CSI >c request the termresponse
5178
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005179 If you notice problems, such as characters being displayed that
5180 disappear after `CTRL-L`, you might want to try making this option
5181 empty. Then set the 'term' option to have it take effect: >
5182 set keyprotocol=
5183 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005184<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005185
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 *'keywordprg'* *'kp'*
5187'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005188 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 Program to use for the |K| command. Environment variables are
5191 expanded |:set_env|. ":help" may be used to access the Vim internal
5192 help. (Note that previously setting the global option to the empty
5193 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005194 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005195 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005196 When "man", "man -s" or an Ex command is used, Vim will automatically
5197 translate a count for the "K" command and pass it as the first
5198 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 See |option-backslash| about including spaces and backslashes.
5200 Example: >
5201 :set keywordprg=man\ -s
5202< This option cannot be set from a |modeline| or in the |sandbox|, for
5203 security reasons.
5204
5205 *'langmap'* *'lmap'* *E357* *E358*
5206'langmap' 'lmap' string (default "")
5207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 {only available when compiled with the |+langmap|
5209 feature}
5210 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005211 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005212 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 care of translating these special characters to the original meaning
5214 of the key. This means you don't have to change the keyboard mode to
5215 be able to execute Normal mode commands.
5216 This is the opposite of the 'keymap' option, where characters are
5217 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005218 Also consider setting 'langremap' to off, to prevent 'langmap' from
5219 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005220 This option cannot be set from a |modeline| or in the |sandbox|, for
5221 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005223 Example (for Greek, in UTF-8): *greek* >
5224 :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 +00005225< Example (exchanges meaning of z and y for commands): >
5226 :set langmap=zy,yz,ZY,YZ
5227<
5228 The 'langmap' option is a list of parts, separated with commas. Each
5229 part can be in one of two forms:
5230 1. A list of pairs. Each pair is a "from" character immediately
5231 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005232 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 characters. Example: "abc;ABC"
5234 Example: "aA,fgh;FGH,cCdDeE"
5235 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005236 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237
5238 This will allow you to activate vim actions without having to switch
5239 back and forth between the languages. Your language characters will
5240 be understood as normal vim English characters (according to the
5241 langmap mappings) in the following cases:
5242 o Normal/Visual mode (commands, buffer/register names, user mappings)
5243 o Insert/Replace Mode: Register names after CTRL-R
5244 o Insert/Replace Mode: Mappings
5245 Characters entered in Command-line mode will NOT be affected by
5246 this option. Note that this option can be changed at any time
5247 allowing to switch between mappings for different languages/encodings.
5248 Use a mapping to avoid having to type it each time!
5249
5250 *'langmenu'* *'lm'*
5251'langmenu' 'lm' string (default "")
5252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 {only available when compiled with the |+menu| and
5254 |+multi_lang| features}
5255 Language to use for menu translation. Tells which file is loaded
5256 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005257 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258< (without the spaces). For example, to always use the Dutch menus, no
5259 matter what $LANG is set to: >
5260 :set langmenu=nl_NL.ISO_8859-1
5261< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005262 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 If your $LANG is set to a non-English language but you do want to use
5264 the English menus: >
5265 :set langmenu=none
5266< This option must be set before loading menus, switching on filetype
5267 detection or syntax highlighting. Once the menus are defined setting
5268 this option has no effect. But you could do this: >
5269 :source $VIMRUNTIME/delmenu.vim
5270 :set langmenu=de_DE.ISO_8859-1
5271 :source $VIMRUNTIME/menu.vim
5272< Warning: This deletes all menus that you defined yourself!
5273
Bram Moolenaard94464e2015-11-02 15:28:18 +01005274 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005275'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005276 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005277 {only available when compiled with the |+langmap|
5278 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005279 This is just like 'langremap' but with the value inverted. It only
5280 exists for backwards compatibility. When setting 'langremap' then
5281 'langnoremap' is set to the inverted value, and the other way around.
5282
5283 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005284'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005285 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005286 {only available when compiled with the |+langmap|
5287 feature}
5288 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005289 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005290 'langmap' disables some of your mappings, try resetting this option.
5291 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005292 that works for you to avoid mappings to break.
5293
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 *'laststatus'* *'ls'*
5295'laststatus' 'ls' number (default 1)
5296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 The value of this option influences when the last window will have a
5298 status line:
5299 0: never
5300 1: only if there are at least two windows
5301 2: always
5302 The screen looks nicer with a status line if you have several
5303 windows, but it takes another screen line. |status-line|
5304
5305 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5306'lazyredraw' 'lz' boolean (default off)
5307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 When this option is set, the screen will not be redrawn while
5309 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005310 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005312 This may occasionally cause display errors. It is only meant to be set
5313 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005314 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315
5316 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5317'linebreak' 'lbr' boolean (default off)
5318 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005319 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005321 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 than at the last character that fits on the screen. Unlike
5323 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005324 it only affects the way the file is displayed, not its contents.
5325 If 'breakindent' is set, line is visually indented. Then, the value
5326 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005327 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 Note that <Tab> characters after an <EOL> are mostly not displayed
5329 with the right amount of white space.
5330
5331 *'lines'* *E593*
5332'lines' number (default 24 or terminal height)
5333 global
5334 Number of lines of the Vim window.
5335 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005336 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 When Vim is running in the GUI or in a resizable window, setting this
5338 option will cause the window size to be changed. When you only want
5339 to use the size for the GUI, put the command in your |gvimrc| file.
5340 Vim limits the number of lines to what fits on the screen. You can
5341 use this command to get the tallest window possible: >
5342 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005343< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005344 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 When you set this option and Vim is unable to change the physical
5346 number of lines of the display, the display may be messed up.
5347
5348 *'linespace'* *'lsp'*
5349'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 {only in the GUI}
5352 Number of pixel lines inserted between characters. Useful if the font
5353 uses the full character cell height, making lines touch each other.
5354 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005355 With some fonts there can be too much room between lines (to have
5356 space for ascents and descents). Then it makes sense to set
5357 'linespace' to a negative value. This may cause display problems
5358 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359
5360 *'lisp'* *'nolisp'*
5361'lisp' boolean (default off)
5362 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 Lisp mode: When <Enter> is typed in insert mode set the indent for
5364 the next line to Lisp standards (well, sort of). Also happens with
5365 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5366 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5367 better. Also see 'lispwords'.
5368 The '-' character is included in keyword characters. Redefines the
5369 "=" operator to use this same indentation algorithm rather than
5370 calling an external program if 'equalprg' is empty.
5371 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005373 *'lispoptions'* *'lop'*
5374'lispoptions' 'lop' string (default "")
5375 local to buffer
5376 Comma-separated list of items that influence the Lisp indenting when
5377 enabled with the |'lisp'| option. Currently only one item is
5378 supported:
5379 expr:1 use 'indentexpr' for Lisp indenting when it is set
5380 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5381 Note that when using 'indentexpr' the `=` operator indents all the
5382 lines, otherwise the first line is not indented (Vi-compatible).
5383
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 *'lispwords'* *'lw'*
5385'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005386 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005387 Comma-separated list of words that influence the Lisp indenting when
5388 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
5390 *'list'* *'nolist'*
5391'list' boolean (default off)
5392 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005393 List mode: By default show tabs as CTRL-I is displayed, display $
5394 after end of line. Useful to see the difference between tabs and
5395 spaces and for trailing blanks. Further changed by the 'listchars'
5396 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005397
5398 The cursor is displayed at the start of the space a Tab character
5399 occupies, not at the end as usual in Normal mode. To get this cursor
5400 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005401 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005402<
5403 Note that list mode will also affect formatting (set with 'textwidth'
5404 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 changing the way tabs are displayed.
5406
5407 *'listchars'* *'lcs'*
5408'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005409 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005410 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005411 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005412 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 eol:c Character to show at the end of each line. When
5414 omitted, there is no extra character at the end of the
5415 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005416 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005417 tab:xy[z] Two or three characters to be used to show a tab.
5418 The third character is optional.
5419
5420 tab:xy The 'x' is always used, then 'y' as many times as will
5421 fit. Thus "tab:>-" displays:
5422 >
5423 >-
5424 >--
5425 etc.
5426
5427 tab:xyz The 'z' is always used, then 'x' is prepended, and
5428 then 'y' is used as many times as will fit. Thus
5429 "tab:<->" displays:
5430 >
5431 <>
5432 <->
5433 <-->
5434 etc.
5435
5436 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005437 *lcs-space*
5438 space:c Character to show for a space. When omitted, spaces
5439 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005440 *lcs-multispace*
5441 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005442 One or more characters to use cyclically to show for
5443 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005444 setting, except for single spaces. When omitted, the
5445 "space" setting is used. For example,
5446 `:set listchars=multispace:---+` shows ten consecutive
5447 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005448 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005449 *lcs-lead*
5450 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005451 leading spaces are blank. Overrides the "space" and
5452 "multispace" settings for leading spaces. You can
5453 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005454 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005455< *lcs-leadmultispace*
5456 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005457 Like the |lcs-multispace| value, but for leading
5458 spaces only. Also overrides |lcs-lead| for leading
5459 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005460 `:set listchars=leadmultispace:---+` shows ten
5461 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005462 ---+---+--XXX ~
5463 Where "XXX" denotes the first non-blank characters in
5464 the line.
5465 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005466 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005467 trailing spaces are blank. Overrides the "space" and
5468 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005469 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 extends:c Character to show in the last column, when 'wrap' is
5471 off and the line continues beyond the right of the
5472 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005473 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005474 precedes:c Character to show in the first visible column of the
5475 physical line, when there is text preceding the
5476 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005477 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005478 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005479 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005480 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005481 nbsp:c Character to show for a non-breakable space character
5482 (0xA0 (160 decimal) and U+202F). Left blank when
5483 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005485 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005487 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005489 Each character can be specified as hex: >
5490 set listchars=eol:\\x24
5491 set listchars=eol:\\u21b5
5492 set listchars=eol:\\U000021b5
5493< Note that a double backslash is used. The number of hex characters
5494 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5495
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 Examples: >
5497 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005498 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 :set lcs=extends:>,precedes:<
5500< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005501 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5502 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005503 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504
5505 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5506'loadplugins' 'lpl' boolean (default on)
5507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 When on the plugin scripts are loaded when starting up |load-plugins|.
5509 This option can be reset in your |vimrc| file to disable the loading
5510 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005511 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5512 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513
Bram Moolenaard94464e2015-11-02 15:28:18 +01005514 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005515'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005516 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005517 {only available when compiled with the |+lua/dyn|
5518 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005519 Specifies the name of the Lua shared library. The default is
5520 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005521 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005522 This option cannot be set from a |modeline| or in the |sandbox|, for
5523 security reasons.
5524
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005525 *'macatsui'* *'nomacatsui'*
5526'macatsui' boolean (default on)
5527 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005528 {not supported}
5529 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005530
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 *'magic'* *'nomagic'*
5532'magic' boolean (default on)
5533 global
5534 Changes the special characters that can be used in search patterns.
5535 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005536 WARNING: Switching this option off most likely breaks plugins! That
5537 is because many patterns assume it's on and will fail when it's off.
5538 Only switch it off when working with old Vi scripts. In any other
5539 situation write patterns that work when 'magic' is on. Include "\M"
5540 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005541 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5542 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543
5544 *'makeef'* *'mef'*
5545'makeef' 'mef' string (default: "")
5546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 {not available when compiled without the |+quickfix|
5548 feature}
5549 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5550 and the |:grep| command.
5551 When it is empty, an internally generated temp file will be used.
5552 When "##" is included, it is replaced by a number to make the name
5553 unique. This makes sure that the ":make" command doesn't overwrite an
5554 existing file.
5555 NOT used for the ":cf" command. See 'errorfile' for that.
5556 Environment variables are expanded |:set_env|.
5557 See |option-backslash| about including spaces and backslashes.
5558 This option cannot be set from a |modeline| or in the |sandbox|, for
5559 security reasons.
5560
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005561 *'makeencoding'* *'menc'*
5562'makeencoding' 'menc' string (default "")
5563 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005564 Encoding used for reading the output of external commands. When empty,
5565 encoding is not converted.
5566 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5567 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5568 and `:laddfile`.
5569
5570 This would be mostly useful when you use MS-Windows and set 'encoding'
5571 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5572 'makeencoding' to "char" has the same effect as setting to the system
5573 locale encoding. Example: >
5574 :set encoding=utf-8
5575 :set makeencoding=char " system locale is used
5576<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 *'makeprg'* *'mp'*
5578'makeprg' 'mp' string (default "make", VMS: "MMS")
5579 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005580 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005581 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5582 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005583 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005584 Environment variables are expanded |:set_env|. See |option-backslash|
5585 about including spaces and backslashes.
5586 Note that a '|' must be escaped twice: once for ":set" and once for
5587 the interpretation of a command. When you use a filter called
5588 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 :set makeprg=gmake\ \\\|\ myfilter
5590< The placeholder "$*" can be given (even multiple times) to specify
5591 where the arguments will be included, for example: >
5592 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5593< This option cannot be set from a |modeline| or in the |sandbox|, for
5594 security reasons.
5595
5596 *'matchpairs'* *'mps'*
5597'matchpairs' 'mps' string (default "(:),{:},[:]")
5598 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005600 other.
5601 Only character pairs are allowed that are different, thus you cannot
5602 jump between two double quotes.
5603 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005604 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005605 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 :set mps+=<:>
5607
5608< A more exotic example, to jump between the '=' and ';' in an
5609 assignment, useful for languages like C and Java: >
5610 :au FileType c,cpp,java set mps+==:;
5611
5612< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005613 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614
5615 *'matchtime'* *'mat'*
5616'matchtime' 'mat' number (default 5)
5617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 Tenths of a second to show the matching paren, when 'showmatch' is
5619 set. Note that this is not in milliseconds, like other options that
5620 set a time. This is to be compatible with Nvi.
5621
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005622 *'maxcombine'* *'mco'*
5623'maxcombine' 'mco' number (default 2)
5624 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005625 The maximum number of combining characters supported for displaying.
5626 Only used when 'encoding' is "utf-8".
5627 The default is OK for most languages. Hebrew may require 4.
5628 Maximum value is 6.
5629 Even when this option is set to 2 you can still edit text with more
5630 combining characters, you just can't see them. Use |g8| or |ga|.
5631 See |mbyte-combining|.
5632
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 *'maxfuncdepth'* *'mfd'*
5634'maxfuncdepth' 'mfd' number (default 100)
5635 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005636 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005637 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 Maximum depth of function calls for user functions. This normally
5639 catches endless recursion. When using a recursive function with
5640 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5641 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005642 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005643 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005645 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646
5647 *'maxmapdepth'* *'mmd'* *E223*
5648'maxmapdepth' 'mmd' number (default 1000)
5649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 Maximum number of times a mapping is done without resulting in a
5651 character to be used. This normally catches endless mappings, like
5652 ":map x y" with ":map y x". It still does not catch ":map g wg",
5653 because the 'w' is used before the next mapping is done. See also
5654 |key-mapping|.
5655
5656 *'maxmem'* *'mm'*
5657'maxmem' 'mm' number (default between 256 to 5120 (system
5658 dependent) or half the amount of memory
5659 available)
5660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5662 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005663 other memory to be freed.
5664 The maximum usable value is about 2000000. Use this to work without a
5665 limit.
5666 The value is ignored when 'swapfile' is off.
5667 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005669 *'maxmempattern'* *'mmp'*
5670'maxmempattern' 'mmp' number (default 1000)
5671 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005672 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005673 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005674 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005675 When Vim runs into the limit it gives an error message and mostly
5676 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005677 Running into the limit often means that the pattern is very
5678 inefficient or too complex. This may already happen with the pattern
5679 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005680 Might also happen on redraw, when syntax rules try to match a complex
5681 text structure.
5682 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5683 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005684
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 *'maxmemtot'* *'mmt'*
5686'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5687 dependent) or half the amount of memory
5688 available)
5689 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005690 Maximum amount of memory in Kbyte to use for all buffers together.
5691 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005692 without a limit.
5693 On 64 bit machines higher values might work. But hey, do you really
5694 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005695 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005696 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005697 Buffers with 'swapfile' off still count to the total amount of memory
5698 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005699 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
5701 *'menuitems'* *'mis'*
5702'menuitems' 'mis' number (default 25)
5703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 {not available when compiled without the |+menu|
5705 feature}
5706 Maximum number of items to use in a menu. Used for menus that are
5707 generated from a list of items, e.g., the Buffers menu. Changing this
5708 option has no direct effect, the menu must be refreshed first.
5709
Christian Brabandt51d4d842024-12-06 17:26:25 +01005710 *'messagesopt'* *'mopt'*
5711'messagesopt' 'mopt' string (default "hit-enter,history:500")
5712 global
5713
zeertzjq8cc43da2024-12-07 16:09:08 +01005714 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005715 following items. Items must be separated by a comma.
5716
zeertzjq8cc43da2024-12-07 16:09:08 +01005717 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005718 'cmdheight' size.
5719
zeertzjq8cc43da2024-12-07 16:09:08 +01005720 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5721 {n} milliseconds so that the user has a chance to read
5722 the message. The maximum value of {n} is 10000. Use
5723 0 to disable the wait (but then the user may miss an
5724 important message).
5725 This item is ignored when "hit-enter" is present, but
5726 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005727
5728 history:{n} Determines how many entries are remembered in the
5729 |:messages| history. The maximum value is 10000.
5730 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005731 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005732
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005733 *'mkspellmem'* *'msm'*
5734'mkspellmem' 'msm' string (default "460000,2000,500")
5735 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005736 {not available when compiled without the |+syntax|
5737 feature}
5738 Parameters for |:mkspell|. This tunes when to start compressing the
5739 word tree. Compression can be slow when there are many words, but
5740 it's needed to avoid running out of memory. The amount of memory used
5741 per word depends very much on how similar the words are, that's why
5742 this tuning is complicated.
5743
5744 There are three numbers, separated by commas:
5745 {start},{inc},{added}
5746
5747 For most languages the uncompressed word tree fits in memory. {start}
5748 gives the amount of memory in Kbyte that can be used before any
5749 compression is done. It should be a bit smaller than the amount of
5750 memory that is available to Vim.
5751
5752 When going over the {start} limit the {inc} number specifies the
5753 amount of memory in Kbyte that can be allocated before another
5754 compression is done. A low number means compression is done after
5755 less words are added, which is slow. A high number means more memory
5756 will be allocated.
5757
5758 After doing compression, {added} times 1024 words can be added before
5759 the {inc} limit is ignored and compression is done when any extra
5760 amount of memory is needed. A low number means there is a smaller
5761 chance of hitting the {inc} limit, less memory is used but it's
5762 slower.
5763
5764 The languages for which these numbers are important are Italian and
5765 Hungarian. The default works for when you have about 512 Mbyte. If
5766 you have 1 Gbyte you could use: >
5767 :set mkspellmem=900000,3000,800
5768< If you have less than 512 Mbyte |:mkspell| may fail for some
5769 languages, no matter what you set 'mkspellmem' to.
5770
dkearns8ebdbc92023-10-29 06:26:19 +11005771 This option cannot be set from a |modeline| or in the |sandbox|, for
5772 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005773
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005775'modeline' 'ml' boolean (Vim default: on (off for root),
5776 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005778 If 'modeline' is on 'modelines' gives the number of lines that is
5779 checked for set commands. If 'modeline' is off or 'modelines' is zero
5780 no lines are checked. See |modeline|.
5781
5782 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5783'modelineexpr' 'mle' boolean (default: off)
5784 global
5785 When on allow some options that are an expression to be set in the
5786 modeline. Check the option for whether it is affected by
5787 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005788 This option cannot be set from a |modeline| or in the |sandbox|, for
5789 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005790
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 *'modelines'* *'mls'*
5792'modelines' 'mls' number (default 5)
5793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 If 'modeline' is on 'modelines' gives the number of lines that is
5795 checked for set commands. If 'modeline' is off or 'modelines' is zero
5796 no lines are checked. See |modeline|.
5797 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5798 set and to the Vim default value when 'compatible' is reset.
5799
5800 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005801 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802'modifiable' 'ma' boolean (default on)
5803 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 When off the buffer contents cannot be changed. The 'fileformat' and
5805 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005806 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807
5808 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5809'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005810 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 When on, the buffer is considered to be modified. This option is set
5812 when:
5813 1. A change was made to the text since it was last written. Using the
5814 |undo| command to go back to the original text will reset the
5815 option. But undoing changes that were made before writing the
5816 buffer will set the option again, since the text is different from
5817 when it was written.
5818 2. 'fileformat' or 'fileencoding' is different from its original
5819 value. The original value is set when the buffer is read or
5820 written. A ":set nomodified" command also resets the original
5821 values to the current values and the 'modified' option will be
5822 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005823 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005824 This option is not set when a change is made to the buffer as the
5825 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5826 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5827 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5829 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005830 Note that the text may actually be the same, e.g. 'modified' is set
5831 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832
5833 *'more'* *'nomore'*
5834'more' boolean (Vim default: on, Vi default: off)
5835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 When on, listings pause when the whole screen is filled. You will get
5837 the |more-prompt|. When this option is off there are no pauses, the
5838 listing continues until finished.
5839 NOTE: This option is set to the Vi default value when 'compatible' is
5840 set and to the Vim default value when 'compatible' is reset.
5841
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005842 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005843'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005844 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005846 Enable the use of the mouse. Works for most terminals (xterm, Win32
5847 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5848 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5849 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005850 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 v Visual mode
5852 i Insert mode
5853 c Command-line mode
5854 h all previous modes when editing a help file
5855 a all previous modes
5856 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005857 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005859< If your terminal can't overrule the mouse events going to the
5860 application, use: >
5861 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005862< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005863 back to Vim using the mouse events.
5864 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5865 "xterm".
5866
5867 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 modeless selection. This doesn't move the text cursor.
5869
5870 See |mouse-using|. Also see |'clipboard'|.
5871
5872 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005873 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 the mouse buttons can still be used by keeping the shift key pressed.
5875 Also see the 'clipboard' option.
5876
5877 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5878'mousefocus' 'mousef' boolean (default off)
5879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 {only works in the GUI}
5881 The window that the mouse pointer is on is automatically activated.
5882 When changing the window layout or window focus in another way, the
5883 mouse pointer is moved to the window with keyboard focus. Off is the
5884 default because it makes using the pull down menus a little goofy, as
5885 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005886 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005887 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888
5889 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5890'mousehide' 'mh' boolean (default on)
5891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 {only works in the GUI}
5893 When on, the mouse pointer is hidden when characters are typed.
5894 The mouse pointer is restored when the mouse is moved.
5895
5896 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005897'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 Sets the model to use for the mouse. The name mostly specifies what
5900 the right mouse button is used for:
5901 extend Right mouse button extends a selection. This works
5902 like in an xterm.
5903 popup Right mouse button pops up a menu. The shifted left
5904 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005905 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 popup_setpos Like "popup", but the cursor will be moved to the
5907 position where the mouse was clicked, and thus the
5908 selected operation will act upon the clicked object.
5909 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005910 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 course, that right clicking outside a selection will
5912 end Visual mode.
5913 Overview of what button does what for each model:
5914 mouse extend popup(_setpos) ~
5915 left click place cursor place cursor
5916 left drag start selection start selection
5917 shift-left search word extend selection
5918 right click extend selection popup menu (place cursor)
5919 right drag extend selection -
5920 middle click paste paste
5921
5922 In the "popup" model the right mouse button produces a pop-up menu.
5923 You need to define this first, see |popup-menu|.
5924
5925 Note that you can further refine the meaning of buttons with mappings.
5926 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5927 selection (because that's handled in the GUI code directly).
5928
5929 The 'mousemodel' option is set by the |:behave| command.
5930
h_east59858792023-10-25 22:47:05 +09005931 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005932'mousemoveevent' 'mousemev' boolean (default off)
5933 global
5934 {only works in the GUI}
5935 When on, mouse move events are delivered to the input queue and are
5936 available for mapping. The default, off, avoids the mouse movement
5937 overhead except when needed. See |gui-mouse-mapping|.
5938 Warning: Setting this option can make pending mappings to be aborted
5939 when the mouse is moved.
5940 Currently only works in the GUI, may be made to work in a terminal
5941 later.
5942
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005944'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5945 vs:leftright,vd:lrsizing,m:no,
5946 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 {only available when compiled with the |+mouseshape|
5949 feature}
5950 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005951 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 like used for 'guicursor'. Each part consist of a mode/location-list
5953 and an argument-list:
5954 mode-list:shape,mode-list:shape,..
5955 The mode-list is a dash separated list of these modes/locations:
5956 In a normal window: ~
5957 n Normal mode
5958 v Visual mode
5959 ve Visual mode with 'selection' "exclusive" (same as 'v',
5960 if not specified)
5961 o Operator-pending mode
5962 i Insert mode
5963 r Replace mode
5964
5965 Others: ~
5966 c appending to the command-line
5967 ci inserting in the command-line
5968 cr replacing in the command-line
5969 m at the 'Hit ENTER' or 'More' prompts
5970 ml idem, but cursor in the last line
5971 e any mode, pointer below last window
5972 s any mode, pointer on a status line
5973 sd any mode, while dragging a status line
5974 vs any mode, pointer on a vertical separator line
5975 vd any mode, while dragging a vertical separator line
5976 a everywhere
5977
5978 The shape is one of the following:
5979 avail name looks like ~
5980 w x arrow Normal mouse pointer
5981 w x blank no pointer at all (use with care!)
5982 w x beam I-beam
5983 w x updown up-down sizing arrows
5984 w x leftright left-right sizing arrows
5985 w x busy The system's usual busy pointer
5986 w x no The system's usual 'no input' pointer
5987 x udsizing indicates up-down resizing
5988 x lrsizing indicates left-right resizing
5989 x crosshair like a big thin +
5990 x hand1 black hand
5991 x hand2 white hand
5992 x pencil what you write with
5993 x question big ?
5994 x rightup-arrow arrow pointing right-up
5995 w x up-arrow arrow pointing up
5996 x <number> any X11 pointer number (see X11/cursorfont.h)
5997
5998 The "avail" column contains a 'w' if the shape is available for Win32,
5999 x for X11.
6000 Any modes not specified or shapes not available use the normal mouse
6001 pointer.
6002
6003 Example: >
6004 :set mouseshape=s:udsizing,m:no
6005< will make the mouse turn to a sizing arrow over the status lines and
6006 indicate no input when the hit-enter prompt is displayed (since
6007 clicking the mouse has no effect in this state.)
6008
6009 *'mousetime'* *'mouset'*
6010'mousetime' 'mouset' number (default 500)
6011 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006012 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 time in msec between two mouse clicks for the second click to be
6014 recognized as a multi click.
6015
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006016
laburnumT3f7855a2023-12-05 18:37:03 +01006017 *'mzquantum'* *'mzq'*
6018'mzquantum' 'mzq' number (default 100)
6019 global
6020 {not available when compiled without the |+mzscheme|
6021 feature}
6022 The number of milliseconds between polls for MzScheme threads.
6023 Negative or zero value means no thread scheduling.
6024 NOTE: This option is set to the Vim default value when 'compatible'
6025 is reset.
6026
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006027 *'mzschemedll'*
6028'mzschemedll' string (default depends on the build)
6029 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006030 {only available when compiled with the |+mzscheme/dyn|
6031 feature}
6032 Specifies the name of the MzScheme shared library. The default is
6033 DYNAMIC_MZSCH_DLL which was specified at compile time.
6034 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006035 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006036 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006037 This option cannot be set from a |modeline| or in the |sandbox|, for
6038 security reasons.
6039
6040 *'mzschemegcdll'*
6041'mzschemegcdll' string (default depends on the build)
6042 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006043 {only available when compiled with the |+mzscheme/dyn|
6044 feature}
6045 Specifies the name of the MzScheme GC shared library. The default is
6046 DYNAMIC_MZGC_DLL which was specified at compile time.
6047 The value can be equal to 'mzschemedll' if it includes the GC code.
6048 Environment variables are expanded |:set_env|.
6049 This option cannot be set from a |modeline| or in the |sandbox|, for
6050 security reasons.
6051
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006053'nrformats' 'nf' string (default "bin,octal,hex",
6054 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 This defines what bases Vim will consider for numbers when using the
6057 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6058 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006059 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006061 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006062 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006064 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 considered to be hexadecimal. Example: Using CTRL-X on
6066 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006067 bin If included, numbers starting with "0b" or "0B" will be
6068 considered to be binary. Example: Using CTRL-X on
6069 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006070 unsigned If included, numbers are recognized as unsigned. Thus a
6071 leading dash or negative sign won't be considered as part of
6072 the number. Examples:
6073 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6074 (without "unsigned" it would become "9-2021").
6075 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6076 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006077 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6078 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006079 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006080 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006081 dash immediately preceded by a non-whitespace character (i.e.,
6082 not a tab or a " "), the negative sign won't be considered as
6083 part of the number. For example:
6084 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6085 (without "blank" it would become "Carbon-13").
6086 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006087 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006088 set, it would result in "Carbon -7").
6089 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006090 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006091 included, "unsigned" will take precedence.
6092
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 Numbers which simply begin with a digit in the range 1-9 are always
6094 considered decimal. This also happens for numbers that are not
6095 recognized as octal or hex.
6096
6097 *'number'* *'nu'* *'nonumber'* *'nonu'*
6098'number' 'nu' boolean (default off)
6099 local to window
6100 Print the line number in front of each line. When the 'n' option is
6101 excluded from 'cpoptions' a wrapped line will not use the column of
6102 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006103 The 'numberwidth' option can be used to set the room used for the line
6104 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 When a long, wrapped line doesn't start with the first character, '-'
6106 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006107 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6108 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006109 *number_relativenumber*
6110 The 'relativenumber' option changes the displayed number to be
6111 relative to the cursor. Together with 'number' there are these
6112 four combinations (cursor in line 3):
6113
Bram Moolenaar3848e002016-03-19 18:42:29 +01006114 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006115 'nornu' 'nornu' 'rnu' 'rnu'
6116
6117 |apple | 1 apple | 2 apple | 2 apple
6118 |pear | 2 pear | 1 pear | 1 pear
6119 |nobody | 3 nobody | 0 nobody |3 nobody
6120 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006122 *'numberwidth'* *'nuw'*
6123'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6124 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006125 {only available when compiled with the |+linebreak|
6126 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006127 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006128 when the 'number' or 'relativenumber' option is set or printing lines
6129 with a line number. Since one space is always between the number and
6130 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006131 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006132 fit the highest line number in the buffer respectively the number of
6133 rows in the window, depending on whether 'number' or 'relativenumber'
6134 is set. Thus with the Vim default of 4 there is room for a line number
6135 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006136 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006137 NOTE: This option is set to the Vi default value when 'compatible' is
6138 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006139
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006140 *'omnifunc'* *'ofu'*
6141'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006142 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006143 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006144 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006145 This option specifies a function to be used for Insert mode omni
6146 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006147 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006148 invoked and what it should return. The value can be the name of a
6149 function, a |lambda| or a |Funcref|. See |option-value-function| for
6150 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006151 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006152 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006153 This option cannot be set from a |modeline| or in the |sandbox|, for
6154 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006155
Bram Moolenaar02467872007-05-06 13:22:01 +00006156 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006157'opendevice' 'odev' boolean (default off)
6158 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006159 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006160 Enable reading and writing from devices. This may get Vim stuck on a
6161 device that can be opened but doesn't actually do the I/O. Therefore
6162 it is off by default.
6163 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6164 result in editing a device.
6165
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006166 *'operatorfunc'* *'opfunc'*
6167'operatorfunc' 'opfunc' string (default: empty)
6168 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006169 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006170 See |:map-operator| for more info and an example. The value can be
6171 the name of a function, a |lambda| or a |Funcref|. See
6172 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006173
6174 This option cannot be set from a |modeline| or in the |sandbox|, for
6175 security reasons.
6176
Bram Moolenaar251e1912011-06-19 05:09:16 +02006177 *'osfiletype'* *'oft'*
6178'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006180 This option was supported on RISC OS, which has been removed.
6181
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006182 *'packpath'* *'pp'*
6183'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006184 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006185 This option cannot be set from a |modeline| or in the |sandbox|, for
6186 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006187
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006189'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 global
6191 Specifies the nroff macros that separate paragraphs. These are pairs
6192 of two letters (see |object-motions|).
6193
6194 *'paste'* *'nopaste'*
6195'paste' boolean (default off)
6196 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006197 Put Vim in Paste mode. This is useful if you want to cut or copy
6198 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 unexpected effects.
6200 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006201 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 knows about pasting and will mostly do the right thing without 'paste'
6203 being set. The same is true for a terminal where Vim handles the
6204 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006205 This option is reset when starting the GUI. Thus if you set it in
6206 your .vimrc it will work in a terminal, but not in the GUI. Setting
6207 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6208 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 When the 'paste' option is switched on (also when it was already on):
6210 - mapping in Insert mode and Command-line mode is disabled
6211 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006213 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006214 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 - 'revins' is reset
6216 - 'ruler' is reset
6217 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006218 - 'smarttab' is reset
6219 - 'softtabstop' is set to 0
6220 - 'textwidth' is set to 0
6221 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006222 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006225 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006226 - 'indentexpr'
6227 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006228 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 NOTE: When you start editing another file while the 'paste' option is
6230 on, settings from the modelines or autocommands may change the
6231 settings again, causing trouble when pasting text. You might want to
6232 set the 'paste' option again.
6233 When the 'paste' option is reset the mentioned options are restored to
6234 the value before the moment 'paste' was switched from off to on.
6235 Resetting 'paste' before ever setting it does not have any effect.
6236 Since mapping doesn't work while 'paste' is active, you need to use
6237 the 'pastetoggle' option to toggle the 'paste' option with some key.
6238
6239 *'pastetoggle'* *'pt'*
6240'pastetoggle' 'pt' string (default "")
6241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 When non-empty, specifies the key sequence that toggles the 'paste'
6243 option. This is like specifying a mapping: >
6244 :map {keys} :set invpaste<CR>
6245< Where {keys} is the value of 'pastetoggle'.
6246 The difference is that it will work even when 'paste' is set.
6247 'pastetoggle' works in Insert mode and Normal mode, but not in
6248 Command-line mode.
6249 Mappings are checked first, thus overrule 'pastetoggle'. However,
6250 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6251 this: >
6252 :map <F10> :set paste<CR>
6253 :map <F11> :set nopaste<CR>
6254 :imap <F10> <C-O>:set paste<CR>
6255 :imap <F11> <nop>
6256 :set pastetoggle=<F11>
6257< This will make <F10> start paste mode and <F11> stop paste mode.
6258 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6259 mode everything is inserted literally, except the 'pastetoggle' key
6260 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006261 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262
6263 *'pex'* *'patchexpr'*
6264'patchexpr' 'pex' string (default "")
6265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 {not available when compiled without the |+diff|
6267 feature}
6268 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006269 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006270 This option cannot be set from a |modeline| or in the |sandbox|, for
6271 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272
Bram Moolenaardbc28022014-07-26 13:40:44 +02006273 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274'patchmode' 'pm' string (default "")
6275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 When non-empty the oldest version of a file is kept. This can be used
6277 to keep the original version of a file if you are changing files in a
6278 source distribution. Only the first time that a file is written a
6279 copy of the original file will be kept. The name of the copy is the
6280 name of the original file with the string in the 'patchmode' option
6281 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006282 ".orig" or ".org". 'backupdir' must not be empty for this to work
6283 (Detail: The backup file is renamed to the patchmode file after the
6284 new file has been successfully written, that's why it must be possible
6285 to write a backup file). If there was no file to be backed up, an
6286 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 When the 'backupskip' pattern matches, a patchmode file is not made.
6288 Using 'patchmode' for compressed files appends the extension at the
6289 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6290 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006291 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006293 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 other systems: ".,,")
6296 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006298 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6299 provided that the file being searched for has a relative path (not
6300 starting with "/", "./" or "../"). The directories in the 'path'
6301 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 - Use commas to separate directory names: >
6303 :set path=.,/usr/local/include,/usr/include
6304< - Spaces can also be used to separate directory names (for backwards
6305 compatibility with version 3.0). To have a space in a directory
6306 name, precede it with an extra backslash, and escape the space: >
6307 :set path=.,/dir/with\\\ space
6308< - To include a comma in a directory name precede it with an extra
6309 backslash: >
6310 :set path=.,/dir/with\\,comma
6311< - To search relative to the directory of the current file, use: >
6312 :set path=.
6313< - To search in the current directory use an empty string between two
6314 commas: >
6315 :set path=,,
6316< - A directory name may end in a ':' or '/'.
6317 - Environment variables are expanded |:set_env|.
6318 - When using |netrw.vim| URLs can be used. For example, adding
6319 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006320 - Search upwards and downwards in a directory tree using "*", "**" and
6321 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 - Careful with '\' characters, type two to get one in the option: >
6323 :set path=.,c:\\include
6324< Or just use '/' instead: >
6325 :set path=.,c:/include
6326< Don't forget "." or files won't even be found in the same directory as
6327 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 it is something like 256 or 1024 characters.
6330 You can check if all the include files are found, using the value of
6331 'path', see |:checkpath|.
6332 The use of |:set+=| and |:set-=| is preferred when adding or removing
6333 directories from the list. This avoids problems when a future version
6334 uses another default. To remove the current directory use: >
6335 :set path-=
6336< To add the current directory use: >
6337 :set path+=
6338< To use an environment variable, you probably need to replace the
6339 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006340 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006341 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342< Replace the ';' with a ':' or whatever separator is used. Note that
6343 this doesn't work when $INCL contains a comma or white space.
6344
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006345 *'perldll'*
6346'perldll' string (default depends on the build)
6347 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006348 {only available when compiled with the |+perl/dyn|
6349 feature}
6350 Specifies the name of the Perl shared library. The default is
6351 DYNAMIC_PERL_DLL, which was specified at compile time.
6352 Environment variables are expanded |:set_env|.
6353 This option cannot be set from a |modeline| or in the |sandbox|, for
6354 security reasons.
6355
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6357'preserveindent' 'pi' boolean (default off)
6358 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 When changing the indent of the current line, preserve as much of the
6360 indent structure as possible. Normally the indent is replaced by a
6361 series of tabs followed by spaces as required (unless |'expandtab'| is
6362 enabled, in which case only spaces are used). Enabling this option
6363 means the indent will preserve as many existing characters as possible
6364 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006365 'expandtab' does not apply to the preserved white space, a Tab remains
6366 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 NOTE: When using ">>" multiple times the resulting indent is a mix of
6368 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006369 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 Also see 'copyindent'.
6371 Use |:retab| to clean up white space.
6372
6373 *'previewheight'* *'pvh'*
6374'previewheight' 'pvh' number (default 12)
6375 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006376 {not available when compiled without the |+quickfix|
6377 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006379 commands. Used for |CTRL-W_}| when no count is given. Not used when
6380 'previewpopup' is set.
6381
6382 *'previewpopup'* *'pvp'*
6383'previewpopup' 'pvp' string (default empty)
6384 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006385 {not available when compiled without the |+textprop|
6386 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006387 When not empty a popup window is used for commands that would open a
6388 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006389 Not used for the insert completion info, add "popup" to
6390 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
6392 *'previewwindow'* *'nopreviewwindow'*
6393 *'pvw'* *'nopvw'* *E590*
6394'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006395 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006396 {not available when compiled without the |+quickfix|
6397 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 set. It's normally not set directly, but by using one of the commands
6400 |:ptag|, |:pedit|, etc.
6401
6402 *'printdevice'* *'pdev'*
6403'printdevice' 'pdev' string (default empty)
6404 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 {only available when compiled with the |+printer|
6406 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006407 The name of the printer to be used for |:hardcopy|.
6408 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006409 This option cannot be set from a |modeline| or in the |sandbox|, for
6410 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411
Bram Moolenaar8299df92004-07-10 09:47:34 +00006412 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006413'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 {only available when compiled with the |+printer|
6416 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006417 Sets the character encoding used when printing.
6418 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419
6420 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006421'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 {only available when compiled with the |+printer|
6424 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006425 Expression used to print the PostScript produced with |:hardcopy|.
6426 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006427 This option cannot be set from a |modeline| or in the |sandbox|, for
6428 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429
Bram Moolenaar8299df92004-07-10 09:47:34 +00006430 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431'printfont' 'pfn' string (default "courier")
6432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 {only available when compiled with the |+printer|
6434 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006435 The name of the font that will be used for |:hardcopy|.
6436 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437
6438 *'printheader'* *'pheader'*
6439'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 {only available when compiled with the |+printer|
6442 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006443 The format of the header produced in |:hardcopy| output.
6444 See |pheader-option|.
6445
6446 *'printmbcharset'* *'pmbcs'*
6447'printmbcharset' 'pmbcs' string (default "")
6448 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006449 {only available when compiled with the |+printer|
6450 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006451 The CJK character set to be used for CJK output from |:hardcopy|.
6452 See |pmbcs-option|.
6453
6454 *'printmbfont'* *'pmbfn'*
6455'printmbfont' 'pmbfn' string (default "")
6456 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006457 {only available when compiled with the |+printer|
6458 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006459 List of font names to be used for CJK output from |:hardcopy|.
6460 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461
6462 *'printoptions'* *'popt'*
6463'printoptions' 'popt' string (default "")
6464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006466 List of items that control the format of the output of |:hardcopy|.
6467 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006469 *'prompt'* *'noprompt'*
6470'prompt' boolean (default on)
6471 global
6472 When on a ":" prompt is used in Ex mode.
6473
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006474 *'pumheight'* *'ph'*
6475'pumheight' 'ph' number (default 0)
6476 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006477 Determines the maximum number of items to show in the popup menu for
6478 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006479 |ins-completion-menu|.
6480
glepnir88d75932025-03-27 20:09:07 +01006481 *'pummaxwidth'* *'pmw'*
6482'pummaxwidth' 'pmw' number (default 0)
6483 global
6484 Determines the maximum width to use for the popup menu for completion.
6485 When zero, there is no maximum width limit, otherwise the popup menu
6486 will never be wider than this value. Truncated text will be indicated
6487 by "..." at the end. Takes precedence over 'pumwidth'.
6488 |ins-completion-menu|.
6489
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006490 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006491'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006492 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006493 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006494 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006495
Bram Moolenaard94464e2015-11-02 15:28:18 +01006496 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006497'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006498 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006499 {only available when compiled with the |+python/dyn|
6500 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006501 Specifies the name of the Python 2.x shared library. The default is
6502 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006503 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006504 This option cannot be set from a |modeline| or in the |sandbox|, for
6505 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006506
Bram Moolenaar94073162018-01-31 21:49:05 +01006507 *'pythonhome'*
6508'pythonhome' string (default "")
6509 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006510 {only available when compiled with the |+python/dyn|
6511 feature}
6512 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6513 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6514 which was specified at compile time, will be used for the Python 2.x
6515 home directory.
6516 Environment variables are expanded |:set_env|.
6517 This option cannot be set from a |modeline| or in the |sandbox|, for
6518 security reasons.
6519
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006520 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006521'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006522 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006523 {only available when compiled with the |+python3/dyn|
6524 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006525 Specifies the name of the Python 3 shared library. The default is
6526 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006527 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006528 This option cannot be set from a |modeline| or in the |sandbox|, for
6529 security reasons.
6530
Bram Moolenaar94073162018-01-31 21:49:05 +01006531 *'pythonthreehome'*
6532'pythonthreehome' string (default "")
6533 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006534 {only available when compiled with the |+python3/dyn|
6535 feature}
6536 Specifies the name of the Python 3 home directory. When
6537 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6538 PYTHON3_HOME, which was specified at compile time, will be used for
6539 the Python 3 home directory.
6540 Environment variables are expanded |:set_env|.
6541 This option cannot be set from a |modeline| or in the |sandbox|, for
6542 security reasons.
6543
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006544 *'pyxversion'* *'pyx'*
6545'pyxversion' 'pyx' number (default depends on the build)
6546 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006547 {only available when compiled with the |+python| or
6548 the |+python3| feature}
6549 Specifies the python version used for pyx* functions and commands
6550 |python_x|. The default value is as follows:
6551
6552 Compiled with Default ~
6553 |+python| and |+python3| 0
6554 only |+python| 2
6555 only |+python3| 3
6556
6557 Available values are 0, 2 and 3.
6558 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6559 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6560 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6561 to 2 if Python 2 is available.
6562 See also: |has-pythonx|
6563
6564 If Vim is compiled with only |+python| or |+python3| setting
6565 'pyxversion' has no effect. The pyx* functions and commands are
6566 always the same as the compiled version.
6567
6568 This option cannot be set from a |modeline| or in the |sandbox|, for
6569 security reasons.
6570
Bram Moolenaar858ba062020-05-31 23:11:59 +02006571 *'quickfixtextfunc'* *'qftf'*
6572'quickfixtextfunc' 'qftf' string (default "")
6573 global
6574 {only available when compiled with the |+quickfix|
6575 feature}
6576 This option specifies a function to be used to get the text to display
6577 in the quickfix and location list windows. This can be used to
6578 customize the information displayed in the quickfix or location window
6579 for each entry in the corresponding quickfix or location list. See
6580 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006581 function and an example. The value can be the name of a function, a
6582 |lambda| or a |Funcref|. See |option-value-function| for more
6583 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006584
6585 This option cannot be set from a |modeline| or in the |sandbox|, for
6586 security reasons.
6587
Bram Moolenaar677ee682005-01-27 14:41:15 +00006588 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006589'quoteescape' 'qe' string (default "\")
6590 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006591 The characters that are used to escape quotes in a string. Used for
6592 objects like a', a" and a` |a'|.
6593 When one of the characters in this option is found inside a string,
6594 the following character will be skipped. The default value makes the
6595 text "foo\"bar\\" considered to be one string.
6596
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6598'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006599 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 If on, writes fail unless you use a '!'. Protects you from
6601 accidentally overwriting a file. Default on when Vim is started
6602 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006603 When using ":w!" the 'readonly' option is reset for the current
6604 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006605 When using the ":view" command the 'readonly' option is set for the
6606 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006607 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006609 *'redrawtime'* *'rdt'*
6610'redrawtime' 'rdt' number (default 2000)
6611 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006612 {only available when compiled with the |+reltime|
6613 feature}
6614 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006615 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006616 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006617 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006618 matches will be highlighted.
6619 For syntax highlighting the time applies per window. When over the
6620 limit syntax highlighting is disabled until |CTRL-L| is used.
6621 This is used to avoid that Vim hangs when using a very complicated
6622 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006623
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006624 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006625'regexpengine' 're' number (default 0)
6626 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006627 This selects the default regexp engine. |two-engines|
6628 The possible values are:
6629 0 automatic selection
6630 1 old engine
6631 2 NFA engine
6632 Note that when using the NFA engine and the pattern contains something
6633 that is not supported the pattern will not match. This is only useful
6634 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006635 Using automatic selection enables Vim to switch the engine, if the
6636 default engine becomes too costly. E.g., when the NFA engine uses too
6637 many states. This should prevent Vim from hanging on a combination of
6638 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006639
Bram Moolenaar64486672010-05-16 15:46:46 +02006640 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6641'relativenumber' 'rnu' boolean (default off)
6642 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006643 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006644 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006645 precede some vertical motion commands (e.g. j k + -) with, without
6646 having to calculate it yourself. Especially useful in combination with
6647 other commands (e.g. y d c < > gq gw =).
6648 When the 'n' option is excluded from 'cpoptions' a wrapped
6649 line will not use the column of line numbers (this is the default when
6650 'compatible' isn't set).
6651 The 'numberwidth' option can be used to set the room used for the line
6652 number.
6653 When a long, wrapped line doesn't start with the first character, '-'
6654 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006655 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6656 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006657
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006658 The number in front of the cursor line also depends on the value of
6659 'number', see |number_relativenumber| for all combinations of the two
6660 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006661
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 *'remap'* *'noremap'*
6663'remap' boolean (default on)
6664 global
6665 Allows for mappings to work recursively. If you do not want this for
6666 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006667 NOTE: To avoid portability problems with Vim scripts, always keep
6668 this option at the default "on". Only switch it off when working with
6669 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670
zeertzjqd086b8f2024-02-25 15:42:52 +08006671 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006672'renderoptions' 'rop' string (default: empty)
6673 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006674 {only available when compiled with GUI and DIRECTX on
6675 MS-Windows}
6676 Select a text renderer and set its options. The options depend on the
6677 renderer.
6678
6679 Syntax: >
6680 set rop=type:{renderer}(,{name}:{value})*
6681<
6682 Currently, only one optional renderer is available.
6683
6684 render behavior ~
6685 directx Vim will draw text using DirectX (DirectWrite). It makes
6686 drawn glyphs more beautiful than default GDI.
6687 It requires 'encoding' is "utf-8", and only works on
6688 MS-Windows Vista or newer version.
6689
6690 Options:
6691 name meaning type value ~
6692 gamma gamma float 1.0 - 2.2 (maybe)
6693 contrast enhancedContrast float (unknown)
6694 level clearTypeLevel float (unknown)
6695 geom pixelGeometry int 0 - 2 (see below)
6696 renmode renderingMode int 0 - 6 (see below)
6697 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006698 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006699
Bram Moolenaar92467d32017-12-05 13:22:16 +01006700 See this URL for detail (except for scrlines):
6701 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006702
6703 For geom: structure of a device pixel.
6704 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6705 1 - DWRITE_PIXEL_GEOMETRY_RGB
6706 2 - DWRITE_PIXEL_GEOMETRY_BGR
6707
6708 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006709 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006710
6711 For renmode: method of rendering glyphs.
6712 0 - DWRITE_RENDERING_MODE_DEFAULT
6713 1 - DWRITE_RENDERING_MODE_ALIASED
6714 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6715 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6716 4 - DWRITE_RENDERING_MODE_NATURAL
6717 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6718 6 - DWRITE_RENDERING_MODE_OUTLINE
6719
6720 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006721 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006722
6723 For taamode: antialiasing mode used for drawing text.
6724 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6725 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6726 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6727 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6728
6729 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006730 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6731
Bram Moolenaara338adc2018-01-31 20:51:47 +01006732 For scrlines:
6733 This was used for optimizing scrolling behavior, however this
6734 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006735
6736 Example: >
6737 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006738 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006739 set rop=type:directx
6740<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006741 If select a raster font (Courier, Terminal or FixedSys which
6742 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006743 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006744
6745 NOTE: It is known that some fonts and options combination
6746 causes trouble on drawing glyphs.
6747
Bram Moolenaar92467d32017-12-05 13:22:16 +01006748 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006749 special made fonts (True-Type fonts which includes only
6750 bitmap glyphs).
6751 - 'taamode:3' will not work with some vector fonts.
6752
6753 NOTE: With this option, you can display colored emoji
6754 (emoticon) in Windows 8.1 or later. To display colored emoji,
6755 there are some conditions which you should notice.
6756
6757 - If your font includes non-colored emoji already, it will
6758 be used.
6759 - If your font doesn't have emoji, the system chooses an
6760 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6761 will be used.
6762 - When this alternative font didn't have fixed width glyph,
6763 emoji might be rendered beyond the bounding box of drawing
6764 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006765
6766 Other render types are currently not supported.
6767
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 *'report'*
6769'report' number (default 2)
6770 global
6771 Threshold for reporting number of lines changed. When the number of
6772 changed lines is more than 'report' a message will be given for most
6773 ":" commands. If you want it always, set 'report' to 0.
6774 For the ":substitute" command the number of substitutions is used
6775 instead of the number of lines.
6776
6777 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6778'restorescreen' 'rs' boolean (default on)
6779 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006780 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 When set, the screen contents is restored when exiting Vim. This also
6782 happens when executing external commands.
6783
6784 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6785 options in your .vimrc. To disable restoring:
6786 set t_ti= t_te=
6787 To enable restoring (for an xterm):
6788 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6789 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6790
6791 *'revins'* *'ri'* *'norevins'* *'nori'*
6792'revins' 'ri' boolean (default off)
6793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 {only available when compiled with the |+rightleft|
6795 feature}
6796 Inserting characters in Insert mode will work backwards. See "typing
6797 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6798 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006799 NOTE: This option is reset when 'compatible' is set.
6800 This option is reset when 'paste' is set and restored when 'paste' is
6801 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802
6803 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6804'rightleft' 'rl' boolean (default off)
6805 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 {only available when compiled with the |+rightleft|
6807 feature}
6808 When on, display orientation becomes right-to-left, i.e., characters
6809 that are stored in the file appear from the right to the left.
6810 Using this option, it is possible to edit files for languages that
6811 are written from the right to the left such as Hebrew and Arabic.
6812 This option is per window, so it is possible to edit mixed files
6813 simultaneously, or to view the same file in both ways (this is
6814 useful whenever you have a mixed text file with both right-to-left
6815 and left-to-right strings so that both sets are displayed properly
6816 in different windows). Also see |rileft.txt|.
6817
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006818 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819'rightleftcmd' 'rlc' string (default "search")
6820 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 {only available when compiled with the |+rightleft|
6822 feature}
6823 Each word in this option enables the command line editing to work in
6824 right-to-left mode for a group of commands:
6825
6826 search "/" and "?" commands
6827
6828 This is useful for languages such as Hebrew, Arabic and Farsi.
6829 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6830
Bram Moolenaard94464e2015-11-02 15:28:18 +01006831 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006832'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006833 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006834 {only available when compiled with the |+ruby/dyn|
6835 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006836 Specifies the name of the Ruby shared library. The default is
6837 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006838 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006839 This option cannot be set from a |modeline| or in the |sandbox|, for
6840 security reasons.
6841
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006843'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006846 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 text in the file is shown on the far right:
6848 Top first line is visible
6849 Bot last line is visible
6850 All first and last line are visible
6851 45% relative position in the file
6852 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006853 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006854 ruler is shown there. Otherwise it is shown in the last line of the
6855 screen. If the statusline is given by 'statusline' (i.e. not empty),
6856 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006858 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 the text column (byte number) and the screen column are shown,
6860 separated with a dash.
6861 For an empty line "0-1" is shown.
6862 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006863 This option is reset when 'paste' is set and restored when 'paste' is
6864 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 If you don't want to see the ruler all the time but want to know where
6866 you are, use "g CTRL-G" |g_CTRL-G|.
6867 NOTE: This option is reset when 'compatible' is set.
6868
6869 *'rulerformat'* *'ruf'*
6870'rulerformat' 'ruf' string (default empty)
6871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 {not available when compiled without the |+statusline|
6873 feature}
6874 When this option is not empty, it determines the content of the ruler
6875 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006876 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006877 This option cannot be set in a modeline when 'modelineexpr' is off.
6878
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 The default ruler width is 17 characters. To make the ruler 15
6880 characters wide, put "%15(" at the start and "%)" at the end.
6881 Example: >
6882 :set rulerformat=%15(%c%V\ %p%%%)
6883<
6884 *'runtimepath'* *'rtp'* *vimfiles*
6885'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006886 Unix: "$HOME/.vim or
6887 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 $VIM/vimfiles,
6889 $VIMRUNTIME,
6890 $VIM/vimfiles/after,
6891 $HOME/.vim/after"
6892 Amiga: "home:vimfiles,
6893 $VIM/vimfiles,
6894 $VIMRUNTIME,
6895 $VIM/vimfiles/after,
6896 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006897 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 $VIM/vimfiles,
6899 $VIMRUNTIME,
6900 $VIM/vimfiles/after,
6901 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006902 Haiku: "$BE_USER_SETTINGS/vim,
6903 $VIM/vimfiles,
6904 $VIMRUNTIME,
6905 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006906 $BE_USER_SETTINGS/vim/after"
6907 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 $VIM/vimfiles,
6909 $VIMRUNTIME,
6910 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006911 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 This is a list of directories which will be searched for runtime
6914 files:
6915 filetype.vim filetypes by file name |new-filetype|
6916 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006917 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 colors/ color scheme files |:colorscheme|
6919 compiler/ compiler files |:compiler|
6920 doc/ documentation |write-local-help|
6921 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006922 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 indent/ indent scripts |indent-expression|
6924 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006925 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006927 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 plugin/ plugin scripts |write-plugin|
6929 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006930 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 syntax/ syntax files |mysyntaxfile|
6932 tutor/ files for vimtutor |tutor|
6933
6934 And any other file searched for with the |:runtime| command.
6935
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006936 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6937
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 The defaults for most systems are setup to search five locations:
6939 1. In your home directory, for your personal preferences.
6940 2. In a system-wide Vim directory, for preferences from the system
6941 administrator.
6942 3. In $VIMRUNTIME, for files distributed with Vim.
6943 *after-directory*
6944 4. In the "after" directory in the system-wide Vim directory. This is
6945 for the system administrator to overrule or add to the distributed
6946 defaults (rarely needed)
6947 5. In the "after" directory in your home directory. This is for
6948 personal preferences to overrule or add to the distributed defaults
6949 or system-wide settings (rarely needed).
6950
Bram Moolenaard0796902016-09-16 20:02:31 +02006951 More entries are added when using |packages|. If it gets very long
6952 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6953 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006954
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6956 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006957 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 wildcards.
6959 See |:runtime|.
6960 Example: >
6961 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6962< This will use the directory "~/vimruntime" first (containing your
6963 personal Vim runtime files), then "/mygroup/vim" (shared between a
6964 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6965 files).
6966 You probably should always include $VIMRUNTIME somewhere, to use the
6967 distributed runtime files. You can put a directory before $VIMRUNTIME
6968 to find files which replace a distributed runtime files. You can put
6969 a directory after $VIMRUNTIME to find files which add to distributed
6970 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006971 When Vim is started with |--clean| the home directory entries are not
6972 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 This option cannot be set from a |modeline| or in the |sandbox|, for
6974 security reasons.
6975
6976 *'scroll'* *'scr'*
6977'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006978 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6980 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006981 changes. This may happen when enabling the |status-line| or
6982 'tabline' option after setting the 'scroll' option.
6983 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006984 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006985 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986
6987 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6988'scrollbind' 'scb' boolean (default off)
6989 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006990 See also |scroll-binding|. When this option is set, scrolling the
6991 current window also scrolls other scrollbind windows (windows that
6992 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 differences between two versions of a file, see 'diff'.
6994 See |'scrollopt'| for options that determine how this option should be
6995 interpreted.
6996 This option is mostly reset when splitting a window to edit another
6997 file. This means that ":split | edit file" results in two windows
6998 with scroll-binding, but ":split file" does not.
6999
Bram Moolenaarae20f342019-11-05 21:09:23 +01007000 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7001'scrollfocus' 'scf' boolean (default off)
7002 global
7003 {only for MS-Windows GUI}
7004 When using the scroll wheel and this option is set, the window under
7005 the mouse pointer is scrolled. With this option off the current
7006 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007007 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007008
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 *'scrolljump'* *'sj'*
7010'scrolljump' 'sj' number (default 1)
7011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 Minimal number of lines to scroll when the cursor gets off the
7013 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7014 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007015 When set to a negative number from -1 to -100 this is used as the
7016 percentage of the window height. Thus -50 scrolls half the window
7017 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 NOTE: This option is set to 1 when 'compatible' is set.
7019
7020 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007021'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007022 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 Minimal number of screen lines to keep above and below the cursor.
7024 This will make some context visible around where you are working. If
7025 you set it to a very large value (999) the cursor line will always be
7026 in the middle of the window (except at the start or end of the file or
7027 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007028 After using the local value, go back the global value with one of
7029 these two: >
7030 setlocal scrolloff<
7031 setlocal scrolloff=-1
7032< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 NOTE: This option is set to 0 when 'compatible' is set.
7034
7035 *'scrollopt'* *'sbo'*
7036'scrollopt' 'sbo' string (default "ver,jump")
7037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007039 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7040 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 The following words are available:
7042 ver Bind vertical scrolling for 'scrollbind' windows
7043 hor Bind horizontal scrolling for 'scrollbind' windows
7044 jump Applies to the offset between two windows for vertical
7045 scrolling. This offset is the difference in the first
7046 displayed line of the bound windows. When moving
7047 around in a window, another 'scrollbind' window may
7048 reach a position before the start or after the end of
7049 the buffer. The offset is not changed though, when
7050 moving back the 'scrollbind' window will try to scroll
7051 to the desired position when possible.
7052 When now making that window the current one, two
7053 things can be done with the relative offset:
7054 1. When "jump" is not included, the relative offset is
7055 adjusted for the scroll position in the new current
7056 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007057 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 2. When "jump" is included, the other windows are
7059 scrolled to keep the same relative offset. When
7060 going back to the other window, it still uses the
7061 same relative offset.
7062 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007063 When 'diff' mode is active there always is vertical scroll binding,
7064 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065
7066 *'sections'* *'sect'*
7067'sections' 'sect' string (default "SHNHH HUnhsh")
7068 global
7069 Specifies the nroff macros that separate sections. These are pairs of
7070 two letters (See |object-motions|). The default makes a section start
7071 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7072
7073 *'secure'* *'nosecure'* *E523*
7074'secure' boolean (default off)
7075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 When on, ":autocmd", shell and write commands are not allowed in
7077 ".vimrc" and ".exrc" in the current directory and map commands are
7078 displayed. Switch it off only if you know that you will not run into
7079 problems, or when the 'exrc' option is off. On Unix this option is
7080 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 'secure' at the end of your ~/.vimrc then.
7083 This option cannot be set from a |modeline| or in the |sandbox|, for
7084 security reasons.
7085
7086 *'selection'* *'sel'*
7087'selection' 'sel' string (default "inclusive")
7088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 This option defines the behavior of the selection. It is only used
7090 in Visual and Select mode.
7091 Possible values:
7092 value past line inclusive ~
7093 old no yes
7094 inclusive yes yes
7095 exclusive yes no
7096 "past line" means that the cursor is allowed to be positioned one
7097 character past the line.
7098 "inclusive" means that the last character of the selection is included
7099 in an operation. For example, when "x" is used to delete the
7100 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007101 When "old" is used and 'virtualedit' allows the cursor to move past
7102 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007103 When "exclusive" is used, cursor position in visual mode will be
7104 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 Note that when "exclusive" is used and selecting from the end
7106 backwards, you cannot include the last character of a line, when
7107 starting in Normal mode and 'virtualedit' empty.
7108
7109 The 'selection' option is set by the |:behave| command.
7110
7111 *'selectmode'* *'slm'*
7112'selectmode' 'slm' string (default "")
7113 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007114 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 Select mode instead of Visual mode, when a selection is started.
7116 Possible values:
7117 mouse when using the mouse
7118 key when using shifted special keys
7119 cmd when using "v", "V" or CTRL-V
7120 See |Select-mode|.
7121 The 'selectmode' option is set by the |:behave| command.
7122
7123 *'sessionoptions'* *'ssop'*
7124'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007125 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007127 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 feature}
7129 Changes the effect of the |:mksession| command. It is a comma
7130 separated list of words. Each word enables saving and restoring
7131 something:
7132 word save and restore ~
7133 blank empty windows
7134 buffers hidden and unloaded buffers, not just those in windows
7135 curdir the current directory
7136 folds manually created folds, opened/closed folds and local
7137 fold options
7138 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007139 and contain at least one lowercase letter. Only
7140 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 help the help window
7142 localoptions options and mappings local to a window or buffer (not
7143 global values for local options)
7144 options all options and mappings (also global values for local
7145 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007146 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 resize size of the Vim window: 'lines' and 'columns'
7148 sesdir the directory in which the session file is located
7149 will become the current directory (useful with
7150 projects accessed over a network from different
7151 systems)
7152 slash backslashes in file names replaced with forward
7153 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007154 tabpages all tab pages; without this only the current tab page
7155 is restored, so that you can make a session for each
7156 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007157 terminal include terminal windows where the command can be
7158 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 unix with Unix end-of-line format (single <NL>), even when
7160 on Windows or DOS
7161 winpos position of the whole Vim window
7162 winsize window sizes
7163
7164 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007165 When neither "curdir" nor "sesdir" is included, file names are stored
7166 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007167 If you leave out "options" many things won't work well after restoring
7168 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 "slash" and "unix" are useful on Windows when sharing session files
7170 with Unix. The Unix version of Vim cannot source dos format scripts,
7171 but the Windows version of Vim can source unix format scripts.
7172
7173 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007174'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 global
7176 Name of the shell to use for ! and :! commands. When changing the
7177 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7178 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007179 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 See |option-backslash| about including spaces and backslashes.
7181 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007182
Bram Moolenaara2baa732022-02-04 16:09:54 +00007183 In |restricted-mode| shell commands will not be possible. This mode
7184 is used if the value of $SHELL ends in "false" or "nologin".
7185
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007186 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007187 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7189< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007190 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007192 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007194 Example with escaped space (Vim will do this when initializing the
7195 option from $SHELL): >
7196 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007197< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007198 backslashes are consumed by `:set`.
7199
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 Under MS-Windows, when the executable ends in ".com" it must be
7201 included. Thus setting the shell to "command.com" or "4dos.com"
7202 works, but "command" and "4dos" do not work for all commands (e.g.,
7203 filtering).
7204 For unknown reasons, when using "4dos.com" the current directory is
7205 changed to "C:\". To avoid this set 'shell' like this: >
7206 :set shell=command.com\ /c\ 4dos
7207< This option cannot be set from a |modeline| or in the |sandbox|, for
7208 security reasons.
7209
7210 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007211'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007212 Win32, when 'shell' contains "powershell":
7213 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007214 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007217 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7218 For MS-Windows, the default is set according to the value of 'shell',
7219 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007220 On Unix it can have more than one flag. Each white space separated
7221 part is passed as an argument to the shell command.
7222 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007223 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 This option cannot be set from a |modeline| or in the |sandbox|, for
7225 security reasons.
7226
7227 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007228'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7229 "2>&1| tee", or
7230 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 {not available when compiled without the |+quickfix|
7233 feature}
7234 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007235 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 including spaces and backslashes.
7237 The name of the temporary file can be represented by "%s" if necessary
7238 (the file name is appended automatically if no %s appears in the value
7239 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007240 For the Amiga the default is ">". For MS-Windows using powershell the
7241 default is "2>&1 | Out-File -Encoding default", otherwise the default
7242 is ">%s 2>&1". The output is directly saved in a file and not echoed
7243 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007244 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 in a file and echoed to the screen. If the 'shell' option is "csh" or
7246 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007247 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007248 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7249 means that stderr is also included. Before using the 'shell' option a
7250 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007251 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7252 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 The initialization of this option is done after reading the ".vimrc"
7254 and the other initializations, so that when the 'shell' option is set
7255 there, the 'shellpipe' option changes automatically, unless it was
7256 explicitly set before.
7257 When 'shellpipe' is set to an empty string, no redirection of the
7258 ":make" output will be done. This is useful if you use a 'makeprg'
7259 that writes to 'makeef' by itself. If you want no piping, but do
7260 want to include the 'makeef', set 'shellpipe' to a single space.
7261 Don't forget to precede the space with a backslash: ":set sp=\ ".
7262 In the future pipes may be used for filtering and this option will
7263 become obsolete (at least for Unix).
7264 This option cannot be set from a |modeline| or in the |sandbox|, for
7265 security reasons.
7266
7267 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007268'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 Quoting character(s), put around the command passed to the shell, for
7271 the "!" and ":!" commands. The redirection is kept outside of the
7272 quoting. See 'shellxquote' to include the redirection. It's
7273 probably not useful to set both options.
7274 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007275 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007276 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 This option cannot be set from a |modeline| or in the |sandbox|, for
7278 security reasons.
7279
7280 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007281'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7282 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 String to be used to put the output of a filter command in a temporary
7285 file. See also |:!|. See |option-backslash| about including spaces
7286 and backslashes.
7287 The name of the temporary file can be represented by "%s" if necessary
7288 (the file name is appended automatically if no %s appears in the value
7289 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007290 The default is ">". For Unix, if the 'shell' option is "csh" or
7291 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007292 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007293 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7294 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007295 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7296 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007297 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7298 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 The initialization of this option is done after reading the ".vimrc"
7300 and the other initializations, so that when the 'shell' option is set
7301 there, the 'shellredir' option changes automatically unless it was
7302 explicitly set before.
7303 In the future pipes may be used for filtering and this option will
7304 become obsolete (at least for Unix).
7305 This option cannot be set from a |modeline| or in the |sandbox|, for
7306 security reasons.
7307
7308 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7309'shellslash' 'ssl' boolean (default off)
7310 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007311 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007313 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007314 powershell.exe. Backward slashes can still be typed, but they are
7315 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 Note that setting or resetting this option has no effect for some
7317 existing file names, thus this option needs to be set before opening
7318 any file for best results. This might change in the future.
7319 'shellslash' only works when a backslash can be used as a path
7320 separator. To test if this is so use: >
7321 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007322< Also see 'completeslash'.
7323
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007324 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7325'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7326 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007327 When on, use temp files for shell commands. When off use a pipe.
7328 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007329 Currently a pipe is only supported on Unix and MS-Windows 2K and
7330 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007331 :if has("filterpipe")
7332< The advantage of using a pipe is that nobody can read the temp file
7333 and the 'shell' command does not need to support redirection.
7334 The advantage of using a temp file is that the file type and encoding
7335 can be detected.
7336 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7337 |FilterWritePost| autocommands event are not triggered when
7338 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007339 The `system()` function does not respect this option and always uses
7340 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007341 NOTE: This option is set to the Vim default value when 'compatible'
7342 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007343
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 *'shelltype'* *'st'*
7345'shelltype' 'st' number (default 0)
7346 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007347 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 On the Amiga this option influences the way how the commands work
7349 which use a shell.
7350 0 and 1: always use the shell
7351 2 and 3: use the shell only to filter lines
7352 4 and 5: use shell only for ':sh' command
7353 When not using the shell, the command is executed directly.
7354
7355 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7356 1 and 3: use "shell cmd" to start external commands
7357
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007358 *'shellxescape'* *'sxe'*
7359'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007360 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007361 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007362 When 'shellxquote' is set to "(" then the characters listed in this
7363 option will be escaped with a '^' character. This makes it possible
7364 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007365 This option cannot be set from a |modeline| or in the |sandbox|, for
7366 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007367
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 *'shellxquote'* *'sxq'*
7369'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007370 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007371 for Win32, when 'shell' is
7372 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007373 for Win32, when 'shell' contains "sh"
7374 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 for Unix, when using system(): "\"")
7376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 Quoting character(s), put around the command passed to the shell, for
7378 the "!" and ":!" commands. Includes the redirection. See
7379 'shellquote' to exclude the redirection. It's probably not useful
7380 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007381 When the value is '(' then ')' is appended. When the value is '"('
7382 then ')"' is appended.
7383 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007384 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007385 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7386 pwsh.exe which automatically strips off the first and last quote on a
7387 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7388 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007389 'shell', to reduce the need to set this option by the user. See
7390 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 This option cannot be set from a |modeline| or in the |sandbox|, for
7392 security reasons.
7393
7394 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7395'shiftround' 'sr' boolean (default off)
7396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 Round indent to multiple of 'shiftwidth'. Applies to > and <
7398 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7399 a multiple of 'shiftwidth' (this is Vi compatible).
7400 NOTE: This option is reset when 'compatible' is set.
7401
7402 *'shiftwidth'* *'sw'*
7403'shiftwidth' 'sw' number (default 8)
7404 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007405 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007407 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007408 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409
7410 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007411'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7412 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007413 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007415 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 It is a list of flags:
7417 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007418 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7419 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7420 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7421 m use "[+]" instead of "[Modified]" *shm-m*
7422 n use "[New]" instead of "[New File]" *shm-n*
7423 r use "[RO]" instead of "[readonly]" *shm-r*
7424 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007426 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7427 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007428 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007429 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007431 o overwrite message for writing a file with subsequent *shm-o*
7432 message for reading a file (useful for ":wn" or when
7433 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007434 O message for reading a file overwrites any previous *shm-O*
7435 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007436 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7437 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007438 the search count do not show "W" before the count message
7439 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007440 t truncate file message at the start if it is too long *shm-t*
7441 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007442 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007443 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007444 long to fit on the command line; "..." will appear in the
7445 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007446 W don't give "written" or "[w]" when writing a file *shm-W*
7447 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007448 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007449 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007450 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007451 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007452 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7453 match", "Pattern not found", "Back at original", etc.
7454 C don't give messages while scanning for ins-completion *shm-C*
7455 items, for instance "scanning tags"
7456 q use "recording" instead of "recording @a" *shm-q*
7457 F don't give the file info when editing a file, like *shm-F*
7458 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007459 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007460 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007461 "[1/5]". When the "S" flag is not present (e.g. search count
7462 is shown), the "search hit BOTTOM, continuing at TOP" and
7463 "search hit TOP, continuing at BOTTOM" messages are only
7464 indicated by a "W" (Mnemonic: Wrapped) letter before the
7465 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466
7467 This gives you the opportunity to avoid that a change between buffers
7468 requires you to hit <Enter>, but still gives as useful a message as
7469 possible for the space available. To get the whole message that you
7470 would have got with 'shm' empty, use ":file!"
7471 Useful values:
7472 shm= No abbreviation of message.
7473 shm=a Abbreviation, but no loss of information.
7474 shm=at Abbreviation, and truncate message when necessary.
7475
7476 NOTE: This option is set to the Vi default value when 'compatible' is
7477 set and to the Vim default value when 'compatible' is reset.
7478
7479 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7480'shortname' 'sn' boolean (default off)
7481 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 Filenames are assumed to be 8 characters plus one extension of 3
7483 characters. Multiple dots in file names are not allowed. When this
7484 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007485 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007487 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
7489 *'showbreak'* *'sbr'* *E595*
7490'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007491 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007492 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 feature}
7494 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007495 values are "> " or "+++ ": >
7496 :set showbreak=>\
7497< Note the backslash to escape the trailing space. It's easier like
7498 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007499 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007500< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 comma (in a future version the comma might be used to separate the
7502 part that is shown at the end and at the start of a line).
7503 The characters are highlighted according to the '@' flag in
7504 'highlight'.
7505 Note that tabs after the showbreak will be displayed differently.
7506 If you want the 'showbreak' to appear in between line numbers, add the
7507 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007508 A window-local value overrules a global value. If the global value is
7509 set and you want no value in the current window use NONE: >
7510 :setlocal showbreak=NONE
7511<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007513'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7514 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007516 Show (partial) command in the last line of the screen. Set this
7517 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 In Visual mode the size of the selected area is shown:
7519 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007520 If the number of bytes is different it is also displayed: "2-6"
7521 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007523 - When selecting a block, the size in screen characters:
7524 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007525 This information can be displayed in an alternative location using the
7526 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 NOTE: This option is set to the Vi default value when 'compatible' is
7528 set and to the Vim default value when 'compatible' is reset.
7529
Luuk van Baalba936f62022-12-15 13:15:39 +00007530 *'showcmdloc'* *'sloc'*
7531'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007532 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007533 This option can be used to display the (partially) entered command in
7534 another location. Possible values are:
7535 last Last line of the screen (default).
7536 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007537 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007538 Setting this option to "statusline" or "tabline" means that these will
7539 be redrawn whenever the command changes, which can be on every key
7540 pressed.
7541 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7542 place the text. Without a custom 'statusline' or 'tabline' it will be
7543 displayed in a convenient location.
7544
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7546'showfulltag' 'sft' boolean (default off)
7547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 When completing a word in insert mode (see |ins-completion|) from the
7549 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007550 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 matched a C function, you can see a template for what arguments are
7552 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007553 Note that this doesn't work well together with having "longest" in
7554 'completeopt', because the completion from the search pattern may not
7555 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556
7557 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7558'showmatch' 'sm' boolean (default off)
7559 global
7560 When a bracket is inserted, briefly jump to the matching one. The
7561 jump is only done if the match can be seen on the screen. The time to
7562 show the match can be set with 'matchtime'.
7563 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007564 seen or not).
7565 This option is reset when 'paste' is set and restored when 'paste' is
7566 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 When the 'm' flag is not included in 'cpoptions', typing a character
7568 will immediately move the cursor back to where it belongs.
7569 See the "sm" field in 'guicursor' for setting the cursor shape and
7570 blinking when showing the match.
7571 The 'matchpairs' option can be used to specify the characters to show
7572 matches for. 'rightleft' and 'revins' are used to look for opposite
7573 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007574 Also see the matchparen plugin for highlighting the match when moving
7575 around |pi_paren.txt|.
7576 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577
7578 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7579'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7580 global
7581 If in Insert, Replace or Visual mode put a message on the last line.
7582 Use the 'M' flag in 'highlight' to set the type of highlighting for
7583 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007584 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 doesn't mean XIM is really active, especially when 'imactivatekey' is
7586 not set.
7587 NOTE: This option is set to the Vi default value when 'compatible' is
7588 set and to the Vim default value when 'compatible' is reset.
7589
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007590 *'showtabline'* *'stal'*
7591'showtabline' 'stal' number (default 1)
7592 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007593 The value of this option specifies when the line with tab page labels
7594 will be displayed:
7595 0: never
7596 1: only if there are at least two tab pages
7597 2: always
7598 This is both for the GUI and non-GUI implementation of the tab pages
7599 line.
7600 See |tab-page| for more information about tab pages.
7601
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 *'sidescroll'* *'ss'*
7603'sidescroll' 'ss' number (default 0)
7604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 The minimal number of columns to scroll horizontally. Used only when
7606 the 'wrap' option is off and the cursor is moved off of the screen.
7607 When it is zero the cursor will be put in the middle of the screen.
7608 When using a slow terminal set it to a large number or 0. When using
7609 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7610 commands.
7611
7612 *'sidescrolloff'* *'siso'*
7613'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007614 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007616 right of the cursor if 'nowrap' is set. Setting this option to a
7617 value greater than 0 while having |'sidescroll'| also at a non-zero
7618 value makes some context visible in the line you are scrolling in
7619 horizontally (except at beginning of the line). Setting this option
7620 to a large value (like 999) has the effect of keeping the cursor
7621 horizontally centered in the window, as long as one does not come too
7622 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007623 After using the local value, go back the global value with one of
7624 these two: >
7625 setlocal sidescrolloff<
7626 setlocal sidescrolloff=-1
7627< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628
7629 Example: Try this together with 'sidescroll' and 'listchars' as
7630 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007631 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632
7633 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7634 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007635<
7636 *'signcolumn'* *'scl'*
7637'signcolumn' 'scl' string (default "auto")
7638 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007639 {not available when compiled without the |+signs|
7640 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007641 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007642 "auto" only when there is a sign to display
7643 "no" never
7644 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007645 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007646 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7649'smartcase' 'scs' boolean (default off)
7650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 Override the 'ignorecase' option if the search pattern contains upper
7652 case characters. Only used when the search pattern is typed and
7653 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007654 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7656 recalling the search pattern from history and hitting <Enter>.
7657 NOTE: This option is reset when 'compatible' is set.
7658
7659 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7660'smartindent' 'si' boolean (default off)
7661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 Do smart autoindenting when starting a new line. Works for C-like
7663 programs, but can also be used for other languages. 'cindent' does
7664 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007665 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007666 setting 'si' has no effect. 'indentexpr' is a more advanced
7667 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 Normally 'autoindent' should also be on when using 'smartindent'.
7669 An indent is automatically inserted:
7670 - After a line ending in '{'.
7671 - After a line starting with a keyword from 'cinwords'.
7672 - Before a line starting with '}' (only with the "O" command).
7673 When typing '}' as the first character in a new line, that line is
7674 given the same indent as the matching '{'.
7675 When typing '#' as the first character in a new line, the indent for
7676 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007677 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7679 When using the ">>" command, lines starting with '#' are not shifted
7680 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007681 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007682 This option is reset when 'paste' is set and restored when 'paste' is
7683 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684
7685 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7686'smarttab' 'sta' boolean (default off)
7687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007689 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7690 <BS> will delete a 'shiftwidth' worth of space at the start of the
7691 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007692 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007693 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7694 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007695 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007697 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007698 This option is reset when 'paste' is set and restored when 'paste' is
7699 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 NOTE: This option is reset when 'compatible' is set.
7701
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007702 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7703'smoothscroll' 'sms' boolean (default off)
7704 local to window
7705 Scrolling works with screen lines. When 'wrap' is set and the first
7706 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007707 above the window. "<<<" is displayed at the start of the first line,
7708 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007709 You may also want to add "lastline" to the 'display' option to show as
7710 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007711 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007712
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 *'softtabstop'* *'sts'*
7714'softtabstop' 'sts' number (default 0)
7715 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 Number of spaces that a <Tab> counts for while performing editing
7717 operations, like inserting a <Tab> or using <BS>. It "feels" like
7718 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7719 used. This is useful to keep the 'ts' setting at its standard value
7720 of 8, while being able to edit like it is set to 'sts'. However,
7721 commands like "x" still work on the actual characters.
7722 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007723 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007724 'softtabstop' is set to 0 when the 'paste' option is set and restored
7725 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7727 spaces is minimized by using <Tab>s.
7728 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7729 set.
7730 NOTE: This option is set to 0 when 'compatible' is set.
7731
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007732 If Vim is compiled with the |+vartabs| feature then the value of
7733 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7734 anything other than an empty string.
7735
Bram Moolenaar217ad922005-03-20 22:37:15 +00007736 *'spell'* *'nospell'*
7737'spell' boolean (default off)
7738 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007739 {not available when compiled without the |+syntax|
7740 feature}
7741 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007742 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007743
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007744 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007745'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007746 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007747 {not available when compiled without the |+syntax|
7748 feature}
7749 Pattern to locate the end of a sentence. The following word will be
7750 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007751 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007752 When this check is not wanted make this option empty.
7753 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007754 Be careful with special characters, see |option-backslash| about
7755 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007756 To set this option automatically depending on the language, see
7757 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007758
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007759 *'spellfile'* *'spf'*
7760'spellfile' 'spf' string (default empty)
7761 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007762 {not available when compiled without the |+syntax|
7763 feature}
7764 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007765 commands. It must end in ".{encoding}.add". You need to include the
7766 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007767 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007768 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007769 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007770 |zg| and |zw| commands can be used to access each. This allows using
7771 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007772 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007773 you: Using the first directory in 'runtimepath' that is writable. If
7774 there is no "spell" directory yet it will be created. For the file
7775 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007776 ignoring the region.
7777 The resulting ".spl" file will be used for spell checking, it does not
7778 have to appear in 'spelllang'.
7779 Normally one file is used for all regions, but you can add the region
7780 name if you want to. However, it will then only be used when
7781 'spellfile' is set to it, for entries in 'spelllang' only files
7782 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007783 This option cannot be set from a |modeline| or in the |sandbox|, for
7784 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007785
Bram Moolenaar217ad922005-03-20 22:37:15 +00007786 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007787'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007788 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007789 {not available when compiled without the |+syntax|
7790 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007791 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007792 on spellchecking will be done for these languages. Example: >
7793 set spelllang=en_us,nl,medical
7794< This means US English, Dutch and medical words are recognized. Words
7795 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007796 The word list name must consist of alphanumeric characters, a dash or
7797 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007798 recommended to separate the two letter language name from a
7799 specification. Thus "en-rare" is used for rare English words.
7800 A region name must come last and have the form "_xx", where "xx" is
7801 the two-letter, lower case region name. You can use more than one
7802 region by listing them: "en_us,en_ca" supports both US and Canadian
7803 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007804 Britain. (Note: currently en_au and en_nz dictionaries are older than
7805 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007806 If the name "cjk" is included East Asian characters are excluded from
7807 spell checking. This is useful when editing text that also has Asian
7808 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007809 Note that the "medical" dictionary does not exist, it is just an
7810 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007811 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007812 As a special case the name of a .spl file can be given as-is. The
7813 first "_xx" in the name is removed and used as the region name
7814 (_xx is an underscore, two letters and followed by a non-letter).
7815 This is mainly for testing purposes. You must make sure the correct
7816 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007817 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007818 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7819 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007820 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007821
Bram Moolenaar98692072006-02-04 00:57:42 +00007822 If the |spellfile.vim| plugin is active and you use a language name
7823 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7824 will ask you if you want to download the file.
7825
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007826 After this option has been set successfully, Vim will source the files
7827 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007828 up to the first character that is not an ASCII letter or number and
7829 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007830
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007831 *'spelloptions'* *'spo'*
7832'spelloptions' 'spo' string (default "")
7833 local to buffer
7834 {not available when compiled without the |+syntax|
7835 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007836 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007837 camel When a word is CamelCased, assume "Cased" is a
7838 separate word: every upper-case character in a word
7839 that comes after a lower case character indicates the
7840 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007841
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007842 *'spellsuggest'* *'sps'*
7843'spellsuggest' 'sps' string (default "best")
7844 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007845 {not available when compiled without the |+syntax|
7846 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007847 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007848 the |spellsuggest()| function. This is a comma-separated list of
7849 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007850
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007851 best Internal method that works best for English. Finds
7852 changes like "fast" and uses a bit of sound-a-like
7853 scoring to improve the ordering.
7854
7855 double Internal method that uses two methods and mixes the
7856 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007857 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007858 word. That only works when the language specifies
7859 sound folding. Can be slow and doesn't always give
7860 better results.
7861
7862 fast Internal method that only checks for simple changes:
7863 character inserts/deletes/swaps. Works well for
7864 simple typing mistakes.
7865
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007866 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007867 Not used for |spellsuggest()|. The number of
7868 suggestions is never more than the value of 'lines'
7869 minus two.
7870
Bram Moolenaar585ee072022-01-29 11:22:17 +00007871 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007872 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007873 methods. When omitted the limit is 5000. When
7874 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007875 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007876
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007877 file:{filename} Read file {filename}, which must have two columns,
7878 separated by a slash. The first column contains the
7879 bad word, the second column the suggested good word.
7880 Example:
7881 theribal/terrible ~
7882 Use this for common mistakes that do not appear at the
7883 top of the suggestion list with the internal methods.
7884 Lines without a slash are ignored, use this for
7885 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007886 The word in the second column must be correct,
7887 otherwise it will not be used. Add the word to an
7888 ".add" file if it is currently flagged as a spelling
7889 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007890 The file is used for all languages.
7891
7892 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007893 trouble with spaces. Best is to call a function
7894 without arguments, see |expr-option-function|.
7895 |v:val| holds the badly spelled word. The expression
7896 must evaluate to a List of Lists, each with a
7897 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007898 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007899 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007900 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007901 internal methods use. A lower score is better.
7902 This may invoke |spellsuggest()| if you temporarily
7903 set 'spellsuggest' to exclude the "expr:" part.
7904 Errors are silently ignored, unless you set the
7905 'verbose' option to a non-zero value.
7906
7907 Only one of "best", "double" or "fast" may be used. The others may
7908 appear several times in any order. Example: >
7909 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7910<
7911 This option cannot be set from a |modeline| or in the |sandbox|, for
7912 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007913
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7915'splitbelow' 'sb' boolean (default off)
7916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 When on, splitting a window will put the new window below the current
7918 one. |:split|
7919
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007920 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007921'splitkeep' 'spk' string (default "cursor")
7922 global
7923 The value of this option determines the scroll behavior when opening,
7924 closing or resizing horizontal splits.
7925
7926 Possible values are:
7927 cursor Keep the same relative cursor position.
7928 screen Keep the text on the same screen line.
7929 topline Keep the topline the same.
7930
7931 For the "screen" and "topline" values, the cursor position will be
7932 changed when necessary. In this case, the jumplist will be populated
7933 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007934 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007935
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7937'splitright' 'spr' boolean (default off)
7938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 When on, splitting a window will put the new window right of the
7940 current one. |:vsplit|
7941
7942 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7943'startofline' 'sol' boolean (default on)
7944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007946 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007947 (if possible). This applies to the commands:
7948 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007949 - "d", "<<", "==" and ">>" with a linewise operator
7950 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007951 - "%" with a count
7952 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7953 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 In case of buffer changing commands the cursor is placed at the column
7955 where it was the last time the buffer was edited.
7956 NOTE: This option is set when 'compatible' is set.
7957
Bram Moolenaar00654022011-02-25 14:42:19 +01007958 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007960 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 {not available when compiled without the |+statusline|
7962 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007963 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 Also see |status-line|.
7965
7966 The option consists of printf style '%' items interspersed with
7967 normal text. Each status line item is of the form:
7968 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007969 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007970 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007972 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007973 When the option starts with "%!" then it is used as an expression,
7974 evaluated and the result is used as the option value. Example: >
7975 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007976< The *g:statusline_winid* variable will be set to the |window-ID| of the
7977 window that the status line belongs to.
7978 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007979 Note that the "%!" expression is evaluated in the context of the
7980 current window and buffer, while %{} items are evaluated in the
7981 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007982
7983 When there is error while evaluating the option then it will be made
7984 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007985 When the result contains unprintable characters the result is
7986 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007987
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 Note that the only effect of 'ruler' when this option is set (and
7989 'laststatus' is 2) is controlling the output of |CTRL-G|.
7990
7991 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007992 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007994 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 minwid Minimum width of the item, padding as set by '-' & '0'.
7996 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007997 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 on the left for text items. Numeric items will be
7999 shifted down to maxwid-2 digits followed by '>'number
8000 where number is the amount of missing digits, much like
8001 an exponential notation.
8002 item A one letter code as described below.
8003
8004 Following is a description of the possible statusline items. The
8005 second character in "item" is the type:
8006 N for number
8007 S for string
8008 F for flags as described below
8009 - not applicable
8010
8011 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008012 f S Path to the file in the buffer, as typed or relative to current
8013 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 F S Full path to the file in the buffer.
8015 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008016 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008018 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008020 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008022 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008024 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008026 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8028 being used: "<keymap>"
8029 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008030 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 B N As above, in hexadecimal.
8032 o N Byte number in file of byte under cursor, first byte is 1.
8033 Mnemonic: Offset from start of file (with one added)
8034 {not available when compiled without |+byte_offset| feature}
8035 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008036 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 l N Line number.
8038 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008039 c N Column number (byte index).
8040 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008041 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 p N Percentage through file in lines as in |CTRL-G|.
8043 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008044 percentage described for 'ruler'. Always 3 in length, unless
8045 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008046 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008047 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008049 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008050 Note that there is no '%' before the closing '}'. The
8051 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008052 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008053 {% - This is almost same as { except the result of the expression is
8054 re-evaluated as a statusline format string. Thus if the
8055 return value of expr contains % items they will get expanded.
8056 The expression can contain the } character, the end of
8057 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008058 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008059 func! Stl_filename() abort
8060 return "%t"
8061 endfunc
8062< `stl=%{Stl_filename()}` results in `"%t"`
8063 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008064 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 ( - Start of item group. Can be used for setting the width and
8066 alignment of a section. Must be followed by %) somewhere.
8067 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008068 T N For 'tabline': start of tab page N label. Use %T after the last
8069 label. This information is used for mouse clicks.
8070 X N For 'tabline': start of close tab N label. Use %X after the
8071 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8072 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 < - Where to truncate line if too long. Default is at the start.
8074 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008075 = - Separation point between alignment sections. Each section will
8076 be separated by an equal number of spaces. With one %= what
8077 comes after it will be right-aligned. With two %= there is a
8078 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008080 # - Set highlight group. The name must follow and then a # again.
8081 Thus use %#HLname# for highlight group HLname. The same
8082 highlighting is used, also for the statusline of non-current
8083 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008085 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008086 The difference between User{N} and StatusLine will be applied to
8087 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 The number N must be between 1 and 9. See |hl-User1..9|
8089
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008090 When displaying a flag, Vim removes the leading comma, if any, when
8091 that flag comes right after plaintext. This will make a nice display
8092 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093
Bram Moolenaar582fd852005-03-28 20:58:01 +00008094 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 not set) and a minwid is not set for the group, the whole group will
8096 become empty. This will make a group like the following disappear
8097 completely from the statusline when none of the flags are set. >
8098 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008099< Beware that an expression is evaluated each and every time the status
8100 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008101 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008102 While evaluating %{} the current buffer and current window will be set
8103 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008104 currently being drawn. The expression will evaluate in this context.
8105 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8106 real current buffer and "g:actual_curwin" to the |window-ID| of the
8107 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008108
Bram Moolenaar30b65812012-07-12 22:01:11 +02008109 The 'statusline' option will be evaluated in the |sandbox| if set from
8110 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008111 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008112
8113 It is not allowed to change text or jump to another window while
8114 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115
8116 If the statusline is not updated when you want it (e.g., after setting
8117 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008118 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008120 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 Otherwise the result is taken as flag text and applied to the rules
8122 described above.
8123
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008124 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008126 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127
8128 Examples:
8129 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008130 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131< Similar, but add ASCII value of char under the cursor (like "ga") >
8132 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8133< Display byte count and byte value, modified flag in red. >
8134 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8135 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8136< Display a ,GZ flag if a compressed file is loaded >
8137 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8138< In the |:autocmd|'s: >
8139 :let b:gzflag = 1
8140< And: >
8141 :unlet b:gzflag
8142< And define this function: >
8143 :function VarExists(var, val)
8144 : if exists(a:var) | return a:val | else | return '' | endif
8145 :endfunction
8146<
8147 *'suffixes'* *'su'*
8148'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 Files with these suffixes get a lower priority when multiple files
8151 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008152 suffixes. Spaces after the comma are ignored. A dot is also seen as
8153 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 separator, precede it with a backslash (see |option-backslash| about
8155 including spaces and backslashes).
8156 See 'wildignore' for completely ignoring files.
8157 The use of |:set+=| and |:set-=| is preferred when adding or removing
8158 suffixes from the list. This avoids problems when a future version
8159 uses another default.
8160
8161 *'suffixesadd'* *'sua'*
8162'suffixesadd' 'sua' string (default "")
8163 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008164 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 file for the "gf", "[I", etc. commands. Example: >
8166 :set suffixesadd=.java
8167<
8168 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8169'swapfile' 'swf' boolean (default on)
8170 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008171 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 swapfile is not wanted for a specific buffer. For example, with
8173 confidential information that even root must not be able to access.
8174 Careful: All text will be in memory:
8175 - Don't use this for big files.
8176 - Recovery will be impossible!
8177 A swapfile will only be present when |'updatecount'| is non-zero and
8178 'swapfile' is set.
8179 When 'swapfile' is reset, the swap file for the current buffer is
8180 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8181 non-zero, a swap file is immediately created.
8182 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008183 If you want to open a new buffer without creating a swap file for it,
8184 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008185 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186
8187 This option is used together with 'bufhidden' and 'buftype' to
8188 specify special kinds of buffers. See |special-buffers|.
8189
8190 *'swapsync'* *'sws'*
8191'swapsync' 'sws' string (default "fsync")
8192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008194 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 When this option is empty parts of the swap file may be in memory and
8196 not written to disk. When the system crashes you may lose more work.
8197 On Unix the system does a sync now and then without Vim asking for it,
8198 so the disadvantage of setting this option off is small. On some
8199 systems the swap file will not be written at all. For a unix system
8200 setting it to "sync" will use the sync() call instead of the default
8201 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008202 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203
8204 *'switchbuf'* *'swb'*
8205'switchbuf' 'swb' string (default "")
8206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008208 This option is checked, when
8209 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008210 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008211 - jumping to a tag using the |:stag| command.
8212 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8213 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8214 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008215 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008216 useopen If included, jump to the first open window in the
8217 current tab page that contains the specified buffer
8218 (if there is one). Otherwise: Do not examine other
8219 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008220 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008221 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008223 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008224 Otherwise: do not split, use current window (when used
8225 in the quickfix window: the previously used window or
8226 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008227 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008228 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008229 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008230 uselast If included, jump to the previously used window when
8231 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008232 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8233 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008235 *'synmaxcol'* *'smc'*
8236'synmaxcol' 'smc' number (default 3000)
8237 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008238 {not available when compiled without the |+syntax|
8239 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008240 Maximum column in which to search for syntax items. In long lines the
8241 text after this column is not highlighted and following lines may not
8242 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008243 This helps to avoid very slow redrawing for an XML file that is one
8244 long line.
8245 Set to zero to remove the limit.
8246
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 *'syntax'* *'syn'*
8248'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008249 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 {not available when compiled without the |+syntax|
8251 feature}
8252 When this option is set, the syntax with this name is loaded, unless
8253 syntax highlighting has been switched off with ":syntax off".
8254 Otherwise this option does not always reflect the current syntax (the
8255 b:current_syntax variable does).
8256 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008257 not automatically recognized. Example, in an IDL file:
8258 /* vim: set syntax=idl : */ ~
8259 When a dot appears in the value then this separates two filetype
8260 names. Example:
8261 /* vim: set syntax=c.doxygen : */ ~
8262 This will use the "c" syntax first, then the "doxygen" syntax.
8263 Note that the second one must be prepared to be loaded as an addition,
8264 otherwise it will be skipped. More than one dot may appear.
8265 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 :set syntax=OFF
8267< To switch syntax highlighting on according to the current value of the
8268 'filetype' option: >
8269 :set syntax=ON
8270< What actually happens when setting the 'syntax' option is that the
8271 Syntax autocommand event is triggered with the value as argument.
8272 This option is not copied to another buffer, independent of the 's' or
8273 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008274 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275
LemonBoy5247b0b2024-07-12 19:30:58 +02008276 *'tabclose'* *'tcl'*
8277'tabclose' 'tcl' string (default "")
8278 global
8279 This option controls the behavior when closing tab pages (e.g., using
8280 |:tabclose|). When empty Vim goes to the next (right) tab page.
8281
8282 Possible values (comma-separated list):
8283 left If included, go to the previous tab page instead of
8284 the next one.
8285 uselast If included, go to the previously used tab page if
8286 possible. This option takes precedence over the
8287 others.
8288
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008289 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008290'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008291 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008292 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008293 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008294 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008295
8296 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008297 option and only when there is no GUI tab line. When 'e' is in
8298 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008299 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008300
8301 The value is evaluated like with 'statusline'. You can use
8302 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008303 the text to be displayed. Use "%1T" for the first label, "%2T" for
8304 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008305
Bram Moolenaare12bab32019-01-08 22:02:56 +01008306 When changing something that is used in 'tabline' that does not
8307 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008308 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008309
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008310 Keep in mind that only one of the tab pages is the current one, others
8311 are invisible and you can't jump to their windows.
8312
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008313 *'tabpagemax'* *'tpm'*
8314'tabpagemax' 'tpm' number (default 10)
8315 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008316 Maximum number of tab pages to be opened by the |-p| command line
8317 argument or the ":tab all" command. |tabpage|
8318
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008319 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320'tabstop' 'ts' number (default 8)
8321 local to buffer
8322 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008323 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324
8325 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008326 appear wrong in many places, e.g., when printing it.
8327 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008329 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8331 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008332 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008334 This is the recommended way, the file will look the same with other
8335 tools and when listing it in a terminal.
8336 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8337 'expandtab'. This way you will always insert spaces. The
8338 formatting will never be messed up when 'tabstop' is changed (leave
8339 it at 8 just in case). The file will be a bit larger.
8340 You do need to check if no Tabs exist in the file. You can get rid
8341 of them by first setting 'expandtab' and using `%retab!`, making
8342 sure the value of 'tabstop' is set correctly.
8343 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 'expandtab'. This way you will always insert spaces. The
8345 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008346 You do need to check if no Tabs exist in the file, just like in the
8347 item just above.
8348 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008349 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008350 works when using Vim to edit the file, other tools assume a tabstop
8351 is worth 8 spaces.
8352 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 'noexpandtab'. This should then work (for initial indents only)
8354 for any tabstop setting that people use. It might be nice to have
8355 tabs after the first non-blank inserted as spaces if you do this
8356 though. Otherwise aligned comments will be wrong when 'tabstop' is
8357 changed.
8358
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008359 If Vim is compiled with the |+vartabs| feature then the value of
8360 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8361 than an empty string.
8362
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8364'tagbsearch' 'tbs' boolean (default on)
8365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008367 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 searching makes searching for a tag a LOT faster, but a linear search
8369 will find more tags if the tags file wasn't properly sorted.
8370 Vim normally assumes that your tags files are sorted, or indicate that
8371 they are not sorted. Only when this is not the case does the
8372 'tagbsearch' option need to be switched off.
8373
8374 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008375 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 certain files, or retry all files with a linear search. When
8377 'tagbsearch' is off, only a linear search is done.
8378
8379 Linear searching is done anyway, for one file, when Vim finds a line
8380 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008381 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382< [The whitespace before and after the '0' must be a single <Tab>]
8383
8384 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008385 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 instead of a normal tag name, a retry is done with a linear search.
8387 Tags in unsorted tags files, and matches with different case will only
8388 be found in the retry.
8389
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008390 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008391 linear search can be avoided when case is ignored. Use a value of '2'
8392 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8393 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008394 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8395 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8396 used for this as well. Note that case must be folded to uppercase for
8397 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008398
8399 By default, tag searches are case-sensitive. Case is ignored when
8400 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8401 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008402 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8403 'tagcase' is "smart", and the pattern contains only lowercase
8404 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405
8406 When 'tagbsearch' is off, tags searching is slower when a full match
8407 exists, but faster when no full match exists. Tags in unsorted tags
8408 files may only be found with 'tagbsearch' off.
8409 When the tags file is not sorted, or sorted in a wrong way (not on
8410 ASCII byte value), 'tagbsearch' should be off, or the line given above
8411 must be included in the tags file.
8412 This option doesn't affect commands that find all matching tags (e.g.,
8413 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008415 *'tagcase'* *'tc'*
8416'tagcase' 'tc' string (default "followic")
8417 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008418 This option specifies how case is handled when searching the tags
8419 file:
8420 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008421 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008422 ignore Ignore case
8423 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008424 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008425 NOTE: This option is set to the Vi default value when 'compatible' is
8426 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008427
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008428 *'tagfunc'* *'tfu'*
8429'tagfunc' 'tfu' string (default: empty)
8430 local to buffer
8431 {not available when compiled without the |+eval|
8432 feature}
8433 This option specifies a function to be used to perform tag searches.
8434 The function gets the tag pattern and should return a List of matching
8435 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008436 function and an example. The value can be the name of a function, a
8437 |lambda| or a |Funcref|. See |option-value-function| for more
8438 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008439 This option cannot be set from a |modeline| or in the |sandbox|, for
8440 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008441
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 *'taglength'* *'tl'*
8443'taglength' 'tl' number (default 0)
8444 global
8445 If non-zero, tags are significant up to this number of characters.
8446
8447 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8448'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8449 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008450 If on and using a tags file in another directory, file names in that
8451 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 NOTE: This option is set to the Vi default value when 'compatible' is
8453 set and to the Vim default value when 'compatible' is reset.
8454
8455 *'tags'* *'tag'* *E433*
8456'tags' 'tag' string (default "./tags,tags", when compiled with
8457 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8458 global or local to buffer |global-local|
8459 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008460 include a space or comma in a file name, precede it with backslashes
8461 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 When a file name starts with "./", the '.' is replaced with the path
8463 of the current file. But only when the 'd' flag is not included in
8464 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8465 |tags-option|.
8466 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008467 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8468 find all files named "tags" below "/lib". The filename itself cannot
8469 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008470 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008471 The |tagfiles()| function can be used to get a list of the file names
8472 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8474 files are also supported. They are automatically recognized. The
8475 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8476 differences are ignored (MS-Windows). |emacs-tags|
8477 The use of |:set+=| and |:set-=| is preferred when adding or removing
8478 file names from the list. This avoids problems when a future version
8479 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480
8481 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8482'tagstack' 'tgst' boolean (default on)
8483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 When on, the |tagstack| is used normally. When off, a ":tag" or
8485 ":tselect" command with an argument will not push the tag onto the
8486 tagstack. A following ":tag" without an argument, a ":pop" command or
8487 any other command that uses the tagstack will use the unmodified
8488 tagstack, but does change the pointer to the active entry.
8489 Resetting this option is useful when using a ":tag" command in a
8490 mapping which should not change the tagstack.
8491
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008492 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008493'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008494 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008495 {only available when compiled with the |+tcl/dyn|
8496 feature}
8497 Specifies the name of the Tcl shared library. The default is
8498 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008499 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008500 This option cannot be set from a |modeline| or in the |sandbox|, for
8501 security reasons.
8502
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 *'term'* *E529* *E530* *E531*
8504'term' string (default is $TERM, if that fails:
8505 in the GUI: "builtin_gui"
8506 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008507 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 on Unix: "ansi"
8510 on VMS: "ansi"
8511 on Win 32: "win32")
8512 global
8513 Name of the terminal. Used for choosing the terminal control
8514 characters. Environment variables are expanded |:set_env|.
8515 For example: >
8516 :set term=$TERM
8517< See |termcap|.
8518
8519 *'termbidi'* *'tbidi'*
8520 *'notermbidi'* *'notbidi'*
8521'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 {only available when compiled with the |+arabic|
8524 feature}
8525 The terminal is in charge of Bi-directionality of text (as specified
8526 by Unicode). The terminal is also expected to do the required shaping
8527 that some languages (such as Arabic) require.
8528 Setting this option implies that 'rightleft' will not be set when
8529 'arabic' is set and the value of 'arabicshape' will be ignored.
8530 Note that setting 'termbidi' has the immediate effect that
8531 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8532 This option is reset when the GUI is started.
8533 For further details see |arabic.txt|.
8534
8535 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008536'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 Encoding used for the terminal. This specifies what character
8539 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008540 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008541 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008542 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008543 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8545 Any attempts to set a different value will be rejected, and an error
8546 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008547 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 because the Win32 system always passes Unicode characters.
8549 When empty, the same encoding is used as for the 'encoding' option.
8550 This is the normal value.
8551 Not all combinations for 'termencoding' and 'encoding' are valid. See
8552 |encoding-table|.
8553 The value for this option must be supported by internal conversions or
8554 iconv(). When this is not possible no conversion will be done and you
8555 will probably experience problems with non-ASCII characters.
8556 Example: You are working with the locale set to euc-jp (Japanese) and
8557 want to edit a UTF-8 file: >
8558 :let &termencoding = &encoding
8559 :set encoding=utf-8
8560< You need to do this when your system has no locale support for UTF-8.
8561
Bram Moolenaar938ae282023-02-20 20:44:55 +00008562 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008563'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8564 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008565 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008566 {not available when compiled without the
8567 |+termguicolors| feature}
8568 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008569 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008570
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008571 Requires a ISO-8613-3 compatible terminal. If setting this option
8572 does not work (produces a colorless UI) reading |xterm-true-color|
8573 might help.
8574
8575 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8576 is required. Use this check to find out: >
8577 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008578< This requires Vim to be built with the |+vtp| feature.
8579
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008580 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008581
8582 When using Vim with Windows Terminal, the background of Windows
8583 Terminal is normally filled with the Vim background color. Setting
8584 'termguicolors' and the guibg of the Normal highlight group to NONE
8585 will make the background transparent: >
8586 :hi Normal guibg=NONE
8587<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008588 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008589
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008590 *'termwinkey'* *'twk'*
8591'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008592 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008593 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008594 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008595 The key can be specified as a single character, a |key-notation| (e.g.
8596 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8597 :set twk=X
8598 :set twk=^I
8599 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008600< The string must be one key stroke but can be multiple bytes.
8601 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008602 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008603 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008604
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008605 *'termwinscroll'* *'twsl'*
8606'termwinscroll' 'twsl' number (default 10000)
8607 local to buffer
8608 {not available when compiled without the
8609 |+terminal| feature}
8610 Number of scrollback lines to keep. When going over this limit the
8611 first 10% of the scrollback lines are deleted. This is just to reduce
8612 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008613 Also used as a limit for text sent to the terminal in one write,
8614 multiplied by the number of columns times 3 (average number of bytes
8615 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008616
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008617 *'termwinsize'* *'tws'*
8618'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008619 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008620 Size used when opening the |terminal| window. Format:
8621 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008622 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008623 - When set with a "x" (e.g., "24x80") the terminal size is not
8624 adjusted to the window size. If the window is smaller only the
8625 top-left part is displayed.
8626 - When set with a "*" (e.g., "10*50") the terminal size follows the
8627 window size, but will not be smaller than the specified rows and/or
8628 columns.
8629 - When rows is zero then use the height of the window.
8630 - When columns is zero then use the width of the window.
8631 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008632 - Can be overruled in the |term_start()| options with "term_rows" and
8633 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008634
8635 Examples:
8636 "30x0" uses 30 rows and the current window width.
8637 "20*0" uses at least 20 rows and the current window width.
8638 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008639 Note that the command running in the terminal window may still change
8640 the size of the terminal. In that case the Vim window will be
8641 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008642
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008643 *'termwintype'* *'twt'*
8644'termwintype' 'twt' string (default "")
8645 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008646 {only available when compiled with the |terminal|
8647 feature on MS-Windows}
8648 Specify the virtual console (pty) used when opening the terminal
8649 window.
8650
8651 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008652 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008653 "winpty" use winpty, fail if not supported
8654 "conpty" use |ConPTY|, fail if not supported
8655
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008656 |ConPTY| support depends on the platform. Windows 10 October 2018
8657 Update is the first version that supports ConPTY, however it is still
8658 considered unstable. ConPTY might become stable in the next release
8659 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008660 supported then you cannot open a terminal window.
8661
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 *'terse'* *'noterse'*
8663'terse' boolean (default off)
8664 global
8665 When set: Add 's' flag to 'shortmess' option (this makes the message
8666 for a search that hits the start or end of the file not being
8667 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8668 shortens a lot of messages}
8669
8670 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8671'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 This option is obsolete. Use 'fileformats'.
8674 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8675 set to the default value for the current system. When 'textauto' is
8676 reset, 'fileformats' is made empty.
8677 NOTE: This option is set to the Vi default value when 'compatible' is
8678 set and to the Vim default value when 'compatible' is reset.
8679
8680 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008681'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 others: default off)
8683 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 This option is obsolete. Use 'fileformat'.
8685 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8686 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8687 "unix".
8688
8689 *'textwidth'* *'tw'*
8690'textwidth' 'tw' number (default 0)
8691 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 Maximum width of text that is being inserted. A longer line will be
8693 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008694 this.
8695 'textwidth' is set to 0 when the 'paste' option is set and restored
8696 when 'paste' is reset.
8697 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008699 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 NOTE: This option is set to 0 when 'compatible' is set.
8701
8702 *'thesaurus'* *'tsr'*
8703'thesaurus' 'tsr' string (default "")
8704 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008706 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8707 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008708
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008709 This option is not used if 'thesaurusfunc' is set, either for the
8710 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008711
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008712 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008714 name. See |option-backslash| about using backslashes. The use of
8715 |:set+=| and |:set-=| is preferred when adding or removing directories
8716 from the list. This avoids problems when a future version uses
8717 another default. Backticks cannot be used in this option for security
8718 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008720 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008721'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008722 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008723 {not available when compiled without the |+eval|
8724 feature}
8725 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008726 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008727 The value can be the name of a function, a |lambda| or a |Funcref|.
8728 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008729
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008730 This option cannot be set from a |modeline| or in the |sandbox|, for
8731 security reasons.
8732
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8734'tildeop' 'top' boolean (default off)
8735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 When on: The tilde command "~" behaves like an operator.
8737 NOTE: This option is reset when 'compatible' is set.
8738
8739 *'timeout'* *'to'* *'notimeout'* *'noto'*
8740'timeout' 'to' boolean (default on)
8741 global
laburnumT3f7855a2023-12-05 18:37:03 +01008742
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008744'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 These two options together determine the behavior when part of a
8747 mapped key sequence or keyboard code has been received:
8748
8749 'timeout' 'ttimeout' action ~
8750 off off do not time out
8751 on on or off time out on :mappings and key codes
8752 off on time out on key codes
8753
8754 If both options are off, Vim will wait until either the complete
8755 mapping or key sequence has been received, or it is clear that there
8756 is no mapping or key sequence for the received characters. For
8757 example: if you have mapped "vl" and Vim has received 'v', the next
8758 character is needed to see if the 'v' is followed by an 'l'.
8759 When one of the options is on, Vim will wait for about 1 second for
8760 the next character to arrive. After that the already received
8761 characters are interpreted as single characters. The waiting time can
8762 be changed with the 'timeoutlen' option.
8763 On slow terminals or very busy systems timing out may cause
8764 malfunctioning cursor keys. If both options are off, Vim waits
8765 forever after an entered <Esc> if there are key codes that start
8766 with <Esc>. You will have to type <Esc> twice. If you do not have
8767 problems with key codes, but would like to have :mapped key
8768 sequences not timing out in 1 second, set the 'ttimeout' option and
8769 reset the 'timeout' option.
8770
8771 NOTE: 'ttimeout' is reset when 'compatible' is set.
8772
8773 *'timeoutlen'* *'tm'*
8774'timeoutlen' 'tm' number (default 1000)
8775 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008776
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008778'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 The time in milliseconds that is waited for a key code or mapped key
8781 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8782 when part of a command has been typed.
8783 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8784 different timeout value for key codes is desired set 'ttimeoutlen' to
8785 a non-negative number.
8786
8787 ttimeoutlen mapping delay key code delay ~
8788 < 0 'timeoutlen' 'timeoutlen'
8789 >= 0 'timeoutlen' 'ttimeoutlen'
8790
8791 The timeout only happens when the 'timeout' and 'ttimeout' options
8792 tell so. A useful setting would be >
8793 :set timeout timeoutlen=3000 ttimeoutlen=100
8794< (time out on mapping after three seconds, time out on key codes after
8795 a tenth of a second).
8796
8797 *'title'* *'notitle'*
8798'title' boolean (default off, on when title can be restored)
8799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 When on, the title of the window will be set to the value of
8801 'titlestring' (if it is not empty), or to:
8802 filename [+=-] (path) - VIM
8803 Where:
8804 filename the name of the file being edited
8805 - indicates the file cannot be modified, 'ma' off
8806 + indicates the file was modified
8807 = indicates the file is read-only
8808 =+ indicates the file is read-only and modified
8809 (path) is the path of the file being edited
8810 - VIM the server name |v:servername| or "VIM"
8811 Only works if the terminal supports setting window titles
8812 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008813 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8815 *X11*
8816 When Vim was compiled with HAVE_X11 defined, the original title will
8817 be restored if possible. The output of ":version" will include "+X11"
8818 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8819 works for the icon name |'icon'|.
8820 But: When Vim was started with the |-X| argument, restoring the title
8821 will not work (except in the GUI).
8822 If the title cannot be restored, it is set to the value of 'titleold'.
8823 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008824 When using an xterm from a remote machine you can use this command: >
8825
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008827 ssh -X machine_name xterm &
8828<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 then the WINDOWID environment variable should be inherited and the
8830 title of the window should change back to what it should be after
8831 exiting Vim.
8832
8833 *'titlelen'*
8834'titlelen' number (default 85)
8835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008837 title. When the title is longer, only the end of the path name is
8838 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 Using a percentage makes this adapt to the width of the window. But
8840 it won't work perfectly, because the actual number of characters
8841 available also depends on the font used and other things in the title
8842 bar. When 'titlelen' is zero the full path is used. Otherwise,
8843 values from 1 to 30000 percent can be used.
8844 'titlelen' is also used for the 'titlestring' option.
8845
8846 *'titleold'*
8847'titleold' string (default "Thanks for flying Vim")
8848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 This option will be used for the window title when exiting Vim if the
8850 original title cannot be restored. Only happens if 'title' is on or
8851 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008852 This option cannot be set from a |modeline| or in the |sandbox|, for
8853 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 *'titlestring'*
8855'titlestring' string (default "")
8856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 When this option is not empty, it will be used for the title of the
8858 window. This happens only when the 'title' option is on.
8859 Only works if the terminal supports setting window titles (currently
8860 Amiga console, Win32 console, all GUI versions and terminals with a
8861 non-empty 't_ts' option).
8862 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008863 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008864
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008866 expanded according to the rules used for 'statusline'. If it contains
8867 an invalid '%' format, the value is used as-is and no error or warning
8868 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008869 This option cannot be set in a modeline when 'modelineexpr' is off.
8870
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008872 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8874< The value of 'titlelen' is used to align items in the middle or right
8875 of the available space.
8876 Some people prefer to have the file name first: >
8877 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8878< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008879 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 separating space only when needed.
8881 NOTE: Use of special characters in 'titlestring' may cause the display
8882 to be garbled (e.g., when it contains a CR or NL character).
8883 {not available when compiled without the |+statusline| feature}
8884
8885 *'toolbar'* *'tb'*
8886'toolbar' 'tb' string (default "icons,tooltips")
8887 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008888 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008889 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 possible values are:
8891 icons Toolbar buttons are shown with icons.
8892 text Toolbar buttons shown with text.
8893 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008894 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008895 tooltips Tooltips are active for toolbar buttons.
8896 Tooltips refer to the popup help text which appears after the mouse
8897 cursor is placed over a toolbar button for a brief moment.
8898
8899 If you want the toolbar to be shown with icons as well as text, do the
8900 following: >
8901 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008902< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 will show icons if both are requested.
8904
8905 If none of the strings specified in 'toolbar' are valid or if
8906 'toolbar' is empty, this option is ignored. If you want to disable
8907 the toolbar, you need to set the 'guioptions' option. For example: >
8908 :set guioptions-=T
8909< Also see |gui-toolbar|.
8910
8911 *'toolbariconsize'* *'tbis'*
8912'toolbariconsize' 'tbis' string (default "small")
8913 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008914 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008916 tiny Use tiny icons.
8917 small Use small icons (default).
8918 medium Use medium-sized icons.
8919 large Use large icons.
8920 huge Use even larger icons.
8921 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008923 the current theme. Common dimensions are giant=48x48, huge=32x32,
8924 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925
8926 If 'toolbariconsize' is empty, the global default size as determined
8927 by user preferences or the current theme is used.
8928
8929 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8930'ttybuiltin' 'tbi' boolean (default on)
8931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 When on, the builtin termcaps are searched before the external ones.
8933 When off the builtin termcaps are searched after the external ones.
8934 When this option is changed, you should set the 'term' option next for
8935 the change to take effect, for example: >
8936 :set notbi term=$TERM
8937< See also |termcap|.
8938 Rationale: The default for this option is "on", because the builtin
8939 termcap entries are generally better (many systems contain faulty
8940 xterm entries...).
8941
8942 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008943'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 Indicates a fast terminal connection. More characters will be sent to
8946 the screen for redrawing, instead of using insert/delete line
8947 commands. Improves smoothness of redrawing when there are multiple
8948 windows and the terminal does not support a scrolling region.
8949 Also enables the extra writing of characters at the end of each screen
8950 line for lines that wrap. This helps when using copy/paste with the
8951 mouse in an xterm and other terminals.
8952
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008953 The default used to be set only for some terminal names, but these
8954 days nearly all terminals are fast, therefore the default is now "on".
8955 If you have a slow connection you may want to set this option off,
8956 e.g. depending on the host name: >
8957 if hostname() =~ 'faraway'
8958 set nottyfast
8959 endif
8960<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 *'ttymouse'* *'ttym'*
8962'ttymouse' 'ttym' string (default depends on 'term')
8963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 {only in Unix and VMS, doesn't work in the GUI; not
8965 available when compiled without |+mouse|}
8966 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008967 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 *xterm-mouse*
8969 xterm xterm-like mouse handling. The mouse generates
8970 "<Esc>[Mscr", where "scr" is three bytes:
8971 "s" = button state
8972 "c" = column plus 33
8973 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008974 This only works up to 223 columns! See "dec",
8975 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 xterm2 Works like "xterm", but with the xterm reporting the
8977 mouse position while the mouse is dragged. This works
8978 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008979 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 work. See below for how Vim detects this
8981 automatically.
8982 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008983 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008985 for the row and column. No other mouse events are
8986 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 *dec-mouse*
8988 dec DEC terminal mouse handling. The mouse generates a
8989 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008990 This is also available for an Xterm, if it was
8991 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 *jsbterm-mouse*
8993 jsbterm JSB term mouse handling.
8994 *pterm-mouse*
8995 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008996 *urxvt-mouse*
8997 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008998 The mouse works only if the terminal supports this
8999 encoding style, but it does not have 223 columns limit
9000 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009001 *sgr-mouse*
9002 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009003 mouse reporting. The mouse works even in columns
9004 beyond 223. This option is backward compatible with
9005 "xterm2" because it can also decode "xterm2" style
9006 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007
9008 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009009 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9010 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9012 recognized, if enabled at compile time. DEC terminal mouse codes
9013 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009014 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9015 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009017 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9018 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9019 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009020 If the terminfo/termcap entry "XM" exists and the first number is
9021 "1006" then 'ttymouse' will be set to "sgr". This works for many
9022 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009023 Additionally, if vim is compiled with the |+termresponse| feature and
9024 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009025 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009027 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9028 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9029 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009030 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9031 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 :set t_RV=
9033<
9034 *'ttyscroll'* *'tsl'*
9035'ttyscroll' 'tsl' number (default 999)
9036 global
9037 Maximum number of lines to scroll the screen. If there are more lines
9038 to scroll the window is redrawn. For terminals where scrolling is
9039 very slow and redrawing is not slow this can be set to a small number,
9040 e.g., 3, to speed up displaying.
9041
9042 *'ttytype'* *'tty'*
9043'ttytype' 'tty' string (default from $TERM)
9044 global
9045 Alias for 'term', see above.
9046
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009047 *'undodir'* *'udir'*
9048'undodir' 'udir' string (default ".")
9049 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009050 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009051 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009052 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009053 "." means using the directory of the file. The undo file name for
9054 "file.txt" is ".file.txt.un~".
9055 For other directories the file name is the full path of the edited
9056 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009057 When writing: The first directory that exists is used. "." always
9058 works, no directories after "." will be used for writing.
9059 When reading all entries are tried to find an undo file. The first
9060 undo file that exists is used. When it cannot be read an error is
9061 given, no further entry is used.
9062 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009063 This option cannot be set from a |modeline| or in the |sandbox|, for
9064 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009065
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009066 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009067'undofile' 'udf' boolean (default off)
9068 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009069 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009070 When on, Vim automatically saves undo history to an undo file when
9071 writing a buffer to a file, and restores undo history from the same
9072 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009073 The directory where the undo file is stored is specified by 'undodir'.
9074 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009075 The undo file is not read when 'undoreload' causes the buffer from
9076 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009077 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009078 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009079
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009081'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009082 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009084 is kept in memory, higher numbers will cause more memory to be used.
9085 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9087 itself: >
9088 set ul=0
9089< But you can also get Vi compatibility by including the 'u' flag in
9090 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009091 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009092 Set to -1 for no undo at all. You might want to do this only for the
9093 current buffer: >
9094 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009096
9097 The local value is set to -123456 when the global value is to be used.
9098
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009099 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009100
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009101 *'undoreload'* *'ur'*
9102'undoreload' 'ur' number (default 10000)
9103 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009104 Save the whole buffer for undo when reloading it. This applies to the
9105 ":e!" command and reloading for when the buffer changed outside of
9106 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009107 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009108 of lines is smaller than the value of this option.
9109 Set this option to zero to disable undo for a reload.
9110
9111 When saving undo for a reload, any undo file is not read.
9112
9113 Note that this causes the whole buffer to be stored in memory. Set
9114 this option to a lower value if you run out of memory.
9115
Bram Moolenaar071d4272004-06-13 20:20:40 +00009116 *'updatecount'* *'uc'*
9117'updatecount' 'uc' number (default: 200)
9118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 After typing this many characters the swap file will be written to
9120 disk. When zero, no swap file will be created at all (see chapter on
9121 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9122 Vim with the "-n" option, see |startup|. When editing in readonly
9123 mode this option will be initialized to 10000.
9124 The swapfile can be disabled per buffer with |'swapfile'|.
9125 When 'updatecount' is set from zero to non-zero, swap files are
9126 created for all buffers that have 'swapfile' set. When 'updatecount'
9127 is set to zero, existing swap files are not deleted.
9128 Also see |'swapsync'|.
9129 This option has no meaning in buffers where |'buftype'| is "nofile"
9130 or "nowrite".
9131
9132 *'updatetime'* *'ut'*
9133'updatetime' 'ut' number (default 4000)
9134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135 If this many milliseconds nothing is typed the swap file will be
9136 written to disk (see |crash-recovery|). Also used for the
9137 |CursorHold| autocommand event.
9138
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009139 *'varsofttabstop'* *'vsts'*
9140'varsofttabstop' 'vsts' string (default "")
9141 local to buffer
9142 {only available when compiled with the |+vartabs|
9143 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009144 A list of the number of spaces that a <Tab> counts for while editing,
9145 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9146 width <Tab>s are being inserted, while in fact a mixture of spaces
9147 and <Tab>s is used. Tab widths are separated with commas, with the
9148 final value applying to all subsequent tabs.
9149
9150 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009151 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009152 to use the following: >
9153 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009154< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9155 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009156
9157 Note that the value of |'softtabstop'| will be ignored while
9158 'varsofttabstop' is set.
9159
9160 *'vartabstop'* *'vts'*
9161'vartabstop' 'vts' string (default "")
9162 local to buffer
9163 {only available when compiled with the |+vartabs|
9164 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009165 A list of the number of spaces that a <Tab> in the file counts for,
9166 separated by commas. Each value corresponds to one tab, with the
9167 final value applying to all subsequent tabs. For example: >
9168 :set vartabstop=4,20,10,8
9169< This will make the first tab 4 spaces wide, the second 20 spaces,
9170 the third 10 spaces, and all following tabs 8 spaces.
9171
9172 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9173 is set.
9174
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 *'verbose'* *'vbs'*
9176'verbose' 'vbs' number (default 0)
9177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178 When bigger than zero, Vim will give messages about what it is doing.
9179 Currently, these messages are given:
9180 >= 1 When the viminfo file is read or written.
9181 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009182 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009183 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184 >= 8 Files for which a group of autocommands is executed.
9185 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009186 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 >= 12 Every executed function.
9188 >= 13 When an exception is thrown, caught, finished, or discarded.
9189 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009190 >= 15 Every executed Ex command from a script (truncated at 200
9191 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009192 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193
9194 This option can also be set with the "-V" argument. See |-V|.
9195 This option is also set by the |:verbose| command.
9196
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009197 When the 'verbosefile' option is set then the verbose messages are not
9198 displayed.
9199
9200 *'verbosefile'* *'vfile'*
9201'verbosefile' 'vfile' string (default empty)
9202 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009203 When not empty all messages are written in a file with this name.
9204 When the file exists messages are appended.
9205 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009206 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009207 Setting 'verbosefile' to a new value is like making it empty first.
9208 The difference with |:redir| is that verbose messages are not
9209 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009210 This option cannot be set from a |modeline| or in the |sandbox|, for
9211 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009212
Bram Moolenaar071d4272004-06-13 20:20:40 +00009213 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009214'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009215 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009216 for Unix: "$HOME/.vim/view" or
9217 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009218 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009220 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 feature}
9222 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009223 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 This option cannot be set from a |modeline| or in the |sandbox|, for
9225 security reasons.
9226
9227 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009228'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009230 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009231 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009232 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009233 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 word save and restore ~
9235 cursor cursor position in file and in window
9236 folds manually created folds, opened/closed folds and local
9237 fold options
9238 options options and mappings local to a window or buffer (not
9239 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009240 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 slash backslashes in file names replaced with forward
9242 slashes
9243 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009244 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009245 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009247 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009249 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250
9251 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009252'viminfo' 'vi' string (Vi default: "", Vim default for
9253 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009254 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9255 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009257 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 feature}
9259 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009260 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9261 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009262 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009263 consisting of a single character identifying the particular parameter,
9264 followed by a number or string which specifies the value of that
9265 parameter. If a particular character is left out, then the default
9266 value is used for that parameter. The following is a list of the
9267 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009269 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270 ! When included, save and restore global variables that start
9271 with an uppercase letter, and don't contain a lowercase
9272 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009273 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009274 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009275 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 " Maximum number of lines saved for each register. Old name of
9277 the '<' item, with the disadvantage that you need to put a
9278 backslash before the ", otherwise it will be recognized as the
9279 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009280 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 % When included, save and restore the buffer list. If Vim is
9282 started with a file name argument, the buffer list is not
9283 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009284 buffer list is restored from the viminfo file. Quickfix
9285 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9286 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009287 When followed by a number, the number specifies the maximum
9288 number of buffers that are stored. Without a number all
9289 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009290 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 ' Maximum number of previously edited files for which the marks
9292 are remembered. This parameter must always be included when
9293 'viminfo' is non-empty.
9294 Including this item also means that the |jumplist| and the
9295 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009296 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009297 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009298 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009299 patterns are also saved. When not included, the value of
9300 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009301 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009303 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009304 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 < Maximum number of lines saved for each register. If zero then
9306 registers are not saved. When not included, all lines are
9307 saved. '"' is the old name for this item.
9308 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009309 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009311 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009312 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 c When included, convert the text in the viminfo file from the
9314 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009315 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009316 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 f Whether file marks need to be stored. If zero, file marks ('0
9318 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009319 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009321 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009322 h Disable the effect of 'hlsearch' when loading the viminfo
9323 file. When not included, it depends on whether ":nohlsearch"
9324 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009325 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009327 the 'n'. Must be at the end of the option! If the
9328 'viminfofile' option is set, that file name overrides the one
9329 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009330 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009331 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009332 r Removable media. The argument is a string (up to the next
9333 ','). This parameter can be given several times. Each
9334 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009335 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9337 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9338 ignored. Maximum length of each 'r' argument is 50
9339 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009340 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009341 s Maximum size of an item in Kbyte. If zero then registers are
9342 not saved. Currently only applies to registers. The default
9343 "s10" will exclude registers with more than 10 Kbyte of text.
9344 Also see the '<' item above: line count limit.
9345
9346 Example: >
9347 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9348<
9349 '50 Marks will be remembered for the last 50 files you
9350 edited.
9351 <1000 Contents of registers (up to 1000 lines each) will be
9352 remembered.
9353 s100 Registers with more than 100 Kbyte text are skipped.
9354 :0 Command-line history will not be saved.
9355 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9356 no / Since '/' is not specified, the default will be used,
9357 that is, save all of the search history, and also the
9358 previous search and substitute patterns.
9359 no % The buffer list will not be saved nor read back.
9360 no h 'hlsearch' highlighting will be restored.
9361
9362 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9363 load the contents of the file, this is not done automatically.
9364
9365 This option cannot be set from a |modeline| or in the |sandbox|, for
9366 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009367 NOTE: This option is set to the Vim default value when 'compatible'
9368 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009370 *'viminfofile'* *'vif'*
9371'viminfofile' 'vif' string (default: "")
9372 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009373 {not available when compiled without the |+viminfo|
9374 feature}
9375 When non-empty, overrides the file name used for viminfo.
9376 When equal to "NONE" no viminfo file will be read or written.
9377 This option can be set with the |-i| command line flag. The |--clean|
9378 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009379 This option cannot be set from a |modeline| or in the |sandbox|, for
9380 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009381
Bram Moolenaar071d4272004-06-13 20:20:40 +00009382 *'virtualedit'* *'ve'*
9383'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009384 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009385 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386 block Allow virtual editing in Visual block mode.
9387 insert Allow virtual editing in Insert mode.
9388 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009389 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009390 none When used as the local value, do not allow virtual
9391 editing even when the global value is set. When used
9392 as the global value, "none" is the same as "".
9393 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009394
Bram Moolenaar071d4272004-06-13 20:20:40 +00009395 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009396 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009397 of the line. Useful for selecting a rectangle in Visual mode and
9398 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009399 "onemore" is not the same, it will only allow moving the cursor just
9400 after the last character of the line. This makes some commands more
9401 consistent. Previously the cursor was always past the end of the line
9402 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009403 break some plugins or Vim scripts. For example because |l| can move
9404 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009405 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009406 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009407 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009408 It doesn't make sense to combine "all" with "onemore", but you will
9409 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009410 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009411 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009412
9413 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9414'visualbell' 'vb' boolean (default off)
9415 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009416 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009417 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009418 use: >
9419 :set vb t_vb=
9420< If you want a short flash, you can use this on many terminals: >
9421 :set vb t_vb=[?5h$<100>[?5l
9422< Here $<100> specifies the time, you can use a smaller or bigger value
9423 to get a shorter or longer flash.
9424
9425 Note: Vim will limit the bell to once per half a second. This avoids
9426 having to wait for the flashing to finish when there are lots of
9427 bells, e.g. on key repeat. This also happens without 'visualbell'
9428 set.
9429
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9431 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9432 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009433
9434 Note: When the GUI starts, 't_vb' is reset to its default value. You
9435 might want to set it again in your |gvimrc|.
9436
Bram Moolenaar071d4272004-06-13 20:20:40 +00009437 Does not work on the Amiga, you always get a screen flash.
9438 Also see 'errorbells'.
9439
9440 *'warn'* *'nowarn'*
9441'warn' boolean (default on)
9442 global
9443 Give a warning message when a shell command is used while the buffer
9444 has been changed.
9445
9446 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9447'weirdinvert' 'wiv' boolean (default off)
9448 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009449 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009450 It is provided for backwards compatibility with version 4.x.
9451 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9452 vice versa. Has no effect when the GUI is running.
9453
9454 *'whichwrap'* *'ww'*
9455'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 Allow specified keys that move the cursor left/right to move to the
9458 previous/next line when the cursor is on the first/last character in
9459 the line. Concatenate characters to allow this for these keys:
9460 char key mode ~
9461 b <BS> Normal and Visual
9462 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009463 h "h" Normal and Visual (not recommended)
9464 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009465 < <Left> Normal and Visual
9466 > <Right> Normal and Visual
9467 ~ "~" Normal
9468 [ <Left> Insert and Replace
9469 ] <Right> Insert and Replace
9470 For example: >
9471 :set ww=<,>,[,]
9472< allows wrap only when cursor keys are used.
9473 When the movement keys are used in combination with a delete or change
9474 operator, the <EOL> also counts for a character. This makes "3h"
9475 different from "3dh" when the cursor crosses the end of a line. This
9476 is also true for "x" and "X", because they do the same as "dl" and
9477 "dh". If you use this, you may also want to use the mapping
9478 ":map <BS> X" to make backspace delete the character in front of the
9479 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009480 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009481 line (not an empty line) then it will not move to the next line. This
9482 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009483 NOTE: This option is set to the Vi default value when 'compatible' is
9484 set and to the Vim default value when 'compatible' is reset.
9485
9486 *'wildchar'* *'wc'*
9487'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009489 Character you have to type to start wildcard expansion in the
9490 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009491 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009492 The character is not recognized when used inside a macro. See
9493 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009494 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009495 <Esc> can be used, but hitting it twice in a row will still exit
9496 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009497 Although 'wc' is a number option, it can be specified as a number, a
9498 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9499 preceded with a caret (e.g. `^F` is CTRL-F): >
9500 :set wc=27
9501 :set wc=X
9502 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009503 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009504< NOTE: This option is set to the Vi default value when 'compatible' is
9505 set and to the Vim default value when 'compatible' is reset.
9506
9507 *'wildcharm'* *'wcm'*
9508'wildcharm' 'wcm' number (default: none (0))
9509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009510 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009511 recognized when used inside a macro. You can find "spare" command-line
9512 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009513 you'll never actually type 'wildcharm', just use it in mappings that
9514 automatically invoke completion mode, e.g.: >
9515 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009516 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009517< Then after typing :ss you can use CTRL-P & CTRL-N.
9518
9519 *'wildignore'* *'wig'*
9520'wildignore' 'wig' string (default "")
9521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009522 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009523 patterns is ignored when expanding |wildcards|, completing file or
9524 directory names, and influences the result of |expand()|, |glob()| and
9525 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9527 Also see 'suffixes'.
9528 Example: >
9529 :set wildignore=*.o,*.obj
9530< The use of |:set+=| and |:set-=| is preferred when adding or removing
9531 a pattern from the list. This avoids problems when a future version
9532 uses another default.
9533
h_east596a9f22023-11-21 21:24:23 +09009534 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009535'wildignorecase' 'wic' boolean (default off)
9536 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009537 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009538 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009539 Does not apply when the shell is used to expand wildcards, which
9540 happens when there are special characters.
9541
Bram Moolenaar071d4272004-06-13 20:20:40 +00009542 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009543'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009545 When 'wildmenu' is on, command-line completion operates in an enhanced
9546 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009547 the possible matches are shown.
9548 When 'wildoptions' contains "pum", then the completion matches are
9549 shown in a popup menu. Otherwise they are displayed just above the
9550 command line, with the first match highlighted (overwriting the status
9551 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009552 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009553 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9554 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9555 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009556 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 If there are more matches than can fit in the line, a ">" is shown on
9558 the right and/or a "<" is shown on the left. The status line scrolls
9559 as needed.
9560 The "wildmenu" mode is abandoned when a key is hit that is not used
9561 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009562 While the "wildmenu" is active, the following keys have special
9563 meanings:
9564 CTRL-P - go to the previous entry
9565 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009566 <CR> - in menu completion, when the cursor is just after a
9567 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009568 CTRL-E - end completion, go back to what was there before
9569 selecting a match.
9570 CTRL-Y - accept the currently selected match and stop
9571 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009572
9573 When not using the popup menu for command line completion, the
9574 following keys have special meanings:
9575 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 <Up> - in filename/menu name completion: move up into
9577 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009578 <Down> - in filename/menu name completion: move into a
9579 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009580
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009581 When using the popup menu for command line completion, the following
9582 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009583 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009584 <PageUp> - select a match several entries back
9585 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009586 <Left> - in filename/menu name completion: move up into
9587 parent directory or parent menu.
9588 <Right> - in filename/menu name completion: move into a
9589 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009590
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591 This makes the menus accessible from the console |console-menus|.
9592
9593 If you prefer the <Left> and <Right> keys to move the cursor instead
9594 of selecting a different match, use this: >
9595 :cnoremap <Left> <Space><BS><Left>
9596 :cnoremap <Right> <Space><BS><Right>
9597<
9598 The "WildMenu" highlighting is used for displaying the current match
9599 |hl-WildMenu|.
9600
9601 *'wildmode'* *'wim'*
9602'wildmode' 'wim' string (Vim default: "full")
9603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009604 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009605 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009606 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009607 first part specifies the behavior for the first use of 'wildchar',
9608 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009609
9610 Each part consists of a colon separated list consisting of the
9611 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009612 "" Complete only the first match.
9613 "full" Complete the next full match. After the last match,
9614 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009615 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009616 "longest" Complete till longest common string. If this doesn't
9617 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009619 "lastused" When completing buffer names and more than one buffer
9620 matches, sort buffers by time last used (other than
9621 the current buffer).
Girish Palya2bacc3e2025-03-02 22:55:57 +01009622 "noselect" Do not pre-select first menu item and start 'wildmenu'
9623 if it is enabled.
9624 When there is only a single match, it is fully completed in all cases
9625 except when "noselect" is present.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009626
9627 Examples of useful colon-separated values:
9628 "longest:full" Like "longest", but also start 'wildmenu' if it is
9629 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009630 "list:full" When more than one match, list all matches and
9631 complete first match.
9632 "list:longest" When more than one match, list all matches and
9633 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009634 "list:lastused" When more than one buffer matches, list all matches
9635 and sort buffers by time last used (other than the
9636 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637
9638 Examples: >
9639 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009640< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009641 :set wildmode=longest,full
9642< Complete longest common string, then each full match >
9643 :set wildmode=list:full
9644< List all matches and complete each full match >
9645 :set wildmode=list,full
9646< List all matches without completing, then each full match >
9647 :set wildmode=longest,list
Girish Palya2bacc3e2025-03-02 22:55:57 +01009648< Complete longest common string, then list alternatives >
9649 :set wildmode=noselect:full
9650< Display 'wildmenu' without completing, then each full match >
9651 :set wildmode=noselect:lastused,full
9652< Same as above, but sort buffers by time last used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009653 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009654
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009655 *'wildoptions'* *'wop'*
9656'wildoptions' 'wop' string (default "")
9657 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009658 A list of words that change how |cmdline-completion| is done.
9659 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009660 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009661 this value is specified, wildcard expansion will not
9662 be used for completion. The matches will be sorted by
9663 the "best match" rather than alphabetically sorted.
9664 This will find more matches than the wildcard
9665 expansion. Currently fuzzy matching based completion
9666 is not supported for file and directory names and
9667 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009668 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009669 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009670 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009671 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009672 is displayed per line. Often used tag kinds are:
9673 d #define
9674 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009675
Bram Moolenaar071d4272004-06-13 20:20:40 +00009676 *'winaltkeys'* *'wak'*
9677'winaltkeys' 'wak' string (default "menu")
9678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009679 {only used in Win32, Motif, GTK and Photon GUI}
9680 Some GUI versions allow the access to menu entries by using the ALT
9681 key in combination with a character that appears underlined in the
9682 menu. This conflicts with the use of the ALT key for mappings and
9683 entering special characters. This option tells what to do:
9684 no Don't use ALT keys for menus. ALT key combinations can be
9685 mapped, but there is no automatic handling. This can then be
9686 done with the |:simalt| command.
9687 yes ALT key handling is done by the windowing system. ALT key
9688 combinations cannot be mapped.
9689 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009690 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009691 keys can be mapped.
9692 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9693 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009694 This option is not used for <F10>; on Win32 and with GTK <F10> will
9695 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009696
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009697 *'wincolor'* *'wcr'*
9698'wincolor' 'wcr' string (default empty)
9699 local to window
9700 Highlight group name to use for this window instead of the Normal
9701 color |hl-Normal|.
9702
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009703 *'window'* *'wi'*
9704'window' 'wi' number (default screen height - 1)
9705 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009706 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9707 window and the value is smaller than 'lines' minus one. The screen
9708 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009709 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9710 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009711 When resizing the Vim window, and the value is smaller than 1 or more
9712 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009713 Note: Do not confuse this with the height of the Vim window, use
9714 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009715
Colin Kennedy21570352024-03-03 16:16:47 +01009716 *'winfixbuf'*
9717'winfixbuf' 'wfb' boolean (default off)
9718 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009719 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009720 For example, attempting to change the buffer with |:edit| will fail.
9721 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009722 also skip any window with 'winfixbuf' enabled. However if an Ex
9723 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009724
laburnumT3f7855a2023-12-05 18:37:03 +01009725 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9726'winfixheight' 'wfh' boolean (default off)
9727 local to window |local-noglobal|
9728 Keep the window height when windows are opened or closed and
9729 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9730 |preview-window| and |quickfix-window|.
9731 The height may be changed anyway when running out of room.
9732
9733 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9734'winfixwidth' 'wfw' boolean (default off)
9735 local to window |local-noglobal|
9736 Keep the window width when windows are opened or closed and
9737 'equalalways' is set. Also for |CTRL-W_=|.
9738 The width may be changed anyway when running out of room.
9739
Bram Moolenaar071d4272004-06-13 20:20:40 +00009740 *'winheight'* *'wh'* *E591*
9741'winheight' 'wh' number (default 1)
9742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009743 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009744 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009745 focus goes to a window that is smaller, its size is increased, at the
9746 cost of the height of other windows.
9747 Set 'winheight' to a small number for normal editing.
9748 Set it to 999 to make the current window fill most of the screen.
9749 Other windows will be only 'winminheight' high. This has the drawback
9750 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9751 to create only two windows, set the option after startup is done,
9752 using the |VimEnter| event: >
9753 au VimEnter * set winheight=999
9754< Minimum value is 1.
9755 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009756 height of the current window.
9757 'winheight' applies to the current window. Use 'winminheight' to set
9758 the minimal height for other windows.
9759
Bram Moolenaar071d4272004-06-13 20:20:40 +00009760 *'winminheight'* *'wmh'*
9761'winminheight' 'wmh' number (default 1)
9762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009763 The minimal height of a window, when it's not the current window.
9764 This is a hard minimum, windows will never become smaller.
9765 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9766 status bar) if necessary. They will return to at least one line when
9767 they become active (since the cursor has to have somewhere to go.)
9768 Use 'winheight' to set the minimal height of the current window.
9769 This option is only checked when making a window smaller. Don't use a
9770 large number, it will cause errors when opening more than a few
9771 windows. A value of 0 to 3 is reasonable.
9772
9773 *'winminwidth'* *'wmw'*
9774'winminwidth' 'wmw' number (default 1)
9775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009776 The minimal width of a window, when it's not the current window.
9777 This is a hard minimum, windows will never become smaller.
9778 When set to zero, windows may be "squashed" to zero columns (i.e. just
9779 a vertical separator) if necessary. They will return to at least one
9780 line when they become active (since the cursor has to have somewhere
9781 to go.)
9782 Use 'winwidth' to set the minimal width of the current window.
9783 This option is only checked when making a window smaller. Don't use a
9784 large number, it will cause errors when opening more than a few
9785 windows. A value of 0 to 12 is reasonable.
9786
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009787 *'winptydll'*
9788'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9789 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009790 {only available when compiled with the |terminal|
9791 feature on MS-Windows}
9792 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009793 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009794 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009795 a fallback.
9796 Environment variables are expanded |:set_env|.
9797 This option cannot be set from a |modeline| or in the |sandbox|, for
9798 security reasons.
9799
Bram Moolenaar071d4272004-06-13 20:20:40 +00009800 *'winwidth'* *'wiw'* *E592*
9801'winwidth' 'wiw' number (default 20)
9802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009803 Minimal number of columns for the current window. This is not a hard
9804 minimum, Vim will use fewer columns if there is not enough room. If
9805 the current window is smaller, its size is increased, at the cost of
9806 the width of other windows. Set it to 999 to make the current window
9807 always fill the screen. Set it to a small number for normal editing.
9808 The width is not adjusted after one of the commands to change the
9809 width of the current window.
9810 'winwidth' applies to the current window. Use 'winminwidth' to set
9811 the minimal width for other windows.
9812
9813 *'wrap'* *'nowrap'*
9814'wrap' boolean (default on)
9815 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009816 This option changes how text is displayed. It doesn't change the text
9817 in the buffer, see 'textwidth' for that.
9818 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009819 displaying continues on the next line. When off lines will not wrap
9820 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009821 moved to a part that is not shown, the screen will scroll
9822 horizontally.
9823 The line will be broken in the middle of a word if necessary. See
9824 'linebreak' to get the break at a word boundary.
9825 To make scrolling horizontally a bit more useful, try this: >
9826 :set sidescroll=5
9827 :set listchars+=precedes:<,extends:>
9828< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009829 This option can't be set from a |modeline| when the 'diff' option is
9830 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009831
9832 *'wrapmargin'* *'wm'*
9833'wrapmargin' 'wm' number (default 0)
9834 local to buffer
9835 Number of characters from the right window border where wrapping
9836 starts. When typing text beyond this limit, an <EOL> will be inserted
9837 and inserting continues on the next line.
9838 Options that add a margin, such as 'number' and 'foldcolumn', cause
9839 the text width to be further reduced. This is Vi compatible.
9840 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009841 This option is set to 0 when 'paste' is set and restored when 'paste'
9842 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009843 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009844
9845 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9846'wrapscan' 'ws' boolean (default on) *E384* *E385*
9847 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009848 Searches wrap around the end of the file. Also applies to |]s| and
9849 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009850
9851 *'write'* *'nowrite'*
9852'write' boolean (default on)
9853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009854 Allows writing files. When not set, writing a file is not allowed.
9855 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009856 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009857 argument. Filtering text is still possible, even though this requires
9858 writing a temporary file.
9859
9860 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9861'writeany' 'wa' boolean (default off)
9862 global
9863 Allows writing to any file with no need for "!" override.
9864
9865 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9866'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9867 otherwise)
9868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009869 Make a backup before overwriting a file. The backup is removed after
9870 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009871 also on.
9872 WARNING: Switching this option off means that when Vim fails to write
9873 your buffer correctly and then, for whatever reason, Vim exits, you
9874 lose both the original file and what you were writing. Only reset
9875 this option if your file system is almost full and it makes the write
9876 fail (and make sure not to exit Vim until the write was successful).
9877 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009878 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009879 Depending on 'backupcopy' the backup is a new file or the original
9880 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009881 NOTE: This option is set to the default value when 'compatible' is
9882 set.
9883
9884 *'writedelay'* *'wd'*
9885'writedelay' 'wd' number (default 0)
9886 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009887 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009888 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009889 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009890
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009891 *'xtermcodes'* *'noxtermcodes'*
9892'xtermcodes' boolean (default on)
9893 global
9894 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009895 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009896 key codes and number of colors from the terminal. This takes care of
9897 various configuration options of the terminal that cannot be obtained
9898 from the termlib/terminfo entry, see |xterm-codes|.
9899 A side effect may be that t_Co changes and Vim will redraw the
9900 display.
9901
9902
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009903 vim:tw=78:ts=8:noet:ft=help:norl: