blob: a2f5f1f0979fd2c5238fca540b77d62e2b177811 [file] [log] [blame]
Qiming zhaoab2fe652025-04-12 11:40:17 +02001*options.txt* For Vim version 9.1. Last change: 2025 Apr 12
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
Qiming zhaoab2fe652025-04-12 11:40:17 +0200215 :set tags=tags\\,file results in "tags\,file"
Yee Cheng Chin54844852023-10-09 18:12:31 +0200216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
Millyd9af78b2024-09-26 15:54:43 +0200399 Command global value local value condition ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display local value is set
404 :set option? display - local value is not set
405 :setlocal option? - display
406:setglobal option? display -
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408
409Global options with a local value *global-local*
410
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000411Options are global when you mostly use one value for all buffers and windows.
412For some global options it's useful to sometimes have a different local value.
413You can set the local value with ":setlocal". That buffer or window will then
414use the local value, while other buffers and windows continue using the global
415value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416
417For example, you have two windows, both on C source code. They use the global
418'makeprg' option. If you do this in one of the two windows: >
419 :set makeprg=gmake
420then the other window will switch to the same value. There is no need to set
421the 'makeprg' option in the other C source window too.
422However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000423another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000424files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 :setlocal makeprg=perlmake
426You can switch back to using the global value by making the local value empty: >
427 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428This only works for a string option. For a number or boolean option you need
429to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100431Note that for non-boolean and non-number options using "<" copies the global
432value to the local value, it doesn't switch back to using the global value
433(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000434 :set path<
435This will make the local value of 'path' empty, so that the global value is
436used. Thus it does the same as: >
437 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000438Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439":setlocal" on a global option might work differently then.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441 *option-value-function*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
64-bitman88d41ab2025-04-06 17:20:39 +02001720 *'chistory'* *'chi'*
1721'chistory' 'chi' number (default: 10)
1722 global
1723 {only available when compiled with the |+quickfix|
1724 feature}
1725 Number of quickfix lists that should be remembered for the quickfix
1726 stack. Must be between 1 and 100. If the option is set to a value
1727 that is lower than the amount of entries in the quickfix list stack,
1728 entries will be removed starting from the oldest one. If the current
1729 quickfix list was removed, then the quickfix list at top of the stack
1730 (the most recently created) will be used in its place. For additional
1731 info, see |quickfix-stack|.
1732
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1734'cindent' 'cin' boolean (default off)
1735 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001736 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 that trigger reindenting in insert mode and 'cinoptions' to set your
1738 preferred indent style.
1739 If 'indentexpr' is not empty, it overrules 'cindent'.
1740 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1741 the "=" operator indents using this algorithm rather than calling an
1742 external program.
1743 See |C-indenting|.
1744 When you don't like the way 'cindent' works, try the 'smartindent'
1745 option or 'indentexpr'.
1746 This option is not used when 'paste' is set.
1747 NOTE: This option is reset when 'compatible' is set.
1748
1749 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001750'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 A list of keys that, when typed in Insert mode, cause reindenting of
1753 the current line. Only used if 'cindent' is on and 'indentexpr' is
1754 empty.
1755 For the format of this option see |cinkeys-format|.
1756 See |C-indenting|.
1757
1758 *'cinoptions'* *'cino'*
1759'cinoptions' 'cino' string (default "")
1760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1762 program. See |cinoptions-values| for the values of this option, and
1763 |C-indenting| for info on C indenting in general.
1764
laburnumT3f7855a2023-12-05 18:37:03 +01001765 *'cinscopedecls'* *'cinsd'*
1766'cinscopedecls' 'cinsd' string (default "public,protected,private")
1767 local to buffer
1768 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1769 Useful e.g. for working with the Qt framework that defines additional
1770 scope declarations "signals", "public slots" and "private slots": >
1771 set cinscopedecls+=signals,public\ slots,private\ slots
1772<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 *'cinwords'* *'cinw'*
1774'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 These keywords start an extra indent in the next line when
1777 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1778 an appropriate place (inside {}).
1779 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1780 matter, include the keyword both the uppercase and lowercase:
1781 "if,If,IF".
1782
laburnumT3f7855a2023-12-05 18:37:03 +01001783 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1785 for X-windows, "" otherwise)
1786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 {only in GUI versions or when the |+xterm_clipboard|
1788 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001789 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001790 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001791 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001792 prepend, e.g.: >
1793 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001794< When using the GUI see |'go-A'|.
1795 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001797 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 unnamed When included, Vim will use the clipboard register '*'
1799 for all yank, delete, change and put operations which
1800 would normally go to the unnamed register. When a
1801 register is explicitly specified, it will always be
1802 used regardless of whether "unnamed" is in 'clipboard'
1803 or not. The clipboard register can always be
1804 explicitly accessed using the "* notation. Also see
1805 |gui-clipboard|.
1806
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001808 unnamedplus A variant of the "unnamed" flag which uses the
1809 clipboard register '+' (|quoteplus|) instead of
1810 register '*' for all yank, delete, change and put
1811 operations which would normally go to the unnamed
1812 register. When "unnamed" is also included to the
1813 option, yank operations (but not delete, change or
1814 put) will additionally copy the text into register
1815 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001816 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001817 Availability can be checked with: >
1818 if has('unnamedplus')
1819<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001820 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 autoselect Works like the 'a' flag in 'guioptions': If present,
1822 then whenever Visual mode is started, or the Visual
1823 area extended, Vim tries to become the owner of the
1824 windowing system's global selection or put the
1825 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001826 register "*. See |'go-a'| and |quotestar| for details.
1827 When the GUI is active, the 'a' flag in 'guioptions'
1828 is used, when the GUI is not active, this "autoselect"
1829 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 Also applies to the modeless selection.
1831
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001832 *clipboard-autoselectplus*
1833 autoselectplus Like "autoselect" but using the + register instead of
1834 the * register. Compare to the 'P' flag in
1835 'guioptions'.
1836
1837 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 autoselectml Like "autoselect", but for the modeless selection
1839 only. Compare to the 'A' flag in 'guioptions'.
1840
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001841 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001842 html When the clipboard contains HTML, use this when
1843 pasting. When putting text on the clipboard, mark it
1844 as HTML. This works to copy rendered HTML from
1845 Firefox, paste it as raw HTML in Vim, select the HTML
1846 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001847 You probably want to add this only temporarily,
1848 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001849 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001850
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001851 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 exclude:{pattern}
1853 Defines a pattern that is matched against the name of
1854 the terminal 'term'. If there is a match, no
1855 connection will be made to the X server. This is
1856 useful in this situation:
1857 - Running Vim in a console.
1858 - $DISPLAY is set to start applications on another
1859 display.
1860 - You do not want to connect to the X server in the
1861 console, but do want this in a terminal emulator.
1862 To never connect to the X server use: >
1863 exclude:.*
1864< This has the same effect as using the |-X| argument.
1865 Note that when there is no connection to the X server
1866 the window title won't be restored and the clipboard
1867 cannot be accessed.
1868 The value of 'magic' is ignored, {pattern} is
1869 interpreted as if 'magic' was on.
1870 The rest of the option value will be used for
1871 {pattern}, this must be the last entry.
1872
1873 *'cmdheight'* *'ch'*
1874'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001875 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001876 Number of screen lines to use for the command-line. A larger value
1877 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001878 The value of this option is stored with the tab page, so that each tab
1879 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880
1881 *'cmdwinheight'* *'cwh'*
1882'cmdwinheight' 'cwh' number (default 7)
1883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 Number of screen lines to use for the command-line window. |cmdwin|
1885
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001886 *'colorcolumn'* *'cc'*
1887'colorcolumn' 'cc' string (default "")
1888 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001889 {not available when compiled without the |+syntax|
1890 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001891 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001892 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1893 text. Will make screen redrawing slower.
1894 The screen column can be an absolute number, or a number preceded with
1895 '+' or '-', which is added to or subtracted from 'textwidth'. >
1896
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001897 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001898 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1899 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1900<
1901 When 'textwidth' is zero then the items with '-' and '+' are not used.
1902 A maximum of 256 columns are highlighted.
1903
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 *'columns'* *'co'* *E594*
1905'columns' 'co' number (default 80 or terminal width)
1906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001908 initialization and does not have to be set by hand. Also see
1909 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 When Vim is running in the GUI or in a resizable window, setting this
1911 option will cause the window size to be changed. When you only want
1912 to use the size for the GUI, put the command in your |gvimrc| file.
1913 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001914 number of columns of the display, the display may be messed up. For
1915 the GUI it is always possible and Vim limits the number of columns to
1916 what fits on the screen. You can use this command to get the widest
1917 window possible: >
1918 :set columns=9999
1919< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920
1921 *'comments'* *'com'* *E524* *E525*
1922'comments' 'com' string (default
1923 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1924 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001925 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 |format-comments|. See |option-backslash| about using backslashes to
1927 insert a space.
1928
1929 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001930'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 {not available when compiled without the |+folding|
1933 feature}
1934 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001935 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001936 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001937 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938
1939 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001940'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001941 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 This option has the effect of making Vim either more Vi-compatible, or
1944 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001945
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001947 other options are also changed as a side effect.
1948 NOTE: Setting or resetting this option can have a lot of unexpected
1949 effects: Mappings are interpreted in another way, undo behaves
1950 differently, etc. If you set this option in your vimrc file, you
1951 should probably put it at the very start.
1952
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 By default this option is on and the Vi defaults are used for the
1954 options. This default was chosen for those people who want to use Vim
1955 just like Vi, and don't even (want to) know about the 'compatible'
1956 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001957 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001958 this option is switched off, and all options that have not been
1959 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001960 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001961 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001962 happen for the system-wide vimrc or gvimrc file, nor for a file given
1963 with the |-u| argument). Also see |compatible-default| and
1964 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 You can also set this option with the "-C" argument, and reset it with
1966 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001967 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 When this option is set, numerous other options are set to make Vim as
1970 Vi-compatible as possible. When this option is unset, various options
1971 are set to make Vim more useful. The table below lists all the
1972 options affected.
1973 The {?} column indicates when the options are affected:
1974 + Means that the option is set to the value given in {set value} when
1975 'compatible' is set.
1976 & Means that the option is set to the value given in {set value} when
1977 'compatible' is set AND is set to its Vim default value when
1978 'compatible' is unset.
1979 - Means the option is NOT changed when setting 'compatible' but IS
1980 set to its Vim default when 'compatible' is unset.
1981 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
Bram Moolenaar036986f2017-03-16 17:41:02 +01001983 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984
1985 'allowrevins' + off no CTRL-_ command
1986 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001987 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001988 'arabicshape' + on correct character shapes
1989 'backspace' + "" normal backspace
1990 'backup' + off no backup file
1991 'backupcopy' & Unix: "yes" backup file is a copy
1992 else: "auto" copy or rename backup file
1993 'balloonexpr' + "" text to show in evaluation balloon
1994 'breakindent' + off don't indent when wrapping lines
1995 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001996 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001997 'cindent' + off no C code indentation
1998 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1999 'copyindent' + off don't copy indent structure
2000 'cpoptions' & (all flags) Vi-compatible flags
2001 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01002002 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002003 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01002004 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002005 'cscopeverbose' + off see |cscopeverbose|
2006 'delcombine' + off unicode: delete whole char combination
2007 'digraph' + off no digraphs
2008 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02002009 this also disables |modifyOtherKeys|
2010 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002011 'expandtab' + off tabs not expanded to spaces
2012 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002013 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002014 'formatexpr' + "" use 'formatprg' for auto-formatting
2015 'formatoptions' & "vt" Vi compatible formatting
2016 'gdefault' + off no default 'g' flag for ":s"
2017 'history' & 0 no commandline history
2018 'hkmap' + off no Hebrew keyboard mapping
2019 'hkmapp' + off no phonetic Hebrew keyboard mapping
2020 'hlsearch' + off no highlighting of search matches
2021 'incsearch' + off no incremental searching
2022 'indentexpr' + "" no indenting by expression
2023 'insertmode' + off do not start in Insert mode
2024 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002026 'joinspaces' + on insert 2 spaces after period
2027 'modeline' & off no modelines
2028 'more' & off no pauses in listings
2029 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2030 'numberwidth' & 8 min number of columns for line number
2031 'preserveindent'+ off don't preserve current indent structure
2032 when changing it
2033 'revins' + off no reverse insert
2034 'ruler' + off no ruler
2035 'scrolljump' + 1 no jump scroll
2036 'scrolloff' + 0 no scroll offset
2037 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2038 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002039 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002040 'showcmd' & off command characters not shown
2041 'showmode' & off current mode not shown
2042 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2043 'smartcase' + off no automatic ignore case switch
2044 'smartindent' + off no smart indentation
2045 'smarttab' + off no smart tab size
2046 'softtabstop' + 0 tabs are always 'tabstop' positions
2047 'startofline' + on goto startofline with some commands
2048 'tagcase' & "followic" 'ignorecase' when searching tags file
2049 'tagrelative' & off tag file names are not relative
2050 'termguicolors' + off don't use highlight-(guifg|guibg)
2051 'textauto' & off no automatic textmode detection
2052 'textwidth' + 0 no automatic line wrap
2053 'tildeop' + off tilde is not an operator
2054 'ttimeout' + off no terminal timeout
2055 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002056 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002057 'virtualedit' + "" cursor can only be placed on characters
2058 'whichwrap' & "" left-right movements don't wrap
2059 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002061 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062
2063 *'complete'* *'cpt'* *E535*
2064'complete' 'cpt' string (default: ".,w,b,u,t,i")
2065 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 This option specifies how keyword completion |ins-completion| works
2067 when CTRL-P or CTRL-N are used. It is also used for whole-line
2068 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002069 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002070 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 w scan buffers from other windows
2072 b scan other loaded buffers that are in the buffer list
2073 u scan the unloaded buffers that are in the buffer list
2074 U scan the buffers that are not in the buffer list
2075 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002076 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 k{dict} scan the file {dict}. Several "k" flags can be given,
2078 patterns are valid too. For example: >
2079 :set cpt=k/usr/dict/*,k~/spanish
2080< s scan the files given with the 'thesaurus' option
2081 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2082 are valid too.
2083 i scan current and included files
2084 d scan current and included files for defined name or macro
2085 |i_CTRL-X_CTRL-D|
2086 ] tag completion
2087 t same as "]"
2088
2089 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2090 not executed, this may lead to unexpected completions from some files
2091 (gzipped files for example). Unloaded buffers are not scanned for
2092 whole-line completion.
2093
2094 The default is ".,w,b,u,t,i", which means to scan:
2095 1. the current buffer
2096 2. buffers in other windows
2097 3. other loaded buffers
2098 4. unloaded buffers
2099 5. tags
2100 6. included files
2101
2102 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002103 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2104 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002106 *'completefunc'* *'cfu'*
2107'completefunc' 'cfu' string (default: empty)
2108 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002109 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002110 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002111 This option specifies a function to be used for Insert mode completion
2112 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002113 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002114 invoked and what it should return. The value can be the name of a
2115 function, a |lambda| or a |Funcref|. See |option-value-function| for
2116 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002117 This option cannot be set from a |modeline| or in the |sandbox|, for
2118 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002119
glepnirf31cfa22025-03-06 21:59:13 +01002120 *'completefuzzycollect'* *'cfc'*
2121'completefuzzycollect' 'cfc' string (default: empty)
2122 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002123 A comma-separated list of strings to enable fuzzy collection for
2124 specific |ins-completion| modes, affecting how matches are gathered
2125 during completion. For specified modes, fuzzy matching is used to
2126 find completion candidates instead of the standard prefix-based
2127 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002128
glepnir58760162025-03-13 21:39:51 +01002129 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2130 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2131 "b", "u", "U" and "k{dict}" in 'complete'
2132 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002133
glepnir58760162025-03-13 21:39:51 +01002134 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002135
glepnir58760162025-03-13 21:39:51 +01002136 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002137
Christian Brabandtf22580e2025-03-14 12:05:52 +01002138 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002139 can identify the longest common string among the best fuzzy matches
2140 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002141
glepnir6a89c942024-10-01 20:32:12 +02002142 *'completeitemalign'* *'cia'*
2143'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2144 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002145 A comma-separated list of strings that controls the alignment and
2146 display order of items in the popup menu during Insert mode
2147 completion. The supported values are "abbr", "kind", and "menu".
2148 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002149 popup menu. Note: must always contain those three values in any
2150 order.
2151
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002152 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002153'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002154 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002155 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002156 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002157
glepnira2c55592025-02-28 17:43:42 +01002158 fuzzy Enable |fuzzy-matching| for completion candidates. This
2159 allows for more flexible and intuitive matching, where
2160 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002161 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002162 does not affect the collection of candidate list, it only
2163 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002164 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002165 to gather more alternatives for your candidate list,
2166 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002167
2168 longest Only insert the longest common text of the matches. If
2169 the menu is displayed you can use CTRL-L to add more
2170 characters. Whether case is ignored depends on the kind
2171 of completion. For buffer text the 'ignorecase' option is
2172 used.
2173
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002174 menu Use a popup menu to show the possible completions. The
2175 menu is only shown when there is more than one match and
2176 sufficient colors are available. |ins-completion-menu|
2177
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002178 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002179 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002180 match, e.g., what file it comes from.
2181
glepnira2c55592025-02-28 17:43:42 +01002182 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002183 a match from the menu. Only works in combination with
2184 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002185
glepnira2c55592025-02-28 17:43:42 +01002186 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002187 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002188 present, "noselect" has precedence.
2189
2190 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002191 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002192 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002193
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002194 popup Show extra information about the currently selected
2195 completion in a popup window. Only works in combination
2196 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002197 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002198 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002199
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002200 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002201 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002202 |CompleteChanged| autocommand to fetch the info and call
2203 |popup_show()| once the popup has been filled.
2204 See the example at |complete-popuphidden|.
2205 {only works when compiled with the |+textprop| feature}
2206
glepniredd4ac32025-01-29 18:53:51 +01002207 preinsert
2208 Preinsert the portion of the first candidate word that is
2209 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002210 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002211 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002212
2213 preview Show extra information about the currently selected
2214 completion in the preview window. Only works in
2215 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002216
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002217 *'completepopup'* *'cpp'*
2218'completepopup' 'cpp' string (default empty)
2219 global
2220 {not available when compiled without the |+textprop|
2221 or |+quickfix| feature}
2222 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002223 properties of the info popup when it is created. If an info popup
2224 window already exists it is closed, so that the option value is
2225 applied when it is created again.
2226 You can also use |popup_findinfo()| and then set properties for an
2227 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002228
laburnumT3f7855a2023-12-05 18:37:03 +01002229 *'completeslash'* *'csl'*
2230'completeslash' 'csl' string (default: "")
2231 local to buffer
2232 {only for MS-Windows}
2233 When this option is set it overrules 'shellslash' for completion:
2234 - When this option is set to "slash", a forward slash is used for path
2235 completion in insert mode. This is useful when editing HTML tag, or
2236 Makefile with 'noshellslash' on MS-Windows.
2237 - When this option is set to "backslash", backslash is used. This is
2238 useful when editing a batch file with 'shellslash' set on MS-Windows.
2239 - When this option is empty, same character is used as for
2240 'shellslash'.
2241 For Insert mode completion the buffer-local value is used. For
2242 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002243
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002244 *'concealcursor'* *'cocu'*
2245'concealcursor' 'cocu' string (default: "")
2246 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002247 {not available when compiled without the |+conceal|
2248 feature}
2249 Sets the modes in which text in the cursor line can also be concealed.
2250 When the current mode is listed then concealing happens just like in
2251 other lines.
2252 n Normal mode
2253 v Visual mode
2254 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002255 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002256
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002257 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002258 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002259 are moving around text is concealed, but when starting to insert text
2260 or selecting a Visual area the concealed text is displayed, so that
2261 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002262 Keep in mind that the cursor position is not always where it's
2263 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002264
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002265 *'conceallevel'* *'cole'*
2266'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002267 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002268 {not available when compiled without the |+conceal|
2269 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002270 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2271 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002272
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002273 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002274 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002275 1 Each block of concealed text is replaced with one
2276 character. If the syntax item does not have a custom
2277 replacement character defined (see |:syn-cchar|) the
2278 character defined in 'listchars' is used (default is a
2279 space).
2280 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002281 2 Concealed text is completely hidden unless it has a
2282 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002283 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002284 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002285
Bram Moolenaara7781e02010-07-19 20:13:22 +02002286 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002287 edit and copy the text. This can be changed with the 'concealcursor'
2288 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002289
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2291'confirm' 'cf' boolean (default off)
2292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 When 'confirm' is on, certain operations that would normally
2294 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2295 instead raise a |dialog| asking if you wish to save the current
2296 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2297 If 'confirm' is off you can still activate confirmation for one
2298 command only (this is most useful in mappings) with the |:confirm|
2299 command.
2300 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2301
2302 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2303'conskey' 'consk' boolean (default off)
2304 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002305 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306
2307 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2308'copyindent' 'ci' boolean (default off)
2309 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 Copy the structure of the existing lines indent when autoindenting a
2311 new line. Normally the new indent is reconstructed by a series of
2312 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2313 in which case only spaces are used). Enabling this option makes the
2314 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002315 existing line. 'expandtab' has no effect on these characters, a Tab
2316 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002318 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 Also see 'preserveindent'.
2320
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002321 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002322'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2323 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002324 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002327 this indicates Vi-compatible behavior. This is used for things where
2328 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 'cpoptions' stands for "compatible-options".
2330 Commas can be added for readability.
2331 To avoid problems with flags that are added in the future, use the
2332 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002333
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 NOTE: This option is set to the Vi default value when 'compatible' is
2335 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002336
2337 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2338 is saved, 'cpoptions' is set to the Vim default, and the saved value
2339 is restored at the end of the script. Changes to the value of
2340 'cpoptions' will be applied to the saved value, but keep in mind that
2341 removing a flag that is not present when 'cpoptions' is changed has no
2342 effect. In the |.vimrc| file the value is not restored, thus using
2343 `vim9script` in the |.vimrc| file results in using the Vim default.
2344
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 NOTE: This option is set to the POSIX default value at startup when
2346 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002347 variable exists |posix|. This means Vim tries to behave like the
2348 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349
2350 contains behavior ~
2351 *cpo-a*
2352 a When included, a ":read" command with a file name
2353 argument will set the alternate file name for the
2354 current window.
2355 *cpo-A*
2356 A When included, a ":write" command with a file name
2357 argument will set the alternate file name for the
2358 current window.
2359 *cpo-b*
2360 b "\|" in a ":map" command is recognized as the end of
2361 the map command. The '\' is included in the mapping,
2362 the text after the '|' is interpreted as the next
2363 command. Use a CTRL-V instead of a backslash to
2364 include the '|' in the mapping. Applies to all
2365 mapping, abbreviation, menu and autocmd commands.
2366 See also |map_bar|.
2367 *cpo-B*
2368 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002369 abbreviations, user commands and the "to" part of the
2370 menu commands. Remove this flag to be able to use a
2371 backslash like a CTRL-V. For example, the command
2372 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 'B' included: "\^[" (^[ is a real <Esc>)
2374 'B' excluded: "<Esc>" (5 characters)
2375 ('<' excluded in both cases)
2376 *cpo-c*
2377 c Searching continues at the end of any match at the
2378 cursor position, but not further than the start of the
2379 next line. When not present searching continues
2380 one character from the cursor position. With 'c'
2381 "abababababab" only gets three matches when repeating
2382 "/abab", without 'c' there are five matches.
2383 *cpo-C*
2384 C Do not concatenate sourced lines that start with a
2385 backslash. See |line-continuation|.
2386 *cpo-d*
2387 d Using "./" in the 'tags' option doesn't mean to use
2388 the tags file relative to the current file, but the
2389 tags file in the current directory.
2390 *cpo-D*
2391 D Can't use CTRL-K to enter a digraph after Normal mode
2392 commands with a character argument, like |r|, |f| and
2393 |t|.
2394 *cpo-e*
2395 e When executing a register with ":@r", always add a
2396 <CR> to the last line, also when the register is not
2397 linewise. If this flag is not present, the register
2398 is not linewise and the last line does not end in a
2399 <CR>, then the last line is put on the command-line
2400 and can be edited before hitting <CR>.
2401 *cpo-E*
2402 E It is an error when using "y", "d", "c", "g~", "gu" or
2403 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002404 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 This makes "y0" fail in the first column.
2406 *cpo-f*
2407 f When included, a ":read" command with a file name
2408 argument will set the file name for the current buffer,
2409 if the current buffer doesn't have a file name yet.
2410 *cpo-F*
2411 F When included, a ":write" command with a file name
2412 argument will set the file name for the current
2413 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002414 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *cpo-g*
2416 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002417 *cpo-H*
2418 H When using "I" on a line with only blanks, insert
2419 before the last blank. Without this flag insert after
2420 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421 *cpo-i*
2422 i When included, interrupting the reading of a file will
2423 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002424 *cpo-I*
2425 I When moving the cursor up or down just after inserting
2426 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 *cpo-j*
2428 j When joining lines, only add two spaces after a '.',
2429 not after '!' or '?'. Also see 'joinspaces'.
2430 *cpo-J*
2431 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002432 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 white space.
2434 *cpo-k*
2435 k Disable the recognition of raw key codes in
2436 mappings, abbreviations, and the "to" part of menu
2437 commands. For example, if <Key> sends ^[OA (where ^[
2438 is <Esc>), the command ":map X ^[OA" results in X
2439 being mapped to:
2440 'k' included: "^[OA" (3 characters)
2441 'k' excluded: "<Key>" (one key code)
2442 Also see the '<' flag below.
2443 *cpo-K*
2444 K Don't wait for a key code to complete when it is
2445 halfway a mapping. This breaks mapping <F1><F1> when
2446 only part of the second <F1> has been read. It
2447 enables cancelling the mapping by typing <F1><Esc>.
2448 *cpo-l*
2449 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002450 literally, only "\]", "\^", "\-" and "\\" are special.
2451 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2453 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002454 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 *cpo-L*
2456 L When the 'list' option is set, 'wrapmargin',
2457 'textwidth', 'softtabstop' and Virtual Replace mode
2458 (see |gR|) count a <Tab> as two characters, instead of
2459 the normal behavior of a <Tab>.
2460 *cpo-m*
2461 m When included, a showmatch will always wait half a
2462 second. When not included, a showmatch will wait half
2463 a second or until a character is typed. |'showmatch'|
2464 *cpo-M*
2465 M When excluded, "%" matching will take backslashes into
2466 account. Thus in "( \( )" and "\( ( \)" the outer
2467 parenthesis match. When included "%" ignores
2468 backslashes, which is Vi compatible.
2469 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002470 n When included, the column used for 'number' and
2471 'relativenumber' will also be used for text of wrapped
2472 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 *cpo-o*
2474 o Line offset to search command is not remembered for
2475 next search.
2476 *cpo-O*
2477 O Don't complain if a file is being overwritten, even
2478 when it didn't exist when editing it. This is a
2479 protection against a file unexpectedly created by
2480 someone else. Vi didn't complain about this.
2481 *cpo-p*
2482 p Vi compatible Lisp indenting. When not present, a
2483 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002484 *cpo-P*
2485 P When included, a ":write" command that appends to a
2486 file will set the file name for the current buffer, if
2487 the current buffer doesn't have a file name yet and
2488 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002489 *cpo-q*
2490 q When joining multiple lines leave the cursor at the
2491 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 *cpo-r*
2493 r Redo ("." command) uses "/" to repeat a search
2494 command, instead of the actually used search string.
2495 *cpo-R*
2496 R Remove marks from filtered lines. Without this flag
2497 marks are kept like |:keepmarks| was used.
2498 *cpo-s*
2499 s Set buffer options when entering the buffer for the
2500 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002501 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 set when the buffer is created.
2503 *cpo-S*
2504 S Set buffer options always when entering a buffer
2505 (except 'readonly', 'fileformat', 'filetype' and
2506 'syntax'). This is the (most) Vi compatible setting.
2507 The options are set to the values in the current
2508 buffer. When you change an option and go to another
2509 buffer, the value is copied. Effectively makes the
2510 buffer options global to all buffers.
2511
2512 's' 'S' copy buffer options
2513 no no when buffer created
2514 yes no when buffer first entered (default)
2515 X yes each time when buffer entered (vi comp.)
2516 *cpo-t*
2517 t Search pattern for the tag command is remembered for
2518 "n" command. Otherwise Vim only puts the pattern in
2519 the history for search pattern, but doesn't change the
2520 last used search pattern.
2521 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002522 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 *cpo-v*
2524 v Backspaced characters remain visible on the screen in
2525 Insert mode. Without this flag the characters are
2526 erased from the screen right away. With this flag the
2527 screen newly typed text overwrites backspaced
2528 characters.
2529 *cpo-w*
2530 w When using "cw" on a blank character, only change one
2531 character and not all blanks until the start of the
2532 next word.
2533 *cpo-W*
2534 W Don't overwrite a readonly file. When omitted, ":w!"
2535 overwrites a readonly file, if possible.
2536 *cpo-x*
2537 x <Esc> on the command-line executes the command-line.
2538 The default in Vim is to abandon the command-line,
2539 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002540 *cpo-X*
2541 X When using a count with "R" the replaced text is
2542 deleted only once. Also when repeating "R" with "."
2543 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002545 y A yank command can be redone with ".". Think twice if
2546 you really want to use this, it may break some
2547 plugins, since most people expect "." to only repeat a
2548 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002549 *cpo-Z*
2550 Z When using "w!" while the 'readonly' option is set,
2551 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002552 *cpo-z*
2553 z Special casing the "cw" and "d" command (see |cw| and
2554 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 *cpo-!*
2556 ! When redoing a filter command, use the last used
2557 external command, whatever it was. Otherwise the last
2558 used -filter- command is used.
2559 *cpo-$*
2560 $ When making a change to one line, don't redisplay the
2561 line, but put a '$' at the end of the changed text.
2562 The changed text will be overwritten when you type the
2563 new text. The line is redisplayed if you type any
2564 command that moves the cursor from the insertion
2565 point.
2566 *cpo-%*
2567 % Vi-compatible matching is done for the "%" command.
2568 Does not recognize "#if", "#endif", etc.
2569 Does not recognize "/*" and "*/".
2570 Parens inside single and double quotes are also
2571 counted, causing a string that contains a paren to
2572 disturb the matching. For example, in a line like
2573 "if (strcmp("foo(", s))" the first paren does not
2574 match the last one. When this flag is not included,
2575 parens inside single and double quotes are treated
2576 specially. When matching a paren outside of quotes,
2577 everything inside quotes is ignored. When matching a
2578 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002579 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002580 This flag is also used for other features, such as
2581 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002582 *cpo--*
2583 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002584 it would go above the first line or below the last
2585 line. Without it the cursor moves to the first or
2586 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002587 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002588 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002589 *cpo-+*
2590 + When included, a ":write file" command will reset the
2591 'modified' flag of the buffer, even though the buffer
2592 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002593 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 * Use ":*" in the same way as ":@". When not included,
2595 ":*" is an alias for ":'<,'>", select the Visual area.
2596 *cpo-<*
2597 < Disable the recognition of special key codes in |<>|
2598 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 ":map X <Tab>" results in X being mapped to:
2601 '<' included: "<Tab>" (5 characters)
2602 '<' excluded: "^I" (^I is a real <Tab>)
2603 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002604 *cpo->*
2605 > When appending to a register, put a line break before
2606 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002607 *cpo-;*
2608 ; When using |,| or |;| to repeat the last |t| search
2609 and the cursor is right in front of the searched
2610 character, the cursor won't move. When not included,
2611 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002612 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002613
2614 POSIX flags. These are not included in the Vi default value, except
2615 when $VIM_POSIX was set on startup. |posix|
2616
2617 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002618 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002619 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002620 *cpo-&*
2621 & When ":preserve" was used keep the swap file when
2622 exiting normally while this buffer is still loaded.
2623 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002624 *cpo-\*
2625 \ Backslash in a [] range in a search pattern is taken
2626 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002627 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2628 '\' excluded: "/[ \-]" finds <Space> and '-'
2629 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002630 *cpo-/*
2631 / When "%" is used as the replacement string in a |:s|
2632 command, use the previous replacement string. |:s%|
2633 *cpo-{*
2634 { The |{| and |}| commands also stop at a "{" character
2635 at the start of a line.
2636 *cpo-.*
2637 . The ":chdir" and ":cd" commands fail if the current
2638 buffer is modified, unless ! is used. Vim doesn't
2639 need this, since it remembers the full path of an
2640 opened file.
2641 *cpo-bar*
2642 | The value of the $LINES and $COLUMNS environment
2643 variables overrule the terminal size values obtained
2644 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002645
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002646 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002647'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002648 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002649 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002650 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002651 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002652 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002653 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002654 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002655 blowfish Blowfish method. Medium strong encryption but it has
2656 an implementation flaw. Requires Vim 7.3 or later,
2657 files can NOT be read by Vim 7.2 and older. This adds
2658 a "seed" to the file, every time you write the file
2659 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002660 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002661 *blowfish2*
2662 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002663 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002664 and older. This adds a "seed" to the file, every time
2665 you write the file the encrypted bytes will be
2666 different. The whole undo file is encrypted, not just
2667 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002668 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002669 *E1197* *E1198* *E1199* *E1200* *E1201*
2670 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002671 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002672 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002673 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002674 It adds a seed and a message authentication code (MAC)
2675 to the file. This needs at least a Vim 8.2.3022 to
2676 read the encrypted file.
2677 Encryption of swap files is not supported, therefore
2678 no swap file will be used when xchacha20 encryption is
2679 enabled.
2680 Encryption of undo files is not yet supported,
2681 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002682 CAREFUL: Files written with this method might have to
2683 be read back with the same version of Vim if the
2684 binary format changes later.
2685 Obsolete, please do no longer use.
2686 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2687 stores the key derivation parameters together with the
2688 encrypted file. Should work better in case the
2689 parameters in the libsodium library ever change.
2690 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002691 might have to be read back with the same version of
2692 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002693
Christian Brabandtaae58342023-04-23 17:50:22 +01002694 You should use "blowfish2", also to re-encrypt older files. The
2695 "xchacha20" method provides better encryption, but it does not work
2696 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002697
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002698 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002699 to the detected method of the file being read. Thus if you write it
2700 without changing 'cryptmethod' the same method will be used.
2701 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002702 explicitly write it, you don't get a warning unless there are other
2703 modifications. Also see |:X|.
2704
2705 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002706 the value "blowfish2". When setting the local value to an empty
2707 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002708
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002709 When a new encryption method is added in a later version of Vim, and
2710 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002711 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002712
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 *'cscopepathcomp'* *'cspc'*
2714'cscopepathcomp' 'cspc' number (default 0)
2715 global
2716 {not available when compiled without the |+cscope|
2717 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 Determines how many components of the path to show in a list of tags.
2719 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002720 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721
2722 *'cscopeprg'* *'csprg'*
2723'cscopeprg' 'csprg' string (default "cscope")
2724 global
2725 {not available when compiled without the |+cscope|
2726 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 Specifies the command to execute cscope. See |cscopeprg|.
2728 This option cannot be set from a |modeline| or in the |sandbox|, for
2729 security reasons.
2730
2731 *'cscopequickfix'* *'csqf'*
2732'cscopequickfix' 'csqf' string (default "")
2733 global
2734 {not available when compiled without the |+cscope|
2735 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 Specifies whether to use quickfix window to show cscope results.
2737 See |cscopequickfix|.
2738
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002739 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002740'cscoperelative' 'csre' boolean (default off)
2741 global
2742 {not available when compiled without the |+cscope|
2743 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002744 In the absence of a prefix (-P) for cscope. setting this option enables
2745 to use the basename of cscope.out path as the prefix.
2746 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002747 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002748
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2750'cscopetag' 'cst' boolean (default off)
2751 global
2752 {not available when compiled without the |+cscope|
2753 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 Use cscope for tag commands. See |cscope-options|.
2755 NOTE: This option is reset when 'compatible' is set.
2756
2757 *'cscopetagorder'* *'csto'*
2758'cscopetagorder' 'csto' number (default 0)
2759 global
2760 {not available when compiled without the |+cscope|
2761 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 Determines the order in which ":cstag" performs a search. See
2763 |cscopetagorder|.
2764 NOTE: This option is set to 0 when 'compatible' is set.
2765
2766 *'cscopeverbose'* *'csverb'*
2767 *'nocscopeverbose'* *'nocsverb'*
2768'cscopeverbose' 'csverb' boolean (default off)
2769 global
2770 {not available when compiled without the |+cscope|
2771 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 Give messages when adding a cscope database. See |cscopeverbose|.
2773 NOTE: This option is reset when 'compatible' is set.
2774
Bram Moolenaar860cae12010-06-05 23:22:07 +02002775 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2776'cursorbind' 'crb' boolean (default off)
2777 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002778 When this option is set, as the cursor in the current
2779 window moves other cursorbound windows (windows that also have
2780 this option set) move their cursors to the corresponding line and
2781 column. This option is useful for viewing the
2782 differences between two versions of a file (see 'diff'); in diff mode,
2783 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002784 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002785
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002786 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2787'cursorcolumn' 'cuc' boolean (default off)
2788 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002789 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002790 feature}
2791 Highlight the screen column of the cursor with CursorColumn
2792 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2793 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002794 If you only want the highlighting in the current window you can use
2795 these autocommands: >
2796 au WinLeave * set nocursorline nocursorcolumn
2797 au WinEnter * set cursorline cursorcolumn
2798<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002799
2800 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2801'cursorline' 'cul' boolean (default off)
2802 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002803 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002804 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002805 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2806 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002807 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002808 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002809
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002810 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002811'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002812 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002813 {not available when compiled without the |+syntax|
2814 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002815 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002816 Valid values:
2817 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002818 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002819 "screenline" Highlight only the screen line of the cursor with
2820 CursorLine |hl-CursorLine|.
2821 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002822 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002823
2824 Special value:
2825 "both" Alias for the values "line,number".
2826
2827 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002828
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 *'debug'*
2830'debug' string (default "")
2831 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002832 These values can be used:
2833 msg Error messages that would otherwise be omitted will be given
2834 anyway.
2835 throw Error messages that would otherwise be omitted will be given
2836 anyway and also throw an exception and set |v:errmsg|.
2837 beep A message will be given when otherwise only a beep would be
2838 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002839 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002840 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2841 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
2843 *'define'* *'def'*
2844'define' 'def' string (default "^\s*#\s*define")
2845 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002846 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 pattern, just like for the "/" command. This option is used for the
2848 commands like "[i" and "[d" |include-search|. The 'isident' option is
2849 used to recognize the defined name after the match:
2850 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2851 See |option-backslash| about inserting backslashes to include a space
2852 or backslash.
2853 The default value is for C programs. For C++ this value would be
2854 useful, to include const type declarations: >
2855 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002856< You can also use "\ze" just before the name and continue the pattern
2857 to check what is following. E.g. for Javascript, if a function is
2858 defined with "func_name = function(args)": >
2859 ^\s*\ze\i\+\s*=\s*function(
2860< If the function is defined with "func_name : function() {...": >
2861 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002863 To avoid that use `:let` with a single quote string: >
2864 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002865<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866
2867 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2868'delcombine' 'deco' boolean (default off)
2869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 If editing Unicode and this option is set, backspace and Normal mode
2871 "x" delete each combining character on its own. When it is off (the
2872 default) the character along with its combining characters are
2873 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002874 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875
2876 This is useful for Arabic, Hebrew and many other languages where one
2877 may have combining characters overtop of base characters, and want
2878 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880
2881 *'dictionary'* *'dict'*
2882'dictionary' 'dict' string (default "")
2883 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 List of file names, separated by commas, that are used to lookup words
2885 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2886 contain a list of words. This can be one word per line, or several
2887 words per line, separated by non-keyword characters (white space is
2888 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002889
2890 When this option is empty or an entry "spell" is present, and spell
2891 checking is enabled, words in the word lists for the currently active
2892 'spelllang' are used. See |spell|.
2893
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002894 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 after a comma are ignored, otherwise spaces are included in the file
2896 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002897 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 Where to find a list of words?
2899 - On FreeBSD, there is the file "/usr/share/dict/words".
2900 - In the Simtel archive, look in the "msdos/linguist" directory.
2901 - In "miscfiles" of the GNU collection.
2902 The use of |:set+=| and |:set-=| is preferred when adding or removing
2903 directories from the list. This avoids problems when a future version
2904 uses another default.
2905 Backticks cannot be used in this option for security reasons.
2906
2907 *'diff'* *'nodiff'*
2908'diff' boolean (default off)
2909 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 {not available when compiled without the |+diff|
2911 feature}
2912 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914
2915 *'dex'* *'diffexpr'*
2916'diffexpr' 'dex' string (default "")
2917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 {not available when compiled without the |+diff|
2919 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002920 Expression which is evaluated to obtain a diff file (either ed-style
2921 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 This option cannot be set from a |modeline| or in the |sandbox|, for
2923 security reasons.
2924
2925 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002926'diffopt' 'dip' string (default
2927 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 {not available when compiled without the |+diff|
2930 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002931 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 All are optional. Items must be separated by a comma.
2933
Jonathon7c7a4e62025-01-12 09:58:00 +01002934 algorithm:{text} Use the specified diff algorithm with the
2935 internal diff engine. Currently supported
2936 algorithms are:
2937 myers the default algorithm
2938 minimal spend extra time to generate the
2939 smallest possible diff
2940 patience patience diff algorithm
2941 histogram histogram diff algorithm
2942
2943 closeoff When a window is closed where 'diff' is set
2944 and there is only one window remaining in the
2945 same tab page with 'diff' set, execute
2946 `:diffoff` in that window. This undoes a
2947 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948
2949 context:{n} Use a context of {n} lines between a change
2950 and a fold that contains unchanged lines.
2951 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002952 When using zero the context is actually one,
2953 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002954 for a deleted line. Set it to a very large
2955 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 See |fold-diff|.
2957
Jonathon7c7a4e62025-01-12 09:58:00 +01002958 filler Show filler lines, to keep the text
2959 synchronized with a window that has inserted
2960 lines at the same position. Mostly useful
2961 when windows are side-by-side and 'scrollbind'
2962 is set.
2963
2964 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2965 starting diff mode. Without this 2 is used.
2966
2967 followwrap Follow the 'wrap' option and leave as it is.
2968
2969 horizontal Start diff mode with horizontal splits (unless
2970 explicitly specified otherwise).
2971
2972 hiddenoff Do not use diff mode for a buffer when it
2973 becomes hidden.
2974
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002975 iblank Ignore changes where lines are all blank. Adds
2976 the "-B" flag to the "diff" command if
2977 'diffexpr' is empty. Check the documentation
2978 of the "diff" command for what this does
2979 exactly.
2980 NOTE: the diff windows will get out of sync,
2981 because no differences between blank lines are
2982 taken into account.
2983
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 icase Ignore changes in case of text. "a" and "A"
2985 are considered the same. Adds the "-i" flag
2986 to the "diff" command if 'diffexpr' is empty.
2987
Jonathon7c7a4e62025-01-12 09:58:00 +01002988 indent-heuristic
2989 Use the indent heuristic for the internal
2990 diff library.
2991
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002992 inline:{text} Highlight inline differences within a change.
2993 See |view-diffs|. Supported values are:
2994
2995 none Do not perform inline highlighting.
2996 simple Highlight from first different
2997 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01002998 line. This is the default if no
2999 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003000 char Use internal diff to perform a
3001 character-wise diff and highlight the
3002 difference.
3003 word Use internal diff to perform a
3004 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003005 difference. Non-alphanumeric
3006 multi-byte characters such as emoji
3007 and CJK characters are considered
3008 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003009
Jonathon7c7a4e62025-01-12 09:58:00 +01003010 internal Use the internal diff library. This is
3011 ignored when 'diffexpr' is set. *E960*
3012 When running out of memory when writing a
3013 buffer this item will be ignored for diffs
3014 involving that buffer. Set the 'verbose'
3015 option to see when this happens.
3016
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 iwhite Ignore changes in amount of white space. Adds
3018 the "-b" flag to the "diff" command if
3019 'diffexpr' is empty. Check the documentation
3020 of the "diff" command for what this does
3021 exactly. It should ignore adding trailing
3022 white space, but not leading white space.
3023
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003024 iwhiteall Ignore all white space changes. Adds
3025 the "-w" flag to the "diff" command if
3026 'diffexpr' is empty. Check the documentation
3027 of the "diff" command for what this does
3028 exactly.
3029
3030 iwhiteeol Ignore white space changes at end of line.
3031 Adds the "-Z" flag to the "diff" command if
3032 'diffexpr' is empty. Check the documentation
3033 of the "diff" command for what this does
3034 exactly.
3035
Jonathon7c7a4e62025-01-12 09:58:00 +01003036 linematch:{n} Align and mark changes between the most
3037 similar lines between the buffers. When the
3038 total number of lines in the diff hunk exceeds
3039 {n}, the lines will not be aligned because for
3040 very large diff hunks there will be a
3041 noticeable lag. A reasonable setting is
3042 "linematch:60", as this will enable alignment
3043 for a 2 buffer diff hunk of 30 lines each,
3044 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003045
3046 vertical Start diff mode with vertical splits (unless
3047 explicitly specified otherwise).
3048
Bram Moolenaare828b762018-09-10 17:51:58 +02003049 Examples: >
3050 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003052 :set diffopt=internal,filler,foldcolumn:3
3053 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054<
3055 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3056'digraph' 'dg' boolean (default off)
3057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 {not available when compiled without the |+digraphs|
3059 feature}
3060 Enable the entering of digraphs in Insert mode with {char1} <BS>
3061 {char2}. See |digraphs|.
3062 NOTE: This option is reset when 'compatible' is set.
3063
3064 *'directory'* *'dir'*
3065'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003066 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 for Unix: ".,~/tmp,/var/tmp,/tmp")
3068 global
3069 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003070 Recommended value: ".,~/vimswap//" - this will put the swap file next
3071 to the edited file if possible, and in your personal swap directory
3072 otherwise. Make sure "~/vimswap//" is only readable for you.
3073
3074 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 - The swap file will be created in the first directory where this is
3076 possible.
3077 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003078 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 - A directory "." means to put the swap file in the same directory as
3080 the edited file. On Unix, a dot is prepended to the file name, so
3081 it doesn't show in a directory listing. On MS-Windows the "hidden"
3082 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003083 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3084 the swap file relative to where the edited file is. The leading "."
3085 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003086 - For Unix and Win32, if a directory ends in two path separators "//",
3087 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003088 with all path separators replaced by percent '%' signs (including
3089 the colon following the drive letter on Win32). This will ensure
3090 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003091 On Win32, it is also possible to end with "\\". However, When a
3092 separating comma is following, you must use "//", since "\\" will
3093 include the comma in the file name. Therefore it is recommended to
3094 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 - Spaces after the comma are ignored, other spaces are considered part
3096 of the directory name. To have a space at the start of a directory
3097 name, precede it with a backslash.
3098 - To include a comma in a directory name precede it with a backslash.
3099 - A directory name may end in an ':' or '/'.
3100 - Environment variables are expanded |:set_env|.
3101 - Careful with '\' characters, type one before a space, type two to
3102 get one in the option (see |option-backslash|), for example: >
3103 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3104< - For backwards compatibility with Vim version 3.0 a '>' at the start
3105 of the option is removed.
3106 Using "." first in the list is recommended. This means that editing
3107 the same file twice will result in a warning. Using "/tmp" on Unix is
3108 discouraged: When the system crashes you lose the swap file.
3109 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003110 choice than "/tmp". But others on the computer may be able to see the
3111 files, and it can contain a lot of files, your swap files get lost in
3112 the crowd. That is why a "tmp" directory in your home directory is
3113 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 The use of |:set+=| and |:set-=| is preferred when adding or removing
3115 directories from the list. This avoids problems when a future version
3116 uses another default.
3117 This option cannot be set from a |modeline| or in the |sandbox|, for
3118 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119
3120 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003121'display' 'dy' string (default "", set to "truncate" in
3122 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003124 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 flags:
3126 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003127 in a window will be displayed. "@@@" is put in the
3128 last columns of the last screen line to indicate the
3129 rest of the line is not displayed.
3130 truncate Like "lastline", but "@@@" is displayed in the first
3131 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 uhex Show unprintable characters hexadecimal as <xx>
3133 instead of using ^C and ~C.
3134
Bram Moolenaard0796902016-09-16 20:02:31 +02003135 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003136 doesn't fit is replaced with "@" lines.
3137
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003138 The "@" character can be changed by setting the "lastline" item in
3139 'fillchars'. The character is highlighted with |hl-NonText|.
3140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 *'eadirection'* *'ead'*
3142'eadirection' 'ead' string (default "both")
3143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 Tells when the 'equalalways' option applies:
3145 ver vertically, width of windows is not affected
3146 hor horizontally, height of windows is not affected
3147 both width and height of windows is affected
3148
3149 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3150'edcompatible' 'ed' boolean (default off)
3151 global
3152 Makes the 'g' and 'c' flags of the ":substitute" command to be
3153 toggled each time the flag is given. See |complex-change|. See
3154 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003155 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003156 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157
Bram Moolenaar03413f42016-04-12 21:07:15 +02003158 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003159'emoji' 'emo' boolean (default: on)
3160 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003161 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003162 This excludes "text emoji" characters, which are normally displayed as
3163 single width. Unfortunately there is no good specification for this
3164 and it has been determined on trial-and-error basis. Use the
3165 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003168'encoding' 'enc' string (default for MS-Windows: "utf-8",
3169 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 Sets the character encoding used inside Vim. It applies to text in
3172 the buffers, registers, Strings in expressions, text stored in the
3173 viminfo file, etc. It sets the kind of characters which Vim can work
3174 with. See |encoding-names| for the possible values.
3175
3176 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003177 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003179 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180
Bram Moolenaar865242e2010-07-14 21:12:05 +02003181 This option cannot be set from a |modeline|. It would most likely
3182 corrupt the text.
3183
Bram Moolenaar3df01732017-02-17 22:47:16 +01003184 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3185 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 'encoding', "utf-8" is the natural choice for the environment and
3187 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003188 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 versions, and to avoid changing the encoding of newly created files
3190 without your knowledge (in case 'fileencodings' is empty).
3191
3192 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003193 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 iconv() or as specified with 'charconvert'.
3195
Bram Moolenaar207f0092020-08-30 17:20:20 +02003196 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003197 can use: >
3198 if has("multi_byte_encoding")
3199<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 Normally 'encoding' will be equal to your current locale. This will
3201 be the default if Vim recognizes your environment settings. If
3202 'encoding' is not set to the current locale, 'termencoding' must be
3203 set to convert typed and displayed text. See |encoding-table|.
3204
3205 When you set this option, it fires the |EncodingChanged| autocommand
3206 event so that you can set up fonts if necessary.
3207
3208 When the option is set, the value is converted to lowercase. Thus
3209 you can set it with uppercase values too. Underscores are translated
3210 to '-' signs.
3211 When the encoding is recognized, it is changed to the standard name.
3212 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3213 "iso-8859-2" and "utf8" becomes "utf-8".
3214
3215 Note: "latin1" is also used when the encoding could not be detected.
3216 This only works when editing files in the same encoding! When the
3217 actual character set is not latin1, make sure 'fileencoding' and
3218 'fileencodings' are empty. When conversion is needed, switch to using
3219 utf-8.
3220
3221 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3222 You don't notice this while editing, but it does matter for the
3223 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3224 setting 'encoding' to one of these values instead of utf-8 only has
3225 effect for encoding used for files when 'fileencoding' is empty.
3226
Bram Moolenaar661b1822005-07-28 22:36:45 +00003227 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3228 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003230 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003231'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003233 Indicates that a CTRL-Z character was found at the end of the file
3234 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003236 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003237 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003238 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003239
3240 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3241'endofline' 'eol' boolean (default on)
3242 local to buffer
3243 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003244 is on, or 'fixeol' option is off, no <EOL> will be written for the
3245 last line in the file. This option is automatically set or reset when
3246 starting to edit a new file, depending on whether file has an <EOL>
3247 for the last line in the file. Normally you don't have to set or
3248 reset this option.
3249 When 'binary' is off and 'fixeol' is on the value is not used when
3250 writing the file. When 'binary' is on or 'fixeol' is off it is used
3251 to remember the presence of a <EOL> for the last line in the file, so
3252 that when you write the file the situation from the original file can
3253 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003254 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255
3256 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3257'equalalways' 'ea' boolean (default on)
3258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003260 splitting or closing a window. This also happens the moment the
3261 option is switched on. When off, splitting a window will reduce the
3262 size of the current window and leave the other windows the same. When
3263 closing a window the extra lines are given to the window next to it
3264 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 When mixing vertically and horizontally split windows, a minimal size
3266 is computed and some windows may be larger if there is room. The
3267 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003268 Changing the height and width of a window can be avoided by setting
3269 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003270 If a window size is specified when creating a new window sizes are
3271 currently not equalized (it's complicated, but may be implemented in
3272 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273
3274 *'equalprg'* *'ep'*
3275'equalprg' 'ep' string (default "")
3276 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003278 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003279 or 'indentexpr'. When Vim was compiled without internal formatting,
3280 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003281 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 about including spaces and backslashes.
3283 This option cannot be set from a |modeline| or in the |sandbox|, for
3284 security reasons.
3285
3286 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3287'errorbells' 'eb' boolean (default off)
3288 global
3289 Ring the bell (beep or screen flash) for error messages. This only
3290 makes a difference for error messages, the bell will be used always
3291 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003292 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003293 screen flash or do nothing. See 'belloff' to finetune when to ring the
3294 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 *'errorfile'* *'ef'*
3297'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3298 others: "errors.err")
3299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 {not available when compiled without the |+quickfix|
3301 feature}
3302 Name of the errorfile for the QuickFix mode (see |:cf|).
3303 When the "-q" command-line argument is used, 'errorfile' is set to the
3304 following argument. See |-q|.
3305 NOT used for the ":make" command. See 'makeef' for that.
3306 Environment variables are expanded |:set_env|.
3307 See |option-backslash| about including spaces and backslashes.
3308 This option cannot be set from a |modeline| or in the |sandbox|, for
3309 security reasons.
3310
3311 *'errorformat'* *'efm'*
3312'errorformat' 'efm' string (default is very long)
3313 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 {not available when compiled without the |+quickfix|
3315 feature}
3316 Scanf-like description of the format for the lines in the error file
3317 (see |errorformat|).
3318
3319 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3320'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 Function keys that start with an <Esc> are recognized in Insert
3323 mode. When this option is off, the cursor and function keys cannot be
3324 used in Insert mode if they start with an <Esc>. The advantage of
3325 this is that the single <Esc> is recognized immediately, instead of
3326 after one second. Instead of resetting this option, you might want to
3327 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3328 when 'esckeys' is off, you can still map anything, but the cursor keys
3329 won't work by default.
3330 NOTE: This option is set to the Vi default value when 'compatible' is
3331 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003332 NOTE: when this option is off then the |modifyOtherKeys| and
3333 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3334 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335
3336 *'eventignore'* *'ei'*
3337'eventignore' 'ei' string (default "")
3338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003340 When set to "all" or when "all" is one of the items, all autocommand
3341 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003342 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 :set ei=WinEnter,WinLeave
3344<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003345 *'eventignorewin'* *'eiw'*
3346'eventignorewin' 'eiw' string (default "")
3347 window-local
3348 Similar to 'eventignore' but applies to a particular window and its
3349 buffers, for which window and buffer related autocommands can be
3350 ignored indefinitely without affecting the global 'eventignore'.
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3353'expandtab' 'et' boolean (default off)
3354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003356 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3358 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003359 This option is reset when the 'paste' option is set and restored when
3360 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 NOTE: This option is reset when 'compatible' is set.
3362
3363 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3364'exrc' 'ex' boolean (default off)
3365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003367 directory.
3368
3369 Setting this option is a potential security leak. E.g., consider
3370 unpacking a package or fetching files from github, a .vimrc in there
3371 might be a trojan horse. BETTER NOT SET THIS OPTION!
3372 Instead, define an autocommand in your .vimrc to set options for a
3373 matching directory.
3374
3375 If you do switch this option on you should also consider setting the
3376 'secure' option (see |initialization|).
3377 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 This option cannot be set from a |modeline| or in the |sandbox|, for
3379 security reasons.
3380
3381 *'fileencoding'* *'fenc'* *E213*
3382'fileencoding' 'fenc' string (default: "")
3383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003385
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003387 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 When 'fileencoding' is empty, the same value as 'encoding' will be
3389 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003390 No error will be given when the value is set, only when it is used,
3391 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003392 Conversion will also be done when 'encoding' and 'fileencoding' are
3393 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3394 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003396 'encoding' is "utf-8" or another Unicode encoding, conversion
3397 is most likely done in a way that the reverse conversion
3398 results in the same text. When 'encoding' is not "utf-8" some
3399 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003400
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 See 'encoding' for the possible values. Additionally, values may be
3402 specified that can be handled by the converter, see
3403 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003404
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 When reading a file 'fileencoding' will be set from 'fileencodings'.
3406 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003407 'fileencoding', use the |++enc| argument. One exception: when
3408 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003409 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003410
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3412 When the option is set, the value is converted to lowercase. Thus
3413 you can set it with uppercase values too. '_' characters are
3414 replaced with '-'. If a name is recognized from the list for
3415 'encoding', it is replaced by the standard name. For example
3416 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 When this option is set, after starting to edit a file, the 'modified'
3419 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003420
3421 Keep in mind that changing 'fenc' from a modeline happens
3422 AFTER the text has been read, thus it applies to when the file will be
3423 written. If you do set 'fenc' in a modeline, you might want to set
3424 'nomodified' to avoid not being able to ":q".
3425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 This option can not be changed when 'modifiable' is off.
3427
3428 *'fe'*
3429 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003430 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 old short name was 'fe', which is no longer used.
3432
3433 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003434'fileencodings' 'fencs' string (default: "ucs-bom",
3435 "ucs-bom,utf-8,default,latin1" when
3436 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 This is a list of character encodings considered when starting to edit
3439 an existing file. When a file is read, Vim tries to use the first
3440 mentioned character encoding. If an error is detected, the next one
3441 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003442 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 an empty string, which means the value of 'encoding' is used.
3444 WARNING: Conversion can cause loss of information! When
3445 'encoding' is "utf-8" (or one of the other Unicode variants)
3446 conversion is most likely done in a way that the reverse
3447 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003448 "utf-8" some non-ASCII characters may be lost! You can use
3449 the |++bad| argument to specify what is done with characters
3450 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 For an empty file or a file with only ASCII characters most encodings
3452 will work and the first entry of 'fileencodings' will be used (except
3453 "ucs-bom", which requires the BOM to be present). If you prefer
3454 another encoding use an BufReadPost autocommand event to test if your
3455 preferred encoding is to be used. Example: >
3456 au BufReadPost * if search('\S', 'w') == 0 |
3457 \ set fenc=iso-2022-jp | endif
3458< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3459 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003460 When the |++enc| argument is used then the value of 'fileencodings' is
3461 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003462 Note that 'fileencodings' is not used for a new file, the global value
3463 of 'fileencoding' is used instead. You can set it with: >
3464 :setglobal fenc=iso-8859-2
3465< This means that a non-existing file may get a different encoding than
3466 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 The special value "ucs-bom" can be used to check for a Unicode BOM
3468 (Byte Order Mark) at the start of the file. It must not be preceded
3469 by "utf-8" or another Unicode encoding for this to work properly.
3470 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3471 because Vim cannot detect an error, thus the encoding is always
3472 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003473 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003474 environment. On MS-Windows this is the system encoding. Otherwise
3475 this is the default value for 'encoding'. It is useful when
3476 'encoding' is set to "utf-8" and your environment uses a non-latin1
3477 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003478 When 'encoding' is "utf-8" and a file contains an illegal byte
3479 sequence it won't be recognized as UTF-8. You can use the |8g8|
3480 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 WRONG VALUES: WHAT'S WRONG:
3482 latin1,utf-8 "latin1" will always be used
3483 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3484 file
3485 cp1250,latin1 "cp1250" will always be used
3486 If 'fileencodings' is empty, 'fileencoding' is not modified.
3487 See 'fileencoding' for the possible values.
3488 Setting this option does not have an effect until the next time a file
3489 is read.
3490
3491 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003492'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003493 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 This gives the <EOL> of the current buffer, which is used for
3496 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003497 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 unix <NL>
3499 mac <CR>
3500 When "dos" is used, CTRL-Z at the end of a file is ignored.
3501 See |file-formats| and |file-read|.
3502 For the character encoding of the file see 'fileencoding'.
3503 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003504 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 This option is set automatically when starting to edit a file and
3506 'fileformats' is not empty and 'binary' is off.
3507 When this option is set, after starting to edit a file, the 'modified'
3508 option is set, because the file would be different when written.
3509 This option can not be changed when 'modifiable' is off.
3510 For backwards compatibility: When this option is set to "dos",
3511 'textmode' is set, otherwise 'textmode' is reset.
3512
3513 *'fileformats'* *'ffs'*
3514'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003515 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003516 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 Vi Cygwin: "unix,dos",
3518 Vi others: "")
3519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 This gives the end-of-line (<EOL>) formats that will be tried when
3521 starting to edit a new buffer and when reading a file into an existing
3522 buffer:
3523 - When empty, the format defined with 'fileformat' will be used
3524 always. It is not set automatically.
3525 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003526 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 'fileformats' name will be used when a file is read into an existing
3528 buffer, no matter what 'fileformat' for that buffer is set to.
3529 - When more than one name is present, separated by commas, automatic
3530 <EOL> detection will be done when reading a file. When starting to
3531 edit a file, a check is done for the <EOL>:
3532 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3533 'fileformat' is set to "dos".
3534 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003535 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003537 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3538 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003539 This means that "mac" is only chosen when:
3540 "unix" is not present or no <NL> is found in the file, and
3541 "dos" is not present or no <CR><NL> is found in the file.
3542 Except: if "unix" was chosen, but there is a <CR> before
3543 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003544 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 4. If 'fileformat' is still not set, the first name from
3546 'fileformats' is used.
3547 When reading a file into an existing buffer, the same is done, but
3548 this happens like 'fileformat' has been set appropriately for that
3549 file only, the option is not changed.
3550 When 'binary' is set, the value of 'fileformats' is not used.
3551
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003552 When Vim starts up with an empty buffer the first item is used. You
3553 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003554
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3556 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3557 done:
3558 - When 'fileformats' is empty, there is no automatic detection. Dos
3559 format will be used.
3560 - When 'fileformats' is set to one or more names, automatic detection
3561 is done. This is based on the first <NL> in the file: If there is a
3562 <CR> in front of it, Dos format is used, otherwise Unix format is
3563 used.
3564 Also see |file-formats|.
3565 For backwards compatibility: When this option is set to an empty
3566 string or one format (no comma is included), 'textauto' is reset,
3567 otherwise 'textauto' is set.
3568 NOTE: This option is set to the Vi default value when 'compatible' is
3569 set and to the Vim default value when 'compatible' is reset.
3570
Bram Moolenaarbf884932013-04-05 22:26:15 +02003571 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3572'fileignorecase' 'fic' boolean (default on for systems where case in file
3573 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003574 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003575 When set case is ignored when using file names and directories.
3576 See 'wildignorecase' for only ignoring case when doing completion.
3577
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 *'filetype'* *'ft'*
3579'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003580 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 When this option is set, the FileType autocommand event is triggered.
3582 All autocommands that match with the value of this option will be
3583 executed. Thus the value of 'filetype' is used in place of the file
3584 name.
3585 Otherwise this option does not always reflect the current file type.
3586 This option is normally set when the file type is detected. To enable
3587 this use the ":filetype on" command. |:filetype|
3588 Setting this option to a different value is most useful in a modeline,
3589 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003590 Example, for in an IDL file:
3591 /* vim: set filetype=idl : */ ~
3592 |FileType| |filetypes|
3593 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003594 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003595 /* vim: set filetype=c.doxygen : */ ~
3596 This will use the "c" filetype first, then the "doxygen" filetype.
3597 This works both for filetype plugins and for syntax files. More than
3598 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 This option is not copied to another buffer, independent of the 's' or
3600 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003601 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602
3603 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003604'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003605 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003606 Characters to fill the statuslines, vertical separators, special
3607 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003608 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003609 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003611 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003612 stl ' ' statusline of the current window
3613 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003614 vert '|' vertical separators |:vsplit|
3615 fold '-' filling 'foldtext'
3616 foldopen '-' mark the beginning of a fold
3617 foldclose '+' show a closed fold
3618 foldsep '|' open fold middle character
3619 diff '-' deleted lines of the 'diff' option
3620 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003621 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003622 trunc '>' truncated text in the
3623 |ins-completion-menu|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003625 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626
3627 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003628 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3629<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003630 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3631 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003632 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003633
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003635 item name highlight group ~
3636 stl StatusLine |hl-StatusLine|
3637 stlnc StatusLineNC |hl-StatusLineNC|
3638 vert VertSplit |hl-VertSplit|
3639 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003640 foldopen FoldColumn |hl-FoldColumn|
3641 foldclose FoldColumn |hl-FoldColumn|
3642 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003643 diff DiffDelete |hl-DiffDelete|
3644 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003645 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003646 trunc one of the many Popup menu highlighting groups like
3647 |hl-PmenuSel|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003649 *'findfunc'* *'ffu'* *E1514*
3650'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003651 global or local to buffer |global-local|
3652 {not available when compiled without the |+eval|
3653 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003654 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003655 command. When this option is empty, the internal |file-searching|
3656 mechanism is used.
3657
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003658 The value can be the name of a function, a |lambda| or a |Funcref|.
3659 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003660
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003661 The function is called with two arguments. The first argument is a
3662 |String| and is the |:find| command argument. The second argument is
3663 a |Boolean| and is set to |v:true| when the function is called to get
3664 a List of command-line completion matches for the |:find| command.
3665 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003666
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003667 The function is called only once per |:find| command invocation.
3668 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003669
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003670 If a match is found, the function should return a |List| containing
3671 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003672 should return an empty List.
3673
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003674 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003675 empty List is used as the return value.
3676
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003677 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003678 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003679
3680 This option cannot be set from a |modeline| or in the |sandbox|, for
3681 security reasons.
3682
3683 Examples:
3684>
3685 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003686 func FindFuncGlob(cmdarg, cmdcomplete)
3687 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003688 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003689 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003690 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003691
3692 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003693 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003694 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003695 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003696 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003697 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003698<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003699 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3700'fixendofline' 'fixeol' boolean (default on)
3701 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003702 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003703 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003704 preserve the situation from the original file.
3705 When the 'binary' option is set the value of this option doesn't
3706 matter.
3707 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003708 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003709
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003711'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 {only available when compiled with the |+rightleft|
3714 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003715 This option was for using Farsi, which has been removed. See
3716 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717
3718 *'foldclose'* *'fcl'*
3719'foldclose' 'fcl' string (default "")
3720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {not available when compiled without the |+folding|
3722 feature}
3723 When set to "all", a fold is closed when the cursor isn't in it and
3724 its level is higher than 'foldlevel'. Useful if you want folds to
3725 automatically close when moving out of them.
3726
3727 *'foldcolumn'* *'fdc'*
3728'foldcolumn' 'fdc' number (default 0)
3729 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 {not available when compiled without the |+folding|
3731 feature}
3732 When non-zero, a column with the specified width is shown at the side
3733 of the window which indicates open and closed folds. The maximum
3734 value is 12.
3735 See |folding|.
3736
3737 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3738'foldenable' 'fen' boolean (default on)
3739 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 {not available when compiled without the |+folding|
3741 feature}
3742 When off, all folds are open. This option can be used to quickly
3743 switch between showing all text unfolded and viewing the text with
3744 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003745 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 'foldenable' is off.
3747 This option is set by commands that create a new fold or close a fold.
3748 See |folding|.
3749
3750 *'foldexpr'* *'fde'*
3751'foldexpr' 'fde' string (default: "0")
3752 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003754 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003756 for each line to obtain its fold level. The context is set to the
3757 script where 'foldexpr' was set, script-local items can be accessed.
3758 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003759
Bram Moolenaar30b65812012-07-12 22:01:11 +02003760 The expression will be evaluated in the |sandbox| if set from a
3761 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003762 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003763 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003764
3765 It is not allowed to change text or jump to another window while
3766 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767
3768 *'foldignore'* *'fdi'*
3769'foldignore' 'fdi' string (default: "#")
3770 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 {not available when compiled without the |+folding|
3772 feature}
3773 Used only when 'foldmethod' is "indent". Lines starting with
3774 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003775 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 The default "#" works well for C programs. See |fold-indent|.
3777
3778 *'foldlevel'* *'fdl'*
3779'foldlevel' 'fdl' number (default: 0)
3780 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 {not available when compiled without the |+folding|
3782 feature}
3783 Sets the fold level: Folds with a higher level will be closed.
3784 Setting this option to zero will close all folds. Higher numbers will
3785 close fewer folds.
3786 This option is set by commands like |zm|, |zM| and |zR|.
3787 See |fold-foldlevel|.
3788
3789 *'foldlevelstart'* *'fdls'*
3790'foldlevelstart' 'fdls' number (default: -1)
3791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 {not available when compiled without the |+folding|
3793 feature}
3794 Sets 'foldlevel' when starting to edit another buffer in a window.
3795 Useful to always start editing with all folds closed (value zero),
3796 some folds closed (one) or no folds closed (99).
3797 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003798 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 ignores this option and closes all folds.
3800 It is also done before BufReadPre autocommands, to allow an autocmd to
3801 overrule the 'foldlevel' value for specific files.
3802 When the value is negative, it is not used.
3803
3804 *'foldmarker'* *'fmr'* *E536*
3805'foldmarker' 'fmr' string (default: "{{{,}}}")
3806 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 {not available when compiled without the |+folding|
3808 feature}
3809 The start and end marker used when 'foldmethod' is "marker". There
3810 must be one comma, which separates the start and end marker. The
3811 marker is a literal string (a regular expression would be too slow).
3812 See |fold-marker|.
3813
3814 *'foldmethod'* *'fdm'*
3815'foldmethod' 'fdm' string (default: "manual")
3816 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 {not available when compiled without the |+folding|
3818 feature}
3819 The kind of folding used for the current window. Possible values:
3820 |fold-manual| manual Folds are created manually.
3821 |fold-indent| indent Lines with equal indent form a fold.
3822 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3823 |fold-marker| marker Markers are used to specify folds.
3824 |fold-syntax| syntax Syntax highlighting items specify folds.
3825 |fold-diff| diff Fold text that is not changed.
3826
3827 *'foldminlines'* *'fml'*
3828'foldminlines' 'fml' number (default: 1)
3829 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 {not available when compiled without the |+folding|
3831 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003832 Sets the number of screen lines above which a fold can be displayed
3833 closed. Also for manually closed folds. With the default value of
3834 one a fold can only be closed if it takes up two or more screen lines.
3835 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003836 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 "zc" to close a fold, which is displayed open because it's smaller
3838 than 'foldminlines', a following "zc" may close a containing fold.
3839
3840 *'foldnestmax'* *'fdn'*
3841'foldnestmax' 'fdn' number (default: 20)
3842 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 {not available when compiled without the |+folding|
3844 feature}
3845 Sets the maximum nesting of folds for the "indent" and "syntax"
3846 methods. This avoids that too many folds will be created. Using more
3847 than 20 doesn't work, because the internal limit is 20.
3848
3849 *'foldopen'* *'fdo'*
3850'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3851 search,tag,undo")
3852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 {not available when compiled without the |+folding|
3854 feature}
3855 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003856 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003858 NOTE: When the command is part of a mapping this option is not used.
3859 Add the |zv| command to the mapping to get the same effect.
3860 (rationale: the mapping may want to control opening folds itself)
3861
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 item commands ~
3863 all any
3864 block "(", "{", "[[", "[{", etc.
3865 hor horizontal movements: "l", "w", "fx", etc.
3866 insert any command in Insert mode
3867 jump far jumps: "G", "gg", etc.
3868 mark jumping to a mark: "'m", CTRL-O, etc.
3869 percent "%"
3870 quickfix ":cn", ":crew", ":make", etc.
3871 search search for a pattern: "/", "n", "*", "gd", etc.
3872 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003873 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 tag jumping to a tag: ":ta", CTRL-T, etc.
3875 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 When a movement command is used for an operator (e.g., "dl" or "y%")
3877 this option is not used. This means the operator will include the
3878 whole closed fold.
3879 Note that vertical movements are not here, because it would make it
3880 very difficult to move onto a closed fold.
3881 In insert mode the folds containing the cursor will always be open
3882 when text is inserted.
3883 To close folds you can re-apply 'foldlevel' with the |zx| command or
3884 set the 'foldclose' option to "all".
3885
3886 *'foldtext'* *'fdt'*
3887'foldtext' 'fdt' string (default: "foldtext()")
3888 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 {not available when compiled without the |+folding|
3890 feature}
3891 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003892 fold. The context is set to the script where 'foldexpr' was set,
3893 script-local items can be accessed. See |fold-foldtext| for the
3894 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895
Bram Moolenaar30b65812012-07-12 22:01:11 +02003896 The expression will be evaluated in the |sandbox| if set from a
3897 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003898 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003899
3900 It is not allowed to change text or jump to another window while
3901 evaluating 'foldtext' |textlock|.
3902
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003903 *'formatexpr'* *'fex'*
3904'formatexpr' 'fex' string (default "")
3905 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003906 {not available when compiled without the |+eval|
3907 feature}
3908 Expression which is evaluated to format a range of lines for the |gq|
3909 operator or automatic formatting (see 'formatoptions'). When this
3910 option is empty 'formatprg' is used.
3911
3912 The |v:lnum| variable holds the first line to be formatted.
3913 The |v:count| variable holds the number of lines to be formatted.
3914 The |v:char| variable holds the character that is going to be
3915 inserted if the expression is being evaluated due to
3916 automatic formatting. This can be empty. Don't insert
3917 it yet!
3918
3919 Example: >
3920 :set formatexpr=mylang#Format()
3921< This will invoke the mylang#Format() function in the
3922 autoload/mylang.vim file in 'runtimepath'. |autoload|
3923
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003924 The advantage of using a function call without arguments is that it is
3925 faster, see |expr-option-function|.
3926
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003927 The expression is also evaluated when 'textwidth' is set and adding
3928 text beyond that limit. This happens under the same conditions as
3929 when internal formatting is used. Make sure the cursor is kept in the
3930 same spot relative to the text then! The |mode()| function will
3931 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003932
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003933 When the expression evaluates to non-zero Vim will fall back to using
3934 the internal format mechanism.
3935
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003936 If the expression starts with s: or |<SID>|, then it is replaced with
3937 the script ID (|local-function|). Example: >
3938 set formatexpr=s:MyFormatExpr()
3939 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003940< Otherwise, the expression is evaluated in the context of the script
3941 where the option was set, thus script-local items are available.
3942
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003943 The expression will be evaluated in the |sandbox| when set from a
3944 modeline, see |sandbox-option|. That stops the option from working,
3945 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003946 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003947 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003948
Bram Moolenaar86b68352004-12-27 21:59:20 +00003949 *'formatlistpat'* *'flp'*
3950'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3951 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003952 A pattern that is used to recognize a list header. This is used for
3953 the "n" flag in 'formatoptions'.
3954 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003955 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003956 while still checking more characters. There must be a character
3957 following the pattern, when it matches the whole line it is handled
3958 like there is no match.
3959 The default recognizes a number, followed by an optional punctuation
3960 character and white space.
3961
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003962 *'formatoptions'* *'fo'*
3963'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3964 local to buffer
3965 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003966 formatting is to be done.
3967 See |fo-table| for possible values and |gq| for how to format text.
3968 When the 'paste' option is on, no formatting is done (like
3969 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003970 To avoid problems with flags that are added in the future, use the
3971 "+=" and "-=" feature of ":set" |add-option-flags|.
3972 NOTE: This option is set to the Vi default value when 'compatible' is
3973 set and to the Vim default value when 'compatible' is reset.
3974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 *'formatprg'* *'fp'*
3976'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003977 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003979 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003981 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003982 If the 'formatexpr' option is not empty it will be used instead.
3983 Otherwise, if 'formatprg' option is an empty string, the internal
3984 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003985 Environment variables are expanded |:set_env|. See |option-backslash|
3986 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003987 This option cannot be set from a |modeline| or in the |sandbox|, for
3988 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989
Bram Moolenaard94464e2015-11-02 15:28:18 +01003990 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003991'fsync' 'fs' boolean (default on)
3992 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003993 When on, the library function fsync() will be called after writing a
3994 file. This will flush a file to disk, ensuring that it is safely
3995 written even on filesystems which do metadata-only journaling. This
3996 will force the harddrive to spin up on Linux systems running in laptop
3997 mode, so it may be undesirable in some situations. Be warned that
3998 turning this off increases the chances of data loss after a crash. On
3999 systems without an fsync() implementation, this variable is always
4000 off.
4001 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004002 'fsync' also applies to |writefile()| (unless a flag is used to
4003 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004004 This option cannot be set from a |modeline| or in the |sandbox|, for
4005 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004006
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4008'gdefault' 'gd' boolean (default off)
4009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 When on, the ":substitute" flag 'g' is default on. This means that
4011 all matches in a line are substituted instead of one. When a 'g' flag
4012 is given to a ":substitute" command, this will toggle the substitution
4013 of all or one match. See |complex-change|.
4014
4015 command 'gdefault' on 'gdefault' off ~
4016 :s/// subst. all subst. one
4017 :s///g subst. one subst. all
4018 :s///gg subst. all subst. one
4019
4020 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004021 Setting this option may break plugins that rely on the default
4022 behavior of the 'g' flag. This will also make the 'g' flag have the
4023 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004024 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025
4026 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004027'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 Format to recognize for the ":grep" command output.
4030 This is a scanf-like string that uses the same format as the
4031 'errorformat' option: see |errorformat|.
4032
4033 *'grepprg'* *'gp'*
4034'grepprg' 'gp' string (default "grep -n ",
4035 Unix: "grep -n $* /dev/null",
4036 Win32: "findstr /n" or "grep -n",
4037 VMS: "SEARCH/NUMBERS ")
4038 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004039 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 and '#' characters, which are expanded like when used in a command-
4041 line. The placeholder "$*" is allowed to specify where the arguments
4042 will be included. Environment variables are expanded |:set_env|. See
4043 |option-backslash| about including spaces and backslashes.
4044 When your "grep" accepts the "-H" argument, use this to make ":grep"
4045 also work well with a single file: >
4046 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004047< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004048 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4049 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004050 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 apply equally to 'grepprg'.
4052 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4053 otherwise it's "grep -n".
4054 This option cannot be set from a |modeline| or in the |sandbox|, for
4055 security reasons.
4056
4057 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4058'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4059 ve:ver35-Cursor,
4060 o:hor50-Cursor,
4061 i-ci:ver25-Cursor/lCursor,
4062 r-cr:hor20-Cursor/lCursor,
4063 sm:block-Cursor
4064 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004065 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 "n-v-c:block,o:hor50,i-ci:hor15,
4067 r-cr:hor30,sm:block")
4068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004070 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004072 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004073 height of the cursor can be changed. This can be done by specifying a
4074 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004075 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4076 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004078 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 mode-list and an argument-list:
4080 mode-list:argument-list,mode-list:argument-list,..
4081 The mode-list is a dash separated list of these modes:
4082 n Normal mode
4083 v Visual mode
4084 ve Visual mode with 'selection' "exclusive" (same as 'v',
4085 if not specified)
4086 o Operator-pending mode
4087 i Insert mode
4088 r Replace mode
4089 c Command-line Normal (append) mode
4090 ci Command-line Insert mode
4091 cr Command-line Replace mode
4092 sm showmatch in Insert mode
4093 a all modes
4094 The argument-list is a dash separated list of these arguments:
4095 hor{N} horizontal bar, {N} percent of the character height
4096 ver{N} vertical bar, {N} percent of the character width
4097 block block cursor, fills the whole character
4098 [only one of the above three should be present]
4099 blinkwait{N} *cursor-blinking*
4100 blinkon{N}
4101 blinkoff{N}
4102 blink times for cursor: blinkwait is the delay before
4103 the cursor starts blinking, blinkon is the time that
4104 the cursor is shown and blinkoff is the time that the
4105 cursor is not shown. The times are in msec. When one
4106 of the numbers is zero, there is no blinking. The
4107 default is: "blinkwait700-blinkon400-blinkoff250".
4108 These numbers are used for a missing entry. This
4109 means that blinking is enabled by default. To switch
4110 blinking off you can use "blinkon0". The cursor only
4111 blinks when Vim is waiting for input, not while
4112 executing a command.
4113 To make the cursor blink in an xterm, see
4114 |xterm-blink|.
4115 {group-name}
4116 a highlight group name, that sets the color and font
4117 for the cursor
4118 {group-name}/{group-name}
4119 Two highlight group names, the first is used when
4120 no language mappings are used, the other when they
4121 are. |language-mapping|
4122
4123 Examples of parts:
4124 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4125 block cursor with colors from the "nCursor"
4126 highlight group
4127 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4128 In Insert and Command-line Insert mode, use a
4129 30% vertical bar cursor with colors from the
4130 "iCursor" highlight group. Blink a bit
4131 faster.
4132
4133 The 'a' mode is different. It will set the given argument-list for
4134 all modes. It does not reset anything to defaults. This can be used
4135 to do a common setting for all modes. For example, to switch off
4136 blinking: "a:blinkon0"
4137
4138 Examples of cursor highlighting: >
4139 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4140 :highlight Cursor gui=NONE guifg=bg guibg=fg
4141<
4142 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004143 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144'guifont' 'gfn' string (default "")
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 {only available when compiled with GUI enabled}
4147 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004148 In its simplest form the value is just one font name.
4149 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150
4151 *'guifontset'* *'gfs'*
4152 *E250* *E252* *E234* *E597* *E598*
4153'guifontset' 'gfs' string (default "")
4154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 {only available when compiled with GUI enabled and
4156 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004157 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 When not empty, specifies two (or more) fonts to be used. The first
4159 one for normal English, the second one for your special language. See
4160 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004161
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4163'guifontwide' 'gfw' string (default "")
4164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 {only available when compiled with GUI enabled}
4166 When not empty, specifies a comma-separated list of fonts to be used
4167 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004168 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004169
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 *'guiheadroom'* *'ghr'*
4171'guiheadroom' 'ghr' number (default 50)
4172 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004173 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 The number of pixels subtracted from the screen height when fitting
4175 the GUI window on the screen. Set this before the GUI is started,
4176 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 lines will be left for window decorations and other items on the
4179 screen. Set it to a negative value to allow windows taller than the
4180 screen.
4181
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004182 *'guiligatures'* *'gli'* *E1243*
4183'guiligatures' 'gli' string (default "")
4184 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004185 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004186 List of ASCII characters that, when combined together, can create more
4187 complex shapes. Each character must be a printable ASCII character
4188 with a value in the 32-127 range.
4189 Example: >
4190 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4191< Changing this option updates screen output immediately. Set it to an
4192 empty string to disable ligatures.
4193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004195'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4196 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004197 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004198 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004201 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 sequence of letters which describes what components and options of the
4203 GUI should be used.
4204 To avoid problems with flags that are added in the future, use the
4205 "+=" and "-=" feature of ":set" |add-option-flags|.
4206
Bram Moolenaar13568252018-03-16 20:46:58 +01004207 Valid characters are as follows:
4208 *'go-!'*
4209 '!' External commands are executed in a terminal window. Without
4210 this flag the MS-Windows GUI will open a console window to
4211 execute the command. The Unix GUI will simulate a dumb
4212 terminal to list the command output.
4213 The terminal window will be positioned at the bottom, and grow
4214 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004215 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 'a' Autoselect: If present, then whenever VISUAL mode is started,
4217 or the Visual area extended, Vim tries to become the owner of
4218 the windowing system's global selection. This means that the
4219 Visually highlighted text is available for pasting into other
4220 applications as well as into Vim itself. When the Visual mode
4221 ends, possibly due to an operation on the text, or when an
4222 application wants to paste the selection, the highlighted text
4223 is automatically yanked into the "* selection register.
4224 Thus the selection is still available for pasting into other
4225 applications after the VISUAL mode has ended.
4226 If not present, then Vim won't become the owner of the
4227 windowing system's global selection unless explicitly told to
4228 by a yank or delete operation for the "* register.
4229 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004230 *'go-P'*
4231 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004232 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004233 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004234 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 applies to the modeless selection.
4236
4237 'guioptions' autoselect Visual autoselect modeless ~
4238 "" - -
4239 "a" yes yes
4240 "A" - yes
4241 "aA" yes yes
4242
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004243 When using a terminal see the 'clipboard' option.
4244
Bram Moolenaar02467872007-05-06 13:22:01 +00004245 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 'c' Use console dialogs instead of popup dialogs for simple
4247 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004248 *'go-d'*
4249 'd' Use dark theme variant if available. Currently only works for
4250 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004251 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004252 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004253 'guitablabel' can be used to change the text in the labels.
4254 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004255 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004256 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004257 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 'f' Foreground: Don't use fork() to detach the GUI from the shell
4259 where it was started. Use this for programs that wait for the
4260 editor to finish (e.g., an e-mail program). Alternatively you
4261 can use "gvim -f" or ":gui -f" to start the GUI in the
4262 foreground. |gui-fork|
4263 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004264 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004265 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4267 corner of the window. It's black&white on non-GTK, because of
4268 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004269 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004271 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004272 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004274 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004276 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004277 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 'g' Grey menu items: Make menu items that are not active grey. If
4279 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004280 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 't' Include tearoff menu items. Currently only works for Win32,
4282 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004283 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004284 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4285 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004286 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004288 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 'R' Right-hand scrollbar is present when there is a vertically
4290 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004291 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004293 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 'L' Left-hand scrollbar is present when there is a vertically
4295 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004296 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4298 the longest visible line, or on the cursor line if the 'h'
4299 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004300 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 'h' Limit horizontal scrollbar size to the length of the cursor
4302 line. Reduces computations. |gui-horiz-scroll|
4303
4304 And yes, you may even have scrollbars on the left AND the right if
4305 you really want to :-). See |gui-scrollbars| for more information.
4306
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004307 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 'v' Use a vertical button layout for dialogs. When not included,
4309 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004310 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004311 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 'p' Use Pointer callbacks for X11 GUI. This is required for some
4313 window managers. If the cursor is not blinking or hollow at
4314 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004315 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004317 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004318 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004319 *'go-k'*
4320 'k' Keep the GUI window size when adding/removing a scrollbar, or
4321 toolbar, tabline, etc. Instead, the behavior is similar to
4322 when the window is maximized and will adjust 'lines' and
4323 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004324 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004325 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004326
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 *'guipty'* *'noguipty'*
4328'guipty' boolean (default on)
4329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 {only available when compiled with GUI enabled}
4331 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4332 I/O to/from shell commands. See |gui-pty|.
4333
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004334 *'guitablabel'* *'gtl'*
4335'guitablabel' 'gtl' string (default empty)
4336 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004337 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004338 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004339 pages line. When empty and when the result is empty Vim will use a
4340 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004341
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004342 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004343 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004344 The expression will be evaluated in the |sandbox| when set from a
4345 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004346 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004347
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004348 Only used when the GUI tab pages line is displayed. 'e' must be
4349 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4350 used.
4351
Bram Moolenaar57657d82006-04-21 22:12:41 +00004352 *'guitabtooltip'* *'gtt'*
4353'guitabtooltip' 'gtt' string (default empty)
4354 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004355 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004356 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004357 pages line. When empty Vim will use a default tooltip.
4358 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004359 You can include a line break. Simplest method is to use |:let|: >
4360 :let &guitabtooltip = "line one\nline two"
4361<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004362
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004364'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 (others) "$VIMRUNTIME/doc/help.txt")
4366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 Name of the main help file. All distributed help files should be
4368 placed together in one directory. Additionally, all "doc" directories
4369 in 'runtimepath' will be used.
4370 Environment variables are expanded |:set_env|. For example:
4371 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004372 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 spaces and backslashes.
4374 This option cannot be set from a |modeline| or in the |sandbox|, for
4375 security reasons.
4376
4377 *'helpheight'* *'hh'*
4378'helpheight' 'hh' number (default 20)
4379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 Minimal initial height of the help window when it is opened with the
4381 ":help" command. The initial height of the help window is half of the
4382 current window, or (when the 'ea' option is on) the same as other
4383 windows. When the height is less than 'helpheight', the height is
4384 set to 'helpheight'. Set to zero to disable.
4385
4386 *'helplang'* *'hlg'*
4387'helplang' 'hlg' string (default: messages language or empty)
4388 global
4389 {only available when compiled with the |+multi_lang|
4390 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004391 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 for which the desired help can be found. The English help will always
4393 be used as a last resort. You can add "en" to prefer English over
4394 another language, but that will only find tags that exist in that
4395 language and not in the English help.
4396 Example: >
4397 :set helplang=de,it
4398< This will first search German, then Italian and finally English help
4399 files.
4400 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4401 try to find the tag in the current language before using this option.
4402 See |help-translated|.
4403
4404 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4405'hidden' 'hid' boolean (default off)
4406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 When off a buffer is unloaded when it is |abandon|ed. When on a
4408 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4409 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004410
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004412 hidden even if the 'hidden' option is off when these three are true:
4413 - the buffer is modified
4414 - 'autowrite' is off or writing is not possible
4415 - the '!' flag was used
4416 Also see |windows.txt|.
4417
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004418 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 This option is set for one command with ":hide {command}" |:hide|.
4420 WARNING: It's easy to forget that you have changes in hidden buffers.
4421 Think twice when using ":q!" or ":qa!".
4422
4423 *'highlight'* *'hl'*
4424'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004425 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4426 d:Directory,e:ErrorMsg,i:IncSearch,
4427 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004428 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004429 N:CursorLineNr,r:Question,s:StatusLine,
4430 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004431 v:Visual,V:VisualNOS,w:WarningMsg,
4432 W:WildMenu,f:Folded,F:FoldColumn,
4433 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004434 T:DiffText,E:DiffTextAdd,>:SignColumn,
4435 -:Conceal,B:SpellBad,P:SpellCap,
4436 R:SpellRare, L:SpellLocal,+:Pmenu,
4437 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004438 [:PmenuKind,]:PmenuKindSel,
4439 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004440 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4441 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004442 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004443 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004444 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004447 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004449 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004451 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4452 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 characters from 'showbreak'
4454 |hl-Directory| d directories in CTRL-D listing and other special
4455 things in listings
4456 |hl-ErrorMsg| e error messages
4457 h (obsolete, ignored)
4458 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004459 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4461 |hl-MoreMsg| m |more-prompt|
4462 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004463 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004464 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004465 |hl-LineNr| n line number for ":number" and ":#" commands, and
4466 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004467 |hl-LineNrAbove| a line number above the cursor for when the
4468 'relativenumber' option is set.
4469 |hl-LineNrBelow| b line number below the cursor for when the
4470 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004471 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4472 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 |hl-Question| r |hit-enter| prompt and yes/no questions
4474 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004475 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4477 |hl-VertSplit| c column used to separate vertically split windows
4478 |hl-Visual| v Visual mode
4479 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4480 Selection" Only X11 Gui's |gui-x11| and
4481 |xterm-clipboard|.
4482 |hl-WarningMsg| w warning messages
4483 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4484 |hl-Folded| f line used for closed folds
4485 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004486 |hl-DiffAdd| A added line in diff mode
4487 |hl-DiffChange| C changed line in diff mode
4488 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004489 |hl-DiffText| T changed text in diff mode
4490 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004492 |hl-Conceal| - the placeholders used for concealed characters
4493 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004494 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004495 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004496 |hl-SpellRare| R rare word |spell|
4497 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004498 |hl-Pmenu| + popup menu normal line
4499 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004500 |hl-PmenuKind| [ popup menu "kind" normal line
4501 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004502 |hl-PmenuExtra| { popup menu "extra" normal line
4503 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004504 |hl-PmenuSbar| x popup menu scrollbar
4505 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004506 |hl-PmenuMatch| k popup menu matched text
4507 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
4509 The display modes are:
4510 r reverse (termcap entry "mr" and "me")
4511 i italic (termcap entry "ZH" and "ZR")
4512 b bold (termcap entry "md" and "me")
4513 s standout (termcap entry "so" and "se")
4514 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004515 c undercurl (termcap entry "Us" and "Ce")
4516 2 double underline (termcap entry "Ds" and "Ce")
4517 d dotted underline (termcap entry "ds" and "Ce")
4518 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004519 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 n no highlighting
4521 - no highlighting
4522 : use a highlight group
4523 The default is used for occasions that are not included.
4524 If you want to change what the display modes do, see |dos-colors|
4525 for an example.
4526 When using the ':' display mode, this must be followed by the name of
4527 a highlight group. A highlight group can be used to define any type
4528 of highlighting, including using color. See |:highlight| on how to
4529 define one. The default uses a different group for each occasion.
4530 See |highlight-default| for the default highlight groups.
4531
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004533'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004536 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004537 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004538 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004539 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 NOTE: This option is set to the Vi default value when 'compatible' is
4541 set and to the Vim default value when 'compatible' is reset.
4542
4543 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4544'hkmap' 'hk' boolean (default off)
4545 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 {only available when compiled with the |+rightleft|
4547 feature}
4548 When on, the keyboard is mapped for the Hebrew character set.
4549 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4550 toggle this option. See |rileft.txt|.
4551 NOTE: This option is reset when 'compatible' is set.
4552
4553 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4554'hkmapp' 'hkp' boolean (default off)
4555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 {only available when compiled with the |+rightleft|
4557 feature}
4558 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4559 This is useful if you have a non-Hebrew keyboard.
4560 See |rileft.txt|.
4561 NOTE: This option is reset when 'compatible' is set.
4562
Bram Moolenaar036986f2017-03-16 17:41:02 +01004563 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4564'hlsearch' 'hls' boolean (default off)
4565 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004566 {not available when compiled without the
4567 |+extra_search| feature}
4568 When there is a previous search pattern, highlight all its matches.
4569 The type of highlighting used can be set with the 'l' occasion in the
4570 'highlight' option. This uses the "Search" highlight group by
4571 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004572 are not applied. If the "CurSearch" highlight group is set then the
4573 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004574 See also: 'incsearch' and |:match|.
4575 When you get bored looking at the highlighted matches, you can turn it
4576 off with |:nohlsearch|. This does not change the option value, as
4577 soon as you use a search command, the highlighting comes back.
4578 'redrawtime' specifies the maximum time spent on finding matches.
4579 When the search pattern can match an end-of-line, Vim will try to
4580 highlight all of the matched text. However, this depends on where the
4581 search starts. This will be the first line in the window or the first
4582 line below a closed fold. A match in a previous line which is not
4583 drawn may not continue in a newly drawn line.
4584 You can specify whether the highlight status is restored on startup
4585 with the 'h' flag in 'viminfo' |viminfo-h|.
4586 NOTE: This option is reset when 'compatible' is set.
4587
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 *'icon'* *'noicon'*
4589'icon' boolean (default off, on when title can be restored)
4590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 When on, the icon text of the window will be set to the value of
4592 'iconstring' (if it is not empty), or to the name of the file
4593 currently being edited. Only the last part of the name is used.
4594 Overridden by the 'iconstring' option.
4595 Only works if the terminal supports setting window icons (currently
4596 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4597 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4598 builtin termcap).
4599 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004600 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004602 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 *'iconstring'*
4605'iconstring' string (default "")
4606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 When this option is not empty, it will be used for the icon text of
4608 the window. This happens only when the 'icon' option is on.
4609 Only works if the terminal supports setting window icon text
4610 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004611 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 When Vim was compiled with HAVE_X11 defined, the original icon will be
4613 restored if possible |X11|.
4614 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004615 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004617 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 {not available when compiled without the |+statusline| feature}
4619
4620 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4621'ignorecase' 'ic' boolean (default off)
4622 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004623 Ignore case in search patterns, |cmdline-completion|, when
4624 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004625 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 Can be overruled by using "\c" or "\C" in the pattern, see
4627 |/ignorecase|.
4628
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004629 *'imactivatefunc'* *'imaf'*
4630'imactivatefunc' 'imaf' string (default "")
4631 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004632 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004633 activate or deactivate the Input Method. The value can be the name of
4634 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4635 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004636 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004637 The expression will be evaluated in the |sandbox| when set from a
4638 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004639
4640 Example: >
4641 function ImActivateFunc(active)
4642 if a:active
4643 ... do something
4644 else
4645 ... do something
4646 endif
4647 " return value is not used
4648 endfunction
4649 set imactivatefunc=ImActivateFunc
4650<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 *'imactivatekey'* *'imak'*
4652'imactivatekey' 'imak' string (default "")
4653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004655 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 Specifies the key that your Input Method in X-Windows uses for
4657 activation. When this is specified correctly, vim can fully control
4658 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4659 You can't use this option to change the activation key, the option
4660 tells Vim what the key is.
4661 Format:
4662 [MODIFIER_FLAG-]KEY_STRING
4663
4664 These characters can be used for MODIFIER_FLAG (case is ignored):
4665 S Shift key
4666 L Lock key
4667 C Control key
4668 1 Mod1 key
4669 2 Mod2 key
4670 3 Mod3 key
4671 4 Mod4 key
4672 5 Mod5 key
4673 Combinations are allowed, for example "S-C-space" or "SC-space" are
4674 both shift+ctrl+space.
4675 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4676
4677 Example: >
4678 :set imactivatekey=S-space
4679< "S-space" means shift+space. This is the activation key for kinput2 +
4680 canna (Japanese), and ami (Korean).
4681
4682 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4683'imcmdline' 'imc' boolean (default off)
4684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 When set the Input Method is always on when starting to edit a command
4686 line, unless entering a search pattern (see 'imsearch' for that).
4687 Setting this option is useful when your input method allows entering
4688 English characters directly, e.g., when it's used to type accented
4689 characters with dead keys.
4690
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004691 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 When set the Input Method is never used. This is useful to disable
4695 the IM when it doesn't work properly.
4696 Currently this option is on by default for SGI/IRIX machines. This
4697 may change in later releases.
4698
4699 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004700'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 Specifies whether :lmap or an Input Method (IM) is to be used in
4703 Insert mode. Valid values:
4704 0 :lmap is off and IM is off
4705 1 :lmap is ON and IM is off
4706 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 To always reset the option to zero when leaving Insert mode with <Esc>
4708 this can be used: >
4709 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4710< This makes :lmap and IM turn off automatically when leaving Insert
4711 mode.
4712 Note that this option changes when using CTRL-^ in Insert mode
4713 |i_CTRL-^|.
4714 The value is set to 1 when setting 'keymap' to a valid keymap name.
4715 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004716 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 methods. Use 'imdisable' to disable XIM then.
4718
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004719 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004720 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004721 |+multi_byte_ime| or |global-ime|.
4722
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004724'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 Specifies whether :lmap or an Input Method (IM) is to be used when
4727 entering a search pattern. Valid values:
4728 -1 the value of 'iminsert' is used, makes it look like
4729 'iminsert' is also used when typing a search pattern
4730 0 :lmap is off and IM is off
4731 1 :lmap is ON and IM is off
4732 2 :lmap is off and IM is ON
4733 Note that this option changes when using CTRL-^ in Command-line mode
4734 |c_CTRL-^|.
4735 The value is set to 1 when it is not -1 and setting the 'keymap'
4736 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004737 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 methods. Use 'imdisable' to disable XIM then.
4739
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004740 *'imstatusfunc'* *'imsf'*
4741'imstatusfunc' 'imsf' string (default "")
4742 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004743 This option specifies a function that is called to obtain the status
4744 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004745 The value can be the name of a function, a |lambda| or a |Funcref|.
4746 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004747 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004748
4749 Example: >
4750 function ImStatusFunc()
4751 let is_active = ...do something
4752 return is_active ? 1 : 0
4753 endfunction
4754 set imstatusfunc=ImStatusFunc
4755<
4756 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004757 The expression will be evaluated in the |sandbox| when set from a
4758 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004759
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004760 *'imstyle'* *'imst'*
4761'imstyle' 'imst' number (default 1)
4762 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004763 {only available when compiled with |+xim| and
4764 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004765 This option specifies the input style of Input Method:
4766 0 use on-the-spot style
4767 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004768 See: |xim-input-style|
4769
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004770 For a long time on-the-spot style had been used in the GTK version of
4771 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004772 |single-repeat|, etc. Therefore over-the-spot style becomes the
4773 default now. This should work fine for most people, however if you
4774 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004775 The expression will be evaluated in the |sandbox| when set from a
4776 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004777
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 *'include'* *'inc'*
4779'include' 'inc' string (default "^\s*#\s*include")
4780 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 {not available when compiled without the
4782 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004783 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 pattern, just like for the "/" command (See |pattern|). The default
4785 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004786 "]I", "[d", etc.
4787 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004788 comes after the matched pattern. But if "\zs" appears in the pattern
4789 then the text matched from "\zs" to the end, or until "\ze" if it
4790 appears, is used as the file name. Use this to include characters
4791 that are not in 'isfname', such as a space. You can then use
4792 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004793 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795 *'includeexpr'* *'inex'*
4796'includeexpr' 'inex' string (default "")
4797 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004799 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004801 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004802 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004804 Note the double backslash: the `:set` command first halves them, then
4805 one remains it the value, where "\." matches a dot literally. For
4806 simple character replacements `tr()` avoids the need for escaping: >
4807 :setlocal includeexpr=tr(v:fname,'.','/')
4808<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004810 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 Also used for |<cfile>|.
4812
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004813 If the expression starts with s: or |<SID>|, then it is replaced with
4814 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004815 setlocal includeexpr=s:MyIncludeExpr()
4816 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004817< Otherwise, the expression is evaluated in the context of the script
4818 where the option was set, thus script-local items are available.
4819
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004820 It is more efficient if the value is just a function call without
4821 arguments, see |expr-option-function|.
4822
Bram Moolenaar30b65812012-07-12 22:01:11 +02004823 The expression will be evaluated in the |sandbox| when set from a
4824 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004825 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004826
4827 It is not allowed to change text or jump to another window while
4828 evaluating 'includeexpr' |textlock|.
4829
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004831'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004832 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004835 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004836 While typing a search command, show where the pattern, as it was typed
4837 so far, matches. The matched string is highlighted. If the pattern
4838 is invalid or not found, nothing is shown. The screen will be updated
4839 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004840 Also applies to the pattern in commands: >
4841 :global
4842 :lvimgrep
4843 :lvimgrepadd
4844 :smagic
4845 :snomagic
4846 :sort
4847 :substitute
4848 :vglobal
4849 :vimgrep
4850 :vimgrepadd
4851< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004852 original position when no match is found and when pressing <Esc>. You
4853 still need to finish the search command with <Enter> to move the
4854 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004855 You can use the CTRL-G and CTRL-T keys to move to the next and
4856 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004857 When compiled with the |+reltime| feature Vim only searches for about
4858 half a second. With a complicated pattern and/or a lot of text the
4859 match may not be found. This is to avoid that Vim hangs while you
4860 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004861 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004862 When 'hlsearch' is on, all matched strings are highlighted too while
4863 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004864 If you don't want to turn 'hlsearch' on, but want to highlight all
4865 matches while searching, you can turn on and off 'hlsearch' with
4866 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004867 augroup vimrc-incsearch-highlight
4868 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004869 autocmd CmdlineEnter /,\? :set hlsearch
4870 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004871 augroup END
4872<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004873 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004874 to the command line. If 'ignorecase' and 'smartcase' are set and the
4875 command line has no uppercase characters, the added character is
4876 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004877 CTRL-R CTRL-W can be used to add the word at the end of the current
4878 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 NOTE: This option is reset when 'compatible' is set.
4880
4881 *'indentexpr'* *'inde'*
4882'indentexpr' 'inde' string (default "")
4883 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004884 {not available when compiled without the |+eval|
4885 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 Expression which is evaluated to obtain the proper indent for a line.
4887 It is used when a new line is created, for the |=| operator and
4888 in Insert mode as specified with the 'indentkeys' option.
4889 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004890 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004891 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 When 'paste' is set this option is not used for indenting.
4893 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004894 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004896
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004897 If the expression starts with s: or |<SID>|, then it is replaced with
4898 the script ID (|local-function|). Example: >
4899 set indentexpr=s:MyIndentExpr()
4900 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004901< Otherwise, the expression is evaluated in the context of the script
4902 where the option was set, thus script-local items are available.
4903
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004904 The advantage of using a function call without arguments is that it is
4905 faster, see |expr-option-function|.
4906
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 The expression must return the number of spaces worth of indent. It
4908 can return "-1" to keep the current indent (this means 'autoindent' is
4909 used for the indent).
4910 Functions useful for computing the indent are |indent()|, |cindent()|
4911 and |lispindent()|.
4912 The evaluation of the expression must not have side effects! It must
4913 not change the text, jump to another window, etc. Afterwards the
4914 cursor position is always restored, thus the cursor may be moved.
4915 Normally this option would be set to call a function: >
4916 :set indentexpr=GetMyIndent()
4917< Error messages will be suppressed, unless the 'debug' option contains
4918 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004919 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004920 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaar30b65812012-07-12 22:01:11 +02004922 The expression will be evaluated in the |sandbox| when set from a
4923 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004924 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004925
4926 It is not allowed to change text or jump to another window while
4927 evaluating 'indentexpr' |textlock|.
4928
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004930'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 A list of keys that, when typed in Insert mode, cause reindenting of
4933 the current line. Only happens if 'indentexpr' isn't empty.
4934 The format is identical to 'cinkeys', see |indentkeys-format|.
4935 See |C-indenting| and |indent-expression|.
4936
4937 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4938'infercase' 'inf' boolean (default off)
4939 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004941 'ignorecase' is also on, the case of the match is adjusted depending
4942 on the typed text. If the typed text contains a lowercase letter
4943 where the match has an upper case letter, the completed part is made
4944 lowercase. If the typed text has no lowercase letters and the match
4945 has a lowercase letter where the typed text has an uppercase letter,
4946 and there is a letter before it, the completed part is made uppercase.
4947 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948
4949 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4950'insertmode' 'im' boolean (default off)
4951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 Makes Vim work in a way that Insert mode is the default mode. Useful
4953 if you want to use Vim as a modeless editor. Used for |evim|.
4954 These Insert mode commands will be useful:
4955 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004956 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 this is a mapping, it is executed as if 'insertmode' was off.
4958 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004960 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4961 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962
4963 These items change when 'insertmode' is set:
4964 - when starting to edit of a file, Vim goes to Insert mode.
4965 - <Esc> in Insert mode is a no-op and beeps.
4966 - <Esc> in Normal mode makes Vim go to Insert mode.
4967 - CTRL-L in Insert mode is a command, it is not inserted.
4968 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4969 However, when <Esc> is used inside a mapping, it behaves like
4970 'insertmode' was not set. This was done to be able to use the same
4971 mappings with 'insertmode' set or not set.
4972 When executing commands with |:normal| 'insertmode' is not used.
4973
4974 NOTE: This option is reset when 'compatible' is set.
4975
4976 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004977'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4979 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4980 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4981 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4982 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 The characters specified by this option are included in file names and
4985 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004986 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 Multi-byte characters 256 and above are always included, only the
4988 characters up to 255 are specified with this option.
4989 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004990 Think twice before adding white space to this option. Although a
4991 space may appear inside a file name, the effect will be that Vim
4992 doesn't know where a file name starts or ends when doing completion.
4993 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994
4995 Note that on systems using a backslash as path separator, Vim tries to
4996 do its best to make it work as you would expect. That is a bit
4997 tricky, since Vi originally used the backslash to escape special
4998 characters. Vim will not remove a backslash in front of a normal file
4999 name character on these systems, but it will on Unix and alikes. The
5000 '&' and '^' are not included by default, because these are special for
5001 cmd.exe.
5002
5003 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005004 Each part can be a single character number or a range. A range is two
5005 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 decimal number between 0 and 255 or the ASCII character itself (does
5007 not work for digits). Example:
5008 "_,-,128-140,#-43" (include '_' and '-' and the range
5009 128 to 140 and '#' to 43)
5010 If a part starts with '^', the following character number or range
5011 will be excluded from the option. The option is interpreted from left
5012 to right. Put the excluded character after the range where it is
5013 included. To include '^' itself use it as the last character of the
5014 option or the end of a range. Example:
5015 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5016 If the character is '@', all characters where isalpha() returns TRUE
5017 are included. Normally these are the characters a to z and A to Z,
5018 plus accented characters. To include '@' itself use "@-@". Examples:
5019 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005020 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 "a-z,A-Z,@-@" All letters plus the '@' character.
5022 A comma can be included by using it where a character number is
5023 expected. Example:
5024 "48-57,,,_" Digits, comma and underscore.
5025 A comma can be excluded by prepending a '^'. Example:
5026 " -~,^,,9" All characters from space to '~', excluding
5027 comma, plus <Tab>.
5028 See |option-backslash| about including spaces and backslashes.
5029
5030 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005031'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 "@,48-57,_,128-167,224-235"
5033 otherwise: "@,48-57,_,192-255")
5034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 The characters given by this option are included in identifiers.
5036 Identifiers are used in recognizing environment variables and after a
5037 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005038 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005039 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005041 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5043
5044 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005045'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 "@,48-57,_,128-167,224-235"
5047 otherwise: "@,48-57,_,192-255"
5048 Vi default: "@,48-57,_")
5049 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005051 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005052 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005053 characters above 255 check the "word" character class (any character
5054 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005055 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 For a help file it is set to all non-blank printable characters except
5057 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5058 command).
5059 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005060 This option also influences syntax highlighting, unless the syntax
5061 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 NOTE: This option is set to the Vi default value when 'compatible' is
5063 set and to the Vim default value when 'compatible' is reset.
5064
5065 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005066'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 "@,~-255"; otherwise: "@,161-255")
5068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 The characters given by this option are displayed directly on the
5070 screen. It is also used for "\p" in a |pattern|. The characters from
5071 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5072 even when they are not included in 'isprint' or excluded. See
5073 'isfname' for a description of the format of this option.
5074
5075 Non-printable characters are displayed with two characters:
5076 0 - 31 "^@" - "^_"
5077 32 - 126 always single characters
5078 127 "^?"
5079 128 - 159 "~@" - "~_"
5080 160 - 254 "| " - "|~"
5081 255 "~?"
5082 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5083 displayed as <xx>, with the hexadecimal value of the byte.
5084 When 'display' contains "uhex" all unprintable characters are
5085 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005086 The SpecialKey highlighting will be used for unprintable characters.
5087 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
5089 Multi-byte characters 256 and above are always included, only the
5090 characters up to 255 are specified with this option. When a character
5091 is printable but it is not available in the current font, a
5092 replacement character will be shown.
5093 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5094 There is no option to specify these characters.
5095
5096 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5097'joinspaces' 'js' boolean (default on)
5098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 Insert two spaces after a '.', '?' and '!' with a join command.
5100 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5101 Otherwise only one space is inserted.
5102 NOTE: This option is set when 'compatible' is set.
5103
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005104 *'jumpoptions'* *'jop'*
5105'jumpoptions' 'jop' string (default "")
5106 global
5107 List of words that change the behavior of the |jumplist|.
5108 stack Make the jumplist behave like the tagstack.
5109 Relative location of entries in the jumplist is
5110 preserved at the cost of discarding subsequent entries
5111 when navigating backwards in the jumplist and then
5112 jumping to a location. |jumplist-stack|
5113
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 *'key'*
5115'key' string (default "")
5116 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005117 {only available when compiled with the |+cryptv|
5118 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005120 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 Careful: Do not set the key value by hand, someone might see the typed
5122 key. Use the |:X| command. But you can make 'key' empty: >
5123 :set key=
5124< It is not possible to get the value of this option with ":set key" or
5125 "echo &key". This is to avoid showing it to someone who shouldn't
5126 know. It also means you cannot see it yourself once you have set it,
5127 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005128 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5129 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005130 You can use "&key" in an expression to detect whether encryption is
5131 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
5133 *'keymap'* *'kmp'* *E544*
5134'keymap' 'kmp' string (default "")
5135 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 {only available when compiled with the |+keymap|
5137 feature}
5138 Name of a keyboard mapping. See |mbyte-keymap|.
5139 Setting this option to a valid keymap name has the side effect of
5140 setting 'iminsert' to one, so that the keymap becomes effective.
5141 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005142 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143
5144 *'keymodel'* *'km'*
5145'keymodel' 'km' string (default "")
5146 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005147 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 can do. These values can be used:
5149 startsel Using a shifted special key starts selection (either
5150 Select mode or Visual mode, depending on "key" being
5151 present in 'selectmode').
5152 stopsel Using a not-shifted special key stops selection.
5153 Special keys in this context are the cursor keys, <End>, <Home>,
5154 <PageUp> and <PageDown>.
5155 The 'keymodel' option is set by the |:behave| command.
5156
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005157 *'keyprotocol'* *'kpc'*
5158'keyprotocol' 'kpc' string (default: see below)
5159 global
5160 Specifies what keyboard protocol to use depending on the value of
5161 'term'. The supported keyboard protocols names are:
5162 none whatever the terminal uses
5163 mok2 modifyOtherKeys level 2, as supported by xterm
5164 kitty Kitty keyboard protocol, as supported by Kitty
5165
Bram Moolenaara87749e2022-11-30 10:23:17 +00005166 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005167 a pattern that is matched against the 'term' option, a colon and the
5168 protocol name to be used. To illustrate this, the default value would
5169 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005170 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5171 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005172
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005173< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005174 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5175 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005176
5177 The first match is used, thus if you want to have "kitty" use the
5178 kitty protocol, but "badkitty" not, then you should match "badkitty"
5179 first and use the "none" value: >
5180 set keyprotocol=badkitty:none,kitty:kitty
5181<
5182 The option is used after 'term' has been changed. First the termcap
5183 entries are set, possibly using the builtin list, see |builtin-terms|.
5184 Then this option is inspected and if there is a match and a protocol
5185 is specified the following happens:
5186 none Nothing, the regular t_TE and t_TI values remain
5187
5188 mok2 The t_TE value is changed to:
5189 CSI >4;m disables modifyOtherKeys
5190 The t_TI value is changed to:
5191 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005192 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005193
5194 kitty The t_TE value is changed to:
5195 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005196 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005197 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005198 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005199 CSI ?u request kitty keyboard protocol state
5200 CSI >c request the termresponse
5201
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005202 If you notice problems, such as characters being displayed that
5203 disappear after `CTRL-L`, you might want to try making this option
5204 empty. Then set the 'term' option to have it take effect: >
5205 set keyprotocol=
5206 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005207<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005208
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 *'keywordprg'* *'kp'*
5210'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005211 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 Program to use for the |K| command. Environment variables are
5214 expanded |:set_env|. ":help" may be used to access the Vim internal
5215 help. (Note that previously setting the global option to the empty
5216 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005217 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005218 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005219 When "man", "man -s" or an Ex command is used, Vim will automatically
5220 translate a count for the "K" command and pass it as the first
5221 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 See |option-backslash| about including spaces and backslashes.
5223 Example: >
5224 :set keywordprg=man\ -s
5225< This option cannot be set from a |modeline| or in the |sandbox|, for
5226 security reasons.
5227
5228 *'langmap'* *'lmap'* *E357* *E358*
5229'langmap' 'lmap' string (default "")
5230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 {only available when compiled with the |+langmap|
5232 feature}
5233 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005234 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005235 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 care of translating these special characters to the original meaning
5237 of the key. This means you don't have to change the keyboard mode to
5238 be able to execute Normal mode commands.
5239 This is the opposite of the 'keymap' option, where characters are
5240 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005241 Also consider setting 'langremap' to off, to prevent 'langmap' from
5242 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005243 This option cannot be set from a |modeline| or in the |sandbox|, for
5244 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005246 Example (for Greek, in UTF-8): *greek* >
5247 :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 +00005248< Example (exchanges meaning of z and y for commands): >
5249 :set langmap=zy,yz,ZY,YZ
5250<
5251 The 'langmap' option is a list of parts, separated with commas. Each
5252 part can be in one of two forms:
5253 1. A list of pairs. Each pair is a "from" character immediately
5254 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005255 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 characters. Example: "abc;ABC"
5257 Example: "aA,fgh;FGH,cCdDeE"
5258 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005259 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260
5261 This will allow you to activate vim actions without having to switch
5262 back and forth between the languages. Your language characters will
5263 be understood as normal vim English characters (according to the
5264 langmap mappings) in the following cases:
5265 o Normal/Visual mode (commands, buffer/register names, user mappings)
5266 o Insert/Replace Mode: Register names after CTRL-R
5267 o Insert/Replace Mode: Mappings
5268 Characters entered in Command-line mode will NOT be affected by
5269 this option. Note that this option can be changed at any time
5270 allowing to switch between mappings for different languages/encodings.
5271 Use a mapping to avoid having to type it each time!
5272
5273 *'langmenu'* *'lm'*
5274'langmenu' 'lm' string (default "")
5275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 {only available when compiled with the |+menu| and
5277 |+multi_lang| features}
5278 Language to use for menu translation. Tells which file is loaded
5279 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005280 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281< (without the spaces). For example, to always use the Dutch menus, no
5282 matter what $LANG is set to: >
5283 :set langmenu=nl_NL.ISO_8859-1
5284< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005285 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 If your $LANG is set to a non-English language but you do want to use
5287 the English menus: >
5288 :set langmenu=none
5289< This option must be set before loading menus, switching on filetype
5290 detection or syntax highlighting. Once the menus are defined setting
5291 this option has no effect. But you could do this: >
5292 :source $VIMRUNTIME/delmenu.vim
5293 :set langmenu=de_DE.ISO_8859-1
5294 :source $VIMRUNTIME/menu.vim
5295< Warning: This deletes all menus that you defined yourself!
5296
Bram Moolenaard94464e2015-11-02 15:28:18 +01005297 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005298'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005299 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005300 {only available when compiled with the |+langmap|
5301 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005302 This is just like 'langremap' but with the value inverted. It only
5303 exists for backwards compatibility. When setting 'langremap' then
5304 'langnoremap' is set to the inverted value, and the other way around.
5305
5306 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005307'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005308 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005309 {only available when compiled with the |+langmap|
5310 feature}
5311 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005312 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005313 'langmap' disables some of your mappings, try resetting this option.
5314 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005315 that works for you to avoid mappings to break.
5316
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 *'laststatus'* *'ls'*
5318'laststatus' 'ls' number (default 1)
5319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 The value of this option influences when the last window will have a
5321 status line:
5322 0: never
5323 1: only if there are at least two windows
5324 2: always
5325 The screen looks nicer with a status line if you have several
5326 windows, but it takes another screen line. |status-line|
5327
5328 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5329'lazyredraw' 'lz' boolean (default off)
5330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 When this option is set, the screen will not be redrawn while
5332 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005333 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005335 This may occasionally cause display errors. It is only meant to be set
5336 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005337 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
64-bitman88d41ab2025-04-06 17:20:39 +02005339 *'lhistory'* *'lhi'*
5340'lhistory' 'lhi' number (default: 10)
5341 local to window
5342 {only available when compiled with the |+quickfix|
5343 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005344 Like 'chistory', but for the location list stack associated with a
5345 window. If the option is changed in either the location list window
5346 itself or the window that is associated with the location list stack,
5347 the new value will also be applied to the other one. This means this
5348 value will always be the same for a given location list window and its
5349 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005350
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5352'linebreak' 'lbr' boolean (default off)
5353 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005354 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005356 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 than at the last character that fits on the screen. Unlike
5358 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005359 it only affects the way the file is displayed, not its contents.
5360 If 'breakindent' is set, line is visually indented. Then, the value
5361 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005362 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 Note that <Tab> characters after an <EOL> are mostly not displayed
5364 with the right amount of white space.
5365
5366 *'lines'* *E593*
5367'lines' number (default 24 or terminal height)
5368 global
5369 Number of lines of the Vim window.
5370 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005371 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 When Vim is running in the GUI or in a resizable window, setting this
5373 option will cause the window size to be changed. When you only want
5374 to use the size for the GUI, put the command in your |gvimrc| file.
5375 Vim limits the number of lines to what fits on the screen. You can
5376 use this command to get the tallest window possible: >
5377 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005378< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005379 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 When you set this option and Vim is unable to change the physical
5381 number of lines of the display, the display may be messed up.
5382
5383 *'linespace'* *'lsp'*
5384'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 {only in the GUI}
5387 Number of pixel lines inserted between characters. Useful if the font
5388 uses the full character cell height, making lines touch each other.
5389 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005390 With some fonts there can be too much room between lines (to have
5391 space for ascents and descents). Then it makes sense to set
5392 'linespace' to a negative value. This may cause display problems
5393 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394
5395 *'lisp'* *'nolisp'*
5396'lisp' boolean (default off)
5397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 Lisp mode: When <Enter> is typed in insert mode set the indent for
5399 the next line to Lisp standards (well, sort of). Also happens with
5400 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5401 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5402 better. Also see 'lispwords'.
5403 The '-' character is included in keyword characters. Redefines the
5404 "=" operator to use this same indentation algorithm rather than
5405 calling an external program if 'equalprg' is empty.
5406 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005408 *'lispoptions'* *'lop'*
5409'lispoptions' 'lop' string (default "")
5410 local to buffer
5411 Comma-separated list of items that influence the Lisp indenting when
5412 enabled with the |'lisp'| option. Currently only one item is
5413 supported:
5414 expr:1 use 'indentexpr' for Lisp indenting when it is set
5415 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5416 Note that when using 'indentexpr' the `=` operator indents all the
5417 lines, otherwise the first line is not indented (Vi-compatible).
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 *'lispwords'* *'lw'*
5420'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005421 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005422 Comma-separated list of words that influence the Lisp indenting when
5423 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424
5425 *'list'* *'nolist'*
5426'list' boolean (default off)
5427 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005428 List mode: By default show tabs as CTRL-I is displayed, display $
5429 after end of line. Useful to see the difference between tabs and
5430 spaces and for trailing blanks. Further changed by the 'listchars'
5431 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005432
5433 The cursor is displayed at the start of the space a Tab character
5434 occupies, not at the end as usual in Normal mode. To get this cursor
5435 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005436 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005437<
5438 Note that list mode will also affect formatting (set with 'textwidth'
5439 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 changing the way tabs are displayed.
5441
5442 *'listchars'* *'lcs'*
5443'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005444 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005445 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005446 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005447 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 eol:c Character to show at the end of each line. When
5449 omitted, there is no extra character at the end of the
5450 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005451 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005452 tab:xy[z] Two or three characters to be used to show a tab.
5453 The third character is optional.
5454
5455 tab:xy The 'x' is always used, then 'y' as many times as will
5456 fit. Thus "tab:>-" displays:
5457 >
5458 >-
5459 >--
5460 etc.
5461
5462 tab:xyz The 'z' is always used, then 'x' is prepended, and
5463 then 'y' is used as many times as will fit. Thus
5464 "tab:<->" displays:
5465 >
5466 <>
5467 <->
5468 <-->
5469 etc.
5470
5471 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005472 *lcs-space*
5473 space:c Character to show for a space. When omitted, spaces
5474 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005475 *lcs-multispace*
5476 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005477 One or more characters to use cyclically to show for
5478 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005479 setting, except for single spaces. When omitted, the
5480 "space" setting is used. For example,
5481 `:set listchars=multispace:---+` shows ten consecutive
5482 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005483 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005484 *lcs-lead*
5485 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005486 leading spaces are blank. Overrides the "space" and
5487 "multispace" settings for leading spaces. You can
5488 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005489 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005490< *lcs-leadmultispace*
5491 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005492 Like the |lcs-multispace| value, but for leading
5493 spaces only. Also overrides |lcs-lead| for leading
5494 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005495 `:set listchars=leadmultispace:---+` shows ten
5496 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005497 ---+---+--XXX ~
5498 Where "XXX" denotes the first non-blank characters in
5499 the line.
5500 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005501 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005502 trailing spaces are blank. Overrides the "space" and
5503 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005504 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 extends:c Character to show in the last column, when 'wrap' is
5506 off and the line continues beyond the right of the
5507 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005508 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005509 precedes:c Character to show in the first visible column of the
5510 physical line, when there is text preceding the
5511 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005512 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005513 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005514 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005515 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005516 nbsp:c Character to show for a non-breakable space character
5517 (0xA0 (160 decimal) and U+202F). Left blank when
5518 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005520 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005522 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005524 Each character can be specified as hex: >
5525 set listchars=eol:\\x24
5526 set listchars=eol:\\u21b5
5527 set listchars=eol:\\U000021b5
5528< Note that a double backslash is used. The number of hex characters
5529 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5530
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 Examples: >
5532 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005533 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 :set lcs=extends:>,precedes:<
5535< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005536 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5537 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005538 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539
5540 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5541'loadplugins' 'lpl' boolean (default on)
5542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 When on the plugin scripts are loaded when starting up |load-plugins|.
5544 This option can be reset in your |vimrc| file to disable the loading
5545 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005546 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5547 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548
Bram Moolenaard94464e2015-11-02 15:28:18 +01005549 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005550'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005551 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005552 {only available when compiled with the |+lua/dyn|
5553 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005554 Specifies the name of the Lua shared library. The default is
5555 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005556 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005557 This option cannot be set from a |modeline| or in the |sandbox|, for
5558 security reasons.
5559
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005560 *'macatsui'* *'nomacatsui'*
5561'macatsui' boolean (default on)
5562 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005563 {not supported}
5564 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005565
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 *'magic'* *'nomagic'*
5567'magic' boolean (default on)
5568 global
5569 Changes the special characters that can be used in search patterns.
5570 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005571 WARNING: Switching this option off most likely breaks plugins! That
5572 is because many patterns assume it's on and will fail when it's off.
5573 Only switch it off when working with old Vi scripts. In any other
5574 situation write patterns that work when 'magic' is on. Include "\M"
5575 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005576 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5577 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578
5579 *'makeef'* *'mef'*
5580'makeef' 'mef' string (default: "")
5581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 {not available when compiled without the |+quickfix|
5583 feature}
5584 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5585 and the |:grep| command.
5586 When it is empty, an internally generated temp file will be used.
5587 When "##" is included, it is replaced by a number to make the name
5588 unique. This makes sure that the ":make" command doesn't overwrite an
5589 existing file.
5590 NOT used for the ":cf" command. See 'errorfile' for that.
5591 Environment variables are expanded |:set_env|.
5592 See |option-backslash| about including spaces and backslashes.
5593 This option cannot be set from a |modeline| or in the |sandbox|, for
5594 security reasons.
5595
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005596 *'makeencoding'* *'menc'*
5597'makeencoding' 'menc' string (default "")
5598 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005599 Encoding used for reading the output of external commands. When empty,
5600 encoding is not converted.
5601 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5602 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5603 and `:laddfile`.
5604
5605 This would be mostly useful when you use MS-Windows and set 'encoding'
5606 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5607 'makeencoding' to "char" has the same effect as setting to the system
5608 locale encoding. Example: >
5609 :set encoding=utf-8
5610 :set makeencoding=char " system locale is used
5611<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 *'makeprg'* *'mp'*
5613'makeprg' 'mp' string (default "make", VMS: "MMS")
5614 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005615 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005616 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5617 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005618 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005619 Environment variables are expanded |:set_env|. See |option-backslash|
5620 about including spaces and backslashes.
5621 Note that a '|' must be escaped twice: once for ":set" and once for
5622 the interpretation of a command. When you use a filter called
5623 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 :set makeprg=gmake\ \\\|\ myfilter
5625< The placeholder "$*" can be given (even multiple times) to specify
5626 where the arguments will be included, for example: >
5627 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5628< This option cannot be set from a |modeline| or in the |sandbox|, for
5629 security reasons.
5630
5631 *'matchpairs'* *'mps'*
5632'matchpairs' 'mps' string (default "(:),{:},[:]")
5633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005635 other.
5636 Only character pairs are allowed that are different, thus you cannot
5637 jump between two double quotes.
5638 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005639 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005640 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 :set mps+=<:>
5642
5643< A more exotic example, to jump between the '=' and ';' in an
5644 assignment, useful for languages like C and Java: >
5645 :au FileType c,cpp,java set mps+==:;
5646
5647< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005648 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
5650 *'matchtime'* *'mat'*
5651'matchtime' 'mat' number (default 5)
5652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 Tenths of a second to show the matching paren, when 'showmatch' is
5654 set. Note that this is not in milliseconds, like other options that
5655 set a time. This is to be compatible with Nvi.
5656
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005657 *'maxcombine'* *'mco'*
5658'maxcombine' 'mco' number (default 2)
5659 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005660 The maximum number of combining characters supported for displaying.
5661 Only used when 'encoding' is "utf-8".
5662 The default is OK for most languages. Hebrew may require 4.
5663 Maximum value is 6.
5664 Even when this option is set to 2 you can still edit text with more
5665 combining characters, you just can't see them. Use |g8| or |ga|.
5666 See |mbyte-combining|.
5667
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 *'maxfuncdepth'* *'mfd'*
5669'maxfuncdepth' 'mfd' number (default 100)
5670 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005671 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005672 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 Maximum depth of function calls for user functions. This normally
5674 catches endless recursion. When using a recursive function with
5675 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5676 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005677 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005678 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005680 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681
5682 *'maxmapdepth'* *'mmd'* *E223*
5683'maxmapdepth' 'mmd' number (default 1000)
5684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 Maximum number of times a mapping is done without resulting in a
5686 character to be used. This normally catches endless mappings, like
5687 ":map x y" with ":map y x". It still does not catch ":map g wg",
5688 because the 'w' is used before the next mapping is done. See also
5689 |key-mapping|.
5690
5691 *'maxmem'* *'mm'*
5692'maxmem' 'mm' number (default between 256 to 5120 (system
5693 dependent) or half the amount of memory
5694 available)
5695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5697 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005698 other memory to be freed.
5699 The maximum usable value is about 2000000. Use this to work without a
5700 limit.
5701 The value is ignored when 'swapfile' is off.
5702 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005704 *'maxmempattern'* *'mmp'*
5705'maxmempattern' 'mmp' number (default 1000)
5706 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005707 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005708 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005709 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005710 When Vim runs into the limit it gives an error message and mostly
5711 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005712 Running into the limit often means that the pattern is very
5713 inefficient or too complex. This may already happen with the pattern
5714 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005715 Might also happen on redraw, when syntax rules try to match a complex
5716 text structure.
5717 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5718 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005719
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 *'maxmemtot'* *'mmt'*
5721'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5722 dependent) or half the amount of memory
5723 available)
5724 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005725 Maximum amount of memory in Kbyte to use for all buffers together.
5726 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005727 without a limit.
5728 On 64 bit machines higher values might work. But hey, do you really
5729 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005730 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005731 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005732 Buffers with 'swapfile' off still count to the total amount of memory
5733 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005734 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
5736 *'menuitems'* *'mis'*
5737'menuitems' 'mis' number (default 25)
5738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 {not available when compiled without the |+menu|
5740 feature}
5741 Maximum number of items to use in a menu. Used for menus that are
5742 generated from a list of items, e.g., the Buffers menu. Changing this
5743 option has no direct effect, the menu must be refreshed first.
5744
Christian Brabandt51d4d842024-12-06 17:26:25 +01005745 *'messagesopt'* *'mopt'*
5746'messagesopt' 'mopt' string (default "hit-enter,history:500")
5747 global
5748
zeertzjq8cc43da2024-12-07 16:09:08 +01005749 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005750 following items. Items must be separated by a comma.
5751
zeertzjq8cc43da2024-12-07 16:09:08 +01005752 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005753 'cmdheight' size.
5754
zeertzjq8cc43da2024-12-07 16:09:08 +01005755 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5756 {n} milliseconds so that the user has a chance to read
5757 the message. The maximum value of {n} is 10000. Use
5758 0 to disable the wait (but then the user may miss an
5759 important message).
5760 This item is ignored when "hit-enter" is present, but
5761 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005762
5763 history:{n} Determines how many entries are remembered in the
5764 |:messages| history. The maximum value is 10000.
5765 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005766 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005767
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005768 *'mkspellmem'* *'msm'*
5769'mkspellmem' 'msm' string (default "460000,2000,500")
5770 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005771 {not available when compiled without the |+syntax|
5772 feature}
5773 Parameters for |:mkspell|. This tunes when to start compressing the
5774 word tree. Compression can be slow when there are many words, but
5775 it's needed to avoid running out of memory. The amount of memory used
5776 per word depends very much on how similar the words are, that's why
5777 this tuning is complicated.
5778
5779 There are three numbers, separated by commas:
5780 {start},{inc},{added}
5781
5782 For most languages the uncompressed word tree fits in memory. {start}
5783 gives the amount of memory in Kbyte that can be used before any
5784 compression is done. It should be a bit smaller than the amount of
5785 memory that is available to Vim.
5786
5787 When going over the {start} limit the {inc} number specifies the
5788 amount of memory in Kbyte that can be allocated before another
5789 compression is done. A low number means compression is done after
5790 less words are added, which is slow. A high number means more memory
5791 will be allocated.
5792
5793 After doing compression, {added} times 1024 words can be added before
5794 the {inc} limit is ignored and compression is done when any extra
5795 amount of memory is needed. A low number means there is a smaller
5796 chance of hitting the {inc} limit, less memory is used but it's
5797 slower.
5798
5799 The languages for which these numbers are important are Italian and
5800 Hungarian. The default works for when you have about 512 Mbyte. If
5801 you have 1 Gbyte you could use: >
5802 :set mkspellmem=900000,3000,800
5803< If you have less than 512 Mbyte |:mkspell| may fail for some
5804 languages, no matter what you set 'mkspellmem' to.
5805
dkearns8ebdbc92023-10-29 06:26:19 +11005806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005808
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005810'modeline' 'ml' boolean (Vim default: on (off for root),
5811 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005813 If 'modeline' is on 'modelines' gives the number of lines that is
5814 checked for set commands. If 'modeline' is off or 'modelines' is zero
5815 no lines are checked. See |modeline|.
5816
5817 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5818'modelineexpr' 'mle' boolean (default: off)
5819 global
5820 When on allow some options that are an expression to be set in the
5821 modeline. Check the option for whether it is affected by
5822 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005823 This option cannot be set from a |modeline| or in the |sandbox|, for
5824 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005825
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 *'modelines'* *'mls'*
5827'modelines' 'mls' number (default 5)
5828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 If 'modeline' is on 'modelines' gives the number of lines that is
5830 checked for set commands. If 'modeline' is off or 'modelines' is zero
5831 no lines are checked. See |modeline|.
5832 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5833 set and to the Vim default value when 'compatible' is reset.
5834
5835 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005836 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837'modifiable' 'ma' boolean (default on)
5838 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 When off the buffer contents cannot be changed. The 'fileformat' and
5840 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005841 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842
5843 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5844'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005845 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 When on, the buffer is considered to be modified. This option is set
5847 when:
5848 1. A change was made to the text since it was last written. Using the
5849 |undo| command to go back to the original text will reset the
5850 option. But undoing changes that were made before writing the
5851 buffer will set the option again, since the text is different from
5852 when it was written.
5853 2. 'fileformat' or 'fileencoding' is different from its original
5854 value. The original value is set when the buffer is read or
5855 written. A ":set nomodified" command also resets the original
5856 values to the current values and the 'modified' option will be
5857 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005858 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005859 This option is not set when a change is made to the buffer as the
5860 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5861 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5862 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5864 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005865 Note that the text may actually be the same, e.g. 'modified' is set
5866 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867
5868 *'more'* *'nomore'*
5869'more' boolean (Vim default: on, Vi default: off)
5870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 When on, listings pause when the whole screen is filled. You will get
5872 the |more-prompt|. When this option is off there are no pauses, the
5873 listing continues until finished.
5874 NOTE: This option is set to the Vi default value when 'compatible' is
5875 set and to the Vim default value when 'compatible' is reset.
5876
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005877 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005878'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005879 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005881 Enable the use of the mouse. Works for most terminals (xterm, Win32
5882 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5883 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5884 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005885 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 v Visual mode
5887 i Insert mode
5888 c Command-line mode
5889 h all previous modes when editing a help file
5890 a all previous modes
5891 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005892 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005894< If your terminal can't overrule the mouse events going to the
5895 application, use: >
5896 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005897< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005898 back to Vim using the mouse events.
5899 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5900 "xterm".
5901
5902 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 modeless selection. This doesn't move the text cursor.
5904
5905 See |mouse-using|. Also see |'clipboard'|.
5906
5907 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005908 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 the mouse buttons can still be used by keeping the shift key pressed.
5910 Also see the 'clipboard' option.
5911
5912 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5913'mousefocus' 'mousef' boolean (default off)
5914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 {only works in the GUI}
5916 The window that the mouse pointer is on is automatically activated.
5917 When changing the window layout or window focus in another way, the
5918 mouse pointer is moved to the window with keyboard focus. Off is the
5919 default because it makes using the pull down menus a little goofy, as
5920 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005921 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005922 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923
5924 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5925'mousehide' 'mh' boolean (default on)
5926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 {only works in the GUI}
5928 When on, the mouse pointer is hidden when characters are typed.
5929 The mouse pointer is restored when the mouse is moved.
5930
5931 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005932'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 Sets the model to use for the mouse. The name mostly specifies what
5935 the right mouse button is used for:
5936 extend Right mouse button extends a selection. This works
5937 like in an xterm.
5938 popup Right mouse button pops up a menu. The shifted left
5939 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005940 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941 popup_setpos Like "popup", but the cursor will be moved to the
5942 position where the mouse was clicked, and thus the
5943 selected operation will act upon the clicked object.
5944 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005945 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 course, that right clicking outside a selection will
5947 end Visual mode.
5948 Overview of what button does what for each model:
5949 mouse extend popup(_setpos) ~
5950 left click place cursor place cursor
5951 left drag start selection start selection
5952 shift-left search word extend selection
5953 right click extend selection popup menu (place cursor)
5954 right drag extend selection -
5955 middle click paste paste
5956
5957 In the "popup" model the right mouse button produces a pop-up menu.
5958 You need to define this first, see |popup-menu|.
5959
5960 Note that you can further refine the meaning of buttons with mappings.
5961 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5962 selection (because that's handled in the GUI code directly).
5963
5964 The 'mousemodel' option is set by the |:behave| command.
5965
h_east59858792023-10-25 22:47:05 +09005966 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005967'mousemoveevent' 'mousemev' boolean (default off)
5968 global
5969 {only works in the GUI}
5970 When on, mouse move events are delivered to the input queue and are
5971 available for mapping. The default, off, avoids the mouse movement
5972 overhead except when needed. See |gui-mouse-mapping|.
5973 Warning: Setting this option can make pending mappings to be aborted
5974 when the mouse is moved.
5975 Currently only works in the GUI, may be made to work in a terminal
5976 later.
5977
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005979'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5980 vs:leftright,vd:lrsizing,m:no,
5981 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 {only available when compiled with the |+mouseshape|
5984 feature}
5985 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005986 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 like used for 'guicursor'. Each part consist of a mode/location-list
5988 and an argument-list:
5989 mode-list:shape,mode-list:shape,..
5990 The mode-list is a dash separated list of these modes/locations:
5991 In a normal window: ~
5992 n Normal mode
5993 v Visual mode
5994 ve Visual mode with 'selection' "exclusive" (same as 'v',
5995 if not specified)
5996 o Operator-pending mode
5997 i Insert mode
5998 r Replace mode
5999
6000 Others: ~
6001 c appending to the command-line
6002 ci inserting in the command-line
6003 cr replacing in the command-line
6004 m at the 'Hit ENTER' or 'More' prompts
6005 ml idem, but cursor in the last line
6006 e any mode, pointer below last window
6007 s any mode, pointer on a status line
6008 sd any mode, while dragging a status line
6009 vs any mode, pointer on a vertical separator line
6010 vd any mode, while dragging a vertical separator line
6011 a everywhere
6012
6013 The shape is one of the following:
6014 avail name looks like ~
6015 w x arrow Normal mouse pointer
6016 w x blank no pointer at all (use with care!)
6017 w x beam I-beam
6018 w x updown up-down sizing arrows
6019 w x leftright left-right sizing arrows
6020 w x busy The system's usual busy pointer
6021 w x no The system's usual 'no input' pointer
6022 x udsizing indicates up-down resizing
6023 x lrsizing indicates left-right resizing
6024 x crosshair like a big thin +
6025 x hand1 black hand
6026 x hand2 white hand
6027 x pencil what you write with
6028 x question big ?
6029 x rightup-arrow arrow pointing right-up
6030 w x up-arrow arrow pointing up
6031 x <number> any X11 pointer number (see X11/cursorfont.h)
6032
6033 The "avail" column contains a 'w' if the shape is available for Win32,
6034 x for X11.
6035 Any modes not specified or shapes not available use the normal mouse
6036 pointer.
6037
6038 Example: >
6039 :set mouseshape=s:udsizing,m:no
6040< will make the mouse turn to a sizing arrow over the status lines and
6041 indicate no input when the hit-enter prompt is displayed (since
6042 clicking the mouse has no effect in this state.)
6043
6044 *'mousetime'* *'mouset'*
6045'mousetime' 'mouset' number (default 500)
6046 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006047 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 time in msec between two mouse clicks for the second click to be
6049 recognized as a multi click.
6050
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006051
laburnumT3f7855a2023-12-05 18:37:03 +01006052 *'mzquantum'* *'mzq'*
6053'mzquantum' 'mzq' number (default 100)
6054 global
6055 {not available when compiled without the |+mzscheme|
6056 feature}
6057 The number of milliseconds between polls for MzScheme threads.
6058 Negative or zero value means no thread scheduling.
6059 NOTE: This option is set to the Vim default value when 'compatible'
6060 is reset.
6061
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006062 *'mzschemedll'*
6063'mzschemedll' string (default depends on the build)
6064 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006065 {only available when compiled with the |+mzscheme/dyn|
6066 feature}
6067 Specifies the name of the MzScheme shared library. The default is
6068 DYNAMIC_MZSCH_DLL which was specified at compile time.
6069 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006070 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006071 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006072 This option cannot be set from a |modeline| or in the |sandbox|, for
6073 security reasons.
6074
6075 *'mzschemegcdll'*
6076'mzschemegcdll' string (default depends on the build)
6077 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006078 {only available when compiled with the |+mzscheme/dyn|
6079 feature}
6080 Specifies the name of the MzScheme GC shared library. The default is
6081 DYNAMIC_MZGC_DLL which was specified at compile time.
6082 The value can be equal to 'mzschemedll' if it includes the GC code.
6083 Environment variables are expanded |:set_env|.
6084 This option cannot be set from a |modeline| or in the |sandbox|, for
6085 security reasons.
6086
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006088'nrformats' 'nf' string (default "bin,octal,hex",
6089 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 This defines what bases Vim will consider for numbers when using the
6092 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6093 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006094 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006096 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006097 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006099 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 considered to be hexadecimal. Example: Using CTRL-X on
6101 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006102 bin If included, numbers starting with "0b" or "0B" will be
6103 considered to be binary. Example: Using CTRL-X on
6104 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006105 unsigned If included, numbers are recognized as unsigned. Thus a
6106 leading dash or negative sign won't be considered as part of
6107 the number. Examples:
6108 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6109 (without "unsigned" it would become "9-2021").
6110 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6111 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006112 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6113 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006114 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006115 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006116 dash immediately preceded by a non-whitespace character (i.e.,
6117 not a tab or a " "), the negative sign won't be considered as
6118 part of the number. For example:
6119 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6120 (without "blank" it would become "Carbon-13").
6121 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006122 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006123 set, it would result in "Carbon -7").
6124 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006125 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006126 included, "unsigned" will take precedence.
6127
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 Numbers which simply begin with a digit in the range 1-9 are always
6129 considered decimal. This also happens for numbers that are not
6130 recognized as octal or hex.
6131
6132 *'number'* *'nu'* *'nonumber'* *'nonu'*
6133'number' 'nu' boolean (default off)
6134 local to window
6135 Print the line number in front of each line. When the 'n' option is
6136 excluded from 'cpoptions' a wrapped line will not use the column of
6137 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006138 The 'numberwidth' option can be used to set the room used for the line
6139 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 When a long, wrapped line doesn't start with the first character, '-'
6141 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006142 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6143 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006144 *number_relativenumber*
6145 The 'relativenumber' option changes the displayed number to be
6146 relative to the cursor. Together with 'number' there are these
6147 four combinations (cursor in line 3):
6148
Bram Moolenaar3848e002016-03-19 18:42:29 +01006149 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006150 'nornu' 'nornu' 'rnu' 'rnu'
6151
6152 |apple | 1 apple | 2 apple | 2 apple
6153 |pear | 2 pear | 1 pear | 1 pear
6154 |nobody | 3 nobody | 0 nobody |3 nobody
6155 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006157 *'numberwidth'* *'nuw'*
6158'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6159 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006160 {only available when compiled with the |+linebreak|
6161 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006162 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006163 when the 'number' or 'relativenumber' option is set or printing lines
6164 with a line number. Since one space is always between the number and
6165 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006166 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006167 fit the highest line number in the buffer respectively the number of
6168 rows in the window, depending on whether 'number' or 'relativenumber'
6169 is set. Thus with the Vim default of 4 there is room for a line number
6170 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006171 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006172 NOTE: This option is set to the Vi default value when 'compatible' is
6173 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006174
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006175 *'omnifunc'* *'ofu'*
6176'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006177 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006178 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006179 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006180 This option specifies a function to be used for Insert mode omni
6181 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006182 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006183 invoked and what it should return. The value can be the name of a
6184 function, a |lambda| or a |Funcref|. See |option-value-function| for
6185 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006186 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006187 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006188 This option cannot be set from a |modeline| or in the |sandbox|, for
6189 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006190
Bram Moolenaar02467872007-05-06 13:22:01 +00006191 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006192'opendevice' 'odev' boolean (default off)
6193 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006194 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006195 Enable reading and writing from devices. This may get Vim stuck on a
6196 device that can be opened but doesn't actually do the I/O. Therefore
6197 it is off by default.
6198 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6199 result in editing a device.
6200
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006201 *'operatorfunc'* *'opfunc'*
6202'operatorfunc' 'opfunc' string (default: empty)
6203 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006204 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006205 See |:map-operator| for more info and an example. The value can be
6206 the name of a function, a |lambda| or a |Funcref|. See
6207 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006208
6209 This option cannot be set from a |modeline| or in the |sandbox|, for
6210 security reasons.
6211
Bram Moolenaar251e1912011-06-19 05:09:16 +02006212 *'osfiletype'* *'oft'*
6213'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006215 This option was supported on RISC OS, which has been removed.
6216
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006217 *'packpath'* *'pp'*
6218'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006219 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006220 This option cannot be set from a |modeline| or in the |sandbox|, for
6221 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006222
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006224'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 global
6226 Specifies the nroff macros that separate paragraphs. These are pairs
6227 of two letters (see |object-motions|).
6228
6229 *'paste'* *'nopaste'*
6230'paste' boolean (default off)
6231 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006232 Put Vim in Paste mode. This is useful if you want to cut or copy
6233 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 unexpected effects.
6235 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006236 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 knows about pasting and will mostly do the right thing without 'paste'
6238 being set. The same is true for a terminal where Vim handles the
6239 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006240 This option is reset when starting the GUI. Thus if you set it in
6241 your .vimrc it will work in a terminal, but not in the GUI. Setting
6242 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6243 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 When the 'paste' option is switched on (also when it was already on):
6245 - mapping in Insert mode and Command-line mode is disabled
6246 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006248 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006249 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 - 'revins' is reset
6251 - 'ruler' is reset
6252 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006253 - 'smarttab' is reset
6254 - 'softtabstop' is set to 0
6255 - 'textwidth' is set to 0
6256 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006257 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006260 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006261 - 'indentexpr'
6262 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006263 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 NOTE: When you start editing another file while the 'paste' option is
6265 on, settings from the modelines or autocommands may change the
6266 settings again, causing trouble when pasting text. You might want to
6267 set the 'paste' option again.
6268 When the 'paste' option is reset the mentioned options are restored to
6269 the value before the moment 'paste' was switched from off to on.
6270 Resetting 'paste' before ever setting it does not have any effect.
6271 Since mapping doesn't work while 'paste' is active, you need to use
6272 the 'pastetoggle' option to toggle the 'paste' option with some key.
6273
6274 *'pastetoggle'* *'pt'*
6275'pastetoggle' 'pt' string (default "")
6276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 When non-empty, specifies the key sequence that toggles the 'paste'
6278 option. This is like specifying a mapping: >
6279 :map {keys} :set invpaste<CR>
6280< Where {keys} is the value of 'pastetoggle'.
6281 The difference is that it will work even when 'paste' is set.
6282 'pastetoggle' works in Insert mode and Normal mode, but not in
6283 Command-line mode.
6284 Mappings are checked first, thus overrule 'pastetoggle'. However,
6285 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6286 this: >
6287 :map <F10> :set paste<CR>
6288 :map <F11> :set nopaste<CR>
6289 :imap <F10> <C-O>:set paste<CR>
6290 :imap <F11> <nop>
6291 :set pastetoggle=<F11>
6292< This will make <F10> start paste mode and <F11> stop paste mode.
6293 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6294 mode everything is inserted literally, except the 'pastetoggle' key
6295 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006296 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297
6298 *'pex'* *'patchexpr'*
6299'patchexpr' 'pex' string (default "")
6300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 {not available when compiled without the |+diff|
6302 feature}
6303 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006304 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006305 This option cannot be set from a |modeline| or in the |sandbox|, for
6306 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307
Bram Moolenaardbc28022014-07-26 13:40:44 +02006308 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309'patchmode' 'pm' string (default "")
6310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 When non-empty the oldest version of a file is kept. This can be used
6312 to keep the original version of a file if you are changing files in a
6313 source distribution. Only the first time that a file is written a
6314 copy of the original file will be kept. The name of the copy is the
6315 name of the original file with the string in the 'patchmode' option
6316 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006317 ".orig" or ".org". 'backupdir' must not be empty for this to work
6318 (Detail: The backup file is renamed to the patchmode file after the
6319 new file has been successfully written, that's why it must be possible
6320 to write a backup file). If there was no file to be backed up, an
6321 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 When the 'backupskip' pattern matches, a patchmode file is not made.
6323 Using 'patchmode' for compressed files appends the extension at the
6324 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6325 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006326 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006328 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 other systems: ".,,")
6331 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006333 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6334 provided that the file being searched for has a relative path (not
6335 starting with "/", "./" or "../"). The directories in the 'path'
6336 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 - Use commas to separate directory names: >
6338 :set path=.,/usr/local/include,/usr/include
6339< - Spaces can also be used to separate directory names (for backwards
6340 compatibility with version 3.0). To have a space in a directory
6341 name, precede it with an extra backslash, and escape the space: >
6342 :set path=.,/dir/with\\\ space
6343< - To include a comma in a directory name precede it with an extra
6344 backslash: >
6345 :set path=.,/dir/with\\,comma
6346< - To search relative to the directory of the current file, use: >
6347 :set path=.
6348< - To search in the current directory use an empty string between two
6349 commas: >
6350 :set path=,,
6351< - A directory name may end in a ':' or '/'.
6352 - Environment variables are expanded |:set_env|.
6353 - When using |netrw.vim| URLs can be used. For example, adding
6354 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006355 - Search upwards and downwards in a directory tree using "*", "**" and
6356 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 - Careful with '\' characters, type two to get one in the option: >
6358 :set path=.,c:\\include
6359< Or just use '/' instead: >
6360 :set path=.,c:/include
6361< Don't forget "." or files won't even be found in the same directory as
6362 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006363 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 it is something like 256 or 1024 characters.
6365 You can check if all the include files are found, using the value of
6366 'path', see |:checkpath|.
6367 The use of |:set+=| and |:set-=| is preferred when adding or removing
6368 directories from the list. This avoids problems when a future version
6369 uses another default. To remove the current directory use: >
6370 :set path-=
6371< To add the current directory use: >
6372 :set path+=
6373< To use an environment variable, you probably need to replace the
6374 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006375 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006376 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377< Replace the ';' with a ':' or whatever separator is used. Note that
6378 this doesn't work when $INCL contains a comma or white space.
6379
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006380 *'perldll'*
6381'perldll' string (default depends on the build)
6382 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006383 {only available when compiled with the |+perl/dyn|
6384 feature}
6385 Specifies the name of the Perl shared library. The default is
6386 DYNAMIC_PERL_DLL, which was specified at compile time.
6387 Environment variables are expanded |:set_env|.
6388 This option cannot be set from a |modeline| or in the |sandbox|, for
6389 security reasons.
6390
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6392'preserveindent' 'pi' boolean (default off)
6393 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 When changing the indent of the current line, preserve as much of the
6395 indent structure as possible. Normally the indent is replaced by a
6396 series of tabs followed by spaces as required (unless |'expandtab'| is
6397 enabled, in which case only spaces are used). Enabling this option
6398 means the indent will preserve as many existing characters as possible
6399 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006400 'expandtab' does not apply to the preserved white space, a Tab remains
6401 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 NOTE: When using ">>" multiple times the resulting indent is a mix of
6403 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006404 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 Also see 'copyindent'.
6406 Use |:retab| to clean up white space.
6407
6408 *'previewheight'* *'pvh'*
6409'previewheight' 'pvh' number (default 12)
6410 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006411 {not available when compiled without the |+quickfix|
6412 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006414 commands. Used for |CTRL-W_}| when no count is given. Not used when
6415 'previewpopup' is set.
6416
6417 *'previewpopup'* *'pvp'*
6418'previewpopup' 'pvp' string (default empty)
6419 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006420 {not available when compiled without the |+textprop|
6421 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006422 When not empty a popup window is used for commands that would open a
6423 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006424 Not used for the insert completion info, add "popup" to
6425 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426
6427 *'previewwindow'* *'nopreviewwindow'*
6428 *'pvw'* *'nopvw'* *E590*
6429'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006430 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006431 {not available when compiled without the |+quickfix|
6432 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006433 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 set. It's normally not set directly, but by using one of the commands
6435 |:ptag|, |:pedit|, etc.
6436
6437 *'printdevice'* *'pdev'*
6438'printdevice' 'pdev' string (default empty)
6439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 {only available when compiled with the |+printer|
6441 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006442 The name of the printer to be used for |:hardcopy|.
6443 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006444 This option cannot be set from a |modeline| or in the |sandbox|, for
6445 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446
Bram Moolenaar8299df92004-07-10 09:47:34 +00006447 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006448'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 {only available when compiled with the |+printer|
6451 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006452 Sets the character encoding used when printing.
6453 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454
6455 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006456'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 {only available when compiled with the |+printer|
6459 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006460 Expression used to print the PostScript produced with |:hardcopy|.
6461 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006462 This option cannot be set from a |modeline| or in the |sandbox|, for
6463 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464
Bram Moolenaar8299df92004-07-10 09:47:34 +00006465 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466'printfont' 'pfn' string (default "courier")
6467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 {only available when compiled with the |+printer|
6469 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006470 The name of the font that will be used for |:hardcopy|.
6471 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472
6473 *'printheader'* *'pheader'*
6474'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 {only available when compiled with the |+printer|
6477 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006478 The format of the header produced in |:hardcopy| output.
6479 See |pheader-option|.
6480
6481 *'printmbcharset'* *'pmbcs'*
6482'printmbcharset' 'pmbcs' string (default "")
6483 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006484 {only available when compiled with the |+printer|
6485 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006486 The CJK character set to be used for CJK output from |:hardcopy|.
6487 See |pmbcs-option|.
6488
6489 *'printmbfont'* *'pmbfn'*
6490'printmbfont' 'pmbfn' string (default "")
6491 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006492 {only available when compiled with the |+printer|
6493 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006494 List of font names to be used for CJK output from |:hardcopy|.
6495 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496
6497 *'printoptions'* *'popt'*
6498'printoptions' 'popt' string (default "")
6499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006501 List of items that control the format of the output of |:hardcopy|.
6502 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006504 *'prompt'* *'noprompt'*
6505'prompt' boolean (default on)
6506 global
6507 When on a ":" prompt is used in Ex mode.
6508
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006509 *'pumheight'* *'ph'*
6510'pumheight' 'ph' number (default 0)
6511 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006512 Determines the maximum number of items to show in the popup menu for
6513 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006514 |ins-completion-menu|.
6515
glepnir88d75932025-03-27 20:09:07 +01006516 *'pummaxwidth'* *'pmw'*
6517'pummaxwidth' 'pmw' number (default 0)
6518 global
6519 Determines the maximum width to use for the popup menu for completion.
6520 When zero, there is no maximum width limit, otherwise the popup menu
6521 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006522 by "trunc" value of 'fillchars' option.
6523
6524 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006525 |ins-completion-menu|.
6526
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006527 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006528'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006529 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006530 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006531 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006532
Bram Moolenaard94464e2015-11-02 15:28:18 +01006533 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006534'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006535 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006536 {only available when compiled with the |+python/dyn|
6537 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006538 Specifies the name of the Python 2.x shared library. The default is
6539 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006540 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006541 This option cannot be set from a |modeline| or in the |sandbox|, for
6542 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006543
Bram Moolenaar94073162018-01-31 21:49:05 +01006544 *'pythonhome'*
6545'pythonhome' string (default "")
6546 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006547 {only available when compiled with the |+python/dyn|
6548 feature}
6549 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6550 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6551 which was specified at compile time, will be used for the Python 2.x
6552 home directory.
6553 Environment variables are expanded |:set_env|.
6554 This option cannot be set from a |modeline| or in the |sandbox|, for
6555 security reasons.
6556
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006557 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006558'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006559 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006560 {only available when compiled with the |+python3/dyn|
6561 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006562 Specifies the name of the Python 3 shared library. The default is
6563 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006564 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006565 This option cannot be set from a |modeline| or in the |sandbox|, for
6566 security reasons.
6567
Bram Moolenaar94073162018-01-31 21:49:05 +01006568 *'pythonthreehome'*
6569'pythonthreehome' string (default "")
6570 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006571 {only available when compiled with the |+python3/dyn|
6572 feature}
6573 Specifies the name of the Python 3 home directory. When
6574 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6575 PYTHON3_HOME, which was specified at compile time, will be used for
6576 the Python 3 home directory.
6577 Environment variables are expanded |:set_env|.
6578 This option cannot be set from a |modeline| or in the |sandbox|, for
6579 security reasons.
6580
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006581 *'pyxversion'* *'pyx'*
6582'pyxversion' 'pyx' number (default depends on the build)
6583 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006584 {only available when compiled with the |+python| or
6585 the |+python3| feature}
6586 Specifies the python version used for pyx* functions and commands
6587 |python_x|. The default value is as follows:
6588
6589 Compiled with Default ~
6590 |+python| and |+python3| 0
6591 only |+python| 2
6592 only |+python3| 3
6593
6594 Available values are 0, 2 and 3.
6595 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6596 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6597 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6598 to 2 if Python 2 is available.
6599 See also: |has-pythonx|
6600
6601 If Vim is compiled with only |+python| or |+python3| setting
6602 'pyxversion' has no effect. The pyx* functions and commands are
6603 always the same as the compiled version.
6604
6605 This option cannot be set from a |modeline| or in the |sandbox|, for
6606 security reasons.
6607
Bram Moolenaar858ba062020-05-31 23:11:59 +02006608 *'quickfixtextfunc'* *'qftf'*
6609'quickfixtextfunc' 'qftf' string (default "")
6610 global
6611 {only available when compiled with the |+quickfix|
6612 feature}
6613 This option specifies a function to be used to get the text to display
6614 in the quickfix and location list windows. This can be used to
6615 customize the information displayed in the quickfix or location window
6616 for each entry in the corresponding quickfix or location list. See
6617 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006618 function and an example. The value can be the name of a function, a
6619 |lambda| or a |Funcref|. See |option-value-function| for more
6620 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006621
6622 This option cannot be set from a |modeline| or in the |sandbox|, for
6623 security reasons.
6624
Bram Moolenaar677ee682005-01-27 14:41:15 +00006625 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006626'quoteescape' 'qe' string (default "\")
6627 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006628 The characters that are used to escape quotes in a string. Used for
6629 objects like a', a" and a` |a'|.
6630 When one of the characters in this option is found inside a string,
6631 the following character will be skipped. The default value makes the
6632 text "foo\"bar\\" considered to be one string.
6633
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6635'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006636 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 If on, writes fail unless you use a '!'. Protects you from
6638 accidentally overwriting a file. Default on when Vim is started
6639 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006640 When using ":w!" the 'readonly' option is reset for the current
6641 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006642 When using the ":view" command the 'readonly' option is set for the
6643 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006644 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006646 *'redrawtime'* *'rdt'*
6647'redrawtime' 'rdt' number (default 2000)
6648 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006649 {only available when compiled with the |+reltime|
6650 feature}
6651 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006652 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006653 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006654 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006655 matches will be highlighted.
6656 For syntax highlighting the time applies per window. When over the
6657 limit syntax highlighting is disabled until |CTRL-L| is used.
6658 This is used to avoid that Vim hangs when using a very complicated
6659 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006660
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006661 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006662'regexpengine' 're' number (default 0)
6663 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006664 This selects the default regexp engine. |two-engines|
6665 The possible values are:
6666 0 automatic selection
6667 1 old engine
6668 2 NFA engine
6669 Note that when using the NFA engine and the pattern contains something
6670 that is not supported the pattern will not match. This is only useful
6671 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006672 Using automatic selection enables Vim to switch the engine, if the
6673 default engine becomes too costly. E.g., when the NFA engine uses too
6674 many states. This should prevent Vim from hanging on a combination of
6675 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006676
Bram Moolenaar64486672010-05-16 15:46:46 +02006677 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6678'relativenumber' 'rnu' boolean (default off)
6679 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006680 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006681 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006682 precede some vertical motion commands (e.g. j k + -) with, without
6683 having to calculate it yourself. Especially useful in combination with
6684 other commands (e.g. y d c < > gq gw =).
6685 When the 'n' option is excluded from 'cpoptions' a wrapped
6686 line will not use the column of line numbers (this is the default when
6687 'compatible' isn't set).
6688 The 'numberwidth' option can be used to set the room used for the line
6689 number.
6690 When a long, wrapped line doesn't start with the first character, '-'
6691 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006692 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6693 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006694
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006695 The number in front of the cursor line also depends on the value of
6696 'number', see |number_relativenumber| for all combinations of the two
6697 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006698
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 *'remap'* *'noremap'*
6700'remap' boolean (default on)
6701 global
6702 Allows for mappings to work recursively. If you do not want this for
6703 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006704 NOTE: To avoid portability problems with Vim scripts, always keep
6705 this option at the default "on". Only switch it off when working with
6706 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707
zeertzjqd086b8f2024-02-25 15:42:52 +08006708 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006709'renderoptions' 'rop' string (default: empty)
6710 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006711 {only available when compiled with GUI and DIRECTX on
6712 MS-Windows}
6713 Select a text renderer and set its options. The options depend on the
6714 renderer.
6715
6716 Syntax: >
6717 set rop=type:{renderer}(,{name}:{value})*
6718<
6719 Currently, only one optional renderer is available.
6720
6721 render behavior ~
6722 directx Vim will draw text using DirectX (DirectWrite). It makes
6723 drawn glyphs more beautiful than default GDI.
6724 It requires 'encoding' is "utf-8", and only works on
6725 MS-Windows Vista or newer version.
6726
6727 Options:
6728 name meaning type value ~
6729 gamma gamma float 1.0 - 2.2 (maybe)
6730 contrast enhancedContrast float (unknown)
6731 level clearTypeLevel float (unknown)
6732 geom pixelGeometry int 0 - 2 (see below)
6733 renmode renderingMode int 0 - 6 (see below)
6734 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006735 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006736
Bram Moolenaar92467d32017-12-05 13:22:16 +01006737 See this URL for detail (except for scrlines):
6738 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006739
6740 For geom: structure of a device pixel.
6741 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6742 1 - DWRITE_PIXEL_GEOMETRY_RGB
6743 2 - DWRITE_PIXEL_GEOMETRY_BGR
6744
6745 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006746 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006747
6748 For renmode: method of rendering glyphs.
6749 0 - DWRITE_RENDERING_MODE_DEFAULT
6750 1 - DWRITE_RENDERING_MODE_ALIASED
6751 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6752 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6753 4 - DWRITE_RENDERING_MODE_NATURAL
6754 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6755 6 - DWRITE_RENDERING_MODE_OUTLINE
6756
6757 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006758 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006759
6760 For taamode: antialiasing mode used for drawing text.
6761 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6762 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6763 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6764 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6765
6766 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006767 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6768
Bram Moolenaara338adc2018-01-31 20:51:47 +01006769 For scrlines:
6770 This was used for optimizing scrolling behavior, however this
6771 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006772
6773 Example: >
6774 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006775 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006776 set rop=type:directx
6777<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006778 If select a raster font (Courier, Terminal or FixedSys which
6779 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006780 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006781
6782 NOTE: It is known that some fonts and options combination
6783 causes trouble on drawing glyphs.
6784
Bram Moolenaar92467d32017-12-05 13:22:16 +01006785 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006786 special made fonts (True-Type fonts which includes only
6787 bitmap glyphs).
6788 - 'taamode:3' will not work with some vector fonts.
6789
6790 NOTE: With this option, you can display colored emoji
6791 (emoticon) in Windows 8.1 or later. To display colored emoji,
6792 there are some conditions which you should notice.
6793
6794 - If your font includes non-colored emoji already, it will
6795 be used.
6796 - If your font doesn't have emoji, the system chooses an
6797 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6798 will be used.
6799 - When this alternative font didn't have fixed width glyph,
6800 emoji might be rendered beyond the bounding box of drawing
6801 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006802
6803 Other render types are currently not supported.
6804
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 *'report'*
6806'report' number (default 2)
6807 global
6808 Threshold for reporting number of lines changed. When the number of
6809 changed lines is more than 'report' a message will be given for most
6810 ":" commands. If you want it always, set 'report' to 0.
6811 For the ":substitute" command the number of substitutions is used
6812 instead of the number of lines.
6813
6814 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6815'restorescreen' 'rs' boolean (default on)
6816 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006817 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 When set, the screen contents is restored when exiting Vim. This also
6819 happens when executing external commands.
6820
6821 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6822 options in your .vimrc. To disable restoring:
6823 set t_ti= t_te=
6824 To enable restoring (for an xterm):
6825 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6826 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6827
6828 *'revins'* *'ri'* *'norevins'* *'nori'*
6829'revins' 'ri' boolean (default off)
6830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 {only available when compiled with the |+rightleft|
6832 feature}
6833 Inserting characters in Insert mode will work backwards. See "typing
6834 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6835 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006836 NOTE: This option is reset when 'compatible' is set.
6837 This option is reset when 'paste' is set and restored when 'paste' is
6838 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839
6840 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6841'rightleft' 'rl' boolean (default off)
6842 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 {only available when compiled with the |+rightleft|
6844 feature}
6845 When on, display orientation becomes right-to-left, i.e., characters
6846 that are stored in the file appear from the right to the left.
6847 Using this option, it is possible to edit files for languages that
6848 are written from the right to the left such as Hebrew and Arabic.
6849 This option is per window, so it is possible to edit mixed files
6850 simultaneously, or to view the same file in both ways (this is
6851 useful whenever you have a mixed text file with both right-to-left
6852 and left-to-right strings so that both sets are displayed properly
6853 in different windows). Also see |rileft.txt|.
6854
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006855 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856'rightleftcmd' 'rlc' string (default "search")
6857 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 {only available when compiled with the |+rightleft|
6859 feature}
6860 Each word in this option enables the command line editing to work in
6861 right-to-left mode for a group of commands:
6862
6863 search "/" and "?" commands
6864
6865 This is useful for languages such as Hebrew, Arabic and Farsi.
6866 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6867
Bram Moolenaard94464e2015-11-02 15:28:18 +01006868 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006869'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006870 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006871 {only available when compiled with the |+ruby/dyn|
6872 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006873 Specifies the name of the Ruby shared library. The default is
6874 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006875 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006876 This option cannot be set from a |modeline| or in the |sandbox|, for
6877 security reasons.
6878
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006880'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006883 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 text in the file is shown on the far right:
6885 Top first line is visible
6886 Bot last line is visible
6887 All first and last line are visible
6888 45% relative position in the file
6889 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006890 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006891 ruler is shown there. Otherwise it is shown in the last line of the
6892 screen. If the statusline is given by 'statusline' (i.e. not empty),
6893 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006895 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 the text column (byte number) and the screen column are shown,
6897 separated with a dash.
6898 For an empty line "0-1" is shown.
6899 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006900 This option is reset when 'paste' is set and restored when 'paste' is
6901 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 If you don't want to see the ruler all the time but want to know where
6903 you are, use "g CTRL-G" |g_CTRL-G|.
6904 NOTE: This option is reset when 'compatible' is set.
6905
6906 *'rulerformat'* *'ruf'*
6907'rulerformat' 'ruf' string (default empty)
6908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 {not available when compiled without the |+statusline|
6910 feature}
6911 When this option is not empty, it determines the content of the ruler
6912 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006913 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006914 This option cannot be set in a modeline when 'modelineexpr' is off.
6915
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 The default ruler width is 17 characters. To make the ruler 15
6917 characters wide, put "%15(" at the start and "%)" at the end.
6918 Example: >
6919 :set rulerformat=%15(%c%V\ %p%%%)
6920<
6921 *'runtimepath'* *'rtp'* *vimfiles*
6922'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006923 Unix: "$HOME/.vim or
6924 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 $VIM/vimfiles,
6926 $VIMRUNTIME,
6927 $VIM/vimfiles/after,
6928 $HOME/.vim/after"
6929 Amiga: "home:vimfiles,
6930 $VIM/vimfiles,
6931 $VIMRUNTIME,
6932 $VIM/vimfiles/after,
6933 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006934 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 $VIM/vimfiles,
6936 $VIMRUNTIME,
6937 $VIM/vimfiles/after,
6938 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006939 Haiku: "$BE_USER_SETTINGS/vim,
6940 $VIM/vimfiles,
6941 $VIMRUNTIME,
6942 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006943 $BE_USER_SETTINGS/vim/after"
6944 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 $VIM/vimfiles,
6946 $VIMRUNTIME,
6947 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006948 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 This is a list of directories which will be searched for runtime
6951 files:
6952 filetype.vim filetypes by file name |new-filetype|
6953 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006954 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 colors/ color scheme files |:colorscheme|
6956 compiler/ compiler files |:compiler|
6957 doc/ documentation |write-local-help|
6958 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006959 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 indent/ indent scripts |indent-expression|
6961 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006962 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006964 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 plugin/ plugin scripts |write-plugin|
6966 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006967 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 syntax/ syntax files |mysyntaxfile|
6969 tutor/ files for vimtutor |tutor|
6970
6971 And any other file searched for with the |:runtime| command.
6972
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006973 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6974
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 The defaults for most systems are setup to search five locations:
6976 1. In your home directory, for your personal preferences.
6977 2. In a system-wide Vim directory, for preferences from the system
6978 administrator.
6979 3. In $VIMRUNTIME, for files distributed with Vim.
6980 *after-directory*
6981 4. In the "after" directory in the system-wide Vim directory. This is
6982 for the system administrator to overrule or add to the distributed
6983 defaults (rarely needed)
6984 5. In the "after" directory in your home directory. This is for
6985 personal preferences to overrule or add to the distributed defaults
6986 or system-wide settings (rarely needed).
6987
Bram Moolenaard0796902016-09-16 20:02:31 +02006988 More entries are added when using |packages|. If it gets very long
6989 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6990 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006991
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6993 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006994 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 wildcards.
6996 See |:runtime|.
6997 Example: >
6998 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6999< This will use the directory "~/vimruntime" first (containing your
7000 personal Vim runtime files), then "/mygroup/vim" (shared between a
7001 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7002 files).
7003 You probably should always include $VIMRUNTIME somewhere, to use the
7004 distributed runtime files. You can put a directory before $VIMRUNTIME
7005 to find files which replace a distributed runtime files. You can put
7006 a directory after $VIMRUNTIME to find files which add to distributed
7007 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007008 When Vim is started with |--clean| the home directory entries are not
7009 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 This option cannot be set from a |modeline| or in the |sandbox|, for
7011 security reasons.
7012
7013 *'scroll'* *'scr'*
7014'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007015 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7017 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007018 changes. This may happen when enabling the |status-line| or
7019 'tabline' option after setting the 'scroll' option.
7020 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007021 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007022 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023
7024 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7025'scrollbind' 'scb' boolean (default off)
7026 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007027 See also |scroll-binding|. When this option is set, scrolling the
7028 current window also scrolls other scrollbind windows (windows that
7029 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 differences between two versions of a file, see 'diff'.
7031 See |'scrollopt'| for options that determine how this option should be
7032 interpreted.
7033 This option is mostly reset when splitting a window to edit another
7034 file. This means that ":split | edit file" results in two windows
7035 with scroll-binding, but ":split file" does not.
7036
Bram Moolenaarae20f342019-11-05 21:09:23 +01007037 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7038'scrollfocus' 'scf' boolean (default off)
7039 global
7040 {only for MS-Windows GUI}
7041 When using the scroll wheel and this option is set, the window under
7042 the mouse pointer is scrolled. With this option off the current
7043 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007044 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007045
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 *'scrolljump'* *'sj'*
7047'scrolljump' 'sj' number (default 1)
7048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 Minimal number of lines to scroll when the cursor gets off the
7050 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7051 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007052 When set to a negative number from -1 to -100 this is used as the
7053 percentage of the window height. Thus -50 scrolls half the window
7054 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 NOTE: This option is set to 1 when 'compatible' is set.
7056
7057 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007058'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007059 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 Minimal number of screen lines to keep above and below the cursor.
7061 This will make some context visible around where you are working. If
7062 you set it to a very large value (999) the cursor line will always be
7063 in the middle of the window (except at the start or end of the file or
7064 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007065 After using the local value, go back the global value with one of
7066 these two: >
7067 setlocal scrolloff<
7068 setlocal scrolloff=-1
7069< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 NOTE: This option is set to 0 when 'compatible' is set.
7071
7072 *'scrollopt'* *'sbo'*
7073'scrollopt' 'sbo' string (default "ver,jump")
7074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007076 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7077 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 The following words are available:
7079 ver Bind vertical scrolling for 'scrollbind' windows
7080 hor Bind horizontal scrolling for 'scrollbind' windows
7081 jump Applies to the offset between two windows for vertical
7082 scrolling. This offset is the difference in the first
7083 displayed line of the bound windows. When moving
7084 around in a window, another 'scrollbind' window may
7085 reach a position before the start or after the end of
7086 the buffer. The offset is not changed though, when
7087 moving back the 'scrollbind' window will try to scroll
7088 to the desired position when possible.
7089 When now making that window the current one, two
7090 things can be done with the relative offset:
7091 1. When "jump" is not included, the relative offset is
7092 adjusted for the scroll position in the new current
7093 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007094 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 2. When "jump" is included, the other windows are
7096 scrolled to keep the same relative offset. When
7097 going back to the other window, it still uses the
7098 same relative offset.
7099 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007100 When 'diff' mode is active there always is vertical scroll binding,
7101 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102
7103 *'sections'* *'sect'*
7104'sections' 'sect' string (default "SHNHH HUnhsh")
7105 global
7106 Specifies the nroff macros that separate sections. These are pairs of
7107 two letters (See |object-motions|). The default makes a section start
7108 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7109
7110 *'secure'* *'nosecure'* *E523*
7111'secure' boolean (default off)
7112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 When on, ":autocmd", shell and write commands are not allowed in
7114 ".vimrc" and ".exrc" in the current directory and map commands are
7115 displayed. Switch it off only if you know that you will not run into
7116 problems, or when the 'exrc' option is off. On Unix this option is
7117 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007118 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 'secure' at the end of your ~/.vimrc then.
7120 This option cannot be set from a |modeline| or in the |sandbox|, for
7121 security reasons.
7122
7123 *'selection'* *'sel'*
7124'selection' 'sel' string (default "inclusive")
7125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 This option defines the behavior of the selection. It is only used
7127 in Visual and Select mode.
7128 Possible values:
7129 value past line inclusive ~
7130 old no yes
7131 inclusive yes yes
7132 exclusive yes no
7133 "past line" means that the cursor is allowed to be positioned one
7134 character past the line.
7135 "inclusive" means that the last character of the selection is included
7136 in an operation. For example, when "x" is used to delete the
7137 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007138 When "old" is used and 'virtualedit' allows the cursor to move past
7139 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007140 When "exclusive" is used, cursor position in visual mode will be
7141 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 Note that when "exclusive" is used and selecting from the end
7143 backwards, you cannot include the last character of a line, when
7144 starting in Normal mode and 'virtualedit' empty.
7145
7146 The 'selection' option is set by the |:behave| command.
7147
7148 *'selectmode'* *'slm'*
7149'selectmode' 'slm' string (default "")
7150 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007151 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 Select mode instead of Visual mode, when a selection is started.
7153 Possible values:
7154 mouse when using the mouse
7155 key when using shifted special keys
7156 cmd when using "v", "V" or CTRL-V
7157 See |Select-mode|.
7158 The 'selectmode' option is set by the |:behave| command.
7159
7160 *'sessionoptions'* *'ssop'*
7161'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007162 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007164 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 feature}
7166 Changes the effect of the |:mksession| command. It is a comma
7167 separated list of words. Each word enables saving and restoring
7168 something:
7169 word save and restore ~
7170 blank empty windows
7171 buffers hidden and unloaded buffers, not just those in windows
7172 curdir the current directory
7173 folds manually created folds, opened/closed folds and local
7174 fold options
7175 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007176 and contain at least one lowercase letter. Only
7177 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 help the help window
7179 localoptions options and mappings local to a window or buffer (not
7180 global values for local options)
7181 options all options and mappings (also global values for local
7182 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007183 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 resize size of the Vim window: 'lines' and 'columns'
7185 sesdir the directory in which the session file is located
7186 will become the current directory (useful with
7187 projects accessed over a network from different
7188 systems)
7189 slash backslashes in file names replaced with forward
7190 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007191 tabpages all tab pages; without this only the current tab page
7192 is restored, so that you can make a session for each
7193 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007194 terminal include terminal windows where the command can be
7195 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 unix with Unix end-of-line format (single <NL>), even when
7197 on Windows or DOS
7198 winpos position of the whole Vim window
7199 winsize window sizes
7200
7201 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007202 When neither "curdir" nor "sesdir" is included, file names are stored
7203 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007204 If you leave out "options" many things won't work well after restoring
7205 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 "slash" and "unix" are useful on Windows when sharing session files
7207 with Unix. The Unix version of Vim cannot source dos format scripts,
7208 but the Windows version of Vim can source unix format scripts.
7209
7210 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007211'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 global
7213 Name of the shell to use for ! and :! commands. When changing the
7214 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7215 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007216 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 See |option-backslash| about including spaces and backslashes.
7218 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007219
Bram Moolenaara2baa732022-02-04 16:09:54 +00007220 In |restricted-mode| shell commands will not be possible. This mode
7221 is used if the value of $SHELL ends in "false" or "nologin".
7222
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007223 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007224 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7226< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007227 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007229 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007231 Example with escaped space (Vim will do this when initializing the
7232 option from $SHELL): >
7233 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007234< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007235 backslashes are consumed by `:set`.
7236
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 Under MS-Windows, when the executable ends in ".com" it must be
7238 included. Thus setting the shell to "command.com" or "4dos.com"
7239 works, but "command" and "4dos" do not work for all commands (e.g.,
7240 filtering).
7241 For unknown reasons, when using "4dos.com" the current directory is
7242 changed to "C:\". To avoid this set 'shell' like this: >
7243 :set shell=command.com\ /c\ 4dos
7244< This option cannot be set from a |modeline| or in the |sandbox|, for
7245 security reasons.
7246
7247 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007248'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007249 Win32, when 'shell' contains "powershell":
7250 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007251 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007254 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7255 For MS-Windows, the default is set according to the value of 'shell',
7256 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007257 On Unix it can have more than one flag. Each white space separated
7258 part is passed as an argument to the shell command.
7259 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007260 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 This option cannot be set from a |modeline| or in the |sandbox|, for
7262 security reasons.
7263
7264 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007265'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7266 "2>&1| tee", or
7267 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 {not available when compiled without the |+quickfix|
7270 feature}
7271 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007272 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 including spaces and backslashes.
7274 The name of the temporary file can be represented by "%s" if necessary
7275 (the file name is appended automatically if no %s appears in the value
7276 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007277 For the Amiga the default is ">". For MS-Windows using powershell the
7278 default is "2>&1 | Out-File -Encoding default", otherwise the default
7279 is ">%s 2>&1". The output is directly saved in a file and not echoed
7280 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007281 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 in a file and echoed to the screen. If the 'shell' option is "csh" or
7283 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007284 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007285 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7286 means that stderr is also included. Before using the 'shell' option a
7287 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007288 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7289 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 The initialization of this option is done after reading the ".vimrc"
7291 and the other initializations, so that when the 'shell' option is set
7292 there, the 'shellpipe' option changes automatically, unless it was
7293 explicitly set before.
7294 When 'shellpipe' is set to an empty string, no redirection of the
7295 ":make" output will be done. This is useful if you use a 'makeprg'
7296 that writes to 'makeef' by itself. If you want no piping, but do
7297 want to include the 'makeef', set 'shellpipe' to a single space.
7298 Don't forget to precede the space with a backslash: ":set sp=\ ".
7299 In the future pipes may be used for filtering and this option will
7300 become obsolete (at least for Unix).
7301 This option cannot be set from a |modeline| or in the |sandbox|, for
7302 security reasons.
7303
7304 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007305'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 Quoting character(s), put around the command passed to the shell, for
7308 the "!" and ":!" commands. The redirection is kept outside of the
7309 quoting. See 'shellxquote' to include the redirection. It's
7310 probably not useful to set both options.
7311 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007312 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007313 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 This option cannot be set from a |modeline| or in the |sandbox|, for
7315 security reasons.
7316
7317 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007318'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7319 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 String to be used to put the output of a filter command in a temporary
7322 file. See also |:!|. See |option-backslash| about including spaces
7323 and backslashes.
7324 The name of the temporary file can be represented by "%s" if necessary
7325 (the file name is appended automatically if no %s appears in the value
7326 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007327 The default is ">". For Unix, if the 'shell' option is "csh" or
7328 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007329 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007330 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7331 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007332 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7333 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007334 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7335 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 The initialization of this option is done after reading the ".vimrc"
7337 and the other initializations, so that when the 'shell' option is set
7338 there, the 'shellredir' option changes automatically unless it was
7339 explicitly set before.
7340 In the future pipes may be used for filtering and this option will
7341 become obsolete (at least for Unix).
7342 This option cannot be set from a |modeline| or in the |sandbox|, for
7343 security reasons.
7344
7345 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7346'shellslash' 'ssl' boolean (default off)
7347 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007348 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007350 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007351 powershell.exe. Backward slashes can still be typed, but they are
7352 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 Note that setting or resetting this option has no effect for some
7354 existing file names, thus this option needs to be set before opening
7355 any file for best results. This might change in the future.
7356 'shellslash' only works when a backslash can be used as a path
7357 separator. To test if this is so use: >
7358 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007359< Also see 'completeslash'.
7360
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007361 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7362'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7363 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007364 When on, use temp files for shell commands. When off use a pipe.
7365 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007366 Currently a pipe is only supported on Unix and MS-Windows 2K and
7367 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007368 :if has("filterpipe")
7369< The advantage of using a pipe is that nobody can read the temp file
7370 and the 'shell' command does not need to support redirection.
7371 The advantage of using a temp file is that the file type and encoding
7372 can be detected.
7373 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7374 |FilterWritePost| autocommands event are not triggered when
7375 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007376 The `system()` function does not respect this option and always uses
7377 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007378 NOTE: This option is set to the Vim default value when 'compatible'
7379 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007380
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 *'shelltype'* *'st'*
7382'shelltype' 'st' number (default 0)
7383 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007384 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 On the Amiga this option influences the way how the commands work
7386 which use a shell.
7387 0 and 1: always use the shell
7388 2 and 3: use the shell only to filter lines
7389 4 and 5: use shell only for ':sh' command
7390 When not using the shell, the command is executed directly.
7391
7392 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7393 1 and 3: use "shell cmd" to start external commands
7394
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007395 *'shellxescape'* *'sxe'*
7396'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007397 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007398 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007399 When 'shellxquote' is set to "(" then the characters listed in this
7400 option will be escaped with a '^' character. This makes it possible
7401 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007402 This option cannot be set from a |modeline| or in the |sandbox|, for
7403 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007404
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 *'shellxquote'* *'sxq'*
7406'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007407 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007408 for Win32, when 'shell' is
7409 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007410 for Win32, when 'shell' contains "sh"
7411 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 for Unix, when using system(): "\"")
7413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 Quoting character(s), put around the command passed to the shell, for
7415 the "!" and ":!" commands. Includes the redirection. See
7416 'shellquote' to exclude the redirection. It's probably not useful
7417 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007418 When the value is '(' then ')' is appended. When the value is '"('
7419 then ')"' is appended.
7420 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007421 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007422 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7423 pwsh.exe which automatically strips off the first and last quote on a
7424 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7425 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007426 'shell', to reduce the need to set this option by the user. See
7427 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 This option cannot be set from a |modeline| or in the |sandbox|, for
7429 security reasons.
7430
7431 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7432'shiftround' 'sr' boolean (default off)
7433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 Round indent to multiple of 'shiftwidth'. Applies to > and <
7435 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7436 a multiple of 'shiftwidth' (this is Vi compatible).
7437 NOTE: This option is reset when 'compatible' is set.
7438
7439 *'shiftwidth'* *'sw'*
7440'shiftwidth' 'sw' number (default 8)
7441 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007444 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007445 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446
7447 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007448'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7449 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007450 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007452 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 It is a list of flags:
7454 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007455 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7456 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7457 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7458 m use "[+]" instead of "[Modified]" *shm-m*
7459 n use "[New]" instead of "[New File]" *shm-n*
7460 r use "[RO]" instead of "[readonly]" *shm-r*
7461 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007463 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7464 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007465 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007466 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007468 o overwrite message for writing a file with subsequent *shm-o*
7469 message for reading a file (useful for ":wn" or when
7470 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007471 O message for reading a file overwrites any previous *shm-O*
7472 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007473 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7474 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007475 the search count do not show "W" before the count message
7476 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007477 t truncate file message at the start if it is too long *shm-t*
7478 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007479 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007480 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007481 long to fit on the command line; "..." will appear in the
7482 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007483 W don't give "written" or "[w]" when writing a file *shm-W*
7484 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007485 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007486 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007487 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007488 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007489 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7490 match", "Pattern not found", "Back at original", etc.
7491 C don't give messages while scanning for ins-completion *shm-C*
7492 items, for instance "scanning tags"
7493 q use "recording" instead of "recording @a" *shm-q*
7494 F don't give the file info when editing a file, like *shm-F*
7495 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007496 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007497 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007498 "[1/5]". When the "S" flag is not present (e.g. search count
7499 is shown), the "search hit BOTTOM, continuing at TOP" and
7500 "search hit TOP, continuing at BOTTOM" messages are only
7501 indicated by a "W" (Mnemonic: Wrapped) letter before the
7502 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503
7504 This gives you the opportunity to avoid that a change between buffers
7505 requires you to hit <Enter>, but still gives as useful a message as
7506 possible for the space available. To get the whole message that you
7507 would have got with 'shm' empty, use ":file!"
7508 Useful values:
7509 shm= No abbreviation of message.
7510 shm=a Abbreviation, but no loss of information.
7511 shm=at Abbreviation, and truncate message when necessary.
7512
7513 NOTE: This option is set to the Vi default value when 'compatible' is
7514 set and to the Vim default value when 'compatible' is reset.
7515
7516 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7517'shortname' 'sn' boolean (default off)
7518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 Filenames are assumed to be 8 characters plus one extension of 3
7520 characters. Multiple dots in file names are not allowed. When this
7521 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007522 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007524 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 *'showbreak'* *'sbr'* *E595*
7527'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007528 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007529 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 feature}
7531 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007532 values are "> " or "+++ ": >
7533 :set showbreak=>\
7534< Note the backslash to escape the trailing space. It's easier like
7535 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007536 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007537< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 comma (in a future version the comma might be used to separate the
7539 part that is shown at the end and at the start of a line).
7540 The characters are highlighted according to the '@' flag in
7541 'highlight'.
7542 Note that tabs after the showbreak will be displayed differently.
7543 If you want the 'showbreak' to appear in between line numbers, add the
7544 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007545 A window-local value overrules a global value. If the global value is
7546 set and you want no value in the current window use NONE: >
7547 :setlocal showbreak=NONE
7548<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007550'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7551 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007553 Show (partial) command in the last line of the screen. Set this
7554 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 In Visual mode the size of the selected area is shown:
7556 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007557 If the number of bytes is different it is also displayed: "2-6"
7558 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007560 - When selecting a block, the size in screen characters:
7561 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007562 This information can be displayed in an alternative location using the
7563 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 NOTE: This option is set to the Vi default value when 'compatible' is
7565 set and to the Vim default value when 'compatible' is reset.
7566
Luuk van Baalba936f62022-12-15 13:15:39 +00007567 *'showcmdloc'* *'sloc'*
7568'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007569 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007570 This option can be used to display the (partially) entered command in
7571 another location. Possible values are:
7572 last Last line of the screen (default).
7573 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007574 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007575 Setting this option to "statusline" or "tabline" means that these will
7576 be redrawn whenever the command changes, which can be on every key
7577 pressed.
7578 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7579 place the text. Without a custom 'statusline' or 'tabline' it will be
7580 displayed in a convenient location.
7581
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7583'showfulltag' 'sft' boolean (default off)
7584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 When completing a word in insert mode (see |ins-completion|) from the
7586 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007587 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 matched a C function, you can see a template for what arguments are
7589 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007590 Note that this doesn't work well together with having "longest" in
7591 'completeopt', because the completion from the search pattern may not
7592 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593
7594 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7595'showmatch' 'sm' boolean (default off)
7596 global
7597 When a bracket is inserted, briefly jump to the matching one. The
7598 jump is only done if the match can be seen on the screen. The time to
7599 show the match can be set with 'matchtime'.
7600 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007601 seen or not).
7602 This option is reset when 'paste' is set and restored when 'paste' is
7603 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 When the 'm' flag is not included in 'cpoptions', typing a character
7605 will immediately move the cursor back to where it belongs.
7606 See the "sm" field in 'guicursor' for setting the cursor shape and
7607 blinking when showing the match.
7608 The 'matchpairs' option can be used to specify the characters to show
7609 matches for. 'rightleft' and 'revins' are used to look for opposite
7610 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007611 Also see the matchparen plugin for highlighting the match when moving
7612 around |pi_paren.txt|.
7613 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614
7615 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7616'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7617 global
7618 If in Insert, Replace or Visual mode put a message on the last line.
7619 Use the 'M' flag in 'highlight' to set the type of highlighting for
7620 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007621 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 doesn't mean XIM is really active, especially when 'imactivatekey' is
7623 not set.
7624 NOTE: This option is set to the Vi default value when 'compatible' is
7625 set and to the Vim default value when 'compatible' is reset.
7626
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007627 *'showtabline'* *'stal'*
7628'showtabline' 'stal' number (default 1)
7629 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007630 The value of this option specifies when the line with tab page labels
7631 will be displayed:
7632 0: never
7633 1: only if there are at least two tab pages
7634 2: always
7635 This is both for the GUI and non-GUI implementation of the tab pages
7636 line.
7637 See |tab-page| for more information about tab pages.
7638
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 *'sidescroll'* *'ss'*
7640'sidescroll' 'ss' number (default 0)
7641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 The minimal number of columns to scroll horizontally. Used only when
7643 the 'wrap' option is off and the cursor is moved off of the screen.
7644 When it is zero the cursor will be put in the middle of the screen.
7645 When using a slow terminal set it to a large number or 0. When using
7646 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7647 commands.
7648
7649 *'sidescrolloff'* *'siso'*
7650'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007651 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007653 right of the cursor if 'nowrap' is set. Setting this option to a
7654 value greater than 0 while having |'sidescroll'| also at a non-zero
7655 value makes some context visible in the line you are scrolling in
7656 horizontally (except at beginning of the line). Setting this option
7657 to a large value (like 999) has the effect of keeping the cursor
7658 horizontally centered in the window, as long as one does not come too
7659 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007660 After using the local value, go back the global value with one of
7661 these two: >
7662 setlocal sidescrolloff<
7663 setlocal sidescrolloff=-1
7664< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665
7666 Example: Try this together with 'sidescroll' and 'listchars' as
7667 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007668 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669
7670 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7671 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007672<
7673 *'signcolumn'* *'scl'*
7674'signcolumn' 'scl' string (default "auto")
7675 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007676 {not available when compiled without the |+signs|
7677 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007678 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007679 "auto" only when there is a sign to display
7680 "no" never
7681 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007682 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007683 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7686'smartcase' 'scs' boolean (default off)
7687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 Override the 'ignorecase' option if the search pattern contains upper
7689 case characters. Only used when the search pattern is typed and
7690 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007691 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7693 recalling the search pattern from history and hitting <Enter>.
7694 NOTE: This option is reset when 'compatible' is set.
7695
7696 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7697'smartindent' 'si' boolean (default off)
7698 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 Do smart autoindenting when starting a new line. Works for C-like
7700 programs, but can also be used for other languages. 'cindent' does
7701 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007702 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007703 setting 'si' has no effect. 'indentexpr' is a more advanced
7704 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 Normally 'autoindent' should also be on when using 'smartindent'.
7706 An indent is automatically inserted:
7707 - After a line ending in '{'.
7708 - After a line starting with a keyword from 'cinwords'.
7709 - Before a line starting with '}' (only with the "O" command).
7710 When typing '}' as the first character in a new line, that line is
7711 given the same indent as the matching '{'.
7712 When typing '#' as the first character in a new line, the indent for
7713 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007714 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7716 When using the ">>" command, lines starting with '#' are not shifted
7717 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007718 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007719 This option is reset when 'paste' is set and restored when 'paste' is
7720 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721
7722 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7723'smarttab' 'sta' boolean (default off)
7724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007726 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7727 <BS> will delete a 'shiftwidth' worth of space at the start of the
7728 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007729 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007730 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7731 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007732 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007734 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007735 This option is reset when 'paste' is set and restored when 'paste' is
7736 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 NOTE: This option is reset when 'compatible' is set.
7738
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007739 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7740'smoothscroll' 'sms' boolean (default off)
7741 local to window
7742 Scrolling works with screen lines. When 'wrap' is set and the first
7743 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007744 above the window. "<<<" is displayed at the start of the first line,
7745 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007746 You may also want to add "lastline" to the 'display' option to show as
7747 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007748 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007749
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 *'softtabstop'* *'sts'*
7751'softtabstop' 'sts' number (default 0)
7752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 Number of spaces that a <Tab> counts for while performing editing
7754 operations, like inserting a <Tab> or using <BS>. It "feels" like
7755 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7756 used. This is useful to keep the 'ts' setting at its standard value
7757 of 8, while being able to edit like it is set to 'sts'. However,
7758 commands like "x" still work on the actual characters.
7759 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007760 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007761 'softtabstop' is set to 0 when the 'paste' option is set and restored
7762 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7764 spaces is minimized by using <Tab>s.
7765 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7766 set.
7767 NOTE: This option is set to 0 when 'compatible' is set.
7768
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007769 If Vim is compiled with the |+vartabs| feature then the value of
7770 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7771 anything other than an empty string.
7772
Bram Moolenaar217ad922005-03-20 22:37:15 +00007773 *'spell'* *'nospell'*
7774'spell' boolean (default off)
7775 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007776 {not available when compiled without the |+syntax|
7777 feature}
7778 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007779 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007780
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007781 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007782'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007783 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007784 {not available when compiled without the |+syntax|
7785 feature}
7786 Pattern to locate the end of a sentence. The following word will be
7787 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007788 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007789 When this check is not wanted make this option empty.
7790 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007791 Be careful with special characters, see |option-backslash| about
7792 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007793 To set this option automatically depending on the language, see
7794 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007795
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007796 *'spellfile'* *'spf'*
7797'spellfile' 'spf' string (default empty)
7798 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007799 {not available when compiled without the |+syntax|
7800 feature}
7801 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007802 commands. It must end in ".{encoding}.add". You need to include the
7803 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007804 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007805 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007806 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007807 |zg| and |zw| commands can be used to access each. This allows using
7808 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007809 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007810 you: Using the first directory in 'runtimepath' that is writable. If
7811 there is no "spell" directory yet it will be created. For the file
7812 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007813 ignoring the region.
7814 The resulting ".spl" file will be used for spell checking, it does not
7815 have to appear in 'spelllang'.
7816 Normally one file is used for all regions, but you can add the region
7817 name if you want to. However, it will then only be used when
7818 'spellfile' is set to it, for entries in 'spelllang' only files
7819 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007820 This option cannot be set from a |modeline| or in the |sandbox|, for
7821 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007822
Bram Moolenaar217ad922005-03-20 22:37:15 +00007823 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007824'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007825 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007826 {not available when compiled without the |+syntax|
7827 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007828 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007829 on spellchecking will be done for these languages. Example: >
7830 set spelllang=en_us,nl,medical
7831< This means US English, Dutch and medical words are recognized. Words
7832 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007833 The word list name must consist of alphanumeric characters, a dash or
7834 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007835 recommended to separate the two letter language name from a
7836 specification. Thus "en-rare" is used for rare English words.
7837 A region name must come last and have the form "_xx", where "xx" is
7838 the two-letter, lower case region name. You can use more than one
7839 region by listing them: "en_us,en_ca" supports both US and Canadian
7840 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007841 Britain. (Note: currently en_au and en_nz dictionaries are older than
7842 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007843 If the name "cjk" is included East Asian characters are excluded from
7844 spell checking. This is useful when editing text that also has Asian
7845 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007846 Note that the "medical" dictionary does not exist, it is just an
7847 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007848 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007849 As a special case the name of a .spl file can be given as-is. The
7850 first "_xx" in the name is removed and used as the region name
7851 (_xx is an underscore, two letters and followed by a non-letter).
7852 This is mainly for testing purposes. You must make sure the correct
7853 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007854 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007855 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7856 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007857 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007858
Bram Moolenaar98692072006-02-04 00:57:42 +00007859 If the |spellfile.vim| plugin is active and you use a language name
7860 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7861 will ask you if you want to download the file.
7862
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007863 After this option has been set successfully, Vim will source the files
7864 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007865 up to the first character that is not an ASCII letter or number and
7866 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007867
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007868 *'spelloptions'* *'spo'*
7869'spelloptions' 'spo' string (default "")
7870 local to buffer
7871 {not available when compiled without the |+syntax|
7872 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007873 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007874 camel When a word is CamelCased, assume "Cased" is a
7875 separate word: every upper-case character in a word
7876 that comes after a lower case character indicates the
7877 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007878
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007879 *'spellsuggest'* *'sps'*
7880'spellsuggest' 'sps' string (default "best")
7881 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007882 {not available when compiled without the |+syntax|
7883 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007884 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007885 the |spellsuggest()| function. This is a comma-separated list of
7886 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007887
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007888 best Internal method that works best for English. Finds
7889 changes like "fast" and uses a bit of sound-a-like
7890 scoring to improve the ordering.
7891
7892 double Internal method that uses two methods and mixes the
7893 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007894 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007895 word. That only works when the language specifies
7896 sound folding. Can be slow and doesn't always give
7897 better results.
7898
7899 fast Internal method that only checks for simple changes:
7900 character inserts/deletes/swaps. Works well for
7901 simple typing mistakes.
7902
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007903 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007904 Not used for |spellsuggest()|. The number of
7905 suggestions is never more than the value of 'lines'
7906 minus two.
7907
Bram Moolenaar585ee072022-01-29 11:22:17 +00007908 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007909 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007910 methods. When omitted the limit is 5000. When
7911 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007912 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007913
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007914 file:{filename} Read file {filename}, which must have two columns,
7915 separated by a slash. The first column contains the
7916 bad word, the second column the suggested good word.
7917 Example:
7918 theribal/terrible ~
7919 Use this for common mistakes that do not appear at the
7920 top of the suggestion list with the internal methods.
7921 Lines without a slash are ignored, use this for
7922 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007923 The word in the second column must be correct,
7924 otherwise it will not be used. Add the word to an
7925 ".add" file if it is currently flagged as a spelling
7926 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007927 The file is used for all languages.
7928
7929 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007930 trouble with spaces. Best is to call a function
7931 without arguments, see |expr-option-function|.
7932 |v:val| holds the badly spelled word. The expression
7933 must evaluate to a List of Lists, each with a
7934 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007935 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007936 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007937 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007938 internal methods use. A lower score is better.
7939 This may invoke |spellsuggest()| if you temporarily
7940 set 'spellsuggest' to exclude the "expr:" part.
7941 Errors are silently ignored, unless you set the
7942 'verbose' option to a non-zero value.
7943
7944 Only one of "best", "double" or "fast" may be used. The others may
7945 appear several times in any order. Example: >
7946 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7947<
7948 This option cannot be set from a |modeline| or in the |sandbox|, for
7949 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007950
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7952'splitbelow' 'sb' boolean (default off)
7953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 When on, splitting a window will put the new window below the current
7955 one. |:split|
7956
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007957 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007958'splitkeep' 'spk' string (default "cursor")
7959 global
7960 The value of this option determines the scroll behavior when opening,
7961 closing or resizing horizontal splits.
7962
7963 Possible values are:
7964 cursor Keep the same relative cursor position.
7965 screen Keep the text on the same screen line.
7966 topline Keep the topline the same.
7967
7968 For the "screen" and "topline" values, the cursor position will be
7969 changed when necessary. In this case, the jumplist will be populated
7970 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007971 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007972
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7974'splitright' 'spr' boolean (default off)
7975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 When on, splitting a window will put the new window right of the
7977 current one. |:vsplit|
7978
7979 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7980'startofline' 'sol' boolean (default on)
7981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007983 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007984 (if possible). This applies to the commands:
7985 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007986 - "d", "<<", "==" and ">>" with a linewise operator
7987 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007988 - "%" with a count
7989 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7990 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 In case of buffer changing commands the cursor is placed at the column
7992 where it was the last time the buffer was edited.
7993 NOTE: This option is set when 'compatible' is set.
7994
Bram Moolenaar00654022011-02-25 14:42:19 +01007995 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007997 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 {not available when compiled without the |+statusline|
7999 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008000 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 Also see |status-line|.
8002
8003 The option consists of printf style '%' items interspersed with
8004 normal text. Each status line item is of the form:
8005 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008006 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008007 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008009 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008010 When the option starts with "%!" then it is used as an expression,
8011 evaluated and the result is used as the option value. Example: >
8012 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008013< The *g:statusline_winid* variable will be set to the |window-ID| of the
8014 window that the status line belongs to.
8015 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008016 Note that the "%!" expression is evaluated in the context of the
8017 current window and buffer, while %{} items are evaluated in the
8018 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008019
8020 When there is error while evaluating the option then it will be made
8021 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008022 When the result contains unprintable characters the result is
8023 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008024
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 Note that the only effect of 'ruler' when this option is set (and
8026 'laststatus' is 2) is controlling the output of |CTRL-G|.
8027
8028 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008029 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008031 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 minwid Minimum width of the item, padding as set by '-' & '0'.
8033 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008034 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 on the left for text items. Numeric items will be
8036 shifted down to maxwid-2 digits followed by '>'number
8037 where number is the amount of missing digits, much like
8038 an exponential notation.
8039 item A one letter code as described below.
8040
8041 Following is a description of the possible statusline items. The
8042 second character in "item" is the type:
8043 N for number
8044 S for string
8045 F for flags as described below
8046 - not applicable
8047
8048 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008049 f S Path to the file in the buffer, as typed or relative to current
8050 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 F S Full path to the file in the buffer.
8052 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008053 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008055 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008057 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008059 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008061 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008063 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8065 being used: "<keymap>"
8066 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008067 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 B N As above, in hexadecimal.
8069 o N Byte number in file of byte under cursor, first byte is 1.
8070 Mnemonic: Offset from start of file (with one added)
8071 {not available when compiled without |+byte_offset| feature}
8072 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008073 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 l N Line number.
8075 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008076 c N Column number (byte index).
8077 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008078 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 p N Percentage through file in lines as in |CTRL-G|.
8080 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008081 percentage described for 'ruler'. Always 3 in length, unless
8082 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008083 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008084 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008086 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008087 Note that there is no '%' before the closing '}'. The
8088 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008089 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008090 {% - This is almost same as { except the result of the expression is
8091 re-evaluated as a statusline format string. Thus if the
8092 return value of expr contains % items they will get expanded.
8093 The expression can contain the } character, the end of
8094 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008095 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008096 func! Stl_filename() abort
8097 return "%t"
8098 endfunc
8099< `stl=%{Stl_filename()}` results in `"%t"`
8100 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008101 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 ( - Start of item group. Can be used for setting the width and
8103 alignment of a section. Must be followed by %) somewhere.
8104 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008105 T N For 'tabline': start of tab page N label. Use %T after the last
8106 label. This information is used for mouse clicks.
8107 X N For 'tabline': start of close tab N label. Use %X after the
8108 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8109 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 < - Where to truncate line if too long. Default is at the start.
8111 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008112 = - Separation point between alignment sections. Each section will
8113 be separated by an equal number of spaces. With one %= what
8114 comes after it will be right-aligned. With two %= there is a
8115 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008117 # - Set highlight group. The name must follow and then a # again.
8118 Thus use %#HLname# for highlight group HLname. The same
8119 highlighting is used, also for the statusline of non-current
8120 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008122 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008123 The difference between User{N} and StatusLine will be applied to
8124 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 The number N must be between 1 and 9. See |hl-User1..9|
8126
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008127 When displaying a flag, Vim removes the leading comma, if any, when
8128 that flag comes right after plaintext. This will make a nice display
8129 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130
Bram Moolenaar582fd852005-03-28 20:58:01 +00008131 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 not set) and a minwid is not set for the group, the whole group will
8133 become empty. This will make a group like the following disappear
8134 completely from the statusline when none of the flags are set. >
8135 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008136< Beware that an expression is evaluated each and every time the status
8137 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008138 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008139 While evaluating %{} the current buffer and current window will be set
8140 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008141 currently being drawn. The expression will evaluate in this context.
8142 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8143 real current buffer and "g:actual_curwin" to the |window-ID| of the
8144 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008145
Bram Moolenaar30b65812012-07-12 22:01:11 +02008146 The 'statusline' option will be evaluated in the |sandbox| if set from
8147 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008148 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008149
8150 It is not allowed to change text or jump to another window while
8151 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152
8153 If the statusline is not updated when you want it (e.g., after setting
8154 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008155 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008157 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 Otherwise the result is taken as flag text and applied to the rules
8159 described above.
8160
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008161 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008163 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164
8165 Examples:
8166 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008167 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168< Similar, but add ASCII value of char under the cursor (like "ga") >
8169 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8170< Display byte count and byte value, modified flag in red. >
8171 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8172 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8173< Display a ,GZ flag if a compressed file is loaded >
8174 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8175< In the |:autocmd|'s: >
8176 :let b:gzflag = 1
8177< And: >
8178 :unlet b:gzflag
8179< And define this function: >
8180 :function VarExists(var, val)
8181 : if exists(a:var) | return a:val | else | return '' | endif
8182 :endfunction
8183<
8184 *'suffixes'* *'su'*
8185'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 Files with these suffixes get a lower priority when multiple files
8188 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008189 suffixes. Spaces after the comma are ignored. A dot is also seen as
8190 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 separator, precede it with a backslash (see |option-backslash| about
8192 including spaces and backslashes).
8193 See 'wildignore' for completely ignoring files.
8194 The use of |:set+=| and |:set-=| is preferred when adding or removing
8195 suffixes from the list. This avoids problems when a future version
8196 uses another default.
8197
8198 *'suffixesadd'* *'sua'*
8199'suffixesadd' 'sua' string (default "")
8200 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008201 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 file for the "gf", "[I", etc. commands. Example: >
8203 :set suffixesadd=.java
8204<
8205 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8206'swapfile' 'swf' boolean (default on)
8207 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008208 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 swapfile is not wanted for a specific buffer. For example, with
8210 confidential information that even root must not be able to access.
8211 Careful: All text will be in memory:
8212 - Don't use this for big files.
8213 - Recovery will be impossible!
8214 A swapfile will only be present when |'updatecount'| is non-zero and
8215 'swapfile' is set.
8216 When 'swapfile' is reset, the swap file for the current buffer is
8217 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8218 non-zero, a swap file is immediately created.
8219 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008220 If you want to open a new buffer without creating a swap file for it,
8221 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008222 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223
8224 This option is used together with 'bufhidden' and 'buftype' to
8225 specify special kinds of buffers. See |special-buffers|.
8226
8227 *'swapsync'* *'sws'*
8228'swapsync' 'sws' string (default "fsync")
8229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008231 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 When this option is empty parts of the swap file may be in memory and
8233 not written to disk. When the system crashes you may lose more work.
8234 On Unix the system does a sync now and then without Vim asking for it,
8235 so the disadvantage of setting this option off is small. On some
8236 systems the swap file will not be written at all. For a unix system
8237 setting it to "sync" will use the sync() call instead of the default
8238 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008239 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240
8241 *'switchbuf'* *'swb'*
8242'switchbuf' 'swb' string (default "")
8243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008245 This option is checked, when
8246 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008247 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008248 - jumping to a tag using the |:stag| command.
8249 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8250 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8251 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008252 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008253 useopen If included, jump to the first open window in the
8254 current tab page that contains the specified buffer
8255 (if there is one). Otherwise: Do not examine other
8256 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008257 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008258 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008260 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008261 Otherwise: do not split, use current window (when used
8262 in the quickfix window: the previously used window or
8263 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008264 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008265 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008266 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008267 uselast If included, jump to the previously used window when
8268 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008269 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8270 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008272 *'synmaxcol'* *'smc'*
8273'synmaxcol' 'smc' number (default 3000)
8274 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008275 {not available when compiled without the |+syntax|
8276 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008277 Maximum column in which to search for syntax items. In long lines the
8278 text after this column is not highlighted and following lines may not
8279 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008280 This helps to avoid very slow redrawing for an XML file that is one
8281 long line.
8282 Set to zero to remove the limit.
8283
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 *'syntax'* *'syn'*
8285'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008286 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008287 {not available when compiled without the |+syntax|
8288 feature}
8289 When this option is set, the syntax with this name is loaded, unless
8290 syntax highlighting has been switched off with ":syntax off".
8291 Otherwise this option does not always reflect the current syntax (the
8292 b:current_syntax variable does).
8293 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008294 not automatically recognized. Example, in an IDL file:
8295 /* vim: set syntax=idl : */ ~
8296 When a dot appears in the value then this separates two filetype
8297 names. Example:
8298 /* vim: set syntax=c.doxygen : */ ~
8299 This will use the "c" syntax first, then the "doxygen" syntax.
8300 Note that the second one must be prepared to be loaded as an addition,
8301 otherwise it will be skipped. More than one dot may appear.
8302 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 :set syntax=OFF
8304< To switch syntax highlighting on according to the current value of the
8305 'filetype' option: >
8306 :set syntax=ON
8307< What actually happens when setting the 'syntax' option is that the
8308 Syntax autocommand event is triggered with the value as argument.
8309 This option is not copied to another buffer, independent of the 's' or
8310 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008311 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312
LemonBoy5247b0b2024-07-12 19:30:58 +02008313 *'tabclose'* *'tcl'*
8314'tabclose' 'tcl' string (default "")
8315 global
8316 This option controls the behavior when closing tab pages (e.g., using
8317 |:tabclose|). When empty Vim goes to the next (right) tab page.
8318
8319 Possible values (comma-separated list):
8320 left If included, go to the previous tab page instead of
8321 the next one.
8322 uselast If included, go to the previously used tab page if
8323 possible. This option takes precedence over the
8324 others.
8325
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008326 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008327'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008328 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008329 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008330 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008331 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008332
8333 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008334 option and only when there is no GUI tab line. When 'e' is in
8335 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008336 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008337
8338 The value is evaluated like with 'statusline'. You can use
8339 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008340 the text to be displayed. Use "%1T" for the first label, "%2T" for
8341 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008342
Bram Moolenaare12bab32019-01-08 22:02:56 +01008343 When changing something that is used in 'tabline' that does not
8344 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008345 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008346
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008347 Keep in mind that only one of the tab pages is the current one, others
8348 are invisible and you can't jump to their windows.
8349
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008350 *'tabpagemax'* *'tpm'*
8351'tabpagemax' 'tpm' number (default 10)
8352 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008353 Maximum number of tab pages to be opened by the |-p| command line
8354 argument or the ":tab all" command. |tabpage|
8355
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008356 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357'tabstop' 'ts' number (default 8)
8358 local to buffer
8359 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008360 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361
8362 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008363 appear wrong in many places, e.g., when printing it.
8364 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008366 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8368 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008369 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008371 This is the recommended way, the file will look the same with other
8372 tools and when listing it in a terminal.
8373 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8374 'expandtab'. This way you will always insert spaces. The
8375 formatting will never be messed up when 'tabstop' is changed (leave
8376 it at 8 just in case). The file will be a bit larger.
8377 You do need to check if no Tabs exist in the file. You can get rid
8378 of them by first setting 'expandtab' and using `%retab!`, making
8379 sure the value of 'tabstop' is set correctly.
8380 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 'expandtab'. This way you will always insert spaces. The
8382 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008383 You do need to check if no Tabs exist in the file, just like in the
8384 item just above.
8385 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008386 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008387 works when using Vim to edit the file, other tools assume a tabstop
8388 is worth 8 spaces.
8389 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 'noexpandtab'. This should then work (for initial indents only)
8391 for any tabstop setting that people use. It might be nice to have
8392 tabs after the first non-blank inserted as spaces if you do this
8393 though. Otherwise aligned comments will be wrong when 'tabstop' is
8394 changed.
8395
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008396 If Vim is compiled with the |+vartabs| feature then the value of
8397 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8398 than an empty string.
8399
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8401'tagbsearch' 'tbs' boolean (default on)
8402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008404 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 searching makes searching for a tag a LOT faster, but a linear search
8406 will find more tags if the tags file wasn't properly sorted.
8407 Vim normally assumes that your tags files are sorted, or indicate that
8408 they are not sorted. Only when this is not the case does the
8409 'tagbsearch' option need to be switched off.
8410
8411 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008412 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 certain files, or retry all files with a linear search. When
8414 'tagbsearch' is off, only a linear search is done.
8415
8416 Linear searching is done anyway, for one file, when Vim finds a line
8417 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008418 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419< [The whitespace before and after the '0' must be a single <Tab>]
8420
8421 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008422 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 instead of a normal tag name, a retry is done with a linear search.
8424 Tags in unsorted tags files, and matches with different case will only
8425 be found in the retry.
8426
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008427 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008428 linear search can be avoided when case is ignored. Use a value of '2'
8429 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8430 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008431 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8432 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8433 used for this as well. Note that case must be folded to uppercase for
8434 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008435
8436 By default, tag searches are case-sensitive. Case is ignored when
8437 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8438 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008439 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8440 'tagcase' is "smart", and the pattern contains only lowercase
8441 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442
8443 When 'tagbsearch' is off, tags searching is slower when a full match
8444 exists, but faster when no full match exists. Tags in unsorted tags
8445 files may only be found with 'tagbsearch' off.
8446 When the tags file is not sorted, or sorted in a wrong way (not on
8447 ASCII byte value), 'tagbsearch' should be off, or the line given above
8448 must be included in the tags file.
8449 This option doesn't affect commands that find all matching tags (e.g.,
8450 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008452 *'tagcase'* *'tc'*
8453'tagcase' 'tc' string (default "followic")
8454 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008455 This option specifies how case is handled when searching the tags
8456 file:
8457 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008458 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008459 ignore Ignore case
8460 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008461 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008462 NOTE: This option is set to the Vi default value when 'compatible' is
8463 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008464
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008465 *'tagfunc'* *'tfu'*
8466'tagfunc' 'tfu' string (default: empty)
8467 local to buffer
8468 {not available when compiled without the |+eval|
8469 feature}
8470 This option specifies a function to be used to perform tag searches.
8471 The function gets the tag pattern and should return a List of matching
8472 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008473 function and an example. The value can be the name of a function, a
8474 |lambda| or a |Funcref|. See |option-value-function| for more
8475 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008476 This option cannot be set from a |modeline| or in the |sandbox|, for
8477 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008478
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 *'taglength'* *'tl'*
8480'taglength' 'tl' number (default 0)
8481 global
8482 If non-zero, tags are significant up to this number of characters.
8483
8484 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8485'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8486 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008487 If on and using a tags file in another directory, file names in that
8488 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 NOTE: This option is set to the Vi default value when 'compatible' is
8490 set and to the Vim default value when 'compatible' is reset.
8491
8492 *'tags'* *'tag'* *E433*
8493'tags' 'tag' string (default "./tags,tags", when compiled with
8494 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8495 global or local to buffer |global-local|
8496 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008497 include a space or comma in a file name, precede it with backslashes
8498 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 When a file name starts with "./", the '.' is replaced with the path
8500 of the current file. But only when the 'd' flag is not included in
8501 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8502 |tags-option|.
8503 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008504 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8505 find all files named "tags" below "/lib". The filename itself cannot
8506 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008507 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008508 The |tagfiles()| function can be used to get a list of the file names
8509 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8511 files are also supported. They are automatically recognized. The
8512 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8513 differences are ignored (MS-Windows). |emacs-tags|
8514 The use of |:set+=| and |:set-=| is preferred when adding or removing
8515 file names from the list. This avoids problems when a future version
8516 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517
8518 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8519'tagstack' 'tgst' boolean (default on)
8520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 When on, the |tagstack| is used normally. When off, a ":tag" or
8522 ":tselect" command with an argument will not push the tag onto the
8523 tagstack. A following ":tag" without an argument, a ":pop" command or
8524 any other command that uses the tagstack will use the unmodified
8525 tagstack, but does change the pointer to the active entry.
8526 Resetting this option is useful when using a ":tag" command in a
8527 mapping which should not change the tagstack.
8528
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008529 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008530'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008531 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008532 {only available when compiled with the |+tcl/dyn|
8533 feature}
8534 Specifies the name of the Tcl shared library. The default is
8535 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008536 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008537 This option cannot be set from a |modeline| or in the |sandbox|, for
8538 security reasons.
8539
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 *'term'* *E529* *E530* *E531*
8541'term' string (default is $TERM, if that fails:
8542 in the GUI: "builtin_gui"
8543 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008544 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 on Unix: "ansi"
8547 on VMS: "ansi"
8548 on Win 32: "win32")
8549 global
8550 Name of the terminal. Used for choosing the terminal control
8551 characters. Environment variables are expanded |:set_env|.
8552 For example: >
8553 :set term=$TERM
8554< See |termcap|.
8555
8556 *'termbidi'* *'tbidi'*
8557 *'notermbidi'* *'notbidi'*
8558'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 {only available when compiled with the |+arabic|
8561 feature}
8562 The terminal is in charge of Bi-directionality of text (as specified
8563 by Unicode). The terminal is also expected to do the required shaping
8564 that some languages (such as Arabic) require.
8565 Setting this option implies that 'rightleft' will not be set when
8566 'arabic' is set and the value of 'arabicshape' will be ignored.
8567 Note that setting 'termbidi' has the immediate effect that
8568 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8569 This option is reset when the GUI is started.
8570 For further details see |arabic.txt|.
8571
8572 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008573'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 Encoding used for the terminal. This specifies what character
8576 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008577 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008578 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008579 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008580 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8582 Any attempts to set a different value will be rejected, and an error
8583 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008584 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 because the Win32 system always passes Unicode characters.
8586 When empty, the same encoding is used as for the 'encoding' option.
8587 This is the normal value.
8588 Not all combinations for 'termencoding' and 'encoding' are valid. See
8589 |encoding-table|.
8590 The value for this option must be supported by internal conversions or
8591 iconv(). When this is not possible no conversion will be done and you
8592 will probably experience problems with non-ASCII characters.
8593 Example: You are working with the locale set to euc-jp (Japanese) and
8594 want to edit a UTF-8 file: >
8595 :let &termencoding = &encoding
8596 :set encoding=utf-8
8597< You need to do this when your system has no locale support for UTF-8.
8598
Bram Moolenaar938ae282023-02-20 20:44:55 +00008599 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008600'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8601 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008602 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008603 {not available when compiled without the
8604 |+termguicolors| feature}
8605 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008606 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008607
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008608 Requires a ISO-8613-3 compatible terminal. If setting this option
8609 does not work (produces a colorless UI) reading |xterm-true-color|
8610 might help.
8611
8612 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8613 is required. Use this check to find out: >
8614 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008615< This requires Vim to be built with the |+vtp| feature.
8616
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008617 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008618
8619 When using Vim with Windows Terminal, the background of Windows
8620 Terminal is normally filled with the Vim background color. Setting
8621 'termguicolors' and the guibg of the Normal highlight group to NONE
8622 will make the background transparent: >
8623 :hi Normal guibg=NONE
8624<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008625 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008626
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008627 *'termwinkey'* *'twk'*
8628'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008629 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008630 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008631 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008632 The key can be specified as a single character, a |key-notation| (e.g.
8633 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8634 :set twk=X
8635 :set twk=^I
8636 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008637< The string must be one key stroke but can be multiple bytes.
8638 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008639 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008640 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008641
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008642 *'termwinscroll'* *'twsl'*
8643'termwinscroll' 'twsl' number (default 10000)
8644 local to buffer
8645 {not available when compiled without the
8646 |+terminal| feature}
8647 Number of scrollback lines to keep. When going over this limit the
8648 first 10% of the scrollback lines are deleted. This is just to reduce
8649 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008650 Also used as a limit for text sent to the terminal in one write,
8651 multiplied by the number of columns times 3 (average number of bytes
8652 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008653
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008654 *'termwinsize'* *'tws'*
8655'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008656 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008657 Size used when opening the |terminal| window. Format:
8658 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008659 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008660 - When set with a "x" (e.g., "24x80") the terminal size is not
8661 adjusted to the window size. If the window is smaller only the
8662 top-left part is displayed.
8663 - When set with a "*" (e.g., "10*50") the terminal size follows the
8664 window size, but will not be smaller than the specified rows and/or
8665 columns.
8666 - When rows is zero then use the height of the window.
8667 - When columns is zero then use the width of the window.
8668 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008669 - Can be overruled in the |term_start()| options with "term_rows" and
8670 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008671
8672 Examples:
8673 "30x0" uses 30 rows and the current window width.
8674 "20*0" uses at least 20 rows and the current window width.
8675 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008676 Note that the command running in the terminal window may still change
8677 the size of the terminal. In that case the Vim window will be
8678 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008679
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008680 *'termwintype'* *'twt'*
8681'termwintype' 'twt' string (default "")
8682 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008683 {only available when compiled with the |terminal|
8684 feature on MS-Windows}
8685 Specify the virtual console (pty) used when opening the terminal
8686 window.
8687
8688 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008689 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008690 "winpty" use winpty, fail if not supported
8691 "conpty" use |ConPTY|, fail if not supported
8692
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008693 |ConPTY| support depends on the platform. Windows 10 October 2018
8694 Update is the first version that supports ConPTY, however it is still
8695 considered unstable. ConPTY might become stable in the next release
8696 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008697 supported then you cannot open a terminal window.
8698
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 *'terse'* *'noterse'*
8700'terse' boolean (default off)
8701 global
8702 When set: Add 's' flag to 'shortmess' option (this makes the message
8703 for a search that hits the start or end of the file not being
8704 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8705 shortens a lot of messages}
8706
8707 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8708'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 This option is obsolete. Use 'fileformats'.
8711 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8712 set to the default value for the current system. When 'textauto' is
8713 reset, 'fileformats' is made empty.
8714 NOTE: This option is set to the Vi default value when 'compatible' is
8715 set and to the Vim default value when 'compatible' is reset.
8716
8717 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008718'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 others: default off)
8720 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 This option is obsolete. Use 'fileformat'.
8722 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8723 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8724 "unix".
8725
8726 *'textwidth'* *'tw'*
8727'textwidth' 'tw' number (default 0)
8728 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 Maximum width of text that is being inserted. A longer line will be
8730 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008731 this.
8732 'textwidth' is set to 0 when the 'paste' option is set and restored
8733 when 'paste' is reset.
8734 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008736 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 NOTE: This option is set to 0 when 'compatible' is set.
8738
8739 *'thesaurus'* *'tsr'*
8740'thesaurus' 'tsr' string (default "")
8741 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008743 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8744 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008745
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008746 This option is not used if 'thesaurusfunc' is set, either for the
8747 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008748
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008749 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008751 name. See |option-backslash| about using backslashes. The use of
8752 |:set+=| and |:set-=| is preferred when adding or removing directories
8753 from the list. This avoids problems when a future version uses
8754 another default. Backticks cannot be used in this option for security
8755 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008757 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008758'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008759 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008760 {not available when compiled without the |+eval|
8761 feature}
8762 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008763 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008764 The value can be the name of a function, a |lambda| or a |Funcref|.
8765 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008766
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008767 This option cannot be set from a |modeline| or in the |sandbox|, for
8768 security reasons.
8769
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8771'tildeop' 'top' boolean (default off)
8772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 When on: The tilde command "~" behaves like an operator.
8774 NOTE: This option is reset when 'compatible' is set.
8775
8776 *'timeout'* *'to'* *'notimeout'* *'noto'*
8777'timeout' 'to' boolean (default on)
8778 global
laburnumT3f7855a2023-12-05 18:37:03 +01008779
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008781'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 These two options together determine the behavior when part of a
8784 mapped key sequence or keyboard code has been received:
8785
8786 'timeout' 'ttimeout' action ~
8787 off off do not time out
8788 on on or off time out on :mappings and key codes
8789 off on time out on key codes
8790
8791 If both options are off, Vim will wait until either the complete
8792 mapping or key sequence has been received, or it is clear that there
8793 is no mapping or key sequence for the received characters. For
8794 example: if you have mapped "vl" and Vim has received 'v', the next
8795 character is needed to see if the 'v' is followed by an 'l'.
8796 When one of the options is on, Vim will wait for about 1 second for
8797 the next character to arrive. After that the already received
8798 characters are interpreted as single characters. The waiting time can
8799 be changed with the 'timeoutlen' option.
8800 On slow terminals or very busy systems timing out may cause
8801 malfunctioning cursor keys. If both options are off, Vim waits
8802 forever after an entered <Esc> if there are key codes that start
8803 with <Esc>. You will have to type <Esc> twice. If you do not have
8804 problems with key codes, but would like to have :mapped key
8805 sequences not timing out in 1 second, set the 'ttimeout' option and
8806 reset the 'timeout' option.
8807
8808 NOTE: 'ttimeout' is reset when 'compatible' is set.
8809
8810 *'timeoutlen'* *'tm'*
8811'timeoutlen' 'tm' number (default 1000)
8812 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008813
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008815'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 The time in milliseconds that is waited for a key code or mapped key
8818 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8819 when part of a command has been typed.
8820 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8821 different timeout value for key codes is desired set 'ttimeoutlen' to
8822 a non-negative number.
8823
8824 ttimeoutlen mapping delay key code delay ~
8825 < 0 'timeoutlen' 'timeoutlen'
8826 >= 0 'timeoutlen' 'ttimeoutlen'
8827
8828 The timeout only happens when the 'timeout' and 'ttimeout' options
8829 tell so. A useful setting would be >
8830 :set timeout timeoutlen=3000 ttimeoutlen=100
8831< (time out on mapping after three seconds, time out on key codes after
8832 a tenth of a second).
8833
8834 *'title'* *'notitle'*
8835'title' boolean (default off, on when title can be restored)
8836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 When on, the title of the window will be set to the value of
8838 'titlestring' (if it is not empty), or to:
8839 filename [+=-] (path) - VIM
8840 Where:
8841 filename the name of the file being edited
8842 - indicates the file cannot be modified, 'ma' off
8843 + indicates the file was modified
8844 = indicates the file is read-only
8845 =+ indicates the file is read-only and modified
8846 (path) is the path of the file being edited
8847 - VIM the server name |v:servername| or "VIM"
8848 Only works if the terminal supports setting window titles
8849 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008850 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8852 *X11*
8853 When Vim was compiled with HAVE_X11 defined, the original title will
8854 be restored if possible. The output of ":version" will include "+X11"
8855 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8856 works for the icon name |'icon'|.
8857 But: When Vim was started with the |-X| argument, restoring the title
8858 will not work (except in the GUI).
8859 If the title cannot be restored, it is set to the value of 'titleold'.
8860 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008861 When using an xterm from a remote machine you can use this command: >
8862
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008864 ssh -X machine_name xterm &
8865<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 then the WINDOWID environment variable should be inherited and the
8867 title of the window should change back to what it should be after
8868 exiting Vim.
8869
8870 *'titlelen'*
8871'titlelen' number (default 85)
8872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008874 title. When the title is longer, only the end of the path name is
8875 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 Using a percentage makes this adapt to the width of the window. But
8877 it won't work perfectly, because the actual number of characters
8878 available also depends on the font used and other things in the title
8879 bar. When 'titlelen' is zero the full path is used. Otherwise,
8880 values from 1 to 30000 percent can be used.
8881 'titlelen' is also used for the 'titlestring' option.
8882
8883 *'titleold'*
8884'titleold' string (default "Thanks for flying Vim")
8885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 This option will be used for the window title when exiting Vim if the
8887 original title cannot be restored. Only happens if 'title' is on or
8888 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008889 This option cannot be set from a |modeline| or in the |sandbox|, for
8890 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 *'titlestring'*
8892'titlestring' string (default "")
8893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 When this option is not empty, it will be used for the title of the
8895 window. This happens only when the 'title' option is on.
8896 Only works if the terminal supports setting window titles (currently
8897 Amiga console, Win32 console, all GUI versions and terminals with a
8898 non-empty 't_ts' option).
8899 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008900 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008901
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008903 expanded according to the rules used for 'statusline'. If it contains
8904 an invalid '%' format, the value is used as-is and no error or warning
8905 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008906 This option cannot be set in a modeline when 'modelineexpr' is off.
8907
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008909 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8911< The value of 'titlelen' is used to align items in the middle or right
8912 of the available space.
8913 Some people prefer to have the file name first: >
8914 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8915< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008916 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 separating space only when needed.
8918 NOTE: Use of special characters in 'titlestring' may cause the display
8919 to be garbled (e.g., when it contains a CR or NL character).
8920 {not available when compiled without the |+statusline| feature}
8921
8922 *'toolbar'* *'tb'*
8923'toolbar' 'tb' string (default "icons,tooltips")
8924 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008925 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008926 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927 possible values are:
8928 icons Toolbar buttons are shown with icons.
8929 text Toolbar buttons shown with text.
8930 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008931 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 tooltips Tooltips are active for toolbar buttons.
8933 Tooltips refer to the popup help text which appears after the mouse
8934 cursor is placed over a toolbar button for a brief moment.
8935
8936 If you want the toolbar to be shown with icons as well as text, do the
8937 following: >
8938 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008939< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 will show icons if both are requested.
8941
8942 If none of the strings specified in 'toolbar' are valid or if
8943 'toolbar' is empty, this option is ignored. If you want to disable
8944 the toolbar, you need to set the 'guioptions' option. For example: >
8945 :set guioptions-=T
8946< Also see |gui-toolbar|.
8947
8948 *'toolbariconsize'* *'tbis'*
8949'toolbariconsize' 'tbis' string (default "small")
8950 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008951 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008953 tiny Use tiny icons.
8954 small Use small icons (default).
8955 medium Use medium-sized icons.
8956 large Use large icons.
8957 huge Use even larger icons.
8958 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008960 the current theme. Common dimensions are giant=48x48, huge=32x32,
8961 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962
8963 If 'toolbariconsize' is empty, the global default size as determined
8964 by user preferences or the current theme is used.
8965
8966 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8967'ttybuiltin' 'tbi' boolean (default on)
8968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 When on, the builtin termcaps are searched before the external ones.
8970 When off the builtin termcaps are searched after the external ones.
8971 When this option is changed, you should set the 'term' option next for
8972 the change to take effect, for example: >
8973 :set notbi term=$TERM
8974< See also |termcap|.
8975 Rationale: The default for this option is "on", because the builtin
8976 termcap entries are generally better (many systems contain faulty
8977 xterm entries...).
8978
8979 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008980'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 Indicates a fast terminal connection. More characters will be sent to
8983 the screen for redrawing, instead of using insert/delete line
8984 commands. Improves smoothness of redrawing when there are multiple
8985 windows and the terminal does not support a scrolling region.
8986 Also enables the extra writing of characters at the end of each screen
8987 line for lines that wrap. This helps when using copy/paste with the
8988 mouse in an xterm and other terminals.
8989
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008990 The default used to be set only for some terminal names, but these
8991 days nearly all terminals are fast, therefore the default is now "on".
8992 If you have a slow connection you may want to set this option off,
8993 e.g. depending on the host name: >
8994 if hostname() =~ 'faraway'
8995 set nottyfast
8996 endif
8997<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 *'ttymouse'* *'ttym'*
8999'ttymouse' 'ttym' string (default depends on 'term')
9000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 {only in Unix and VMS, doesn't work in the GUI; not
9002 available when compiled without |+mouse|}
9003 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009004 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 *xterm-mouse*
9006 xterm xterm-like mouse handling. The mouse generates
9007 "<Esc>[Mscr", where "scr" is three bytes:
9008 "s" = button state
9009 "c" = column plus 33
9010 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009011 This only works up to 223 columns! See "dec",
9012 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 xterm2 Works like "xterm", but with the xterm reporting the
9014 mouse position while the mouse is dragged. This works
9015 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009016 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 work. See below for how Vim detects this
9018 automatically.
9019 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009020 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009022 for the row and column. No other mouse events are
9023 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 *dec-mouse*
9025 dec DEC terminal mouse handling. The mouse generates a
9026 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009027 This is also available for an Xterm, if it was
9028 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 *jsbterm-mouse*
9030 jsbterm JSB term mouse handling.
9031 *pterm-mouse*
9032 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009033 *urxvt-mouse*
9034 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009035 The mouse works only if the terminal supports this
9036 encoding style, but it does not have 223 columns limit
9037 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009038 *sgr-mouse*
9039 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009040 mouse reporting. The mouse works even in columns
9041 beyond 223. This option is backward compatible with
9042 "xterm2" because it can also decode "xterm2" style
9043 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044
9045 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009046 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9047 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9049 recognized, if enabled at compile time. DEC terminal mouse codes
9050 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009051 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9052 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009054 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9055 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9056 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009057 If the terminfo/termcap entry "XM" exists and the first number is
9058 "1006" then 'ttymouse' will be set to "sgr". This works for many
9059 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009060 Additionally, if vim is compiled with the |+termresponse| feature and
9061 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009062 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009064 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9065 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9066 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009067 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9068 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 :set t_RV=
9070<
9071 *'ttyscroll'* *'tsl'*
9072'ttyscroll' 'tsl' number (default 999)
9073 global
9074 Maximum number of lines to scroll the screen. If there are more lines
9075 to scroll the window is redrawn. For terminals where scrolling is
9076 very slow and redrawing is not slow this can be set to a small number,
9077 e.g., 3, to speed up displaying.
9078
9079 *'ttytype'* *'tty'*
9080'ttytype' 'tty' string (default from $TERM)
9081 global
9082 Alias for 'term', see above.
9083
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009084 *'undodir'* *'udir'*
9085'undodir' 'udir' string (default ".")
9086 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009087 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009088 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009089 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009090 "." means using the directory of the file. The undo file name for
9091 "file.txt" is ".file.txt.un~".
9092 For other directories the file name is the full path of the edited
9093 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009094 When writing: The first directory that exists is used. "." always
9095 works, no directories after "." will be used for writing.
9096 When reading all entries are tried to find an undo file. The first
9097 undo file that exists is used. When it cannot be read an error is
9098 given, no further entry is used.
9099 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009100 This option cannot be set from a |modeline| or in the |sandbox|, for
9101 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009102
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009103 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009104'undofile' 'udf' boolean (default off)
9105 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009106 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009107 When on, Vim automatically saves undo history to an undo file when
9108 writing a buffer to a file, and restores undo history from the same
9109 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009110 The directory where the undo file is stored is specified by 'undodir'.
9111 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009112 The undo file is not read when 'undoreload' causes the buffer from
9113 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009114 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009115 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009116
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009118'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009119 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009121 is kept in memory, higher numbers will cause more memory to be used.
9122 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9124 itself: >
9125 set ul=0
9126< But you can also get Vi compatibility by including the 'u' flag in
9127 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009128 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009129 Set to -1 for no undo at all. You might want to do this only for the
9130 current buffer: >
9131 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009133
9134 The local value is set to -123456 when the global value is to be used.
9135
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009136 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009138 *'undoreload'* *'ur'*
9139'undoreload' 'ur' number (default 10000)
9140 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009141 Save the whole buffer for undo when reloading it. This applies to the
9142 ":e!" command and reloading for when the buffer changed outside of
9143 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009144 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009145 of lines is smaller than the value of this option.
9146 Set this option to zero to disable undo for a reload.
9147
9148 When saving undo for a reload, any undo file is not read.
9149
9150 Note that this causes the whole buffer to be stored in memory. Set
9151 this option to a lower value if you run out of memory.
9152
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153 *'updatecount'* *'uc'*
9154'updatecount' 'uc' number (default: 200)
9155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 After typing this many characters the swap file will be written to
9157 disk. When zero, no swap file will be created at all (see chapter on
9158 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9159 Vim with the "-n" option, see |startup|. When editing in readonly
9160 mode this option will be initialized to 10000.
9161 The swapfile can be disabled per buffer with |'swapfile'|.
9162 When 'updatecount' is set from zero to non-zero, swap files are
9163 created for all buffers that have 'swapfile' set. When 'updatecount'
9164 is set to zero, existing swap files are not deleted.
9165 Also see |'swapsync'|.
9166 This option has no meaning in buffers where |'buftype'| is "nofile"
9167 or "nowrite".
9168
9169 *'updatetime'* *'ut'*
9170'updatetime' 'ut' number (default 4000)
9171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 If this many milliseconds nothing is typed the swap file will be
9173 written to disk (see |crash-recovery|). Also used for the
9174 |CursorHold| autocommand event.
9175
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009176 *'varsofttabstop'* *'vsts'*
9177'varsofttabstop' 'vsts' string (default "")
9178 local to buffer
9179 {only available when compiled with the |+vartabs|
9180 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009181 A list of the number of spaces that a <Tab> counts for while editing,
9182 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9183 width <Tab>s are being inserted, while in fact a mixture of spaces
9184 and <Tab>s is used. Tab widths are separated with commas, with the
9185 final value applying to all subsequent tabs.
9186
9187 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009188 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009189 to use the following: >
9190 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009191< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9192 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009193
9194 Note that the value of |'softtabstop'| will be ignored while
9195 'varsofttabstop' is set.
9196
9197 *'vartabstop'* *'vts'*
9198'vartabstop' 'vts' string (default "")
9199 local to buffer
9200 {only available when compiled with the |+vartabs|
9201 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009202 A list of the number of spaces that a <Tab> in the file counts for,
9203 separated by commas. Each value corresponds to one tab, with the
9204 final value applying to all subsequent tabs. For example: >
9205 :set vartabstop=4,20,10,8
9206< This will make the first tab 4 spaces wide, the second 20 spaces,
9207 the third 10 spaces, and all following tabs 8 spaces.
9208
9209 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9210 is set.
9211
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 *'verbose'* *'vbs'*
9213'verbose' 'vbs' number (default 0)
9214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 When bigger than zero, Vim will give messages about what it is doing.
9216 Currently, these messages are given:
9217 >= 1 When the viminfo file is read or written.
9218 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009219 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009220 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 >= 8 Files for which a group of autocommands is executed.
9222 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009223 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 >= 12 Every executed function.
9225 >= 13 When an exception is thrown, caught, finished, or discarded.
9226 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009227 >= 15 Every executed Ex command from a script (truncated at 200
9228 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009229 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230
9231 This option can also be set with the "-V" argument. See |-V|.
9232 This option is also set by the |:verbose| command.
9233
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009234 When the 'verbosefile' option is set then the verbose messages are not
9235 displayed.
9236
9237 *'verbosefile'* *'vfile'*
9238'verbosefile' 'vfile' string (default empty)
9239 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009240 When not empty all messages are written in a file with this name.
9241 When the file exists messages are appended.
9242 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009243 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009244 Setting 'verbosefile' to a new value is like making it empty first.
9245 The difference with |:redir| is that verbose messages are not
9246 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009247 This option cannot be set from a |modeline| or in the |sandbox|, for
9248 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009249
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009251'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009252 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009253 for Unix: "$HOME/.vim/view" or
9254 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009255 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009257 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 feature}
9259 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009260 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 This option cannot be set from a |modeline| or in the |sandbox|, for
9262 security reasons.
9263
9264 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009265'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009266 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009267 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009269 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009270 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 word save and restore ~
9272 cursor cursor position in file and in window
9273 folds manually created folds, opened/closed folds and local
9274 fold options
9275 options options and mappings local to a window or buffer (not
9276 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009277 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009278 slash backslashes in file names replaced with forward
9279 slashes
9280 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009281 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009282 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009284 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009286 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287
9288 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009289'viminfo' 'vi' string (Vi default: "", Vim default for
9290 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009291 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9292 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009294 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 feature}
9296 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009297 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9298 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009299 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009300 consisting of a single character identifying the particular parameter,
9301 followed by a number or string which specifies the value of that
9302 parameter. If a particular character is left out, then the default
9303 value is used for that parameter. The following is a list of the
9304 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009306 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307 ! When included, save and restore global variables that start
9308 with an uppercase letter, and don't contain a lowercase
9309 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009310 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009311 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009312 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 " Maximum number of lines saved for each register. Old name of
9314 the '<' item, with the disadvantage that you need to put a
9315 backslash before the ", otherwise it will be recognized as the
9316 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009317 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318 % When included, save and restore the buffer list. If Vim is
9319 started with a file name argument, the buffer list is not
9320 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009321 buffer list is restored from the viminfo file. Quickfix
9322 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9323 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009324 When followed by a number, the number specifies the maximum
9325 number of buffers that are stored. Without a number all
9326 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009327 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 ' Maximum number of previously edited files for which the marks
9329 are remembered. This parameter must always be included when
9330 'viminfo' is non-empty.
9331 Including this item also means that the |jumplist| and the
9332 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009333 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009335 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336 patterns are also saved. When not included, the value of
9337 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009338 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009340 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009341 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342 < Maximum number of lines saved for each register. If zero then
9343 registers are not saved. When not included, all lines are
9344 saved. '"' is the old name for this item.
9345 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009346 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009347 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009348 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009349 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009350 c When included, convert the text in the viminfo file from the
9351 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009352 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009353 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354 f Whether file marks need to be stored. If zero, file marks ('0
9355 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009356 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009357 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009358 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 h Disable the effect of 'hlsearch' when loading the viminfo
9360 file. When not included, it depends on whether ":nohlsearch"
9361 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009362 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009364 the 'n'. Must be at the end of the option! If the
9365 'viminfofile' option is set, that file name overrides the one
9366 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009367 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009368 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369 r Removable media. The argument is a string (up to the next
9370 ','). This parameter can be given several times. Each
9371 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009372 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009373 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9374 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9375 ignored. Maximum length of each 'r' argument is 50
9376 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009377 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 s Maximum size of an item in Kbyte. If zero then registers are
9379 not saved. Currently only applies to registers. The default
9380 "s10" will exclude registers with more than 10 Kbyte of text.
9381 Also see the '<' item above: line count limit.
9382
9383 Example: >
9384 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9385<
9386 '50 Marks will be remembered for the last 50 files you
9387 edited.
9388 <1000 Contents of registers (up to 1000 lines each) will be
9389 remembered.
9390 s100 Registers with more than 100 Kbyte text are skipped.
9391 :0 Command-line history will not be saved.
9392 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9393 no / Since '/' is not specified, the default will be used,
9394 that is, save all of the search history, and also the
9395 previous search and substitute patterns.
9396 no % The buffer list will not be saved nor read back.
9397 no h 'hlsearch' highlighting will be restored.
9398
9399 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9400 load the contents of the file, this is not done automatically.
9401
9402 This option cannot be set from a |modeline| or in the |sandbox|, for
9403 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009404 NOTE: This option is set to the Vim default value when 'compatible'
9405 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009406
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009407 *'viminfofile'* *'vif'*
9408'viminfofile' 'vif' string (default: "")
9409 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009410 {not available when compiled without the |+viminfo|
9411 feature}
9412 When non-empty, overrides the file name used for viminfo.
9413 When equal to "NONE" no viminfo file will be read or written.
9414 This option can be set with the |-i| command line flag. The |--clean|
9415 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009416 This option cannot be set from a |modeline| or in the |sandbox|, for
9417 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009418
Bram Moolenaar071d4272004-06-13 20:20:40 +00009419 *'virtualedit'* *'ve'*
9420'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009421 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009422 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009423 block Allow virtual editing in Visual block mode.
9424 insert Allow virtual editing in Insert mode.
9425 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009426 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009427 none When used as the local value, do not allow virtual
9428 editing even when the global value is set. When used
9429 as the global value, "none" is the same as "".
9430 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009431
Bram Moolenaar071d4272004-06-13 20:20:40 +00009432 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009433 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009434 of the line. Useful for selecting a rectangle in Visual mode and
9435 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009436 "onemore" is not the same, it will only allow moving the cursor just
9437 after the last character of the line. This makes some commands more
9438 consistent. Previously the cursor was always past the end of the line
9439 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009440 break some plugins or Vim scripts. For example because |l| can move
9441 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009442 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009443 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009444 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009445 It doesn't make sense to combine "all" with "onemore", but you will
9446 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009447 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009448 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009449
9450 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9451'visualbell' 'vb' boolean (default off)
9452 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009453 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009454 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009455 use: >
9456 :set vb t_vb=
9457< If you want a short flash, you can use this on many terminals: >
9458 :set vb t_vb=[?5h$<100>[?5l
9459< Here $<100> specifies the time, you can use a smaller or bigger value
9460 to get a shorter or longer flash.
9461
9462 Note: Vim will limit the bell to once per half a second. This avoids
9463 having to wait for the flashing to finish when there are lots of
9464 bells, e.g. on key repeat. This also happens without 'visualbell'
9465 set.
9466
Bram Moolenaar071d4272004-06-13 20:20:40 +00009467 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9468 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9469 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009470
9471 Note: When the GUI starts, 't_vb' is reset to its default value. You
9472 might want to set it again in your |gvimrc|.
9473
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 Does not work on the Amiga, you always get a screen flash.
9475 Also see 'errorbells'.
9476
9477 *'warn'* *'nowarn'*
9478'warn' boolean (default on)
9479 global
9480 Give a warning message when a shell command is used while the buffer
9481 has been changed.
9482
9483 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9484'weirdinvert' 'wiv' boolean (default off)
9485 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009486 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009487 It is provided for backwards compatibility with version 4.x.
9488 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9489 vice versa. Has no effect when the GUI is running.
9490
9491 *'whichwrap'* *'ww'*
9492'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009494 Allow specified keys that move the cursor left/right to move to the
9495 previous/next line when the cursor is on the first/last character in
9496 the line. Concatenate characters to allow this for these keys:
9497 char key mode ~
9498 b <BS> Normal and Visual
9499 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009500 h "h" Normal and Visual (not recommended)
9501 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009502 < <Left> Normal and Visual
9503 > <Right> Normal and Visual
9504 ~ "~" Normal
9505 [ <Left> Insert and Replace
9506 ] <Right> Insert and Replace
9507 For example: >
9508 :set ww=<,>,[,]
9509< allows wrap only when cursor keys are used.
9510 When the movement keys are used in combination with a delete or change
9511 operator, the <EOL> also counts for a character. This makes "3h"
9512 different from "3dh" when the cursor crosses the end of a line. This
9513 is also true for "x" and "X", because they do the same as "dl" and
9514 "dh". If you use this, you may also want to use the mapping
9515 ":map <BS> X" to make backspace delete the character in front of the
9516 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009517 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009518 line (not an empty line) then it will not move to the next line. This
9519 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520 NOTE: This option is set to the Vi default value when 'compatible' is
9521 set and to the Vim default value when 'compatible' is reset.
9522
9523 *'wildchar'* *'wc'*
9524'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 Character you have to type to start wildcard expansion in the
9527 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009528 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009529 The character is not recognized when used inside a macro. See
9530 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009531 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009532 <Esc> can be used, but hitting it twice in a row will still exit
9533 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009534 Although 'wc' is a number option, it can be specified as a number, a
9535 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9536 preceded with a caret (e.g. `^F` is CTRL-F): >
9537 :set wc=27
9538 :set wc=X
9539 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009540 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009541< NOTE: This option is set to the Vi default value when 'compatible' is
9542 set and to the Vim default value when 'compatible' is reset.
9543
9544 *'wildcharm'* *'wcm'*
9545'wildcharm' 'wcm' number (default: none (0))
9546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009547 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009548 recognized when used inside a macro. You can find "spare" command-line
9549 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009550 you'll never actually type 'wildcharm', just use it in mappings that
9551 automatically invoke completion mode, e.g.: >
9552 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009553 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554< Then after typing :ss you can use CTRL-P & CTRL-N.
9555
9556 *'wildignore'* *'wig'*
9557'wildignore' 'wig' string (default "")
9558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009559 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009560 patterns is ignored when expanding |wildcards|, completing file or
9561 directory names, and influences the result of |expand()|, |glob()| and
9562 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009563 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9564 Also see 'suffixes'.
9565 Example: >
9566 :set wildignore=*.o,*.obj
9567< The use of |:set+=| and |:set-=| is preferred when adding or removing
9568 a pattern from the list. This avoids problems when a future version
9569 uses another default.
9570
h_east596a9f22023-11-21 21:24:23 +09009571 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009572'wildignorecase' 'wic' boolean (default off)
9573 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009574 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009575 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009576 Does not apply when the shell is used to expand wildcards, which
9577 happens when there are special characters.
9578
Bram Moolenaar071d4272004-06-13 20:20:40 +00009579 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009580'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009582 When 'wildmenu' is on, command-line completion operates in an enhanced
9583 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009584 the possible matches are shown.
9585 When 'wildoptions' contains "pum", then the completion matches are
9586 shown in a popup menu. Otherwise they are displayed just above the
9587 command line, with the first match highlighted (overwriting the status
9588 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009589 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009590 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9591 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9592 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009593 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009594 If there are more matches than can fit in the line, a ">" is shown on
9595 the right and/or a "<" is shown on the left. The status line scrolls
9596 as needed.
9597 The "wildmenu" mode is abandoned when a key is hit that is not used
9598 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009599 While the "wildmenu" is active, the following keys have special
9600 meanings:
9601 CTRL-P - go to the previous entry
9602 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009603 <CR> - in menu completion, when the cursor is just after a
9604 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009605 CTRL-E - end completion, go back to what was there before
9606 selecting a match.
9607 CTRL-Y - accept the currently selected match and stop
9608 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009609
9610 When not using the popup menu for command line completion, the
9611 following keys have special meanings:
9612 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009613 <Up> - in filename/menu name completion: move up into
9614 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009615 <Down> - in filename/menu name completion: move into a
9616 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009618 When using the popup menu for command line completion, the following
9619 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009620 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009621 <PageUp> - select a match several entries back
9622 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009623 <Left> - in filename/menu name completion: move up into
9624 parent directory or parent menu.
9625 <Right> - in filename/menu name completion: move into a
9626 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009627
Bram Moolenaar071d4272004-06-13 20:20:40 +00009628 This makes the menus accessible from the console |console-menus|.
9629
9630 If you prefer the <Left> and <Right> keys to move the cursor instead
9631 of selecting a different match, use this: >
9632 :cnoremap <Left> <Space><BS><Left>
9633 :cnoremap <Right> <Space><BS><Right>
9634<
9635 The "WildMenu" highlighting is used for displaying the current match
9636 |hl-WildMenu|.
9637
9638 *'wildmode'* *'wim'*
9639'wildmode' 'wim' string (Vim default: "full")
9640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009641 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009642 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009643 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009644 first part specifies the behavior for the first use of 'wildchar',
9645 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009646
9647 Each part consists of a colon separated list consisting of the
9648 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009649 "" Complete only the first match.
9650 "full" Complete the next full match. After the last match,
9651 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009652 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009653 "longest" Complete till longest common string. If this doesn't
9654 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009655 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009656 "lastused" When completing buffer names and more than one buffer
9657 matches, sort buffers by time last used (other than
9658 the current buffer).
Girish Palya2bacc3e2025-03-02 22:55:57 +01009659 "noselect" Do not pre-select first menu item and start 'wildmenu'
9660 if it is enabled.
9661 When there is only a single match, it is fully completed in all cases
9662 except when "noselect" is present.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009663
9664 Examples of useful colon-separated values:
9665 "longest:full" Like "longest", but also start 'wildmenu' if it is
9666 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009667 "list:full" When more than one match, list all matches and
9668 complete first match.
9669 "list:longest" When more than one match, list all matches and
9670 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009671 "list:lastused" When more than one buffer matches, list all matches
9672 and sort buffers by time last used (other than the
9673 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009674
9675 Examples: >
9676 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009677< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009678 :set wildmode=longest,full
9679< Complete longest common string, then each full match >
9680 :set wildmode=list:full
9681< List all matches and complete each full match >
9682 :set wildmode=list,full
9683< List all matches without completing, then each full match >
9684 :set wildmode=longest,list
Girish Palya2bacc3e2025-03-02 22:55:57 +01009685< Complete longest common string, then list alternatives >
9686 :set wildmode=noselect:full
9687< Display 'wildmenu' without completing, then each full match >
9688 :set wildmode=noselect:lastused,full
9689< Same as above, but sort buffers by time last used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009690 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009691
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009692 *'wildoptions'* *'wop'*
9693'wildoptions' 'wop' string (default "")
9694 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009695 A list of words that change how |cmdline-completion| is done.
9696 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009697 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009698 this value is specified, wildcard expansion will not
9699 be used for completion. The matches will be sorted by
9700 the "best match" rather than alphabetically sorted.
9701 This will find more matches than the wildcard
9702 expansion. Currently fuzzy matching based completion
9703 is not supported for file and directory names and
9704 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009705 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009706 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009707 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009708 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009709 is displayed per line. Often used tag kinds are:
9710 d #define
9711 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009712
Bram Moolenaar071d4272004-06-13 20:20:40 +00009713 *'winaltkeys'* *'wak'*
9714'winaltkeys' 'wak' string (default "menu")
9715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009716 {only used in Win32, Motif, GTK and Photon GUI}
9717 Some GUI versions allow the access to menu entries by using the ALT
9718 key in combination with a character that appears underlined in the
9719 menu. This conflicts with the use of the ALT key for mappings and
9720 entering special characters. This option tells what to do:
9721 no Don't use ALT keys for menus. ALT key combinations can be
9722 mapped, but there is no automatic handling. This can then be
9723 done with the |:simalt| command.
9724 yes ALT key handling is done by the windowing system. ALT key
9725 combinations cannot be mapped.
9726 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009727 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009728 keys can be mapped.
9729 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9730 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009731 This option is not used for <F10>; on Win32 and with GTK <F10> will
9732 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009733
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009734 *'wincolor'* *'wcr'*
9735'wincolor' 'wcr' string (default empty)
9736 local to window
9737 Highlight group name to use for this window instead of the Normal
9738 color |hl-Normal|.
9739
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009740 *'window'* *'wi'*
9741'window' 'wi' number (default screen height - 1)
9742 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009743 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9744 window and the value is smaller than 'lines' minus one. The screen
9745 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009746 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9747 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009748 When resizing the Vim window, and the value is smaller than 1 or more
9749 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009750 Note: Do not confuse this with the height of the Vim window, use
9751 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009752
Colin Kennedy21570352024-03-03 16:16:47 +01009753 *'winfixbuf'*
9754'winfixbuf' 'wfb' boolean (default off)
9755 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009756 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009757 For example, attempting to change the buffer with |:edit| will fail.
9758 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009759 also skip any window with 'winfixbuf' enabled. However if an Ex
9760 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009761
laburnumT3f7855a2023-12-05 18:37:03 +01009762 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9763'winfixheight' 'wfh' boolean (default off)
9764 local to window |local-noglobal|
9765 Keep the window height when windows are opened or closed and
9766 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9767 |preview-window| and |quickfix-window|.
9768 The height may be changed anyway when running out of room.
9769
9770 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9771'winfixwidth' 'wfw' boolean (default off)
9772 local to window |local-noglobal|
9773 Keep the window width when windows are opened or closed and
9774 'equalalways' is set. Also for |CTRL-W_=|.
9775 The width may be changed anyway when running out of room.
9776
Bram Moolenaar071d4272004-06-13 20:20:40 +00009777 *'winheight'* *'wh'* *E591*
9778'winheight' 'wh' number (default 1)
9779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009780 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009781 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009782 focus goes to a window that is smaller, its size is increased, at the
9783 cost of the height of other windows.
9784 Set 'winheight' to a small number for normal editing.
9785 Set it to 999 to make the current window fill most of the screen.
9786 Other windows will be only 'winminheight' high. This has the drawback
9787 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9788 to create only two windows, set the option after startup is done,
9789 using the |VimEnter| event: >
9790 au VimEnter * set winheight=999
9791< Minimum value is 1.
9792 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009793 height of the current window.
9794 'winheight' applies to the current window. Use 'winminheight' to set
9795 the minimal height for other windows.
9796
Bram Moolenaar071d4272004-06-13 20:20:40 +00009797 *'winminheight'* *'wmh'*
9798'winminheight' 'wmh' number (default 1)
9799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009800 The minimal height of a window, when it's not the current window.
9801 This is a hard minimum, windows will never become smaller.
9802 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9803 status bar) if necessary. They will return to at least one line when
9804 they become active (since the cursor has to have somewhere to go.)
9805 Use 'winheight' to set the minimal height of the current window.
9806 This option is only checked when making a window smaller. Don't use a
9807 large number, it will cause errors when opening more than a few
9808 windows. A value of 0 to 3 is reasonable.
9809
9810 *'winminwidth'* *'wmw'*
9811'winminwidth' 'wmw' number (default 1)
9812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009813 The minimal width of a window, when it's not the current window.
9814 This is a hard minimum, windows will never become smaller.
9815 When set to zero, windows may be "squashed" to zero columns (i.e. just
9816 a vertical separator) if necessary. They will return to at least one
9817 line when they become active (since the cursor has to have somewhere
9818 to go.)
9819 Use 'winwidth' to set the minimal width of the current window.
9820 This option is only checked when making a window smaller. Don't use a
9821 large number, it will cause errors when opening more than a few
9822 windows. A value of 0 to 12 is reasonable.
9823
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009824 *'winptydll'*
9825'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9826 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009827 {only available when compiled with the |terminal|
9828 feature on MS-Windows}
9829 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009830 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009831 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009832 a fallback.
9833 Environment variables are expanded |:set_env|.
9834 This option cannot be set from a |modeline| or in the |sandbox|, for
9835 security reasons.
9836
Bram Moolenaar071d4272004-06-13 20:20:40 +00009837 *'winwidth'* *'wiw'* *E592*
9838'winwidth' 'wiw' number (default 20)
9839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009840 Minimal number of columns for the current window. This is not a hard
9841 minimum, Vim will use fewer columns if there is not enough room. If
9842 the current window is smaller, its size is increased, at the cost of
9843 the width of other windows. Set it to 999 to make the current window
9844 always fill the screen. Set it to a small number for normal editing.
9845 The width is not adjusted after one of the commands to change the
9846 width of the current window.
9847 'winwidth' applies to the current window. Use 'winminwidth' to set
9848 the minimal width for other windows.
9849
9850 *'wrap'* *'nowrap'*
9851'wrap' boolean (default on)
9852 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009853 This option changes how text is displayed. It doesn't change the text
9854 in the buffer, see 'textwidth' for that.
9855 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009856 displaying continues on the next line. When off lines will not wrap
9857 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009858 moved to a part that is not shown, the screen will scroll
9859 horizontally.
9860 The line will be broken in the middle of a word if necessary. See
9861 'linebreak' to get the break at a word boundary.
9862 To make scrolling horizontally a bit more useful, try this: >
9863 :set sidescroll=5
9864 :set listchars+=precedes:<,extends:>
9865< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009866 This option can't be set from a |modeline| when the 'diff' option is
9867 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009868
9869 *'wrapmargin'* *'wm'*
9870'wrapmargin' 'wm' number (default 0)
9871 local to buffer
9872 Number of characters from the right window border where wrapping
9873 starts. When typing text beyond this limit, an <EOL> will be inserted
9874 and inserting continues on the next line.
9875 Options that add a margin, such as 'number' and 'foldcolumn', cause
9876 the text width to be further reduced. This is Vi compatible.
9877 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009878 This option is set to 0 when 'paste' is set and restored when 'paste'
9879 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009880 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009881
9882 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9883'wrapscan' 'ws' boolean (default on) *E384* *E385*
9884 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009885 Searches wrap around the end of the file. Also applies to |]s| and
9886 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009887
9888 *'write'* *'nowrite'*
9889'write' boolean (default on)
9890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009891 Allows writing files. When not set, writing a file is not allowed.
9892 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009893 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009894 argument. Filtering text is still possible, even though this requires
9895 writing a temporary file.
9896
9897 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9898'writeany' 'wa' boolean (default off)
9899 global
9900 Allows writing to any file with no need for "!" override.
9901
9902 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9903'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9904 otherwise)
9905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009906 Make a backup before overwriting a file. The backup is removed after
9907 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009908 also on.
9909 WARNING: Switching this option off means that when Vim fails to write
9910 your buffer correctly and then, for whatever reason, Vim exits, you
9911 lose both the original file and what you were writing. Only reset
9912 this option if your file system is almost full and it makes the write
9913 fail (and make sure not to exit Vim until the write was successful).
9914 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009915 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009916 Depending on 'backupcopy' the backup is a new file or the original
9917 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009918 NOTE: This option is set to the default value when 'compatible' is
9919 set.
9920
9921 *'writedelay'* *'wd'*
9922'writedelay' 'wd' number (default 0)
9923 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009924 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009925 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009926 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009927
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009928 *'xtermcodes'* *'noxtermcodes'*
9929'xtermcodes' boolean (default on)
9930 global
9931 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009932 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009933 key codes and number of colors from the terminal. This takes care of
9934 various configuration options of the terminal that cannot be obtained
9935 from the termlib/terminfo entry, see |xterm-codes|.
9936 A side effect may be that t_Co changes and Vim will redraw the
9937 display.
9938
9939
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009940 vim:tw=78:ts=8:noet:ft=help:norl: