blob: 99e6d54f897252e26e3fb7258738690fd4f438b3 [file] [log] [blame]
Girish Palyacbe53192025-04-14 22:13:15 +02001*options.txt* For Vim version 9.1. Last change: 2025 Apr 14
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 "]"
Girish Palyacbe53192025-04-14 22:13:15 +02002088 f{func} call the function {func}. Multiple "f" flags may be specified.
2089 Refer to |complete-functions| for details on how the function
2090 is invoked and what it should return. The value can be the
2091 name of a function or a |Funcref|. For |Funcref| values,
2092 spaces must be escaped with a backslash ('\'), and commas with
2093 double backslashes ('\\') (see |option-backslash|).
2094 If the Dict returned by the {func} includes {"refresh": "always"},
2095 the function will be invoked again whenever the leading text
2096 changes.
2097 Completion matches are always inserted at the keyword
2098 boundary, regardless of the column returned by {func} when
2099 a:findstart is 1. This ensures compatibility with other
2100 completion sources.
2101 To make further modifications to the inserted text, {func}
2102 can make use of |CompleteDonePre|.
2103 If generating matches is potentially slow, |complete_check()|
2104 should be used to avoid blocking and preserve editor
2105 responsiveness.
2106 f equivalent to using "f{func}", where the function is taken from
2107 the 'completefunc' option.
2108 o equivalent to using "f{func}", where the function is taken from
2109 the 'omnifunc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2112 not executed, this may lead to unexpected completions from some files
2113 (gzipped files for example). Unloaded buffers are not scanned for
2114 whole-line completion.
2115
2116 The default is ".,w,b,u,t,i", which means to scan:
2117 1. the current buffer
2118 2. buffers in other windows
2119 3. other loaded buffers
2120 4. unloaded buffers
2121 5. tags
2122 6. included files
2123
2124 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002125 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2126 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002128 *'completefunc'* *'cfu'*
2129'completefunc' 'cfu' string (default: empty)
2130 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002131 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002132 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002133 This option specifies a function to be used for Insert mode completion
2134 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002135 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002136 invoked and what it should return. The value can be the name of a
2137 function, a |lambda| or a |Funcref|. See |option-value-function| for
2138 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002139 This option cannot be set from a |modeline| or in the |sandbox|, for
2140 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002141
glepnirf31cfa22025-03-06 21:59:13 +01002142 *'completefuzzycollect'* *'cfc'*
2143'completefuzzycollect' 'cfc' string (default: empty)
2144 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002145 A comma-separated list of strings to enable fuzzy collection for
2146 specific |ins-completion| modes, affecting how matches are gathered
2147 during completion. For specified modes, fuzzy matching is used to
2148 find completion candidates instead of the standard prefix-based
2149 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002150
glepnir58760162025-03-13 21:39:51 +01002151 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2152 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2153 "b", "u", "U" and "k{dict}" in 'complete'
2154 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002155
glepnir58760162025-03-13 21:39:51 +01002156 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002157
glepnir58760162025-03-13 21:39:51 +01002158 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002159
Christian Brabandtf22580e2025-03-14 12:05:52 +01002160 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002161 can identify the longest common string among the best fuzzy matches
2162 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002163
glepnir6a89c942024-10-01 20:32:12 +02002164 *'completeitemalign'* *'cia'*
2165'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2166 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002167 A comma-separated list of strings that controls the alignment and
2168 display order of items in the popup menu during Insert mode
2169 completion. The supported values are "abbr", "kind", and "menu".
2170 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002171 popup menu. Note: must always contain those three values in any
2172 order.
2173
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002174 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002175'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002176 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002177 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002178 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002179
glepnira2c55592025-02-28 17:43:42 +01002180 fuzzy Enable |fuzzy-matching| for completion candidates. This
2181 allows for more flexible and intuitive matching, where
2182 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002183 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002184 does not affect the collection of candidate list, it only
2185 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002186 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002187 to gather more alternatives for your candidate list,
2188 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002189
2190 longest Only insert the longest common text of the matches. If
2191 the menu is displayed you can use CTRL-L to add more
2192 characters. Whether case is ignored depends on the kind
2193 of completion. For buffer text the 'ignorecase' option is
2194 used.
2195
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002196 menu Use a popup menu to show the possible completions. The
2197 menu is only shown when there is more than one match and
2198 sufficient colors are available. |ins-completion-menu|
2199
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002200 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002201 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002202 match, e.g., what file it comes from.
2203
glepnira2c55592025-02-28 17:43:42 +01002204 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002205 a match from the menu. Only works in combination with
2206 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002207
glepnira2c55592025-02-28 17:43:42 +01002208 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002209 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002210 present, "noselect" has precedence.
2211
2212 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002213 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002214 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002215
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002216 popup Show extra information about the currently selected
2217 completion in a popup window. Only works in combination
2218 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002219 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002220 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002221
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002222 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002223 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002224 |CompleteChanged| autocommand to fetch the info and call
2225 |popup_show()| once the popup has been filled.
2226 See the example at |complete-popuphidden|.
2227 {only works when compiled with the |+textprop| feature}
2228
glepniredd4ac32025-01-29 18:53:51 +01002229 preinsert
2230 Preinsert the portion of the first candidate word that is
2231 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002232 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002233 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002234
2235 preview Show extra information about the currently selected
2236 completion in the preview window. Only works in
2237 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002238
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002239 *'completepopup'* *'cpp'*
2240'completepopup' 'cpp' string (default empty)
2241 global
2242 {not available when compiled without the |+textprop|
2243 or |+quickfix| feature}
2244 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002245 properties of the info popup when it is created. If an info popup
2246 window already exists it is closed, so that the option value is
2247 applied when it is created again.
2248 You can also use |popup_findinfo()| and then set properties for an
2249 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002250
laburnumT3f7855a2023-12-05 18:37:03 +01002251 *'completeslash'* *'csl'*
2252'completeslash' 'csl' string (default: "")
2253 local to buffer
2254 {only for MS-Windows}
2255 When this option is set it overrules 'shellslash' for completion:
2256 - When this option is set to "slash", a forward slash is used for path
2257 completion in insert mode. This is useful when editing HTML tag, or
2258 Makefile with 'noshellslash' on MS-Windows.
2259 - When this option is set to "backslash", backslash is used. This is
2260 useful when editing a batch file with 'shellslash' set on MS-Windows.
2261 - When this option is empty, same character is used as for
2262 'shellslash'.
2263 For Insert mode completion the buffer-local value is used. For
2264 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002265
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002266 *'concealcursor'* *'cocu'*
2267'concealcursor' 'cocu' string (default: "")
2268 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002269 {not available when compiled without the |+conceal|
2270 feature}
2271 Sets the modes in which text in the cursor line can also be concealed.
2272 When the current mode is listed then concealing happens just like in
2273 other lines.
2274 n Normal mode
2275 v Visual mode
2276 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002277 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002278
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002279 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002280 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002281 are moving around text is concealed, but when starting to insert text
2282 or selecting a Visual area the concealed text is displayed, so that
2283 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002284 Keep in mind that the cursor position is not always where it's
2285 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002286
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002287 *'conceallevel'* *'cole'*
2288'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002289 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002290 {not available when compiled without the |+conceal|
2291 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002292 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2293 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002294
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002295 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002296 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002297 1 Each block of concealed text is replaced with one
2298 character. If the syntax item does not have a custom
2299 replacement character defined (see |:syn-cchar|) the
2300 character defined in 'listchars' is used (default is a
2301 space).
2302 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002303 2 Concealed text is completely hidden unless it has a
2304 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002305 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002306 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002307
Bram Moolenaara7781e02010-07-19 20:13:22 +02002308 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002309 edit and copy the text. This can be changed with the 'concealcursor'
2310 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002311
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2313'confirm' 'cf' boolean (default off)
2314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 When 'confirm' is on, certain operations that would normally
2316 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2317 instead raise a |dialog| asking if you wish to save the current
2318 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2319 If 'confirm' is off you can still activate confirmation for one
2320 command only (this is most useful in mappings) with the |:confirm|
2321 command.
2322 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2323
2324 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2325'conskey' 'consk' boolean (default off)
2326 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002327 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328
2329 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2330'copyindent' 'ci' boolean (default off)
2331 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 Copy the structure of the existing lines indent when autoindenting a
2333 new line. Normally the new indent is reconstructed by a series of
2334 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2335 in which case only spaces are used). Enabling this option makes the
2336 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002337 existing line. 'expandtab' has no effect on these characters, a Tab
2338 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002340 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 Also see 'preserveindent'.
2342
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002343 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002344'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2345 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002346 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002349 this indicates Vi-compatible behavior. This is used for things where
2350 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 'cpoptions' stands for "compatible-options".
2352 Commas can be added for readability.
2353 To avoid problems with flags that are added in the future, use the
2354 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002355
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 NOTE: This option is set to the Vi default value when 'compatible' is
2357 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002358
2359 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2360 is saved, 'cpoptions' is set to the Vim default, and the saved value
2361 is restored at the end of the script. Changes to the value of
2362 'cpoptions' will be applied to the saved value, but keep in mind that
2363 removing a flag that is not present when 'cpoptions' is changed has no
2364 effect. In the |.vimrc| file the value is not restored, thus using
2365 `vim9script` in the |.vimrc| file results in using the Vim default.
2366
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002367 NOTE: This option is set to the POSIX default value at startup when
2368 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002369 variable exists |posix|. This means Vim tries to behave like the
2370 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
2372 contains behavior ~
2373 *cpo-a*
2374 a When included, a ":read" command with a file name
2375 argument will set the alternate file name for the
2376 current window.
2377 *cpo-A*
2378 A When included, a ":write" command with a file name
2379 argument will set the alternate file name for the
2380 current window.
2381 *cpo-b*
2382 b "\|" in a ":map" command is recognized as the end of
2383 the map command. The '\' is included in the mapping,
2384 the text after the '|' is interpreted as the next
2385 command. Use a CTRL-V instead of a backslash to
2386 include the '|' in the mapping. Applies to all
2387 mapping, abbreviation, menu and autocmd commands.
2388 See also |map_bar|.
2389 *cpo-B*
2390 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002391 abbreviations, user commands and the "to" part of the
2392 menu commands. Remove this flag to be able to use a
2393 backslash like a CTRL-V. For example, the command
2394 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 'B' included: "\^[" (^[ is a real <Esc>)
2396 'B' excluded: "<Esc>" (5 characters)
2397 ('<' excluded in both cases)
2398 *cpo-c*
2399 c Searching continues at the end of any match at the
2400 cursor position, but not further than the start of the
2401 next line. When not present searching continues
2402 one character from the cursor position. With 'c'
2403 "abababababab" only gets three matches when repeating
2404 "/abab", without 'c' there are five matches.
2405 *cpo-C*
2406 C Do not concatenate sourced lines that start with a
2407 backslash. See |line-continuation|.
2408 *cpo-d*
2409 d Using "./" in the 'tags' option doesn't mean to use
2410 the tags file relative to the current file, but the
2411 tags file in the current directory.
2412 *cpo-D*
2413 D Can't use CTRL-K to enter a digraph after Normal mode
2414 commands with a character argument, like |r|, |f| and
2415 |t|.
2416 *cpo-e*
2417 e When executing a register with ":@r", always add a
2418 <CR> to the last line, also when the register is not
2419 linewise. If this flag is not present, the register
2420 is not linewise and the last line does not end in a
2421 <CR>, then the last line is put on the command-line
2422 and can be edited before hitting <CR>.
2423 *cpo-E*
2424 E It is an error when using "y", "d", "c", "g~", "gu" or
2425 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002426 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 This makes "y0" fail in the first column.
2428 *cpo-f*
2429 f When included, a ":read" command with a file name
2430 argument will set the file name for the current buffer,
2431 if the current buffer doesn't have a file name yet.
2432 *cpo-F*
2433 F When included, a ":write" command with a file name
2434 argument will set the file name for the current
2435 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002436 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 *cpo-g*
2438 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002439 *cpo-H*
2440 H When using "I" on a line with only blanks, insert
2441 before the last blank. Without this flag insert after
2442 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 *cpo-i*
2444 i When included, interrupting the reading of a file will
2445 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002446 *cpo-I*
2447 I When moving the cursor up or down just after inserting
2448 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 *cpo-j*
2450 j When joining lines, only add two spaces after a '.',
2451 not after '!' or '?'. Also see 'joinspaces'.
2452 *cpo-J*
2453 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002454 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 white space.
2456 *cpo-k*
2457 k Disable the recognition of raw key codes in
2458 mappings, abbreviations, and the "to" part of menu
2459 commands. For example, if <Key> sends ^[OA (where ^[
2460 is <Esc>), the command ":map X ^[OA" results in X
2461 being mapped to:
2462 'k' included: "^[OA" (3 characters)
2463 'k' excluded: "<Key>" (one key code)
2464 Also see the '<' flag below.
2465 *cpo-K*
2466 K Don't wait for a key code to complete when it is
2467 halfway a mapping. This breaks mapping <F1><F1> when
2468 only part of the second <F1> has been read. It
2469 enables cancelling the mapping by typing <F1><Esc>.
2470 *cpo-l*
2471 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002472 literally, only "\]", "\^", "\-" and "\\" are special.
2473 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2475 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002476 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 *cpo-L*
2478 L When the 'list' option is set, 'wrapmargin',
2479 'textwidth', 'softtabstop' and Virtual Replace mode
2480 (see |gR|) count a <Tab> as two characters, instead of
2481 the normal behavior of a <Tab>.
2482 *cpo-m*
2483 m When included, a showmatch will always wait half a
2484 second. When not included, a showmatch will wait half
2485 a second or until a character is typed. |'showmatch'|
2486 *cpo-M*
2487 M When excluded, "%" matching will take backslashes into
2488 account. Thus in "( \( )" and "\( ( \)" the outer
2489 parenthesis match. When included "%" ignores
2490 backslashes, which is Vi compatible.
2491 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002492 n When included, the column used for 'number' and
2493 'relativenumber' will also be used for text of wrapped
2494 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 *cpo-o*
2496 o Line offset to search command is not remembered for
2497 next search.
2498 *cpo-O*
2499 O Don't complain if a file is being overwritten, even
2500 when it didn't exist when editing it. This is a
2501 protection against a file unexpectedly created by
2502 someone else. Vi didn't complain about this.
2503 *cpo-p*
2504 p Vi compatible Lisp indenting. When not present, a
2505 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002506 *cpo-P*
2507 P When included, a ":write" command that appends to a
2508 file will set the file name for the current buffer, if
2509 the current buffer doesn't have a file name yet and
2510 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002511 *cpo-q*
2512 q When joining multiple lines leave the cursor at the
2513 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 *cpo-r*
2515 r Redo ("." command) uses "/" to repeat a search
2516 command, instead of the actually used search string.
2517 *cpo-R*
2518 R Remove marks from filtered lines. Without this flag
2519 marks are kept like |:keepmarks| was used.
2520 *cpo-s*
2521 s Set buffer options when entering the buffer for the
2522 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 set when the buffer is created.
2525 *cpo-S*
2526 S Set buffer options always when entering a buffer
2527 (except 'readonly', 'fileformat', 'filetype' and
2528 'syntax'). This is the (most) Vi compatible setting.
2529 The options are set to the values in the current
2530 buffer. When you change an option and go to another
2531 buffer, the value is copied. Effectively makes the
2532 buffer options global to all buffers.
2533
2534 's' 'S' copy buffer options
2535 no no when buffer created
2536 yes no when buffer first entered (default)
2537 X yes each time when buffer entered (vi comp.)
2538 *cpo-t*
2539 t Search pattern for the tag command is remembered for
2540 "n" command. Otherwise Vim only puts the pattern in
2541 the history for search pattern, but doesn't change the
2542 last used search pattern.
2543 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002544 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 *cpo-v*
2546 v Backspaced characters remain visible on the screen in
2547 Insert mode. Without this flag the characters are
2548 erased from the screen right away. With this flag the
2549 screen newly typed text overwrites backspaced
2550 characters.
2551 *cpo-w*
2552 w When using "cw" on a blank character, only change one
2553 character and not all blanks until the start of the
2554 next word.
2555 *cpo-W*
2556 W Don't overwrite a readonly file. When omitted, ":w!"
2557 overwrites a readonly file, if possible.
2558 *cpo-x*
2559 x <Esc> on the command-line executes the command-line.
2560 The default in Vim is to abandon the command-line,
2561 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002562 *cpo-X*
2563 X When using a count with "R" the replaced text is
2564 deleted only once. Also when repeating "R" with "."
2565 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002567 y A yank command can be redone with ".". Think twice if
2568 you really want to use this, it may break some
2569 plugins, since most people expect "." to only repeat a
2570 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002571 *cpo-Z*
2572 Z When using "w!" while the 'readonly' option is set,
2573 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002574 *cpo-z*
2575 z Special casing the "cw" and "d" command (see |cw| and
2576 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 *cpo-!*
2578 ! When redoing a filter command, use the last used
2579 external command, whatever it was. Otherwise the last
2580 used -filter- command is used.
2581 *cpo-$*
2582 $ When making a change to one line, don't redisplay the
2583 line, but put a '$' at the end of the changed text.
2584 The changed text will be overwritten when you type the
2585 new text. The line is redisplayed if you type any
2586 command that moves the cursor from the insertion
2587 point.
2588 *cpo-%*
2589 % Vi-compatible matching is done for the "%" command.
2590 Does not recognize "#if", "#endif", etc.
2591 Does not recognize "/*" and "*/".
2592 Parens inside single and double quotes are also
2593 counted, causing a string that contains a paren to
2594 disturb the matching. For example, in a line like
2595 "if (strcmp("foo(", s))" the first paren does not
2596 match the last one. When this flag is not included,
2597 parens inside single and double quotes are treated
2598 specially. When matching a paren outside of quotes,
2599 everything inside quotes is ignored. When matching a
2600 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002601 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002602 This flag is also used for other features, such as
2603 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002604 *cpo--*
2605 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002606 it would go above the first line or below the last
2607 line. Without it the cursor moves to the first or
2608 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002609 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002610 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002611 *cpo-+*
2612 + When included, a ":write file" command will reset the
2613 'modified' flag of the buffer, even though the buffer
2614 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002615 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 * Use ":*" in the same way as ":@". When not included,
2617 ":*" is an alias for ":'<,'>", select the Visual area.
2618 *cpo-<*
2619 < Disable the recognition of special key codes in |<>|
2620 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 ":map X <Tab>" results in X being mapped to:
2623 '<' included: "<Tab>" (5 characters)
2624 '<' excluded: "^I" (^I is a real <Tab>)
2625 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002626 *cpo->*
2627 > When appending to a register, put a line break before
2628 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002629 *cpo-;*
2630 ; When using |,| or |;| to repeat the last |t| search
2631 and the cursor is right in front of the searched
2632 character, the cursor won't move. When not included,
2633 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002634 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002635
2636 POSIX flags. These are not included in the Vi default value, except
2637 when $VIM_POSIX was set on startup. |posix|
2638
2639 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002640 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002641 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002642 *cpo-&*
2643 & When ":preserve" was used keep the swap file when
2644 exiting normally while this buffer is still loaded.
2645 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002646 *cpo-\*
2647 \ Backslash in a [] range in a search pattern is taken
2648 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002649 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2650 '\' excluded: "/[ \-]" finds <Space> and '-'
2651 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002652 *cpo-/*
2653 / When "%" is used as the replacement string in a |:s|
2654 command, use the previous replacement string. |:s%|
2655 *cpo-{*
2656 { The |{| and |}| commands also stop at a "{" character
2657 at the start of a line.
2658 *cpo-.*
2659 . The ":chdir" and ":cd" commands fail if the current
2660 buffer is modified, unless ! is used. Vim doesn't
2661 need this, since it remembers the full path of an
2662 opened file.
2663 *cpo-bar*
2664 | The value of the $LINES and $COLUMNS environment
2665 variables overrule the terminal size values obtained
2666 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002667
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002668 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002669'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002670 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002671 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002672 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002673 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002674 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002675 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002676 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002677 blowfish Blowfish method. Medium strong encryption but it has
2678 an implementation flaw. Requires Vim 7.3 or later,
2679 files can NOT be read by Vim 7.2 and older. This adds
2680 a "seed" to the file, every time you write the file
2681 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002682 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002683 *blowfish2*
2684 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002685 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002686 and older. This adds a "seed" to the file, every time
2687 you write the file the encrypted bytes will be
2688 different. The whole undo file is encrypted, not just
2689 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002690 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002691 *E1197* *E1198* *E1199* *E1200* *E1201*
2692 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002693 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002694 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002695 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002696 It adds a seed and a message authentication code (MAC)
2697 to the file. This needs at least a Vim 8.2.3022 to
2698 read the encrypted file.
2699 Encryption of swap files is not supported, therefore
2700 no swap file will be used when xchacha20 encryption is
2701 enabled.
2702 Encryption of undo files is not yet supported,
2703 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002704 CAREFUL: Files written with this method might have to
2705 be read back with the same version of Vim if the
2706 binary format changes later.
2707 Obsolete, please do no longer use.
2708 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2709 stores the key derivation parameters together with the
2710 encrypted file. Should work better in case the
2711 parameters in the libsodium library ever change.
2712 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002713 might have to be read back with the same version of
2714 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002715
Christian Brabandtaae58342023-04-23 17:50:22 +01002716 You should use "blowfish2", also to re-encrypt older files. The
2717 "xchacha20" method provides better encryption, but it does not work
2718 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002719
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002720 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002721 to the detected method of the file being read. Thus if you write it
2722 without changing 'cryptmethod' the same method will be used.
2723 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002724 explicitly write it, you don't get a warning unless there are other
2725 modifications. Also see |:X|.
2726
2727 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002728 the value "blowfish2". When setting the local value to an empty
2729 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002730
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002731 When a new encryption method is added in a later version of Vim, and
2732 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002733 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002734
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 *'cscopepathcomp'* *'cspc'*
2736'cscopepathcomp' 'cspc' number (default 0)
2737 global
2738 {not available when compiled without the |+cscope|
2739 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 Determines how many components of the path to show in a list of tags.
2741 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002742 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743
2744 *'cscopeprg'* *'csprg'*
2745'cscopeprg' 'csprg' string (default "cscope")
2746 global
2747 {not available when compiled without the |+cscope|
2748 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Specifies the command to execute cscope. See |cscopeprg|.
2750 This option cannot be set from a |modeline| or in the |sandbox|, for
2751 security reasons.
2752
2753 *'cscopequickfix'* *'csqf'*
2754'cscopequickfix' 'csqf' string (default "")
2755 global
2756 {not available when compiled without the |+cscope|
2757 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 Specifies whether to use quickfix window to show cscope results.
2759 See |cscopequickfix|.
2760
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002761 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002762'cscoperelative' 'csre' boolean (default off)
2763 global
2764 {not available when compiled without the |+cscope|
2765 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002766 In the absence of a prefix (-P) for cscope. setting this option enables
2767 to use the basename of cscope.out path as the prefix.
2768 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002769 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002770
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2772'cscopetag' 'cst' boolean (default off)
2773 global
2774 {not available when compiled without the |+cscope|
2775 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 Use cscope for tag commands. See |cscope-options|.
2777 NOTE: This option is reset when 'compatible' is set.
2778
2779 *'cscopetagorder'* *'csto'*
2780'cscopetagorder' 'csto' number (default 0)
2781 global
2782 {not available when compiled without the |+cscope|
2783 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 Determines the order in which ":cstag" performs a search. See
2785 |cscopetagorder|.
2786 NOTE: This option is set to 0 when 'compatible' is set.
2787
2788 *'cscopeverbose'* *'csverb'*
2789 *'nocscopeverbose'* *'nocsverb'*
2790'cscopeverbose' 'csverb' boolean (default off)
2791 global
2792 {not available when compiled without the |+cscope|
2793 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 Give messages when adding a cscope database. See |cscopeverbose|.
2795 NOTE: This option is reset when 'compatible' is set.
2796
Bram Moolenaar860cae12010-06-05 23:22:07 +02002797 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2798'cursorbind' 'crb' boolean (default off)
2799 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002800 When this option is set, as the cursor in the current
2801 window moves other cursorbound windows (windows that also have
2802 this option set) move their cursors to the corresponding line and
2803 column. This option is useful for viewing the
2804 differences between two versions of a file (see 'diff'); in diff mode,
2805 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002806 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002807
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002808 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2809'cursorcolumn' 'cuc' boolean (default off)
2810 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002811 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002812 feature}
2813 Highlight the screen column of the cursor with CursorColumn
2814 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2815 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002816 If you only want the highlighting in the current window you can use
2817 these autocommands: >
2818 au WinLeave * set nocursorline nocursorcolumn
2819 au WinEnter * set cursorline cursorcolumn
2820<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002821
2822 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2823'cursorline' 'cul' boolean (default off)
2824 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002825 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002826 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002827 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2828 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002829 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002830 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002831
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002832 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002833'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002834 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002835 {not available when compiled without the |+syntax|
2836 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002837 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002838 Valid values:
2839 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002840 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002841 "screenline" Highlight only the screen line of the cursor with
2842 CursorLine |hl-CursorLine|.
2843 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002844 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002845
2846 Special value:
2847 "both" Alias for the values "line,number".
2848
2849 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002850
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 *'debug'*
2852'debug' string (default "")
2853 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002854 These values can be used:
2855 msg Error messages that would otherwise be omitted will be given
2856 anyway.
2857 throw Error messages that would otherwise be omitted will be given
2858 anyway and also throw an exception and set |v:errmsg|.
2859 beep A message will be given when otherwise only a beep would be
2860 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002861 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002862 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2863 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864
2865 *'define'* *'def'*
2866'define' 'def' string (default "^\s*#\s*define")
2867 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002868 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 pattern, just like for the "/" command. This option is used for the
2870 commands like "[i" and "[d" |include-search|. The 'isident' option is
2871 used to recognize the defined name after the match:
2872 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2873 See |option-backslash| about inserting backslashes to include a space
2874 or backslash.
2875 The default value is for C programs. For C++ this value would be
2876 useful, to include const type declarations: >
2877 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002878< You can also use "\ze" just before the name and continue the pattern
2879 to check what is following. E.g. for Javascript, if a function is
2880 defined with "func_name = function(args)": >
2881 ^\s*\ze\i\+\s*=\s*function(
2882< If the function is defined with "func_name : function() {...": >
2883 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002885 To avoid that use `:let` with a single quote string: >
2886 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002887<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888
2889 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2890'delcombine' 'deco' boolean (default off)
2891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 If editing Unicode and this option is set, backspace and Normal mode
2893 "x" delete each combining character on its own. When it is off (the
2894 default) the character along with its combining characters are
2895 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002896 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897
2898 This is useful for Arabic, Hebrew and many other languages where one
2899 may have combining characters overtop of base characters, and want
2900 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002901 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902
2903 *'dictionary'* *'dict'*
2904'dictionary' 'dict' string (default "")
2905 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 List of file names, separated by commas, that are used to lookup words
2907 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2908 contain a list of words. This can be one word per line, or several
2909 words per line, separated by non-keyword characters (white space is
2910 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002911
2912 When this option is empty or an entry "spell" is present, and spell
2913 checking is enabled, words in the word lists for the currently active
2914 'spelllang' are used. See |spell|.
2915
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002916 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 after a comma are ignored, otherwise spaces are included in the file
2918 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002919 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 Where to find a list of words?
2921 - On FreeBSD, there is the file "/usr/share/dict/words".
2922 - In the Simtel archive, look in the "msdos/linguist" directory.
2923 - In "miscfiles" of the GNU collection.
2924 The use of |:set+=| and |:set-=| is preferred when adding or removing
2925 directories from the list. This avoids problems when a future version
2926 uses another default.
2927 Backticks cannot be used in this option for security reasons.
2928
2929 *'diff'* *'nodiff'*
2930'diff' boolean (default off)
2931 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 {not available when compiled without the |+diff|
2933 feature}
2934 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002935 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936
2937 *'dex'* *'diffexpr'*
2938'diffexpr' 'dex' string (default "")
2939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 {not available when compiled without the |+diff|
2941 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002942 Expression which is evaluated to obtain a diff file (either ed-style
2943 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 This option cannot be set from a |modeline| or in the |sandbox|, for
2945 security reasons.
2946
2947 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002948'diffopt' 'dip' string (default
2949 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 {not available when compiled without the |+diff|
2952 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 All are optional. Items must be separated by a comma.
2955
Jonathon7c7a4e62025-01-12 09:58:00 +01002956 algorithm:{text} Use the specified diff algorithm with the
2957 internal diff engine. Currently supported
2958 algorithms are:
2959 myers the default algorithm
2960 minimal spend extra time to generate the
2961 smallest possible diff
2962 patience patience diff algorithm
2963 histogram histogram diff algorithm
2964
2965 closeoff When a window is closed where 'diff' is set
2966 and there is only one window remaining in the
2967 same tab page with 'diff' set, execute
2968 `:diffoff` in that window. This undoes a
2969 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
2971 context:{n} Use a context of {n} lines between a change
2972 and a fold that contains unchanged lines.
2973 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002974 When using zero the context is actually one,
2975 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002976 for a deleted line. Set it to a very large
2977 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 See |fold-diff|.
2979
Jonathon7c7a4e62025-01-12 09:58:00 +01002980 filler Show filler lines, to keep the text
2981 synchronized with a window that has inserted
2982 lines at the same position. Mostly useful
2983 when windows are side-by-side and 'scrollbind'
2984 is set.
2985
2986 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2987 starting diff mode. Without this 2 is used.
2988
2989 followwrap Follow the 'wrap' option and leave as it is.
2990
2991 horizontal Start diff mode with horizontal splits (unless
2992 explicitly specified otherwise).
2993
2994 hiddenoff Do not use diff mode for a buffer when it
2995 becomes hidden.
2996
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002997 iblank Ignore changes where lines are all blank. Adds
2998 the "-B" flag to the "diff" command if
2999 'diffexpr' is empty. Check the documentation
3000 of the "diff" command for what this does
3001 exactly.
3002 NOTE: the diff windows will get out of sync,
3003 because no differences between blank lines are
3004 taken into account.
3005
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 icase Ignore changes in case of text. "a" and "A"
3007 are considered the same. Adds the "-i" flag
3008 to the "diff" command if 'diffexpr' is empty.
3009
Jonathon7c7a4e62025-01-12 09:58:00 +01003010 indent-heuristic
3011 Use the indent heuristic for the internal
3012 diff library.
3013
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003014 inline:{text} Highlight inline differences within a change.
3015 See |view-diffs|. Supported values are:
3016
3017 none Do not perform inline highlighting.
3018 simple Highlight from first different
3019 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003020 line. This is the default if no
3021 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003022 char Use internal diff to perform a
3023 character-wise diff and highlight the
3024 difference.
3025 word Use internal diff to perform a
3026 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003027 difference. Non-alphanumeric
3028 multi-byte characters such as emoji
3029 and CJK characters are considered
3030 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003031
Jonathon7c7a4e62025-01-12 09:58:00 +01003032 internal Use the internal diff library. This is
3033 ignored when 'diffexpr' is set. *E960*
3034 When running out of memory when writing a
3035 buffer this item will be ignored for diffs
3036 involving that buffer. Set the 'verbose'
3037 option to see when this happens.
3038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 iwhite Ignore changes in amount of white space. Adds
3040 the "-b" flag to the "diff" command if
3041 'diffexpr' is empty. Check the documentation
3042 of the "diff" command for what this does
3043 exactly. It should ignore adding trailing
3044 white space, but not leading white space.
3045
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003046 iwhiteall Ignore all white space changes. Adds
3047 the "-w" flag to the "diff" command if
3048 'diffexpr' is empty. Check the documentation
3049 of the "diff" command for what this does
3050 exactly.
3051
3052 iwhiteeol Ignore white space changes at end of line.
3053 Adds the "-Z" flag to the "diff" command if
3054 'diffexpr' is empty. Check the documentation
3055 of the "diff" command for what this does
3056 exactly.
3057
Jonathon7c7a4e62025-01-12 09:58:00 +01003058 linematch:{n} Align and mark changes between the most
3059 similar lines between the buffers. When the
3060 total number of lines in the diff hunk exceeds
3061 {n}, the lines will not be aligned because for
3062 very large diff hunks there will be a
3063 noticeable lag. A reasonable setting is
3064 "linematch:60", as this will enable alignment
3065 for a 2 buffer diff hunk of 30 lines each,
3066 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003067
3068 vertical Start diff mode with vertical splits (unless
3069 explicitly specified otherwise).
3070
Bram Moolenaare828b762018-09-10 17:51:58 +02003071 Examples: >
3072 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003074 :set diffopt=internal,filler,foldcolumn:3
3075 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076<
3077 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3078'digraph' 'dg' boolean (default off)
3079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 {not available when compiled without the |+digraphs|
3081 feature}
3082 Enable the entering of digraphs in Insert mode with {char1} <BS>
3083 {char2}. See |digraphs|.
3084 NOTE: This option is reset when 'compatible' is set.
3085
3086 *'directory'* *'dir'*
3087'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003088 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 for Unix: ".,~/tmp,/var/tmp,/tmp")
3090 global
3091 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003092 Recommended value: ".,~/vimswap//" - this will put the swap file next
3093 to the edited file if possible, and in your personal swap directory
3094 otherwise. Make sure "~/vimswap//" is only readable for you.
3095
3096 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 - The swap file will be created in the first directory where this is
3098 possible.
3099 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003100 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 - A directory "." means to put the swap file in the same directory as
3102 the edited file. On Unix, a dot is prepended to the file name, so
3103 it doesn't show in a directory listing. On MS-Windows the "hidden"
3104 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003105 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3106 the swap file relative to where the edited file is. The leading "."
3107 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003108 - For Unix and Win32, if a directory ends in two path separators "//",
3109 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003110 with all path separators replaced by percent '%' signs (including
3111 the colon following the drive letter on Win32). This will ensure
3112 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003113 On Win32, it is also possible to end with "\\". However, When a
3114 separating comma is following, you must use "//", since "\\" will
3115 include the comma in the file name. Therefore it is recommended to
3116 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 - Spaces after the comma are ignored, other spaces are considered part
3118 of the directory name. To have a space at the start of a directory
3119 name, precede it with a backslash.
3120 - To include a comma in a directory name precede it with a backslash.
3121 - A directory name may end in an ':' or '/'.
3122 - Environment variables are expanded |:set_env|.
3123 - Careful with '\' characters, type one before a space, type two to
3124 get one in the option (see |option-backslash|), for example: >
3125 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3126< - For backwards compatibility with Vim version 3.0 a '>' at the start
3127 of the option is removed.
3128 Using "." first in the list is recommended. This means that editing
3129 the same file twice will result in a warning. Using "/tmp" on Unix is
3130 discouraged: When the system crashes you lose the swap file.
3131 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003132 choice than "/tmp". But others on the computer may be able to see the
3133 files, and it can contain a lot of files, your swap files get lost in
3134 the crowd. That is why a "tmp" directory in your home directory is
3135 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 The use of |:set+=| and |:set-=| is preferred when adding or removing
3137 directories from the list. This avoids problems when a future version
3138 uses another default.
3139 This option cannot be set from a |modeline| or in the |sandbox|, for
3140 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141
3142 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003143'display' 'dy' string (default "", set to "truncate" in
3144 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003146 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 flags:
3148 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003149 in a window will be displayed. "@@@" is put in the
3150 last columns of the last screen line to indicate the
3151 rest of the line is not displayed.
3152 truncate Like "lastline", but "@@@" is displayed in the first
3153 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 uhex Show unprintable characters hexadecimal as <xx>
3155 instead of using ^C and ~C.
3156
Bram Moolenaard0796902016-09-16 20:02:31 +02003157 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003158 doesn't fit is replaced with "@" lines.
3159
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003160 The "@" character can be changed by setting the "lastline" item in
3161 'fillchars'. The character is highlighted with |hl-NonText|.
3162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 *'eadirection'* *'ead'*
3164'eadirection' 'ead' string (default "both")
3165 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 Tells when the 'equalalways' option applies:
3167 ver vertically, width of windows is not affected
3168 hor horizontally, height of windows is not affected
3169 both width and height of windows is affected
3170
3171 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3172'edcompatible' 'ed' boolean (default off)
3173 global
3174 Makes the 'g' and 'c' flags of the ":substitute" command to be
3175 toggled each time the flag is given. See |complex-change|. See
3176 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003177 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003178 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179
Bram Moolenaar03413f42016-04-12 21:07:15 +02003180 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003181'emoji' 'emo' boolean (default: on)
3182 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003183 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003184 This excludes "text emoji" characters, which are normally displayed as
3185 single width. Unfortunately there is no good specification for this
3186 and it has been determined on trial-and-error basis. Use the
3187 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003190'encoding' 'enc' string (default for MS-Windows: "utf-8",
3191 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 Sets the character encoding used inside Vim. It applies to text in
3194 the buffers, registers, Strings in expressions, text stored in the
3195 viminfo file, etc. It sets the kind of characters which Vim can work
3196 with. See |encoding-names| for the possible values.
3197
3198 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003199 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003201 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202
Bram Moolenaar865242e2010-07-14 21:12:05 +02003203 This option cannot be set from a |modeline|. It would most likely
3204 corrupt the text.
3205
Bram Moolenaar3df01732017-02-17 22:47:16 +01003206 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3207 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 'encoding', "utf-8" is the natural choice for the environment and
3209 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003210 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 versions, and to avoid changing the encoding of newly created files
3212 without your knowledge (in case 'fileencodings' is empty).
3213
3214 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003215 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 iconv() or as specified with 'charconvert'.
3217
Bram Moolenaar207f0092020-08-30 17:20:20 +02003218 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003219 can use: >
3220 if has("multi_byte_encoding")
3221<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 Normally 'encoding' will be equal to your current locale. This will
3223 be the default if Vim recognizes your environment settings. If
3224 'encoding' is not set to the current locale, 'termencoding' must be
3225 set to convert typed and displayed text. See |encoding-table|.
3226
3227 When you set this option, it fires the |EncodingChanged| autocommand
3228 event so that you can set up fonts if necessary.
3229
3230 When the option is set, the value is converted to lowercase. Thus
3231 you can set it with uppercase values too. Underscores are translated
3232 to '-' signs.
3233 When the encoding is recognized, it is changed to the standard name.
3234 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3235 "iso-8859-2" and "utf8" becomes "utf-8".
3236
3237 Note: "latin1" is also used when the encoding could not be detected.
3238 This only works when editing files in the same encoding! When the
3239 actual character set is not latin1, make sure 'fileencoding' and
3240 'fileencodings' are empty. When conversion is needed, switch to using
3241 utf-8.
3242
3243 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3244 You don't notice this while editing, but it does matter for the
3245 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3246 setting 'encoding' to one of these values instead of utf-8 only has
3247 effect for encoding used for files when 'fileencoding' is empty.
3248
Bram Moolenaar661b1822005-07-28 22:36:45 +00003249 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3250 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003252 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003253'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003255 Indicates that a CTRL-Z character was found at the end of the file
3256 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003258 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003259 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003260 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003261
3262 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3263'endofline' 'eol' boolean (default on)
3264 local to buffer
3265 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003266 is on, or 'fixeol' option is off, no <EOL> will be written for the
3267 last line in the file. This option is automatically set or reset when
3268 starting to edit a new file, depending on whether file has an <EOL>
3269 for the last line in the file. Normally you don't have to set or
3270 reset this option.
3271 When 'binary' is off and 'fixeol' is on the value is not used when
3272 writing the file. When 'binary' is on or 'fixeol' is off it is used
3273 to remember the presence of a <EOL> for the last line in the file, so
3274 that when you write the file the situation from the original file can
3275 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003276 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277
3278 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3279'equalalways' 'ea' boolean (default on)
3280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003282 splitting or closing a window. This also happens the moment the
3283 option is switched on. When off, splitting a window will reduce the
3284 size of the current window and leave the other windows the same. When
3285 closing a window the extra lines are given to the window next to it
3286 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 When mixing vertically and horizontally split windows, a minimal size
3288 is computed and some windows may be larger if there is room. The
3289 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003290 Changing the height and width of a window can be avoided by setting
3291 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003292 If a window size is specified when creating a new window sizes are
3293 currently not equalized (it's complicated, but may be implemented in
3294 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 *'equalprg'* *'ep'*
3297'equalprg' 'ep' string (default "")
3298 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003300 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003301 or 'indentexpr'. When Vim was compiled without internal formatting,
3302 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003303 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 about including spaces and backslashes.
3305 This option cannot be set from a |modeline| or in the |sandbox|, for
3306 security reasons.
3307
3308 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3309'errorbells' 'eb' boolean (default off)
3310 global
3311 Ring the bell (beep or screen flash) for error messages. This only
3312 makes a difference for error messages, the bell will be used always
3313 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003314 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003315 screen flash or do nothing. See 'belloff' to finetune when to ring the
3316 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317
3318 *'errorfile'* *'ef'*
3319'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3320 others: "errors.err")
3321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 {not available when compiled without the |+quickfix|
3323 feature}
3324 Name of the errorfile for the QuickFix mode (see |:cf|).
3325 When the "-q" command-line argument is used, 'errorfile' is set to the
3326 following argument. See |-q|.
3327 NOT used for the ":make" command. See 'makeef' for that.
3328 Environment variables are expanded |:set_env|.
3329 See |option-backslash| about including spaces and backslashes.
3330 This option cannot be set from a |modeline| or in the |sandbox|, for
3331 security reasons.
3332
3333 *'errorformat'* *'efm'*
3334'errorformat' 'efm' string (default is very long)
3335 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 {not available when compiled without the |+quickfix|
3337 feature}
3338 Scanf-like description of the format for the lines in the error file
3339 (see |errorformat|).
3340
3341 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3342'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 Function keys that start with an <Esc> are recognized in Insert
3345 mode. When this option is off, the cursor and function keys cannot be
3346 used in Insert mode if they start with an <Esc>. The advantage of
3347 this is that the single <Esc> is recognized immediately, instead of
3348 after one second. Instead of resetting this option, you might want to
3349 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3350 when 'esckeys' is off, you can still map anything, but the cursor keys
3351 won't work by default.
3352 NOTE: This option is set to the Vi default value when 'compatible' is
3353 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003354 NOTE: when this option is off then the |modifyOtherKeys| and
3355 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3356 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357
3358 *'eventignore'* *'ei'*
3359'eventignore' 'ei' string (default "")
3360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003362 When set to "all" or when "all" is one of the items, all autocommand
3363 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003364 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 :set ei=WinEnter,WinLeave
3366<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003367 *'eventignorewin'* *'eiw'*
3368'eventignorewin' 'eiw' string (default "")
3369 window-local
3370 Similar to 'eventignore' but applies to a particular window and its
3371 buffers, for which window and buffer related autocommands can be
3372 ignored indefinitely without affecting the global 'eventignore'.
3373
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3375'expandtab' 'et' boolean (default off)
3376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003378 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3380 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003381 This option is reset when the 'paste' option is set and restored when
3382 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 NOTE: This option is reset when 'compatible' is set.
3384
3385 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3386'exrc' 'ex' boolean (default off)
3387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003389 directory.
3390
3391 Setting this option is a potential security leak. E.g., consider
3392 unpacking a package or fetching files from github, a .vimrc in there
3393 might be a trojan horse. BETTER NOT SET THIS OPTION!
3394 Instead, define an autocommand in your .vimrc to set options for a
3395 matching directory.
3396
3397 If you do switch this option on you should also consider setting the
3398 'secure' option (see |initialization|).
3399 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 This option cannot be set from a |modeline| or in the |sandbox|, for
3401 security reasons.
3402
3403 *'fileencoding'* *'fenc'* *E213*
3404'fileencoding' 'fenc' string (default: "")
3405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003407
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003409 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 When 'fileencoding' is empty, the same value as 'encoding' will be
3411 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003412 No error will be given when the value is set, only when it is used,
3413 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003414 Conversion will also be done when 'encoding' and 'fileencoding' are
3415 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3416 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003418 'encoding' is "utf-8" or another Unicode encoding, conversion
3419 is most likely done in a way that the reverse conversion
3420 results in the same text. When 'encoding' is not "utf-8" some
3421 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003422
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 See 'encoding' for the possible values. Additionally, values may be
3424 specified that can be handled by the converter, see
3425 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003426
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 When reading a file 'fileencoding' will be set from 'fileencodings'.
3428 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003429 'fileencoding', use the |++enc| argument. One exception: when
3430 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003431 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003432
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3434 When the option is set, the value is converted to lowercase. Thus
3435 you can set it with uppercase values too. '_' characters are
3436 replaced with '-'. If a name is recognized from the list for
3437 'encoding', it is replaced by the standard name. For example
3438 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 When this option is set, after starting to edit a file, the 'modified'
3441 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003442
3443 Keep in mind that changing 'fenc' from a modeline happens
3444 AFTER the text has been read, thus it applies to when the file will be
3445 written. If you do set 'fenc' in a modeline, you might want to set
3446 'nomodified' to avoid not being able to ":q".
3447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 This option can not be changed when 'modifiable' is off.
3449
3450 *'fe'*
3451 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003452 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 old short name was 'fe', which is no longer used.
3454
3455 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003456'fileencodings' 'fencs' string (default: "ucs-bom",
3457 "ucs-bom,utf-8,default,latin1" when
3458 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 This is a list of character encodings considered when starting to edit
3461 an existing file. When a file is read, Vim tries to use the first
3462 mentioned character encoding. If an error is detected, the next one
3463 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003464 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 an empty string, which means the value of 'encoding' is used.
3466 WARNING: Conversion can cause loss of information! When
3467 'encoding' is "utf-8" (or one of the other Unicode variants)
3468 conversion is most likely done in a way that the reverse
3469 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003470 "utf-8" some non-ASCII characters may be lost! You can use
3471 the |++bad| argument to specify what is done with characters
3472 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 For an empty file or a file with only ASCII characters most encodings
3474 will work and the first entry of 'fileencodings' will be used (except
3475 "ucs-bom", which requires the BOM to be present). If you prefer
3476 another encoding use an BufReadPost autocommand event to test if your
3477 preferred encoding is to be used. Example: >
3478 au BufReadPost * if search('\S', 'w') == 0 |
3479 \ set fenc=iso-2022-jp | endif
3480< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3481 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003482 When the |++enc| argument is used then the value of 'fileencodings' is
3483 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003484 Note that 'fileencodings' is not used for a new file, the global value
3485 of 'fileencoding' is used instead. You can set it with: >
3486 :setglobal fenc=iso-8859-2
3487< This means that a non-existing file may get a different encoding than
3488 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 The special value "ucs-bom" can be used to check for a Unicode BOM
3490 (Byte Order Mark) at the start of the file. It must not be preceded
3491 by "utf-8" or another Unicode encoding for this to work properly.
3492 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3493 because Vim cannot detect an error, thus the encoding is always
3494 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003495 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003496 environment. On MS-Windows this is the system encoding. Otherwise
3497 this is the default value for 'encoding'. It is useful when
3498 'encoding' is set to "utf-8" and your environment uses a non-latin1
3499 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003500 When 'encoding' is "utf-8" and a file contains an illegal byte
3501 sequence it won't be recognized as UTF-8. You can use the |8g8|
3502 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 WRONG VALUES: WHAT'S WRONG:
3504 latin1,utf-8 "latin1" will always be used
3505 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3506 file
3507 cp1250,latin1 "cp1250" will always be used
3508 If 'fileencodings' is empty, 'fileencoding' is not modified.
3509 See 'fileencoding' for the possible values.
3510 Setting this option does not have an effect until the next time a file
3511 is read.
3512
3513 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003514'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003515 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 This gives the <EOL> of the current buffer, which is used for
3518 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003519 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 unix <NL>
3521 mac <CR>
3522 When "dos" is used, CTRL-Z at the end of a file is ignored.
3523 See |file-formats| and |file-read|.
3524 For the character encoding of the file see 'fileencoding'.
3525 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003526 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 This option is set automatically when starting to edit a file and
3528 'fileformats' is not empty and 'binary' is off.
3529 When this option is set, after starting to edit a file, the 'modified'
3530 option is set, because the file would be different when written.
3531 This option can not be changed when 'modifiable' is off.
3532 For backwards compatibility: When this option is set to "dos",
3533 'textmode' is set, otherwise 'textmode' is reset.
3534
3535 *'fileformats'* *'ffs'*
3536'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003537 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003538 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 Vi Cygwin: "unix,dos",
3540 Vi others: "")
3541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 This gives the end-of-line (<EOL>) formats that will be tried when
3543 starting to edit a new buffer and when reading a file into an existing
3544 buffer:
3545 - When empty, the format defined with 'fileformat' will be used
3546 always. It is not set automatically.
3547 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003548 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 'fileformats' name will be used when a file is read into an existing
3550 buffer, no matter what 'fileformat' for that buffer is set to.
3551 - When more than one name is present, separated by commas, automatic
3552 <EOL> detection will be done when reading a file. When starting to
3553 edit a file, a check is done for the <EOL>:
3554 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3555 'fileformat' is set to "dos".
3556 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003557 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003559 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3560 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003561 This means that "mac" is only chosen when:
3562 "unix" is not present or no <NL> is found in the file, and
3563 "dos" is not present or no <CR><NL> is found in the file.
3564 Except: if "unix" was chosen, but there is a <CR> before
3565 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003566 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 4. If 'fileformat' is still not set, the first name from
3568 'fileformats' is used.
3569 When reading a file into an existing buffer, the same is done, but
3570 this happens like 'fileformat' has been set appropriately for that
3571 file only, the option is not changed.
3572 When 'binary' is set, the value of 'fileformats' is not used.
3573
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003574 When Vim starts up with an empty buffer the first item is used. You
3575 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003576
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3578 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3579 done:
3580 - When 'fileformats' is empty, there is no automatic detection. Dos
3581 format will be used.
3582 - When 'fileformats' is set to one or more names, automatic detection
3583 is done. This is based on the first <NL> in the file: If there is a
3584 <CR> in front of it, Dos format is used, otherwise Unix format is
3585 used.
3586 Also see |file-formats|.
3587 For backwards compatibility: When this option is set to an empty
3588 string or one format (no comma is included), 'textauto' is reset,
3589 otherwise 'textauto' is set.
3590 NOTE: This option is set to the Vi default value when 'compatible' is
3591 set and to the Vim default value when 'compatible' is reset.
3592
Bram Moolenaarbf884932013-04-05 22:26:15 +02003593 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3594'fileignorecase' 'fic' boolean (default on for systems where case in file
3595 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003596 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003597 When set case is ignored when using file names and directories.
3598 See 'wildignorecase' for only ignoring case when doing completion.
3599
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 *'filetype'* *'ft'*
3601'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003602 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 When this option is set, the FileType autocommand event is triggered.
3604 All autocommands that match with the value of this option will be
3605 executed. Thus the value of 'filetype' is used in place of the file
3606 name.
3607 Otherwise this option does not always reflect the current file type.
3608 This option is normally set when the file type is detected. To enable
3609 this use the ":filetype on" command. |:filetype|
3610 Setting this option to a different value is most useful in a modeline,
3611 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003612 Example, for in an IDL file:
3613 /* vim: set filetype=idl : */ ~
3614 |FileType| |filetypes|
3615 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003616 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003617 /* vim: set filetype=c.doxygen : */ ~
3618 This will use the "c" filetype first, then the "doxygen" filetype.
3619 This works both for filetype plugins and for syntax files. More than
3620 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 This option is not copied to another buffer, independent of the 's' or
3622 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003623 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
3625 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003626'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003627 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003628 Characters to fill the statuslines, vertical separators, special
3629 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003630 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003631 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003633 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003634 stl ' ' statusline of the current window
3635 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003636 vert '|' vertical separators |:vsplit|
3637 fold '-' filling 'foldtext'
3638 foldopen '-' mark the beginning of a fold
3639 foldclose '+' show a closed fold
3640 foldsep '|' open fold middle character
3641 diff '-' deleted lines of the 'diff' option
3642 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003643 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003644 trunc '>' truncated text in the
3645 |ins-completion-menu|.
glepnird4dbf822025-04-12 18:35:34 +02003646 truncrl '<' same as "trunc' in 'rightleft' mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003648 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649
3650 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003651 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3652<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003653 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3654 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003655 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003656
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003658 item name highlight group ~
3659 stl StatusLine |hl-StatusLine|
3660 stlnc StatusLineNC |hl-StatusLineNC|
3661 vert VertSplit |hl-VertSplit|
3662 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003663 foldopen FoldColumn |hl-FoldColumn|
3664 foldclose FoldColumn |hl-FoldColumn|
3665 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003666 diff DiffDelete |hl-DiffDelete|
3667 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003668 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003669 trunc one of the many Popup menu highlighting groups like
3670 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003671 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003673 *'findfunc'* *'ffu'* *E1514*
3674'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003675 global or local to buffer |global-local|
3676 {not available when compiled without the |+eval|
3677 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003678 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003679 command. When this option is empty, the internal |file-searching|
3680 mechanism is used.
3681
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003682 The value can be the name of a function, a |lambda| or a |Funcref|.
3683 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003684
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003685 The function is called with two arguments. The first argument is a
3686 |String| and is the |:find| command argument. The second argument is
3687 a |Boolean| and is set to |v:true| when the function is called to get
3688 a List of command-line completion matches for the |:find| command.
3689 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003690
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003691 The function is called only once per |:find| command invocation.
3692 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003693
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003694 If a match is found, the function should return a |List| containing
3695 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003696 should return an empty List.
3697
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003698 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003699 empty List is used as the return value.
3700
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003701 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003702 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003703
3704 This option cannot be set from a |modeline| or in the |sandbox|, for
3705 security reasons.
3706
3707 Examples:
3708>
3709 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003710 func FindFuncGlob(cmdarg, cmdcomplete)
3711 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003712 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003713 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003714 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003715
3716 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003717 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003718 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003719 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003720 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003721 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003722<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003723 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3724'fixendofline' 'fixeol' boolean (default on)
3725 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003726 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003727 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003728 preserve the situation from the original file.
3729 When the 'binary' option is set the value of this option doesn't
3730 matter.
3731 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003732 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003733
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003735'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 {only available when compiled with the |+rightleft|
3738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003739 This option was for using Farsi, which has been removed. See
3740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741
3742 *'foldclose'* *'fcl'*
3743'foldclose' 'fcl' string (default "")
3744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 {not available when compiled without the |+folding|
3746 feature}
3747 When set to "all", a fold is closed when the cursor isn't in it and
3748 its level is higher than 'foldlevel'. Useful if you want folds to
3749 automatically close when moving out of them.
3750
3751 *'foldcolumn'* *'fdc'*
3752'foldcolumn' 'fdc' number (default 0)
3753 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 {not available when compiled without the |+folding|
3755 feature}
3756 When non-zero, a column with the specified width is shown at the side
3757 of the window which indicates open and closed folds. The maximum
3758 value is 12.
3759 See |folding|.
3760
3761 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3762'foldenable' 'fen' boolean (default on)
3763 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 {not available when compiled without the |+folding|
3765 feature}
3766 When off, all folds are open. This option can be used to quickly
3767 switch between showing all text unfolded and viewing the text with
3768 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003769 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 'foldenable' is off.
3771 This option is set by commands that create a new fold or close a fold.
3772 See |folding|.
3773
3774 *'foldexpr'* *'fde'*
3775'foldexpr' 'fde' string (default: "0")
3776 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003778 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003780 for each line to obtain its fold level. The context is set to the
3781 script where 'foldexpr' was set, script-local items can be accessed.
3782 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003783
Bram Moolenaar30b65812012-07-12 22:01:11 +02003784 The expression will be evaluated in the |sandbox| if set from a
3785 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003786 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003787 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003788
3789 It is not allowed to change text or jump to another window while
3790 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
3792 *'foldignore'* *'fdi'*
3793'foldignore' 'fdi' string (default: "#")
3794 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 {not available when compiled without the |+folding|
3796 feature}
3797 Used only when 'foldmethod' is "indent". Lines starting with
3798 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003799 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 The default "#" works well for C programs. See |fold-indent|.
3801
3802 *'foldlevel'* *'fdl'*
3803'foldlevel' 'fdl' number (default: 0)
3804 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 {not available when compiled without the |+folding|
3806 feature}
3807 Sets the fold level: Folds with a higher level will be closed.
3808 Setting this option to zero will close all folds. Higher numbers will
3809 close fewer folds.
3810 This option is set by commands like |zm|, |zM| and |zR|.
3811 See |fold-foldlevel|.
3812
3813 *'foldlevelstart'* *'fdls'*
3814'foldlevelstart' 'fdls' number (default: -1)
3815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {not available when compiled without the |+folding|
3817 feature}
3818 Sets 'foldlevel' when starting to edit another buffer in a window.
3819 Useful to always start editing with all folds closed (value zero),
3820 some folds closed (one) or no folds closed (99).
3821 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003822 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 ignores this option and closes all folds.
3824 It is also done before BufReadPre autocommands, to allow an autocmd to
3825 overrule the 'foldlevel' value for specific files.
3826 When the value is negative, it is not used.
3827
3828 *'foldmarker'* *'fmr'* *E536*
3829'foldmarker' 'fmr' string (default: "{{{,}}}")
3830 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 {not available when compiled without the |+folding|
3832 feature}
3833 The start and end marker used when 'foldmethod' is "marker". There
3834 must be one comma, which separates the start and end marker. The
3835 marker is a literal string (a regular expression would be too slow).
3836 See |fold-marker|.
3837
3838 *'foldmethod'* *'fdm'*
3839'foldmethod' 'fdm' string (default: "manual")
3840 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 {not available when compiled without the |+folding|
3842 feature}
3843 The kind of folding used for the current window. Possible values:
3844 |fold-manual| manual Folds are created manually.
3845 |fold-indent| indent Lines with equal indent form a fold.
3846 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3847 |fold-marker| marker Markers are used to specify folds.
3848 |fold-syntax| syntax Syntax highlighting items specify folds.
3849 |fold-diff| diff Fold text that is not changed.
3850
3851 *'foldminlines'* *'fml'*
3852'foldminlines' 'fml' number (default: 1)
3853 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 {not available when compiled without the |+folding|
3855 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003856 Sets the number of screen lines above which a fold can be displayed
3857 closed. Also for manually closed folds. With the default value of
3858 one a fold can only be closed if it takes up two or more screen lines.
3859 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003860 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 "zc" to close a fold, which is displayed open because it's smaller
3862 than 'foldminlines', a following "zc" may close a containing fold.
3863
3864 *'foldnestmax'* *'fdn'*
3865'foldnestmax' 'fdn' number (default: 20)
3866 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 {not available when compiled without the |+folding|
3868 feature}
3869 Sets the maximum nesting of folds for the "indent" and "syntax"
3870 methods. This avoids that too many folds will be created. Using more
3871 than 20 doesn't work, because the internal limit is 20.
3872
3873 *'foldopen'* *'fdo'*
3874'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3875 search,tag,undo")
3876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 {not available when compiled without the |+folding|
3878 feature}
3879 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003880 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003882 NOTE: When the command is part of a mapping this option is not used.
3883 Add the |zv| command to the mapping to get the same effect.
3884 (rationale: the mapping may want to control opening folds itself)
3885
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 item commands ~
3887 all any
3888 block "(", "{", "[[", "[{", etc.
3889 hor horizontal movements: "l", "w", "fx", etc.
3890 insert any command in Insert mode
3891 jump far jumps: "G", "gg", etc.
3892 mark jumping to a mark: "'m", CTRL-O, etc.
3893 percent "%"
3894 quickfix ":cn", ":crew", ":make", etc.
3895 search search for a pattern: "/", "n", "*", "gd", etc.
3896 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 tag jumping to a tag: ":ta", CTRL-T, etc.
3899 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 When a movement command is used for an operator (e.g., "dl" or "y%")
3901 this option is not used. This means the operator will include the
3902 whole closed fold.
3903 Note that vertical movements are not here, because it would make it
3904 very difficult to move onto a closed fold.
3905 In insert mode the folds containing the cursor will always be open
3906 when text is inserted.
3907 To close folds you can re-apply 'foldlevel' with the |zx| command or
3908 set the 'foldclose' option to "all".
3909
3910 *'foldtext'* *'fdt'*
3911'foldtext' 'fdt' string (default: "foldtext()")
3912 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 {not available when compiled without the |+folding|
3914 feature}
3915 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003916 fold. The context is set to the script where 'foldexpr' was set,
3917 script-local items can be accessed. See |fold-foldtext| for the
3918 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919
Bram Moolenaar30b65812012-07-12 22:01:11 +02003920 The expression will be evaluated in the |sandbox| if set from a
3921 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003922 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003923
3924 It is not allowed to change text or jump to another window while
3925 evaluating 'foldtext' |textlock|.
3926
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003927 *'formatexpr'* *'fex'*
3928'formatexpr' 'fex' string (default "")
3929 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003930 {not available when compiled without the |+eval|
3931 feature}
3932 Expression which is evaluated to format a range of lines for the |gq|
3933 operator or automatic formatting (see 'formatoptions'). When this
3934 option is empty 'formatprg' is used.
3935
3936 The |v:lnum| variable holds the first line to be formatted.
3937 The |v:count| variable holds the number of lines to be formatted.
3938 The |v:char| variable holds the character that is going to be
3939 inserted if the expression is being evaluated due to
3940 automatic formatting. This can be empty. Don't insert
3941 it yet!
3942
3943 Example: >
3944 :set formatexpr=mylang#Format()
3945< This will invoke the mylang#Format() function in the
3946 autoload/mylang.vim file in 'runtimepath'. |autoload|
3947
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003948 The advantage of using a function call without arguments is that it is
3949 faster, see |expr-option-function|.
3950
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003951 The expression is also evaluated when 'textwidth' is set and adding
3952 text beyond that limit. This happens under the same conditions as
3953 when internal formatting is used. Make sure the cursor is kept in the
3954 same spot relative to the text then! The |mode()| function will
3955 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003956
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003957 When the expression evaluates to non-zero Vim will fall back to using
3958 the internal format mechanism.
3959
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003960 If the expression starts with s: or |<SID>|, then it is replaced with
3961 the script ID (|local-function|). Example: >
3962 set formatexpr=s:MyFormatExpr()
3963 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003964< Otherwise, the expression is evaluated in the context of the script
3965 where the option was set, thus script-local items are available.
3966
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003967 The expression will be evaluated in the |sandbox| when set from a
3968 modeline, see |sandbox-option|. That stops the option from working,
3969 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003970 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003971 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003972
Bram Moolenaar86b68352004-12-27 21:59:20 +00003973 *'formatlistpat'* *'flp'*
3974'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3975 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003976 A pattern that is used to recognize a list header. This is used for
3977 the "n" flag in 'formatoptions'.
3978 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003979 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003980 while still checking more characters. There must be a character
3981 following the pattern, when it matches the whole line it is handled
3982 like there is no match.
3983 The default recognizes a number, followed by an optional punctuation
3984 character and white space.
3985
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003986 *'formatoptions'* *'fo'*
3987'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3988 local to buffer
3989 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003990 formatting is to be done.
3991 See |fo-table| for possible values and |gq| for how to format text.
3992 When the 'paste' option is on, no formatting is done (like
3993 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003994 To avoid problems with flags that are added in the future, use the
3995 "+=" and "-=" feature of ":set" |add-option-flags|.
3996 NOTE: This option is set to the Vi default value when 'compatible' is
3997 set and to the Vim default value when 'compatible' is reset.
3998
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 *'formatprg'* *'fp'*
4000'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004001 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004003 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004005 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004006 If the 'formatexpr' option is not empty it will be used instead.
4007 Otherwise, if 'formatprg' option is an empty string, the internal
4008 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004009 Environment variables are expanded |:set_env|. See |option-backslash|
4010 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004011 This option cannot be set from a |modeline| or in the |sandbox|, for
4012 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013
Bram Moolenaard94464e2015-11-02 15:28:18 +01004014 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004015'fsync' 'fs' boolean (default on)
4016 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004017 When on, the library function fsync() will be called after writing a
4018 file. This will flush a file to disk, ensuring that it is safely
4019 written even on filesystems which do metadata-only journaling. This
4020 will force the harddrive to spin up on Linux systems running in laptop
4021 mode, so it may be undesirable in some situations. Be warned that
4022 turning this off increases the chances of data loss after a crash. On
4023 systems without an fsync() implementation, this variable is always
4024 off.
4025 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004026 'fsync' also applies to |writefile()| (unless a flag is used to
4027 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004028 This option cannot be set from a |modeline| or in the |sandbox|, for
4029 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004030
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4032'gdefault' 'gd' boolean (default off)
4033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 When on, the ":substitute" flag 'g' is default on. This means that
4035 all matches in a line are substituted instead of one. When a 'g' flag
4036 is given to a ":substitute" command, this will toggle the substitution
4037 of all or one match. See |complex-change|.
4038
4039 command 'gdefault' on 'gdefault' off ~
4040 :s/// subst. all subst. one
4041 :s///g subst. one subst. all
4042 :s///gg subst. all subst. one
4043
4044 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004045 Setting this option may break plugins that rely on the default
4046 behavior of the 'g' flag. This will also make the 'g' flag have the
4047 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004048 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049
4050 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004051'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 Format to recognize for the ":grep" command output.
4054 This is a scanf-like string that uses the same format as the
4055 'errorformat' option: see |errorformat|.
4056
4057 *'grepprg'* *'gp'*
4058'grepprg' 'gp' string (default "grep -n ",
4059 Unix: "grep -n $* /dev/null",
4060 Win32: "findstr /n" or "grep -n",
4061 VMS: "SEARCH/NUMBERS ")
4062 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004063 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 and '#' characters, which are expanded like when used in a command-
4065 line. The placeholder "$*" is allowed to specify where the arguments
4066 will be included. Environment variables are expanded |:set_env|. See
4067 |option-backslash| about including spaces and backslashes.
4068 When your "grep" accepts the "-H" argument, use this to make ":grep"
4069 also work well with a single file: >
4070 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004071< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004072 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4073 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004074 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 apply equally to 'grepprg'.
4076 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4077 otherwise it's "grep -n".
4078 This option cannot be set from a |modeline| or in the |sandbox|, for
4079 security reasons.
4080
4081 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4082'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4083 ve:ver35-Cursor,
4084 o:hor50-Cursor,
4085 i-ci:ver25-Cursor/lCursor,
4086 r-cr:hor20-Cursor/lCursor,
4087 sm:block-Cursor
4088 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004089 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 "n-v-c:block,o:hor50,i-ci:hor15,
4091 r-cr:hor30,sm:block")
4092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004094 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004096 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004097 height of the cursor can be changed. This can be done by specifying a
4098 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004099 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4100 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004102 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 mode-list and an argument-list:
4104 mode-list:argument-list,mode-list:argument-list,..
4105 The mode-list is a dash separated list of these modes:
4106 n Normal mode
4107 v Visual mode
4108 ve Visual mode with 'selection' "exclusive" (same as 'v',
4109 if not specified)
4110 o Operator-pending mode
4111 i Insert mode
4112 r Replace mode
4113 c Command-line Normal (append) mode
4114 ci Command-line Insert mode
4115 cr Command-line Replace mode
4116 sm showmatch in Insert mode
4117 a all modes
4118 The argument-list is a dash separated list of these arguments:
4119 hor{N} horizontal bar, {N} percent of the character height
4120 ver{N} vertical bar, {N} percent of the character width
4121 block block cursor, fills the whole character
4122 [only one of the above three should be present]
4123 blinkwait{N} *cursor-blinking*
4124 blinkon{N}
4125 blinkoff{N}
4126 blink times for cursor: blinkwait is the delay before
4127 the cursor starts blinking, blinkon is the time that
4128 the cursor is shown and blinkoff is the time that the
4129 cursor is not shown. The times are in msec. When one
4130 of the numbers is zero, there is no blinking. The
4131 default is: "blinkwait700-blinkon400-blinkoff250".
4132 These numbers are used for a missing entry. This
4133 means that blinking is enabled by default. To switch
4134 blinking off you can use "blinkon0". The cursor only
4135 blinks when Vim is waiting for input, not while
4136 executing a command.
4137 To make the cursor blink in an xterm, see
4138 |xterm-blink|.
4139 {group-name}
4140 a highlight group name, that sets the color and font
4141 for the cursor
4142 {group-name}/{group-name}
4143 Two highlight group names, the first is used when
4144 no language mappings are used, the other when they
4145 are. |language-mapping|
4146
4147 Examples of parts:
4148 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4149 block cursor with colors from the "nCursor"
4150 highlight group
4151 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4152 In Insert and Command-line Insert mode, use a
4153 30% vertical bar cursor with colors from the
4154 "iCursor" highlight group. Blink a bit
4155 faster.
4156
4157 The 'a' mode is different. It will set the given argument-list for
4158 all modes. It does not reset anything to defaults. This can be used
4159 to do a common setting for all modes. For example, to switch off
4160 blinking: "a:blinkon0"
4161
4162 Examples of cursor highlighting: >
4163 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4164 :highlight Cursor gui=NONE guifg=bg guibg=fg
4165<
4166 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004167 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168'guifont' 'gfn' string (default "")
4169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 {only available when compiled with GUI enabled}
4171 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004172 In its simplest form the value is just one font name.
4173 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174
4175 *'guifontset'* *'gfs'*
4176 *E250* *E252* *E234* *E597* *E598*
4177'guifontset' 'gfs' string (default "")
4178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 {only available when compiled with GUI enabled and
4180 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004181 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 When not empty, specifies two (or more) fonts to be used. The first
4183 one for normal English, the second one for your special language. See
4184 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004185
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4187'guifontwide' 'gfw' string (default "")
4188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 {only available when compiled with GUI enabled}
4190 When not empty, specifies a comma-separated list of fonts to be used
4191 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004192 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 *'guiheadroom'* *'ghr'*
4195'guiheadroom' 'ghr' number (default 50)
4196 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004197 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 The number of pixels subtracted from the screen height when fitting
4199 the GUI window on the screen. Set this before the GUI is started,
4200 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004201 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 lines will be left for window decorations and other items on the
4203 screen. Set it to a negative value to allow windows taller than the
4204 screen.
4205
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004206 *'guiligatures'* *'gli'* *E1243*
4207'guiligatures' 'gli' string (default "")
4208 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004209 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004210 List of ASCII characters that, when combined together, can create more
4211 complex shapes. Each character must be a printable ASCII character
4212 with a value in the 32-127 range.
4213 Example: >
4214 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4215< Changing this option updates screen output immediately. Set it to an
4216 empty string to disable ligatures.
4217
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004219'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4220 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004221 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004222 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004225 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 sequence of letters which describes what components and options of the
4227 GUI should be used.
4228 To avoid problems with flags that are added in the future, use the
4229 "+=" and "-=" feature of ":set" |add-option-flags|.
4230
Bram Moolenaar13568252018-03-16 20:46:58 +01004231 Valid characters are as follows:
4232 *'go-!'*
4233 '!' External commands are executed in a terminal window. Without
4234 this flag the MS-Windows GUI will open a console window to
4235 execute the command. The Unix GUI will simulate a dumb
4236 terminal to list the command output.
4237 The terminal window will be positioned at the bottom, and grow
4238 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004239 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 'a' Autoselect: If present, then whenever VISUAL mode is started,
4241 or the Visual area extended, Vim tries to become the owner of
4242 the windowing system's global selection. This means that the
4243 Visually highlighted text is available for pasting into other
4244 applications as well as into Vim itself. When the Visual mode
4245 ends, possibly due to an operation on the text, or when an
4246 application wants to paste the selection, the highlighted text
4247 is automatically yanked into the "* selection register.
4248 Thus the selection is still available for pasting into other
4249 applications after the VISUAL mode has ended.
4250 If not present, then Vim won't become the owner of the
4251 windowing system's global selection unless explicitly told to
4252 by a yank or delete operation for the "* register.
4253 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004254 *'go-P'*
4255 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004256 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004257 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004258 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 applies to the modeless selection.
4260
4261 'guioptions' autoselect Visual autoselect modeless ~
4262 "" - -
4263 "a" yes yes
4264 "A" - yes
4265 "aA" yes yes
4266
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004267 When using a terminal see the 'clipboard' option.
4268
Bram Moolenaar02467872007-05-06 13:22:01 +00004269 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 'c' Use console dialogs instead of popup dialogs for simple
4271 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004272 *'go-d'*
4273 'd' Use dark theme variant if available. Currently only works for
4274 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004275 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004276 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004277 'guitablabel' can be used to change the text in the labels.
4278 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004279 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004280 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004281 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 'f' Foreground: Don't use fork() to detach the GUI from the shell
4283 where it was started. Use this for programs that wait for the
4284 editor to finish (e.g., an e-mail program). Alternatively you
4285 can use "gvim -f" or ":gui -f" to start the GUI in the
4286 foreground. |gui-fork|
4287 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004288 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004289 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4291 corner of the window. It's black&white on non-GTK, because of
4292 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004293 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004295 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004296 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004298 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004300 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004301 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 'g' Grey menu items: Make menu items that are not active grey. If
4303 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004304 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 't' Include tearoff menu items. Currently only works for Win32,
4306 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004307 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004308 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4309 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004310 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004312 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 'R' Right-hand scrollbar is present when there is a vertically
4314 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004315 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004317 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 'L' Left-hand scrollbar is present when there is a vertically
4319 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004320 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4322 the longest visible line, or on the cursor line if the 'h'
4323 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004324 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 'h' Limit horizontal scrollbar size to the length of the cursor
4326 line. Reduces computations. |gui-horiz-scroll|
4327
4328 And yes, you may even have scrollbars on the left AND the right if
4329 you really want to :-). See |gui-scrollbars| for more information.
4330
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004331 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 'v' Use a vertical button layout for dialogs. When not included,
4333 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004334 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004335 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 'p' Use Pointer callbacks for X11 GUI. This is required for some
4337 window managers. If the cursor is not blinking or hollow at
4338 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004339 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004341 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004342 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004343 *'go-k'*
4344 'k' Keep the GUI window size when adding/removing a scrollbar, or
4345 toolbar, tabline, etc. Instead, the behavior is similar to
4346 when the window is maximized and will adjust 'lines' and
4347 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004348 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004349 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004350
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 *'guipty'* *'noguipty'*
4352'guipty' boolean (default on)
4353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 {only available when compiled with GUI enabled}
4355 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4356 I/O to/from shell commands. See |gui-pty|.
4357
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004358 *'guitablabel'* *'gtl'*
4359'guitablabel' 'gtl' string (default empty)
4360 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004361 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004362 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004363 pages line. When empty and when the result is empty Vim will use a
4364 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004365
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004366 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004367 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004368 The expression will be evaluated in the |sandbox| when set from a
4369 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004370 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004371
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004372 Only used when the GUI tab pages line is displayed. 'e' must be
4373 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4374 used.
4375
Bram Moolenaar57657d82006-04-21 22:12:41 +00004376 *'guitabtooltip'* *'gtt'*
4377'guitabtooltip' 'gtt' string (default empty)
4378 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004379 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004380 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004381 pages line. When empty Vim will use a default tooltip.
4382 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004383 You can include a line break. Simplest method is to use |:let|: >
4384 :let &guitabtooltip = "line one\nline two"
4385<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004386
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004388'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 (others) "$VIMRUNTIME/doc/help.txt")
4390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 Name of the main help file. All distributed help files should be
4392 placed together in one directory. Additionally, all "doc" directories
4393 in 'runtimepath' will be used.
4394 Environment variables are expanded |:set_env|. For example:
4395 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004396 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 spaces and backslashes.
4398 This option cannot be set from a |modeline| or in the |sandbox|, for
4399 security reasons.
4400
4401 *'helpheight'* *'hh'*
4402'helpheight' 'hh' number (default 20)
4403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 Minimal initial height of the help window when it is opened with the
4405 ":help" command. The initial height of the help window is half of the
4406 current window, or (when the 'ea' option is on) the same as other
4407 windows. When the height is less than 'helpheight', the height is
4408 set to 'helpheight'. Set to zero to disable.
4409
4410 *'helplang'* *'hlg'*
4411'helplang' 'hlg' string (default: messages language or empty)
4412 global
4413 {only available when compiled with the |+multi_lang|
4414 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004415 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 for which the desired help can be found. The English help will always
4417 be used as a last resort. You can add "en" to prefer English over
4418 another language, but that will only find tags that exist in that
4419 language and not in the English help.
4420 Example: >
4421 :set helplang=de,it
4422< This will first search German, then Italian and finally English help
4423 files.
4424 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4425 try to find the tag in the current language before using this option.
4426 See |help-translated|.
4427
4428 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4429'hidden' 'hid' boolean (default off)
4430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 When off a buffer is unloaded when it is |abandon|ed. When on a
4432 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4433 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004434
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004436 hidden even if the 'hidden' option is off when these three are true:
4437 - the buffer is modified
4438 - 'autowrite' is off or writing is not possible
4439 - the '!' flag was used
4440 Also see |windows.txt|.
4441
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004442 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 This option is set for one command with ":hide {command}" |:hide|.
4444 WARNING: It's easy to forget that you have changes in hidden buffers.
4445 Think twice when using ":q!" or ":qa!".
4446
4447 *'highlight'* *'hl'*
4448'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004449 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4450 d:Directory,e:ErrorMsg,i:IncSearch,
4451 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004452 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004453 N:CursorLineNr,r:Question,s:StatusLine,
4454 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004455 v:Visual,V:VisualNOS,w:WarningMsg,
4456 W:WildMenu,f:Folded,F:FoldColumn,
4457 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004458 T:DiffText,E:DiffTextAdd,>:SignColumn,
4459 -:Conceal,B:SpellBad,P:SpellCap,
4460 R:SpellRare, L:SpellLocal,+:Pmenu,
4461 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004462 [:PmenuKind,]:PmenuKindSel,
4463 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004464 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4465 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004466 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004467 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004468 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004471 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004473 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004475 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4476 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 characters from 'showbreak'
4478 |hl-Directory| d directories in CTRL-D listing and other special
4479 things in listings
4480 |hl-ErrorMsg| e error messages
4481 h (obsolete, ignored)
4482 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004483 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4485 |hl-MoreMsg| m |more-prompt|
4486 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004487 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004488 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004489 |hl-LineNr| n line number for ":number" and ":#" commands, and
4490 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004491 |hl-LineNrAbove| a line number above the cursor for when the
4492 'relativenumber' option is set.
4493 |hl-LineNrBelow| b line number below the cursor for when the
4494 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004495 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4496 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 |hl-Question| r |hit-enter| prompt and yes/no questions
4498 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004499 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4501 |hl-VertSplit| c column used to separate vertically split windows
4502 |hl-Visual| v Visual mode
4503 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4504 Selection" Only X11 Gui's |gui-x11| and
4505 |xterm-clipboard|.
4506 |hl-WarningMsg| w warning messages
4507 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4508 |hl-Folded| f line used for closed folds
4509 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004510 |hl-DiffAdd| A added line in diff mode
4511 |hl-DiffChange| C changed line in diff mode
4512 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004513 |hl-DiffText| T changed text in diff mode
4514 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004516 |hl-Conceal| - the placeholders used for concealed characters
4517 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004518 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004519 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004520 |hl-SpellRare| R rare word |spell|
4521 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004522 |hl-Pmenu| + popup menu normal line
4523 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004524 |hl-PmenuKind| [ popup menu "kind" normal line
4525 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004526 |hl-PmenuExtra| { popup menu "extra" normal line
4527 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004528 |hl-PmenuSbar| x popup menu scrollbar
4529 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004530 |hl-PmenuMatch| k popup menu matched text
4531 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532
4533 The display modes are:
4534 r reverse (termcap entry "mr" and "me")
4535 i italic (termcap entry "ZH" and "ZR")
4536 b bold (termcap entry "md" and "me")
4537 s standout (termcap entry "so" and "se")
4538 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004539 c undercurl (termcap entry "Us" and "Ce")
4540 2 double underline (termcap entry "Ds" and "Ce")
4541 d dotted underline (termcap entry "ds" and "Ce")
4542 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004543 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 n no highlighting
4545 - no highlighting
4546 : use a highlight group
4547 The default is used for occasions that are not included.
4548 If you want to change what the display modes do, see |dos-colors|
4549 for an example.
4550 When using the ':' display mode, this must be followed by the name of
4551 a highlight group. A highlight group can be used to define any type
4552 of highlighting, including using color. See |:highlight| on how to
4553 define one. The default uses a different group for each occasion.
4554 See |highlight-default| for the default highlight groups.
4555
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004557'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004560 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004561 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004562 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004563 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 NOTE: This option is set to the Vi default value when 'compatible' is
4565 set and to the Vim default value when 'compatible' is reset.
4566
4567 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4568'hkmap' 'hk' boolean (default off)
4569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 {only available when compiled with the |+rightleft|
4571 feature}
4572 When on, the keyboard is mapped for the Hebrew character set.
4573 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4574 toggle this option. See |rileft.txt|.
4575 NOTE: This option is reset when 'compatible' is set.
4576
4577 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4578'hkmapp' 'hkp' boolean (default off)
4579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 {only available when compiled with the |+rightleft|
4581 feature}
4582 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4583 This is useful if you have a non-Hebrew keyboard.
4584 See |rileft.txt|.
4585 NOTE: This option is reset when 'compatible' is set.
4586
Bram Moolenaar036986f2017-03-16 17:41:02 +01004587 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4588'hlsearch' 'hls' boolean (default off)
4589 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004590 {not available when compiled without the
4591 |+extra_search| feature}
4592 When there is a previous search pattern, highlight all its matches.
4593 The type of highlighting used can be set with the 'l' occasion in the
4594 'highlight' option. This uses the "Search" highlight group by
4595 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004596 are not applied. If the "CurSearch" highlight group is set then the
4597 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004598 See also: 'incsearch' and |:match|.
4599 When you get bored looking at the highlighted matches, you can turn it
4600 off with |:nohlsearch|. This does not change the option value, as
4601 soon as you use a search command, the highlighting comes back.
4602 'redrawtime' specifies the maximum time spent on finding matches.
4603 When the search pattern can match an end-of-line, Vim will try to
4604 highlight all of the matched text. However, this depends on where the
4605 search starts. This will be the first line in the window or the first
4606 line below a closed fold. A match in a previous line which is not
4607 drawn may not continue in a newly drawn line.
4608 You can specify whether the highlight status is restored on startup
4609 with the 'h' flag in 'viminfo' |viminfo-h|.
4610 NOTE: This option is reset when 'compatible' is set.
4611
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 *'icon'* *'noicon'*
4613'icon' boolean (default off, on when title can be restored)
4614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 When on, the icon text of the window will be set to the value of
4616 'iconstring' (if it is not empty), or to the name of the file
4617 currently being edited. Only the last part of the name is used.
4618 Overridden by the 'iconstring' option.
4619 Only works if the terminal supports setting window icons (currently
4620 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4621 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4622 builtin termcap).
4623 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004624 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004626 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627
4628 *'iconstring'*
4629'iconstring' string (default "")
4630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 When this option is not empty, it will be used for the icon text of
4632 the window. This happens only when the 'icon' option is on.
4633 Only works if the terminal supports setting window icon text
4634 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004635 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 When Vim was compiled with HAVE_X11 defined, the original icon will be
4637 restored if possible |X11|.
4638 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004639 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004641 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 {not available when compiled without the |+statusline| feature}
4643
4644 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4645'ignorecase' 'ic' boolean (default off)
4646 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004647 Ignore case in search patterns, |cmdline-completion|, when
4648 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004649 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 Can be overruled by using "\c" or "\C" in the pattern, see
4651 |/ignorecase|.
4652
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004653 *'imactivatefunc'* *'imaf'*
4654'imactivatefunc' 'imaf' string (default "")
4655 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004656 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004657 activate or deactivate the Input Method. The value can be the name of
4658 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4659 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004660 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004661 The expression will be evaluated in the |sandbox| when set from a
4662 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004663
4664 Example: >
4665 function ImActivateFunc(active)
4666 if a:active
4667 ... do something
4668 else
4669 ... do something
4670 endif
4671 " return value is not used
4672 endfunction
4673 set imactivatefunc=ImActivateFunc
4674<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 *'imactivatekey'* *'imak'*
4676'imactivatekey' 'imak' string (default "")
4677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004679 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 Specifies the key that your Input Method in X-Windows uses for
4681 activation. When this is specified correctly, vim can fully control
4682 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4683 You can't use this option to change the activation key, the option
4684 tells Vim what the key is.
4685 Format:
4686 [MODIFIER_FLAG-]KEY_STRING
4687
4688 These characters can be used for MODIFIER_FLAG (case is ignored):
4689 S Shift key
4690 L Lock key
4691 C Control key
4692 1 Mod1 key
4693 2 Mod2 key
4694 3 Mod3 key
4695 4 Mod4 key
4696 5 Mod5 key
4697 Combinations are allowed, for example "S-C-space" or "SC-space" are
4698 both shift+ctrl+space.
4699 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4700
4701 Example: >
4702 :set imactivatekey=S-space
4703< "S-space" means shift+space. This is the activation key for kinput2 +
4704 canna (Japanese), and ami (Korean).
4705
4706 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4707'imcmdline' 'imc' boolean (default off)
4708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 When set the Input Method is always on when starting to edit a command
4710 line, unless entering a search pattern (see 'imsearch' for that).
4711 Setting this option is useful when your input method allows entering
4712 English characters directly, e.g., when it's used to type accented
4713 characters with dead keys.
4714
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004715 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 When set the Input Method is never used. This is useful to disable
4719 the IM when it doesn't work properly.
4720 Currently this option is on by default for SGI/IRIX machines. This
4721 may change in later releases.
4722
4723 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004724'iminsert' 'imi' number (default 0)
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 in
4727 Insert mode. Valid values:
4728 0 :lmap is off and IM is off
4729 1 :lmap is ON and IM is off
4730 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 To always reset the option to zero when leaving Insert mode with <Esc>
4732 this can be used: >
4733 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4734< This makes :lmap and IM turn off automatically when leaving Insert
4735 mode.
4736 Note that this option changes when using CTRL-^ in Insert mode
4737 |i_CTRL-^|.
4738 The value is set to 1 when setting 'keymap' to a valid keymap name.
4739 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004740 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 methods. Use 'imdisable' to disable XIM then.
4742
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004743 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004744 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004745 |+multi_byte_ime| or |global-ime|.
4746
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004748'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 Specifies whether :lmap or an Input Method (IM) is to be used when
4751 entering a search pattern. Valid values:
4752 -1 the value of 'iminsert' is used, makes it look like
4753 'iminsert' is also used when typing a search pattern
4754 0 :lmap is off and IM is off
4755 1 :lmap is ON and IM is off
4756 2 :lmap is off and IM is ON
4757 Note that this option changes when using CTRL-^ in Command-line mode
4758 |c_CTRL-^|.
4759 The value is set to 1 when it is not -1 and setting the 'keymap'
4760 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004761 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 methods. Use 'imdisable' to disable XIM then.
4763
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004764 *'imstatusfunc'* *'imsf'*
4765'imstatusfunc' 'imsf' string (default "")
4766 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004767 This option specifies a function that is called to obtain the status
4768 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004769 The value can be the name of a function, a |lambda| or a |Funcref|.
4770 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004771 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004772
4773 Example: >
4774 function ImStatusFunc()
4775 let is_active = ...do something
4776 return is_active ? 1 : 0
4777 endfunction
4778 set imstatusfunc=ImStatusFunc
4779<
4780 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004781 The expression will be evaluated in the |sandbox| when set from a
4782 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004783
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004784 *'imstyle'* *'imst'*
4785'imstyle' 'imst' number (default 1)
4786 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004787 {only available when compiled with |+xim| and
4788 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004789 This option specifies the input style of Input Method:
4790 0 use on-the-spot style
4791 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004792 See: |xim-input-style|
4793
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004794 For a long time on-the-spot style had been used in the GTK version of
4795 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004796 |single-repeat|, etc. Therefore over-the-spot style becomes the
4797 default now. This should work fine for most people, however if you
4798 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004799 The expression will be evaluated in the |sandbox| when set from a
4800 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004801
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 *'include'* *'inc'*
4803'include' 'inc' string (default "^\s*#\s*include")
4804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 {not available when compiled without the
4806 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004807 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 pattern, just like for the "/" command (See |pattern|). The default
4809 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004810 "]I", "[d", etc.
4811 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004812 comes after the matched pattern. But if "\zs" appears in the pattern
4813 then the text matched from "\zs" to the end, or until "\ze" if it
4814 appears, is used as the file name. Use this to include characters
4815 that are not in 'isfname', such as a space. You can then use
4816 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004817 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818
4819 *'includeexpr'* *'inex'*
4820'includeexpr' 'inex' string (default "")
4821 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004823 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004826 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004828 Note the double backslash: the `:set` command first halves them, then
4829 one remains it the value, where "\." matches a dot literally. For
4830 simple character replacements `tr()` avoids the need for escaping: >
4831 :setlocal includeexpr=tr(v:fname,'.','/')
4832<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004834 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 Also used for |<cfile>|.
4836
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004837 If the expression starts with s: or |<SID>|, then it is replaced with
4838 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004839 setlocal includeexpr=s:MyIncludeExpr()
4840 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004841< Otherwise, the expression is evaluated in the context of the script
4842 where the option was set, thus script-local items are available.
4843
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004844 It is more efficient if the value is just a function call without
4845 arguments, see |expr-option-function|.
4846
Bram Moolenaar30b65812012-07-12 22:01:11 +02004847 The expression will be evaluated in the |sandbox| when set from a
4848 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004849 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004850
4851 It is not allowed to change text or jump to another window while
4852 evaluating 'includeexpr' |textlock|.
4853
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004855'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004856 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004859 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004860 While typing a search command, show where the pattern, as it was typed
4861 so far, matches. The matched string is highlighted. If the pattern
4862 is invalid or not found, nothing is shown. The screen will be updated
4863 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004864 Also applies to the pattern in commands: >
4865 :global
4866 :lvimgrep
4867 :lvimgrepadd
4868 :smagic
4869 :snomagic
4870 :sort
4871 :substitute
4872 :vglobal
4873 :vimgrep
4874 :vimgrepadd
4875< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004876 original position when no match is found and when pressing <Esc>. You
4877 still need to finish the search command with <Enter> to move the
4878 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004879 You can use the CTRL-G and CTRL-T keys to move to the next and
4880 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004881 When compiled with the |+reltime| feature Vim only searches for about
4882 half a second. With a complicated pattern and/or a lot of text the
4883 match may not be found. This is to avoid that Vim hangs while you
4884 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004885 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004886 When 'hlsearch' is on, all matched strings are highlighted too while
4887 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004888 If you don't want to turn 'hlsearch' on, but want to highlight all
4889 matches while searching, you can turn on and off 'hlsearch' with
4890 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004891 augroup vimrc-incsearch-highlight
4892 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004893 autocmd CmdlineEnter /,\? :set hlsearch
4894 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004895 augroup END
4896<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004897 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004898 to the command line. If 'ignorecase' and 'smartcase' are set and the
4899 command line has no uppercase characters, the added character is
4900 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004901 CTRL-R CTRL-W can be used to add the word at the end of the current
4902 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 NOTE: This option is reset when 'compatible' is set.
4904
4905 *'indentexpr'* *'inde'*
4906'indentexpr' 'inde' string (default "")
4907 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004908 {not available when compiled without the |+eval|
4909 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 Expression which is evaluated to obtain the proper indent for a line.
4911 It is used when a new line is created, for the |=| operator and
4912 in Insert mode as specified with the 'indentkeys' option.
4913 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004914 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004915 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 When 'paste' is set this option is not used for indenting.
4917 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004918 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004920
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004921 If the expression starts with s: or |<SID>|, then it is replaced with
4922 the script ID (|local-function|). Example: >
4923 set indentexpr=s:MyIndentExpr()
4924 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004925< Otherwise, the expression is evaluated in the context of the script
4926 where the option was set, thus script-local items are available.
4927
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004928 The advantage of using a function call without arguments is that it is
4929 faster, see |expr-option-function|.
4930
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 The expression must return the number of spaces worth of indent. It
4932 can return "-1" to keep the current indent (this means 'autoindent' is
4933 used for the indent).
4934 Functions useful for computing the indent are |indent()|, |cindent()|
4935 and |lispindent()|.
4936 The evaluation of the expression must not have side effects! It must
4937 not change the text, jump to another window, etc. Afterwards the
4938 cursor position is always restored, thus the cursor may be moved.
4939 Normally this option would be set to call a function: >
4940 :set indentexpr=GetMyIndent()
4941< Error messages will be suppressed, unless the 'debug' option contains
4942 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004943 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004944 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
Bram Moolenaar30b65812012-07-12 22:01:11 +02004946 The expression will be evaluated in the |sandbox| when set from a
4947 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004948 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004949
4950 It is not allowed to change text or jump to another window while
4951 evaluating 'indentexpr' |textlock|.
4952
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004954'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 A list of keys that, when typed in Insert mode, cause reindenting of
4957 the current line. Only happens if 'indentexpr' isn't empty.
4958 The format is identical to 'cinkeys', see |indentkeys-format|.
4959 See |C-indenting| and |indent-expression|.
4960
4961 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4962'infercase' 'inf' boolean (default off)
4963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004965 'ignorecase' is also on, the case of the match is adjusted depending
4966 on the typed text. If the typed text contains a lowercase letter
4967 where the match has an upper case letter, the completed part is made
4968 lowercase. If the typed text has no lowercase letters and the match
4969 has a lowercase letter where the typed text has an uppercase letter,
4970 and there is a letter before it, the completed part is made uppercase.
4971 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
4973 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4974'insertmode' 'im' boolean (default off)
4975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 Makes Vim work in a way that Insert mode is the default mode. Useful
4977 if you want to use Vim as a modeless editor. Used for |evim|.
4978 These Insert mode commands will be useful:
4979 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004980 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 this is a mapping, it is executed as if 'insertmode' was off.
4982 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004984 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4985 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986
4987 These items change when 'insertmode' is set:
4988 - when starting to edit of a file, Vim goes to Insert mode.
4989 - <Esc> in Insert mode is a no-op and beeps.
4990 - <Esc> in Normal mode makes Vim go to Insert mode.
4991 - CTRL-L in Insert mode is a command, it is not inserted.
4992 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4993 However, when <Esc> is used inside a mapping, it behaves like
4994 'insertmode' was not set. This was done to be able to use the same
4995 mappings with 'insertmode' set or not set.
4996 When executing commands with |:normal| 'insertmode' is not used.
4997
4998 NOTE: This option is reset when 'compatible' is set.
4999
5000 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005001'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5003 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5004 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5005 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5006 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 The characters specified by this option are included in file names and
5009 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005010 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 Multi-byte characters 256 and above are always included, only the
5012 characters up to 255 are specified with this option.
5013 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005014 Think twice before adding white space to this option. Although a
5015 space may appear inside a file name, the effect will be that Vim
5016 doesn't know where a file name starts or ends when doing completion.
5017 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
5019 Note that on systems using a backslash as path separator, Vim tries to
5020 do its best to make it work as you would expect. That is a bit
5021 tricky, since Vi originally used the backslash to escape special
5022 characters. Vim will not remove a backslash in front of a normal file
5023 name character on these systems, but it will on Unix and alikes. The
5024 '&' and '^' are not included by default, because these are special for
5025 cmd.exe.
5026
5027 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005028 Each part can be a single character number or a range. A range is two
5029 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 decimal number between 0 and 255 or the ASCII character itself (does
5031 not work for digits). Example:
5032 "_,-,128-140,#-43" (include '_' and '-' and the range
5033 128 to 140 and '#' to 43)
5034 If a part starts with '^', the following character number or range
5035 will be excluded from the option. The option is interpreted from left
5036 to right. Put the excluded character after the range where it is
5037 included. To include '^' itself use it as the last character of the
5038 option or the end of a range. Example:
5039 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5040 If the character is '@', all characters where isalpha() returns TRUE
5041 are included. Normally these are the characters a to z and A to Z,
5042 plus accented characters. To include '@' itself use "@-@". Examples:
5043 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005044 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 "a-z,A-Z,@-@" All letters plus the '@' character.
5046 A comma can be included by using it where a character number is
5047 expected. Example:
5048 "48-57,,,_" Digits, comma and underscore.
5049 A comma can be excluded by prepending a '^'. Example:
5050 " -~,^,,9" All characters from space to '~', excluding
5051 comma, plus <Tab>.
5052 See |option-backslash| about including spaces and backslashes.
5053
5054 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005055'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 "@,48-57,_,128-167,224-235"
5057 otherwise: "@,48-57,_,192-255")
5058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 The characters given by this option are included in identifiers.
5060 Identifiers are used in recognizing environment variables and after a
5061 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005062 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005063 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005065 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5067
5068 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005069'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 "@,48-57,_,128-167,224-235"
5071 otherwise: "@,48-57,_,192-255"
5072 Vi default: "@,48-57,_")
5073 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005075 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005076 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005077 characters above 255 check the "word" character class (any character
5078 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005079 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 For a help file it is set to all non-blank printable characters except
5081 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5082 command).
5083 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005084 This option also influences syntax highlighting, unless the syntax
5085 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 NOTE: This option is set to the Vi default value when 'compatible' is
5087 set and to the Vim default value when 'compatible' is reset.
5088
5089 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005090'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 "@,~-255"; otherwise: "@,161-255")
5092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 The characters given by this option are displayed directly on the
5094 screen. It is also used for "\p" in a |pattern|. The characters from
5095 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5096 even when they are not included in 'isprint' or excluded. See
5097 'isfname' for a description of the format of this option.
5098
5099 Non-printable characters are displayed with two characters:
5100 0 - 31 "^@" - "^_"
5101 32 - 126 always single characters
5102 127 "^?"
5103 128 - 159 "~@" - "~_"
5104 160 - 254 "| " - "|~"
5105 255 "~?"
5106 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5107 displayed as <xx>, with the hexadecimal value of the byte.
5108 When 'display' contains "uhex" all unprintable characters are
5109 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005110 The SpecialKey highlighting will be used for unprintable characters.
5111 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112
5113 Multi-byte characters 256 and above are always included, only the
5114 characters up to 255 are specified with this option. When a character
5115 is printable but it is not available in the current font, a
5116 replacement character will be shown.
5117 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5118 There is no option to specify these characters.
5119
5120 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5121'joinspaces' 'js' boolean (default on)
5122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 Insert two spaces after a '.', '?' and '!' with a join command.
5124 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5125 Otherwise only one space is inserted.
5126 NOTE: This option is set when 'compatible' is set.
5127
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005128 *'jumpoptions'* *'jop'*
5129'jumpoptions' 'jop' string (default "")
5130 global
5131 List of words that change the behavior of the |jumplist|.
5132 stack Make the jumplist behave like the tagstack.
5133 Relative location of entries in the jumplist is
5134 preserved at the cost of discarding subsequent entries
5135 when navigating backwards in the jumplist and then
5136 jumping to a location. |jumplist-stack|
5137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 *'key'*
5139'key' string (default "")
5140 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005141 {only available when compiled with the |+cryptv|
5142 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005144 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 Careful: Do not set the key value by hand, someone might see the typed
5146 key. Use the |:X| command. But you can make 'key' empty: >
5147 :set key=
5148< It is not possible to get the value of this option with ":set key" or
5149 "echo &key". This is to avoid showing it to someone who shouldn't
5150 know. It also means you cannot see it yourself once you have set it,
5151 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005152 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5153 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005154 You can use "&key" in an expression to detect whether encryption is
5155 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
5157 *'keymap'* *'kmp'* *E544*
5158'keymap' 'kmp' string (default "")
5159 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 {only available when compiled with the |+keymap|
5161 feature}
5162 Name of a keyboard mapping. See |mbyte-keymap|.
5163 Setting this option to a valid keymap name has the side effect of
5164 setting 'iminsert' to one, so that the keymap becomes effective.
5165 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005166 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167
5168 *'keymodel'* *'km'*
5169'keymodel' 'km' string (default "")
5170 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005171 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 can do. These values can be used:
5173 startsel Using a shifted special key starts selection (either
5174 Select mode or Visual mode, depending on "key" being
5175 present in 'selectmode').
5176 stopsel Using a not-shifted special key stops selection.
5177 Special keys in this context are the cursor keys, <End>, <Home>,
5178 <PageUp> and <PageDown>.
5179 The 'keymodel' option is set by the |:behave| command.
5180
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005181 *'keyprotocol'* *'kpc'*
5182'keyprotocol' 'kpc' string (default: see below)
5183 global
5184 Specifies what keyboard protocol to use depending on the value of
5185 'term'. The supported keyboard protocols names are:
5186 none whatever the terminal uses
5187 mok2 modifyOtherKeys level 2, as supported by xterm
5188 kitty Kitty keyboard protocol, as supported by Kitty
5189
Bram Moolenaara87749e2022-11-30 10:23:17 +00005190 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005191 a pattern that is matched against the 'term' option, a colon and the
5192 protocol name to be used. To illustrate this, the default value would
5193 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005194 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5195 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005196
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005197< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005198 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5199 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005200
5201 The first match is used, thus if you want to have "kitty" use the
5202 kitty protocol, but "badkitty" not, then you should match "badkitty"
5203 first and use the "none" value: >
5204 set keyprotocol=badkitty:none,kitty:kitty
5205<
5206 The option is used after 'term' has been changed. First the termcap
5207 entries are set, possibly using the builtin list, see |builtin-terms|.
5208 Then this option is inspected and if there is a match and a protocol
5209 is specified the following happens:
5210 none Nothing, the regular t_TE and t_TI values remain
5211
5212 mok2 The t_TE value is changed to:
5213 CSI >4;m disables modifyOtherKeys
5214 The t_TI value is changed to:
5215 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005216 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005217
5218 kitty The t_TE value is changed to:
5219 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005220 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005221 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005222 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005223 CSI ?u request kitty keyboard protocol state
5224 CSI >c request the termresponse
5225
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005226 If you notice problems, such as characters being displayed that
5227 disappear after `CTRL-L`, you might want to try making this option
5228 empty. Then set the 'term' option to have it take effect: >
5229 set keyprotocol=
5230 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005231<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005232
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 *'keywordprg'* *'kp'*
5234'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005235 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 Program to use for the |K| command. Environment variables are
5238 expanded |:set_env|. ":help" may be used to access the Vim internal
5239 help. (Note that previously setting the global option to the empty
5240 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005241 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005242 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005243 When "man", "man -s" or an Ex command is used, Vim will automatically
5244 translate a count for the "K" command and pass it as the first
5245 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 See |option-backslash| about including spaces and backslashes.
5247 Example: >
5248 :set keywordprg=man\ -s
5249< This option cannot be set from a |modeline| or in the |sandbox|, for
5250 security reasons.
5251
5252 *'langmap'* *'lmap'* *E357* *E358*
5253'langmap' 'lmap' string (default "")
5254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 {only available when compiled with the |+langmap|
5256 feature}
5257 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005258 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005259 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 care of translating these special characters to the original meaning
5261 of the key. This means you don't have to change the keyboard mode to
5262 be able to execute Normal mode commands.
5263 This is the opposite of the 'keymap' option, where characters are
5264 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005265 Also consider setting 'langremap' to off, to prevent 'langmap' from
5266 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005267 This option cannot be set from a |modeline| or in the |sandbox|, for
5268 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005270 Example (for Greek, in UTF-8): *greek* >
5271 :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 +00005272< Example (exchanges meaning of z and y for commands): >
5273 :set langmap=zy,yz,ZY,YZ
5274<
5275 The 'langmap' option is a list of parts, separated with commas. Each
5276 part can be in one of two forms:
5277 1. A list of pairs. Each pair is a "from" character immediately
5278 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005279 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 characters. Example: "abc;ABC"
5281 Example: "aA,fgh;FGH,cCdDeE"
5282 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005283 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284
5285 This will allow you to activate vim actions without having to switch
5286 back and forth between the languages. Your language characters will
5287 be understood as normal vim English characters (according to the
5288 langmap mappings) in the following cases:
5289 o Normal/Visual mode (commands, buffer/register names, user mappings)
5290 o Insert/Replace Mode: Register names after CTRL-R
5291 o Insert/Replace Mode: Mappings
5292 Characters entered in Command-line mode will NOT be affected by
5293 this option. Note that this option can be changed at any time
5294 allowing to switch between mappings for different languages/encodings.
5295 Use a mapping to avoid having to type it each time!
5296
5297 *'langmenu'* *'lm'*
5298'langmenu' 'lm' string (default "")
5299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 {only available when compiled with the |+menu| and
5301 |+multi_lang| features}
5302 Language to use for menu translation. Tells which file is loaded
5303 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005304 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305< (without the spaces). For example, to always use the Dutch menus, no
5306 matter what $LANG is set to: >
5307 :set langmenu=nl_NL.ISO_8859-1
5308< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005309 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 If your $LANG is set to a non-English language but you do want to use
5311 the English menus: >
5312 :set langmenu=none
5313< This option must be set before loading menus, switching on filetype
5314 detection or syntax highlighting. Once the menus are defined setting
5315 this option has no effect. But you could do this: >
5316 :source $VIMRUNTIME/delmenu.vim
5317 :set langmenu=de_DE.ISO_8859-1
5318 :source $VIMRUNTIME/menu.vim
5319< Warning: This deletes all menus that you defined yourself!
5320
Bram Moolenaard94464e2015-11-02 15:28:18 +01005321 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005322'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005323 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005324 {only available when compiled with the |+langmap|
5325 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005326 This is just like 'langremap' but with the value inverted. It only
5327 exists for backwards compatibility. When setting 'langremap' then
5328 'langnoremap' is set to the inverted value, and the other way around.
5329
5330 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005331'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005332 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005333 {only available when compiled with the |+langmap|
5334 feature}
5335 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005336 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005337 'langmap' disables some of your mappings, try resetting this option.
5338 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005339 that works for you to avoid mappings to break.
5340
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 *'laststatus'* *'ls'*
5342'laststatus' 'ls' number (default 1)
5343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 The value of this option influences when the last window will have a
5345 status line:
5346 0: never
5347 1: only if there are at least two windows
5348 2: always
5349 The screen looks nicer with a status line if you have several
5350 windows, but it takes another screen line. |status-line|
5351
5352 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5353'lazyredraw' 'lz' boolean (default off)
5354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 When this option is set, the screen will not be redrawn while
5356 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005357 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005359 This may occasionally cause display errors. It is only meant to be set
5360 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005361 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
64-bitman88d41ab2025-04-06 17:20:39 +02005363 *'lhistory'* *'lhi'*
5364'lhistory' 'lhi' number (default: 10)
5365 local to window
5366 {only available when compiled with the |+quickfix|
5367 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005368 Like 'chistory', but for the location list stack associated with a
5369 window. If the option is changed in either the location list window
5370 itself or the window that is associated with the location list stack,
5371 the new value will also be applied to the other one. This means this
5372 value will always be the same for a given location list window and its
5373 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005374
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5376'linebreak' 'lbr' boolean (default off)
5377 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005378 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005380 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 than at the last character that fits on the screen. Unlike
5382 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005383 it only affects the way the file is displayed, not its contents.
5384 If 'breakindent' is set, line is visually indented. Then, the value
5385 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005386 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 Note that <Tab> characters after an <EOL> are mostly not displayed
5388 with the right amount of white space.
5389
5390 *'lines'* *E593*
5391'lines' number (default 24 or terminal height)
5392 global
5393 Number of lines of the Vim window.
5394 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005395 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 When Vim is running in the GUI or in a resizable window, setting this
5397 option will cause the window size to be changed. When you only want
5398 to use the size for the GUI, put the command in your |gvimrc| file.
5399 Vim limits the number of lines to what fits on the screen. You can
5400 use this command to get the tallest window possible: >
5401 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005402< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005403 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 When you set this option and Vim is unable to change the physical
5405 number of lines of the display, the display may be messed up.
5406
5407 *'linespace'* *'lsp'*
5408'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 {only in the GUI}
5411 Number of pixel lines inserted between characters. Useful if the font
5412 uses the full character cell height, making lines touch each other.
5413 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005414 With some fonts there can be too much room between lines (to have
5415 space for ascents and descents). Then it makes sense to set
5416 'linespace' to a negative value. This may cause display problems
5417 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418
5419 *'lisp'* *'nolisp'*
5420'lisp' boolean (default off)
5421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 Lisp mode: When <Enter> is typed in insert mode set the indent for
5423 the next line to Lisp standards (well, sort of). Also happens with
5424 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5425 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5426 better. Also see 'lispwords'.
5427 The '-' character is included in keyword characters. Redefines the
5428 "=" operator to use this same indentation algorithm rather than
5429 calling an external program if 'equalprg' is empty.
5430 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005432 *'lispoptions'* *'lop'*
5433'lispoptions' 'lop' string (default "")
5434 local to buffer
5435 Comma-separated list of items that influence the Lisp indenting when
5436 enabled with the |'lisp'| option. Currently only one item is
5437 supported:
5438 expr:1 use 'indentexpr' for Lisp indenting when it is set
5439 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5440 Note that when using 'indentexpr' the `=` operator indents all the
5441 lines, otherwise the first line is not indented (Vi-compatible).
5442
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 *'lispwords'* *'lw'*
5444'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005445 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005446 Comma-separated list of words that influence the Lisp indenting when
5447 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
5449 *'list'* *'nolist'*
5450'list' boolean (default off)
5451 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005452 List mode: By default show tabs as CTRL-I is displayed, display $
5453 after end of line. Useful to see the difference between tabs and
5454 spaces and for trailing blanks. Further changed by the 'listchars'
5455 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005456
5457 The cursor is displayed at the start of the space a Tab character
5458 occupies, not at the end as usual in Normal mode. To get this cursor
5459 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005460 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005461<
5462 Note that list mode will also affect formatting (set with 'textwidth'
5463 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 changing the way tabs are displayed.
5465
5466 *'listchars'* *'lcs'*
5467'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005468 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005469 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005470 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005471 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 eol:c Character to show at the end of each line. When
5473 omitted, there is no extra character at the end of the
5474 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005475 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005476 tab:xy[z] Two or three characters to be used to show a tab.
5477 The third character is optional.
5478
5479 tab:xy The 'x' is always used, then 'y' as many times as will
5480 fit. Thus "tab:>-" displays:
5481 >
5482 >-
5483 >--
5484 etc.
5485
5486 tab:xyz The 'z' is always used, then 'x' is prepended, and
5487 then 'y' is used as many times as will fit. Thus
5488 "tab:<->" displays:
5489 >
5490 <>
5491 <->
5492 <-->
5493 etc.
5494
5495 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005496 *lcs-space*
5497 space:c Character to show for a space. When omitted, spaces
5498 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005499 *lcs-multispace*
5500 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005501 One or more characters to use cyclically to show for
5502 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005503 setting, except for single spaces. When omitted, the
5504 "space" setting is used. For example,
5505 `:set listchars=multispace:---+` shows ten consecutive
5506 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005507 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005508 *lcs-lead*
5509 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005510 leading spaces are blank. Overrides the "space" and
5511 "multispace" settings for leading spaces. You can
5512 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005513 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005514< *lcs-leadmultispace*
5515 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005516 Like the |lcs-multispace| value, but for leading
5517 spaces only. Also overrides |lcs-lead| for leading
5518 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005519 `:set listchars=leadmultispace:---+` shows ten
5520 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005521 ---+---+--XXX ~
5522 Where "XXX" denotes the first non-blank characters in
5523 the line.
5524 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005525 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005526 trailing spaces are blank. Overrides the "space" and
5527 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005528 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 extends:c Character to show in the last column, when 'wrap' is
5530 off and the line continues beyond the right of the
5531 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005532 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005533 precedes:c Character to show in the first visible column of the
5534 physical line, when there is text preceding the
5535 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005536 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005537 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005538 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005539 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005540 nbsp:c Character to show for a non-breakable space character
5541 (0xA0 (160 decimal) and U+202F). Left blank when
5542 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005544 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005546 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005548 Each character can be specified as hex: >
5549 set listchars=eol:\\x24
5550 set listchars=eol:\\u21b5
5551 set listchars=eol:\\U000021b5
5552< Note that a double backslash is used. The number of hex characters
5553 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5554
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 Examples: >
5556 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005557 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 :set lcs=extends:>,precedes:<
5559< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005560 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5561 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005562 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563
5564 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5565'loadplugins' 'lpl' boolean (default on)
5566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 When on the plugin scripts are loaded when starting up |load-plugins|.
5568 This option can be reset in your |vimrc| file to disable the loading
5569 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005570 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5571 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
Bram Moolenaard94464e2015-11-02 15:28:18 +01005573 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005574'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005575 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005576 {only available when compiled with the |+lua/dyn|
5577 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005578 Specifies the name of the Lua shared library. The default is
5579 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005580 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005584 *'macatsui'* *'nomacatsui'*
5585'macatsui' boolean (default on)
5586 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005587 {not supported}
5588 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005589
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 *'magic'* *'nomagic'*
5591'magic' boolean (default on)
5592 global
5593 Changes the special characters that can be used in search patterns.
5594 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005595 WARNING: Switching this option off most likely breaks plugins! That
5596 is because many patterns assume it's on and will fail when it's off.
5597 Only switch it off when working with old Vi scripts. In any other
5598 situation write patterns that work when 'magic' is on. Include "\M"
5599 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005600 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5601 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602
5603 *'makeef'* *'mef'*
5604'makeef' 'mef' string (default: "")
5605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 {not available when compiled without the |+quickfix|
5607 feature}
5608 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5609 and the |:grep| command.
5610 When it is empty, an internally generated temp file will be used.
5611 When "##" is included, it is replaced by a number to make the name
5612 unique. This makes sure that the ":make" command doesn't overwrite an
5613 existing file.
5614 NOT used for the ":cf" command. See 'errorfile' for that.
5615 Environment variables are expanded |:set_env|.
5616 See |option-backslash| about including spaces and backslashes.
5617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
5619
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005620 *'makeencoding'* *'menc'*
5621'makeencoding' 'menc' string (default "")
5622 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005623 Encoding used for reading the output of external commands. When empty,
5624 encoding is not converted.
5625 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5626 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5627 and `:laddfile`.
5628
5629 This would be mostly useful when you use MS-Windows and set 'encoding'
5630 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5631 'makeencoding' to "char" has the same effect as setting to the system
5632 locale encoding. Example: >
5633 :set encoding=utf-8
5634 :set makeencoding=char " system locale is used
5635<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 *'makeprg'* *'mp'*
5637'makeprg' 'mp' string (default "make", VMS: "MMS")
5638 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005639 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005640 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5641 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005642 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005643 Environment variables are expanded |:set_env|. See |option-backslash|
5644 about including spaces and backslashes.
5645 Note that a '|' must be escaped twice: once for ":set" and once for
5646 the interpretation of a command. When you use a filter called
5647 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 :set makeprg=gmake\ \\\|\ myfilter
5649< The placeholder "$*" can be given (even multiple times) to specify
5650 where the arguments will be included, for example: >
5651 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5652< This option cannot be set from a |modeline| or in the |sandbox|, for
5653 security reasons.
5654
5655 *'matchpairs'* *'mps'*
5656'matchpairs' 'mps' string (default "(:),{:},[:]")
5657 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005659 other.
5660 Only character pairs are allowed that are different, thus you cannot
5661 jump between two double quotes.
5662 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005663 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005664 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 :set mps+=<:>
5666
5667< A more exotic example, to jump between the '=' and ';' in an
5668 assignment, useful for languages like C and Java: >
5669 :au FileType c,cpp,java set mps+==:;
5670
5671< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005672 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673
5674 *'matchtime'* *'mat'*
5675'matchtime' 'mat' number (default 5)
5676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 Tenths of a second to show the matching paren, when 'showmatch' is
5678 set. Note that this is not in milliseconds, like other options that
5679 set a time. This is to be compatible with Nvi.
5680
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005681 *'maxcombine'* *'mco'*
5682'maxcombine' 'mco' number (default 2)
5683 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005684 The maximum number of combining characters supported for displaying.
5685 Only used when 'encoding' is "utf-8".
5686 The default is OK for most languages. Hebrew may require 4.
5687 Maximum value is 6.
5688 Even when this option is set to 2 you can still edit text with more
5689 combining characters, you just can't see them. Use |g8| or |ga|.
5690 See |mbyte-combining|.
5691
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 *'maxfuncdepth'* *'mfd'*
5693'maxfuncdepth' 'mfd' number (default 100)
5694 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005695 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005696 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 Maximum depth of function calls for user functions. This normally
5698 catches endless recursion. When using a recursive function with
5699 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5700 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005701 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005702 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005704 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705
5706 *'maxmapdepth'* *'mmd'* *E223*
5707'maxmapdepth' 'mmd' number (default 1000)
5708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 Maximum number of times a mapping is done without resulting in a
5710 character to be used. This normally catches endless mappings, like
5711 ":map x y" with ":map y x". It still does not catch ":map g wg",
5712 because the 'w' is used before the next mapping is done. See also
5713 |key-mapping|.
5714
5715 *'maxmem'* *'mm'*
5716'maxmem' 'mm' number (default between 256 to 5120 (system
5717 dependent) or half the amount of memory
5718 available)
5719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5721 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005722 other memory to be freed.
5723 The maximum usable value is about 2000000. Use this to work without a
5724 limit.
5725 The value is ignored when 'swapfile' is off.
5726 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005728 *'maxmempattern'* *'mmp'*
5729'maxmempattern' 'mmp' number (default 1000)
5730 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005731 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005732 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005733 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005734 When Vim runs into the limit it gives an error message and mostly
5735 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005736 Running into the limit often means that the pattern is very
5737 inefficient or too complex. This may already happen with the pattern
5738 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005739 Might also happen on redraw, when syntax rules try to match a complex
5740 text structure.
5741 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5742 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005743
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 *'maxmemtot'* *'mmt'*
5745'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5746 dependent) or half the amount of memory
5747 available)
5748 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005749 Maximum amount of memory in Kbyte to use for all buffers together.
5750 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005751 without a limit.
5752 On 64 bit machines higher values might work. But hey, do you really
5753 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005754 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005755 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005756 Buffers with 'swapfile' off still count to the total amount of memory
5757 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005758 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759
5760 *'menuitems'* *'mis'*
5761'menuitems' 'mis' number (default 25)
5762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 {not available when compiled without the |+menu|
5764 feature}
5765 Maximum number of items to use in a menu. Used for menus that are
5766 generated from a list of items, e.g., the Buffers menu. Changing this
5767 option has no direct effect, the menu must be refreshed first.
5768
Christian Brabandt51d4d842024-12-06 17:26:25 +01005769 *'messagesopt'* *'mopt'*
5770'messagesopt' 'mopt' string (default "hit-enter,history:500")
5771 global
5772
zeertzjq8cc43da2024-12-07 16:09:08 +01005773 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005774 following items. Items must be separated by a comma.
5775
zeertzjq8cc43da2024-12-07 16:09:08 +01005776 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005777 'cmdheight' size.
5778
zeertzjq8cc43da2024-12-07 16:09:08 +01005779 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5780 {n} milliseconds so that the user has a chance to read
5781 the message. The maximum value of {n} is 10000. Use
5782 0 to disable the wait (but then the user may miss an
5783 important message).
5784 This item is ignored when "hit-enter" is present, but
5785 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005786
5787 history:{n} Determines how many entries are remembered in the
5788 |:messages| history. The maximum value is 10000.
5789 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005790 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005791
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005792 *'mkspellmem'* *'msm'*
5793'mkspellmem' 'msm' string (default "460000,2000,500")
5794 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005795 {not available when compiled without the |+syntax|
5796 feature}
5797 Parameters for |:mkspell|. This tunes when to start compressing the
5798 word tree. Compression can be slow when there are many words, but
5799 it's needed to avoid running out of memory. The amount of memory used
5800 per word depends very much on how similar the words are, that's why
5801 this tuning is complicated.
5802
5803 There are three numbers, separated by commas:
5804 {start},{inc},{added}
5805
5806 For most languages the uncompressed word tree fits in memory. {start}
5807 gives the amount of memory in Kbyte that can be used before any
5808 compression is done. It should be a bit smaller than the amount of
5809 memory that is available to Vim.
5810
5811 When going over the {start} limit the {inc} number specifies the
5812 amount of memory in Kbyte that can be allocated before another
5813 compression is done. A low number means compression is done after
5814 less words are added, which is slow. A high number means more memory
5815 will be allocated.
5816
5817 After doing compression, {added} times 1024 words can be added before
5818 the {inc} limit is ignored and compression is done when any extra
5819 amount of memory is needed. A low number means there is a smaller
5820 chance of hitting the {inc} limit, less memory is used but it's
5821 slower.
5822
5823 The languages for which these numbers are important are Italian and
5824 Hungarian. The default works for when you have about 512 Mbyte. If
5825 you have 1 Gbyte you could use: >
5826 :set mkspellmem=900000,3000,800
5827< If you have less than 512 Mbyte |:mkspell| may fail for some
5828 languages, no matter what you set 'mkspellmem' to.
5829
dkearns8ebdbc92023-10-29 06:26:19 +11005830 This option cannot be set from a |modeline| or in the |sandbox|, for
5831 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005832
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005834'modeline' 'ml' boolean (Vim default: on (off for root),
5835 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005837 If 'modeline' is on 'modelines' gives the number of lines that is
5838 checked for set commands. If 'modeline' is off or 'modelines' is zero
5839 no lines are checked. See |modeline|.
5840
5841 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5842'modelineexpr' 'mle' boolean (default: off)
5843 global
5844 When on allow some options that are an expression to be set in the
5845 modeline. Check the option for whether it is affected by
5846 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005847 This option cannot be set from a |modeline| or in the |sandbox|, for
5848 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005849
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 *'modelines'* *'mls'*
5851'modelines' 'mls' number (default 5)
5852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 If 'modeline' is on 'modelines' gives the number of lines that is
5854 checked for set commands. If 'modeline' is off or 'modelines' is zero
5855 no lines are checked. See |modeline|.
5856 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5857 set and to the Vim default value when 'compatible' is reset.
5858
5859 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005860 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861'modifiable' 'ma' boolean (default on)
5862 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 When off the buffer contents cannot be changed. The 'fileformat' and
5864 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005865 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866
5867 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5868'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005869 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 When on, the buffer is considered to be modified. This option is set
5871 when:
5872 1. A change was made to the text since it was last written. Using the
5873 |undo| command to go back to the original text will reset the
5874 option. But undoing changes that were made before writing the
5875 buffer will set the option again, since the text is different from
5876 when it was written.
5877 2. 'fileformat' or 'fileencoding' is different from its original
5878 value. The original value is set when the buffer is read or
5879 written. A ":set nomodified" command also resets the original
5880 values to the current values and the 'modified' option will be
5881 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005882 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005883 This option is not set when a change is made to the buffer as the
5884 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5885 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5886 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5888 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005889 Note that the text may actually be the same, e.g. 'modified' is set
5890 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891
5892 *'more'* *'nomore'*
5893'more' boolean (Vim default: on, Vi default: off)
5894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 When on, listings pause when the whole screen is filled. You will get
5896 the |more-prompt|. When this option is off there are no pauses, the
5897 listing continues until finished.
5898 NOTE: This option is set to the Vi default value when 'compatible' is
5899 set and to the Vim default value when 'compatible' is reset.
5900
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005901 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005902'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005903 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005905 Enable the use of the mouse. Works for most terminals (xterm, Win32
5906 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5907 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5908 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005909 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 v Visual mode
5911 i Insert mode
5912 c Command-line mode
5913 h all previous modes when editing a help file
5914 a all previous modes
5915 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005916 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005918< If your terminal can't overrule the mouse events going to the
5919 application, use: >
5920 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005921< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005922 back to Vim using the mouse events.
5923 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5924 "xterm".
5925
5926 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 modeless selection. This doesn't move the text cursor.
5928
5929 See |mouse-using|. Also see |'clipboard'|.
5930
5931 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005932 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 the mouse buttons can still be used by keeping the shift key pressed.
5934 Also see the 'clipboard' option.
5935
5936 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5937'mousefocus' 'mousef' boolean (default off)
5938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939 {only works in the GUI}
5940 The window that the mouse pointer is on is automatically activated.
5941 When changing the window layout or window focus in another way, the
5942 mouse pointer is moved to the window with keyboard focus. Off is the
5943 default because it makes using the pull down menus a little goofy, as
5944 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005945 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005946 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947
5948 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5949'mousehide' 'mh' boolean (default on)
5950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005951 {only works in the GUI}
5952 When on, the mouse pointer is hidden when characters are typed.
5953 The mouse pointer is restored when the mouse is moved.
5954
5955 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005956'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 Sets the model to use for the mouse. The name mostly specifies what
5959 the right mouse button is used for:
5960 extend Right mouse button extends a selection. This works
5961 like in an xterm.
5962 popup Right mouse button pops up a menu. The shifted left
5963 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005964 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 popup_setpos Like "popup", but the cursor will be moved to the
5966 position where the mouse was clicked, and thus the
5967 selected operation will act upon the clicked object.
5968 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005969 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 course, that right clicking outside a selection will
5971 end Visual mode.
5972 Overview of what button does what for each model:
5973 mouse extend popup(_setpos) ~
5974 left click place cursor place cursor
5975 left drag start selection start selection
5976 shift-left search word extend selection
5977 right click extend selection popup menu (place cursor)
5978 right drag extend selection -
5979 middle click paste paste
5980
5981 In the "popup" model the right mouse button produces a pop-up menu.
5982 You need to define this first, see |popup-menu|.
5983
5984 Note that you can further refine the meaning of buttons with mappings.
5985 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5986 selection (because that's handled in the GUI code directly).
5987
5988 The 'mousemodel' option is set by the |:behave| command.
5989
h_east59858792023-10-25 22:47:05 +09005990 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005991'mousemoveevent' 'mousemev' boolean (default off)
5992 global
5993 {only works in the GUI}
5994 When on, mouse move events are delivered to the input queue and are
5995 available for mapping. The default, off, avoids the mouse movement
5996 overhead except when needed. See |gui-mouse-mapping|.
5997 Warning: Setting this option can make pending mappings to be aborted
5998 when the mouse is moved.
5999 Currently only works in the GUI, may be made to work in a terminal
6000 later.
6001
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006003'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6004 vs:leftright,vd:lrsizing,m:no,
6005 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 {only available when compiled with the |+mouseshape|
6008 feature}
6009 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006010 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 like used for 'guicursor'. Each part consist of a mode/location-list
6012 and an argument-list:
6013 mode-list:shape,mode-list:shape,..
6014 The mode-list is a dash separated list of these modes/locations:
6015 In a normal window: ~
6016 n Normal mode
6017 v Visual mode
6018 ve Visual mode with 'selection' "exclusive" (same as 'v',
6019 if not specified)
6020 o Operator-pending mode
6021 i Insert mode
6022 r Replace mode
6023
6024 Others: ~
6025 c appending to the command-line
6026 ci inserting in the command-line
6027 cr replacing in the command-line
6028 m at the 'Hit ENTER' or 'More' prompts
6029 ml idem, but cursor in the last line
6030 e any mode, pointer below last window
6031 s any mode, pointer on a status line
6032 sd any mode, while dragging a status line
6033 vs any mode, pointer on a vertical separator line
6034 vd any mode, while dragging a vertical separator line
6035 a everywhere
6036
6037 The shape is one of the following:
6038 avail name looks like ~
6039 w x arrow Normal mouse pointer
6040 w x blank no pointer at all (use with care!)
6041 w x beam I-beam
6042 w x updown up-down sizing arrows
6043 w x leftright left-right sizing arrows
6044 w x busy The system's usual busy pointer
6045 w x no The system's usual 'no input' pointer
6046 x udsizing indicates up-down resizing
6047 x lrsizing indicates left-right resizing
6048 x crosshair like a big thin +
6049 x hand1 black hand
6050 x hand2 white hand
6051 x pencil what you write with
6052 x question big ?
6053 x rightup-arrow arrow pointing right-up
6054 w x up-arrow arrow pointing up
6055 x <number> any X11 pointer number (see X11/cursorfont.h)
6056
6057 The "avail" column contains a 'w' if the shape is available for Win32,
6058 x for X11.
6059 Any modes not specified or shapes not available use the normal mouse
6060 pointer.
6061
6062 Example: >
6063 :set mouseshape=s:udsizing,m:no
6064< will make the mouse turn to a sizing arrow over the status lines and
6065 indicate no input when the hit-enter prompt is displayed (since
6066 clicking the mouse has no effect in this state.)
6067
6068 *'mousetime'* *'mouset'*
6069'mousetime' 'mouset' number (default 500)
6070 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006071 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 time in msec between two mouse clicks for the second click to be
6073 recognized as a multi click.
6074
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006075
laburnumT3f7855a2023-12-05 18:37:03 +01006076 *'mzquantum'* *'mzq'*
6077'mzquantum' 'mzq' number (default 100)
6078 global
6079 {not available when compiled without the |+mzscheme|
6080 feature}
6081 The number of milliseconds between polls for MzScheme threads.
6082 Negative or zero value means no thread scheduling.
6083 NOTE: This option is set to the Vim default value when 'compatible'
6084 is reset.
6085
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006086 *'mzschemedll'*
6087'mzschemedll' string (default depends on the build)
6088 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006089 {only available when compiled with the |+mzscheme/dyn|
6090 feature}
6091 Specifies the name of the MzScheme shared library. The default is
6092 DYNAMIC_MZSCH_DLL which was specified at compile time.
6093 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006094 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006095 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006096 This option cannot be set from a |modeline| or in the |sandbox|, for
6097 security reasons.
6098
6099 *'mzschemegcdll'*
6100'mzschemegcdll' string (default depends on the build)
6101 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006102 {only available when compiled with the |+mzscheme/dyn|
6103 feature}
6104 Specifies the name of the MzScheme GC shared library. The default is
6105 DYNAMIC_MZGC_DLL which was specified at compile time.
6106 The value can be equal to 'mzschemedll' if it includes the GC code.
6107 Environment variables are expanded |:set_env|.
6108 This option cannot be set from a |modeline| or in the |sandbox|, for
6109 security reasons.
6110
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006112'nrformats' 'nf' string (default "bin,octal,hex",
6113 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 This defines what bases Vim will consider for numbers when using the
6116 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6117 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006118 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006120 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006121 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006123 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124 considered to be hexadecimal. Example: Using CTRL-X on
6125 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006126 bin If included, numbers starting with "0b" or "0B" will be
6127 considered to be binary. Example: Using CTRL-X on
6128 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006129 unsigned If included, numbers are recognized as unsigned. Thus a
6130 leading dash or negative sign won't be considered as part of
6131 the number. Examples:
6132 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6133 (without "unsigned" it would become "9-2021").
6134 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6135 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006136 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6137 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006138 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006139 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006140 dash immediately preceded by a non-whitespace character (i.e.,
6141 not a tab or a " "), the negative sign won't be considered as
6142 part of the number. For example:
6143 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6144 (without "blank" it would become "Carbon-13").
6145 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006146 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006147 set, it would result in "Carbon -7").
6148 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006149 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006150 included, "unsigned" will take precedence.
6151
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 Numbers which simply begin with a digit in the range 1-9 are always
6153 considered decimal. This also happens for numbers that are not
6154 recognized as octal or hex.
6155
6156 *'number'* *'nu'* *'nonumber'* *'nonu'*
6157'number' 'nu' boolean (default off)
6158 local to window
6159 Print the line number in front of each line. When the 'n' option is
6160 excluded from 'cpoptions' a wrapped line will not use the column of
6161 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006162 The 'numberwidth' option can be used to set the room used for the line
6163 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 When a long, wrapped line doesn't start with the first character, '-'
6165 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006166 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6167 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006168 *number_relativenumber*
6169 The 'relativenumber' option changes the displayed number to be
6170 relative to the cursor. Together with 'number' there are these
6171 four combinations (cursor in line 3):
6172
Bram Moolenaar3848e002016-03-19 18:42:29 +01006173 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006174 'nornu' 'nornu' 'rnu' 'rnu'
6175
6176 |apple | 1 apple | 2 apple | 2 apple
6177 |pear | 2 pear | 1 pear | 1 pear
6178 |nobody | 3 nobody | 0 nobody |3 nobody
6179 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006181 *'numberwidth'* *'nuw'*
6182'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6183 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006184 {only available when compiled with the |+linebreak|
6185 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006186 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006187 when the 'number' or 'relativenumber' option is set or printing lines
6188 with a line number. Since one space is always between the number and
6189 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006190 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006191 fit the highest line number in the buffer respectively the number of
6192 rows in the window, depending on whether 'number' or 'relativenumber'
6193 is set. Thus with the Vim default of 4 there is room for a line number
6194 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006195 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006196 NOTE: This option is set to the Vi default value when 'compatible' is
6197 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006198
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006199 *'omnifunc'* *'ofu'*
6200'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006201 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006202 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006203 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006204 This option specifies a function to be used for Insert mode omni
6205 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006206 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006207 invoked and what it should return. The value can be the name of a
6208 function, a |lambda| or a |Funcref|. See |option-value-function| for
6209 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006210 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006211 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006212 This option cannot be set from a |modeline| or in the |sandbox|, for
6213 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006214
Bram Moolenaar02467872007-05-06 13:22:01 +00006215 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006216'opendevice' 'odev' boolean (default off)
6217 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006218 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006219 Enable reading and writing from devices. This may get Vim stuck on a
6220 device that can be opened but doesn't actually do the I/O. Therefore
6221 it is off by default.
6222 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6223 result in editing a device.
6224
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006225 *'operatorfunc'* *'opfunc'*
6226'operatorfunc' 'opfunc' string (default: empty)
6227 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006228 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006229 See |:map-operator| for more info and an example. The value can be
6230 the name of a function, a |lambda| or a |Funcref|. See
6231 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006232
6233 This option cannot be set from a |modeline| or in the |sandbox|, for
6234 security reasons.
6235
Bram Moolenaar251e1912011-06-19 05:09:16 +02006236 *'osfiletype'* *'oft'*
6237'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006239 This option was supported on RISC OS, which has been removed.
6240
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006241 *'packpath'* *'pp'*
6242'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006243 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006244 This option cannot be set from a |modeline| or in the |sandbox|, for
6245 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006246
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006248'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 global
6250 Specifies the nroff macros that separate paragraphs. These are pairs
6251 of two letters (see |object-motions|).
6252
6253 *'paste'* *'nopaste'*
6254'paste' boolean (default off)
6255 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006256 Put Vim in Paste mode. This is useful if you want to cut or copy
6257 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 unexpected effects.
6259 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006260 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 knows about pasting and will mostly do the right thing without 'paste'
6262 being set. The same is true for a terminal where Vim handles the
6263 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006264 This option is reset when starting the GUI. Thus if you set it in
6265 your .vimrc it will work in a terminal, but not in the GUI. Setting
6266 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6267 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 When the 'paste' option is switched on (also when it was already on):
6269 - mapping in Insert mode and Command-line mode is disabled
6270 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006272 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006273 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 - 'revins' is reset
6275 - 'ruler' is reset
6276 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006277 - 'smarttab' is reset
6278 - 'softtabstop' is set to 0
6279 - 'textwidth' is set to 0
6280 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006281 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006284 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006285 - 'indentexpr'
6286 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006287 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 NOTE: When you start editing another file while the 'paste' option is
6289 on, settings from the modelines or autocommands may change the
6290 settings again, causing trouble when pasting text. You might want to
6291 set the 'paste' option again.
6292 When the 'paste' option is reset the mentioned options are restored to
6293 the value before the moment 'paste' was switched from off to on.
6294 Resetting 'paste' before ever setting it does not have any effect.
6295 Since mapping doesn't work while 'paste' is active, you need to use
6296 the 'pastetoggle' option to toggle the 'paste' option with some key.
6297
6298 *'pastetoggle'* *'pt'*
6299'pastetoggle' 'pt' string (default "")
6300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 When non-empty, specifies the key sequence that toggles the 'paste'
6302 option. This is like specifying a mapping: >
6303 :map {keys} :set invpaste<CR>
6304< Where {keys} is the value of 'pastetoggle'.
6305 The difference is that it will work even when 'paste' is set.
6306 'pastetoggle' works in Insert mode and Normal mode, but not in
6307 Command-line mode.
6308 Mappings are checked first, thus overrule 'pastetoggle'. However,
6309 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6310 this: >
6311 :map <F10> :set paste<CR>
6312 :map <F11> :set nopaste<CR>
6313 :imap <F10> <C-O>:set paste<CR>
6314 :imap <F11> <nop>
6315 :set pastetoggle=<F11>
6316< This will make <F10> start paste mode and <F11> stop paste mode.
6317 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6318 mode everything is inserted literally, except the 'pastetoggle' key
6319 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006320 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321
6322 *'pex'* *'patchexpr'*
6323'patchexpr' 'pex' string (default "")
6324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 {not available when compiled without the |+diff|
6326 feature}
6327 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006329 This option cannot be set from a |modeline| or in the |sandbox|, for
6330 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331
Bram Moolenaardbc28022014-07-26 13:40:44 +02006332 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333'patchmode' 'pm' string (default "")
6334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 When non-empty the oldest version of a file is kept. This can be used
6336 to keep the original version of a file if you are changing files in a
6337 source distribution. Only the first time that a file is written a
6338 copy of the original file will be kept. The name of the copy is the
6339 name of the original file with the string in the 'patchmode' option
6340 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006341 ".orig" or ".org". 'backupdir' must not be empty for this to work
6342 (Detail: The backup file is renamed to the patchmode file after the
6343 new file has been successfully written, that's why it must be possible
6344 to write a backup file). If there was no file to be backed up, an
6345 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 When the 'backupskip' pattern matches, a patchmode file is not made.
6347 Using 'patchmode' for compressed files appends the extension at the
6348 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6349 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006350 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006352 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 other systems: ".,,")
6355 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006357 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6358 provided that the file being searched for has a relative path (not
6359 starting with "/", "./" or "../"). The directories in the 'path'
6360 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 - Use commas to separate directory names: >
6362 :set path=.,/usr/local/include,/usr/include
6363< - Spaces can also be used to separate directory names (for backwards
6364 compatibility with version 3.0). To have a space in a directory
6365 name, precede it with an extra backslash, and escape the space: >
6366 :set path=.,/dir/with\\\ space
6367< - To include a comma in a directory name precede it with an extra
6368 backslash: >
6369 :set path=.,/dir/with\\,comma
6370< - To search relative to the directory of the current file, use: >
6371 :set path=.
6372< - To search in the current directory use an empty string between two
6373 commas: >
6374 :set path=,,
6375< - A directory name may end in a ':' or '/'.
6376 - Environment variables are expanded |:set_env|.
6377 - When using |netrw.vim| URLs can be used. For example, adding
6378 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006379 - Search upwards and downwards in a directory tree using "*", "**" and
6380 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 - Careful with '\' characters, type two to get one in the option: >
6382 :set path=.,c:\\include
6383< Or just use '/' instead: >
6384 :set path=.,c:/include
6385< Don't forget "." or files won't even be found in the same directory as
6386 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006387 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 it is something like 256 or 1024 characters.
6389 You can check if all the include files are found, using the value of
6390 'path', see |:checkpath|.
6391 The use of |:set+=| and |:set-=| is preferred when adding or removing
6392 directories from the list. This avoids problems when a future version
6393 uses another default. To remove the current directory use: >
6394 :set path-=
6395< To add the current directory use: >
6396 :set path+=
6397< To use an environment variable, you probably need to replace the
6398 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006399 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006400 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401< Replace the ';' with a ':' or whatever separator is used. Note that
6402 this doesn't work when $INCL contains a comma or white space.
6403
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006404 *'perldll'*
6405'perldll' string (default depends on the build)
6406 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006407 {only available when compiled with the |+perl/dyn|
6408 feature}
6409 Specifies the name of the Perl shared library. The default is
6410 DYNAMIC_PERL_DLL, which was specified at compile time.
6411 Environment variables are expanded |:set_env|.
6412 This option cannot be set from a |modeline| or in the |sandbox|, for
6413 security reasons.
6414
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6416'preserveindent' 'pi' boolean (default off)
6417 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 When changing the indent of the current line, preserve as much of the
6419 indent structure as possible. Normally the indent is replaced by a
6420 series of tabs followed by spaces as required (unless |'expandtab'| is
6421 enabled, in which case only spaces are used). Enabling this option
6422 means the indent will preserve as many existing characters as possible
6423 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006424 'expandtab' does not apply to the preserved white space, a Tab remains
6425 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 NOTE: When using ">>" multiple times the resulting indent is a mix of
6427 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006428 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 Also see 'copyindent'.
6430 Use |:retab| to clean up white space.
6431
6432 *'previewheight'* *'pvh'*
6433'previewheight' 'pvh' number (default 12)
6434 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006435 {not available when compiled without the |+quickfix|
6436 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006438 commands. Used for |CTRL-W_}| when no count is given. Not used when
6439 'previewpopup' is set.
6440
6441 *'previewpopup'* *'pvp'*
6442'previewpopup' 'pvp' string (default empty)
6443 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006444 {not available when compiled without the |+textprop|
6445 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006446 When not empty a popup window is used for commands that would open a
6447 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006448 Not used for the insert completion info, add "popup" to
6449 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450
6451 *'previewwindow'* *'nopreviewwindow'*
6452 *'pvw'* *'nopvw'* *E590*
6453'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006454 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006455 {not available when compiled without the |+quickfix|
6456 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006457 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 set. It's normally not set directly, but by using one of the commands
6459 |:ptag|, |:pedit|, etc.
6460
6461 *'printdevice'* *'pdev'*
6462'printdevice' 'pdev' string (default empty)
6463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 {only available when compiled with the |+printer|
6465 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006466 The name of the printer to be used for |:hardcopy|.
6467 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006468 This option cannot be set from a |modeline| or in the |sandbox|, for
6469 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470
Bram Moolenaar8299df92004-07-10 09:47:34 +00006471 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006472'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 {only available when compiled with the |+printer|
6475 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006476 Sets the character encoding used when printing.
6477 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478
6479 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006480'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 {only available when compiled with the |+printer|
6483 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006484 Expression used to print the PostScript produced with |:hardcopy|.
6485 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006486 This option cannot be set from a |modeline| or in the |sandbox|, for
6487 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488
Bram Moolenaar8299df92004-07-10 09:47:34 +00006489 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490'printfont' 'pfn' string (default "courier")
6491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 {only available when compiled with the |+printer|
6493 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006494 The name of the font that will be used for |:hardcopy|.
6495 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496
6497 *'printheader'* *'pheader'*
6498'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 {only available when compiled with the |+printer|
6501 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006502 The format of the header produced in |:hardcopy| output.
6503 See |pheader-option|.
6504
6505 *'printmbcharset'* *'pmbcs'*
6506'printmbcharset' 'pmbcs' string (default "")
6507 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006508 {only available when compiled with the |+printer|
6509 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006510 The CJK character set to be used for CJK output from |:hardcopy|.
6511 See |pmbcs-option|.
6512
6513 *'printmbfont'* *'pmbfn'*
6514'printmbfont' 'pmbfn' string (default "")
6515 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006516 {only available when compiled with the |+printer|
6517 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006518 List of font names to be used for CJK output from |:hardcopy|.
6519 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520
6521 *'printoptions'* *'popt'*
6522'printoptions' 'popt' string (default "")
6523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006525 List of items that control the format of the output of |:hardcopy|.
6526 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006528 *'prompt'* *'noprompt'*
6529'prompt' boolean (default on)
6530 global
6531 When on a ":" prompt is used in Ex mode.
6532
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006533 *'pumheight'* *'ph'*
6534'pumheight' 'ph' number (default 0)
6535 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006536 Determines the maximum number of items to show in the popup menu for
6537 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006538 |ins-completion-menu|.
6539
glepnir88d75932025-03-27 20:09:07 +01006540 *'pummaxwidth'* *'pmw'*
6541'pummaxwidth' 'pmw' number (default 0)
6542 global
6543 Determines the maximum width to use for the popup menu for completion.
6544 When zero, there is no maximum width limit, otherwise the popup menu
6545 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006546 by "trunc" value of 'fillchars' option.
6547
6548 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006549 |ins-completion-menu|.
6550
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006551 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006552'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006553 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006554 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006555 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006556
Bram Moolenaard94464e2015-11-02 15:28:18 +01006557 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006558'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006559 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006560 {only available when compiled with the |+python/dyn|
6561 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006562 Specifies the name of the Python 2.x shared library. The default is
6563 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006564 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006565 This option cannot be set from a |modeline| or in the |sandbox|, for
6566 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006567
Bram Moolenaar94073162018-01-31 21:49:05 +01006568 *'pythonhome'*
6569'pythonhome' string (default "")
6570 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006571 {only available when compiled with the |+python/dyn|
6572 feature}
6573 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6574 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6575 which was specified at compile time, will be used for the Python 2.x
6576 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 Moolenaarb4ff5182015-11-10 21:15:48 +01006581 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006582'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006583 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006584 {only available when compiled with the |+python3/dyn|
6585 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006586 Specifies the name of the Python 3 shared library. The default is
6587 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006588 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006589 This option cannot be set from a |modeline| or in the |sandbox|, for
6590 security reasons.
6591
Bram Moolenaar94073162018-01-31 21:49:05 +01006592 *'pythonthreehome'*
6593'pythonthreehome' string (default "")
6594 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006595 {only available when compiled with the |+python3/dyn|
6596 feature}
6597 Specifies the name of the Python 3 home directory. When
6598 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6599 PYTHON3_HOME, which was specified at compile time, will be used for
6600 the Python 3 home directory.
6601 Environment variables are expanded |:set_env|.
6602 This option cannot be set from a |modeline| or in the |sandbox|, for
6603 security reasons.
6604
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006605 *'pyxversion'* *'pyx'*
6606'pyxversion' 'pyx' number (default depends on the build)
6607 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006608 {only available when compiled with the |+python| or
6609 the |+python3| feature}
6610 Specifies the python version used for pyx* functions and commands
6611 |python_x|. The default value is as follows:
6612
6613 Compiled with Default ~
6614 |+python| and |+python3| 0
6615 only |+python| 2
6616 only |+python3| 3
6617
6618 Available values are 0, 2 and 3.
6619 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6620 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6621 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6622 to 2 if Python 2 is available.
6623 See also: |has-pythonx|
6624
6625 If Vim is compiled with only |+python| or |+python3| setting
6626 'pyxversion' has no effect. The pyx* functions and commands are
6627 always the same as the compiled version.
6628
6629 This option cannot be set from a |modeline| or in the |sandbox|, for
6630 security reasons.
6631
Bram Moolenaar858ba062020-05-31 23:11:59 +02006632 *'quickfixtextfunc'* *'qftf'*
6633'quickfixtextfunc' 'qftf' string (default "")
6634 global
6635 {only available when compiled with the |+quickfix|
6636 feature}
6637 This option specifies a function to be used to get the text to display
6638 in the quickfix and location list windows. This can be used to
6639 customize the information displayed in the quickfix or location window
6640 for each entry in the corresponding quickfix or location list. See
6641 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006642 function and an example. The value can be the name of a function, a
6643 |lambda| or a |Funcref|. See |option-value-function| for more
6644 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006645
6646 This option cannot be set from a |modeline| or in the |sandbox|, for
6647 security reasons.
6648
Bram Moolenaar677ee682005-01-27 14:41:15 +00006649 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006650'quoteescape' 'qe' string (default "\")
6651 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006652 The characters that are used to escape quotes in a string. Used for
6653 objects like a', a" and a` |a'|.
6654 When one of the characters in this option is found inside a string,
6655 the following character will be skipped. The default value makes the
6656 text "foo\"bar\\" considered to be one string.
6657
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6659'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006660 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 If on, writes fail unless you use a '!'. Protects you from
6662 accidentally overwriting a file. Default on when Vim is started
6663 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006664 When using ":w!" the 'readonly' option is reset for the current
6665 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006666 When using the ":view" command the 'readonly' option is set for the
6667 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006668 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006670 *'redrawtime'* *'rdt'*
6671'redrawtime' 'rdt' number (default 2000)
6672 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006673 {only available when compiled with the |+reltime|
6674 feature}
6675 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006676 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006677 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006678 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006679 matches will be highlighted.
6680 For syntax highlighting the time applies per window. When over the
6681 limit syntax highlighting is disabled until |CTRL-L| is used.
6682 This is used to avoid that Vim hangs when using a very complicated
6683 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006684
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006685 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006686'regexpengine' 're' number (default 0)
6687 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006688 This selects the default regexp engine. |two-engines|
6689 The possible values are:
6690 0 automatic selection
6691 1 old engine
6692 2 NFA engine
6693 Note that when using the NFA engine and the pattern contains something
6694 that is not supported the pattern will not match. This is only useful
6695 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006696 Using automatic selection enables Vim to switch the engine, if the
6697 default engine becomes too costly. E.g., when the NFA engine uses too
6698 many states. This should prevent Vim from hanging on a combination of
6699 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006700
Bram Moolenaar64486672010-05-16 15:46:46 +02006701 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6702'relativenumber' 'rnu' boolean (default off)
6703 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006704 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006705 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006706 precede some vertical motion commands (e.g. j k + -) with, without
6707 having to calculate it yourself. Especially useful in combination with
6708 other commands (e.g. y d c < > gq gw =).
6709 When the 'n' option is excluded from 'cpoptions' a wrapped
6710 line will not use the column of line numbers (this is the default when
6711 'compatible' isn't set).
6712 The 'numberwidth' option can be used to set the room used for the line
6713 number.
6714 When a long, wrapped line doesn't start with the first character, '-'
6715 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006716 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6717 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006718
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006719 The number in front of the cursor line also depends on the value of
6720 'number', see |number_relativenumber| for all combinations of the two
6721 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006722
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 *'remap'* *'noremap'*
6724'remap' boolean (default on)
6725 global
6726 Allows for mappings to work recursively. If you do not want this for
6727 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006728 NOTE: To avoid portability problems with Vim scripts, always keep
6729 this option at the default "on". Only switch it off when working with
6730 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731
zeertzjqd086b8f2024-02-25 15:42:52 +08006732 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006733'renderoptions' 'rop' string (default: empty)
6734 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006735 {only available when compiled with GUI and DIRECTX on
6736 MS-Windows}
6737 Select a text renderer and set its options. The options depend on the
6738 renderer.
6739
6740 Syntax: >
6741 set rop=type:{renderer}(,{name}:{value})*
6742<
6743 Currently, only one optional renderer is available.
6744
6745 render behavior ~
6746 directx Vim will draw text using DirectX (DirectWrite). It makes
6747 drawn glyphs more beautiful than default GDI.
6748 It requires 'encoding' is "utf-8", and only works on
6749 MS-Windows Vista or newer version.
6750
6751 Options:
6752 name meaning type value ~
6753 gamma gamma float 1.0 - 2.2 (maybe)
6754 contrast enhancedContrast float (unknown)
6755 level clearTypeLevel float (unknown)
6756 geom pixelGeometry int 0 - 2 (see below)
6757 renmode renderingMode int 0 - 6 (see below)
6758 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006759 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006760
Bram Moolenaar92467d32017-12-05 13:22:16 +01006761 See this URL for detail (except for scrlines):
6762 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006763
6764 For geom: structure of a device pixel.
6765 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6766 1 - DWRITE_PIXEL_GEOMETRY_RGB
6767 2 - DWRITE_PIXEL_GEOMETRY_BGR
6768
6769 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006770 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006771
6772 For renmode: method of rendering glyphs.
6773 0 - DWRITE_RENDERING_MODE_DEFAULT
6774 1 - DWRITE_RENDERING_MODE_ALIASED
6775 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6776 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6777 4 - DWRITE_RENDERING_MODE_NATURAL
6778 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6779 6 - DWRITE_RENDERING_MODE_OUTLINE
6780
6781 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006782 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006783
6784 For taamode: antialiasing mode used for drawing text.
6785 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6786 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6787 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6788 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6789
6790 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006791 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6792
Bram Moolenaara338adc2018-01-31 20:51:47 +01006793 For scrlines:
6794 This was used for optimizing scrolling behavior, however this
6795 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006796
6797 Example: >
6798 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006799 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006800 set rop=type:directx
6801<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006802 If select a raster font (Courier, Terminal or FixedSys which
6803 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006804 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006805
6806 NOTE: It is known that some fonts and options combination
6807 causes trouble on drawing glyphs.
6808
Bram Moolenaar92467d32017-12-05 13:22:16 +01006809 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006810 special made fonts (True-Type fonts which includes only
6811 bitmap glyphs).
6812 - 'taamode:3' will not work with some vector fonts.
6813
6814 NOTE: With this option, you can display colored emoji
6815 (emoticon) in Windows 8.1 or later. To display colored emoji,
6816 there are some conditions which you should notice.
6817
6818 - If your font includes non-colored emoji already, it will
6819 be used.
6820 - If your font doesn't have emoji, the system chooses an
6821 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6822 will be used.
6823 - When this alternative font didn't have fixed width glyph,
6824 emoji might be rendered beyond the bounding box of drawing
6825 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006826
6827 Other render types are currently not supported.
6828
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 *'report'*
6830'report' number (default 2)
6831 global
6832 Threshold for reporting number of lines changed. When the number of
6833 changed lines is more than 'report' a message will be given for most
6834 ":" commands. If you want it always, set 'report' to 0.
6835 For the ":substitute" command the number of substitutions is used
6836 instead of the number of lines.
6837
6838 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6839'restorescreen' 'rs' boolean (default on)
6840 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006841 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 When set, the screen contents is restored when exiting Vim. This also
6843 happens when executing external commands.
6844
6845 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6846 options in your .vimrc. To disable restoring:
6847 set t_ti= t_te=
6848 To enable restoring (for an xterm):
6849 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6850 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6851
6852 *'revins'* *'ri'* *'norevins'* *'nori'*
6853'revins' 'ri' boolean (default off)
6854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 {only available when compiled with the |+rightleft|
6856 feature}
6857 Inserting characters in Insert mode will work backwards. See "typing
6858 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6859 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006860 NOTE: This option is reset when 'compatible' is set.
6861 This option is reset when 'paste' is set and restored when 'paste' is
6862 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863
6864 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6865'rightleft' 'rl' boolean (default off)
6866 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 {only available when compiled with the |+rightleft|
6868 feature}
6869 When on, display orientation becomes right-to-left, i.e., characters
6870 that are stored in the file appear from the right to the left.
6871 Using this option, it is possible to edit files for languages that
6872 are written from the right to the left such as Hebrew and Arabic.
6873 This option is per window, so it is possible to edit mixed files
6874 simultaneously, or to view the same file in both ways (this is
6875 useful whenever you have a mixed text file with both right-to-left
6876 and left-to-right strings so that both sets are displayed properly
6877 in different windows). Also see |rileft.txt|.
6878
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006879 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880'rightleftcmd' 'rlc' string (default "search")
6881 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 {only available when compiled with the |+rightleft|
6883 feature}
6884 Each word in this option enables the command line editing to work in
6885 right-to-left mode for a group of commands:
6886
6887 search "/" and "?" commands
6888
6889 This is useful for languages such as Hebrew, Arabic and Farsi.
6890 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6891
Bram Moolenaard94464e2015-11-02 15:28:18 +01006892 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006893'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006894 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006895 {only available when compiled with the |+ruby/dyn|
6896 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006897 Specifies the name of the Ruby shared library. The default is
6898 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006899 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006900 This option cannot be set from a |modeline| or in the |sandbox|, for
6901 security reasons.
6902
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006904'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006907 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 text in the file is shown on the far right:
6909 Top first line is visible
6910 Bot last line is visible
6911 All first and last line are visible
6912 45% relative position in the file
6913 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006914 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006915 ruler is shown there. Otherwise it is shown in the last line of the
6916 screen. If the statusline is given by 'statusline' (i.e. not empty),
6917 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006919 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 the text column (byte number) and the screen column are shown,
6921 separated with a dash.
6922 For an empty line "0-1" is shown.
6923 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006924 This option is reset when 'paste' is set and restored when 'paste' is
6925 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 If you don't want to see the ruler all the time but want to know where
6927 you are, use "g CTRL-G" |g_CTRL-G|.
6928 NOTE: This option is reset when 'compatible' is set.
6929
6930 *'rulerformat'* *'ruf'*
6931'rulerformat' 'ruf' string (default empty)
6932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 {not available when compiled without the |+statusline|
6934 feature}
6935 When this option is not empty, it determines the content of the ruler
6936 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006937 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006938 This option cannot be set in a modeline when 'modelineexpr' is off.
6939
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 The default ruler width is 17 characters. To make the ruler 15
6941 characters wide, put "%15(" at the start and "%)" at the end.
6942 Example: >
6943 :set rulerformat=%15(%c%V\ %p%%%)
6944<
6945 *'runtimepath'* *'rtp'* *vimfiles*
6946'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006947 Unix: "$HOME/.vim or
6948 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 $VIM/vimfiles,
6950 $VIMRUNTIME,
6951 $VIM/vimfiles/after,
6952 $HOME/.vim/after"
6953 Amiga: "home:vimfiles,
6954 $VIM/vimfiles,
6955 $VIMRUNTIME,
6956 $VIM/vimfiles/after,
6957 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006958 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 $VIM/vimfiles,
6960 $VIMRUNTIME,
6961 $VIM/vimfiles/after,
6962 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006963 Haiku: "$BE_USER_SETTINGS/vim,
6964 $VIM/vimfiles,
6965 $VIMRUNTIME,
6966 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006967 $BE_USER_SETTINGS/vim/after"
6968 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 $VIM/vimfiles,
6970 $VIMRUNTIME,
6971 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006972 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 This is a list of directories which will be searched for runtime
6975 files:
6976 filetype.vim filetypes by file name |new-filetype|
6977 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006978 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 colors/ color scheme files |:colorscheme|
6980 compiler/ compiler files |:compiler|
6981 doc/ documentation |write-local-help|
6982 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006983 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 indent/ indent scripts |indent-expression|
6985 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006986 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006988 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 plugin/ plugin scripts |write-plugin|
6990 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006991 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 syntax/ syntax files |mysyntaxfile|
6993 tutor/ files for vimtutor |tutor|
6994
6995 And any other file searched for with the |:runtime| command.
6996
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006997 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6998
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 The defaults for most systems are setup to search five locations:
7000 1. In your home directory, for your personal preferences.
7001 2. In a system-wide Vim directory, for preferences from the system
7002 administrator.
7003 3. In $VIMRUNTIME, for files distributed with Vim.
7004 *after-directory*
7005 4. In the "after" directory in the system-wide Vim directory. This is
7006 for the system administrator to overrule or add to the distributed
7007 defaults (rarely needed)
7008 5. In the "after" directory in your home directory. This is for
7009 personal preferences to overrule or add to the distributed defaults
7010 or system-wide settings (rarely needed).
7011
Bram Moolenaard0796902016-09-16 20:02:31 +02007012 More entries are added when using |packages|. If it gets very long
7013 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7014 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007015
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7017 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007018 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 wildcards.
7020 See |:runtime|.
7021 Example: >
7022 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7023< This will use the directory "~/vimruntime" first (containing your
7024 personal Vim runtime files), then "/mygroup/vim" (shared between a
7025 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7026 files).
7027 You probably should always include $VIMRUNTIME somewhere, to use the
7028 distributed runtime files. You can put a directory before $VIMRUNTIME
7029 to find files which replace a distributed runtime files. You can put
7030 a directory after $VIMRUNTIME to find files which add to distributed
7031 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007032 When Vim is started with |--clean| the home directory entries are not
7033 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 This option cannot be set from a |modeline| or in the |sandbox|, for
7035 security reasons.
7036
7037 *'scroll'* *'scr'*
7038'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007039 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7041 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007042 changes. This may happen when enabling the |status-line| or
7043 'tabline' option after setting the 'scroll' option.
7044 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007045 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007046 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047
7048 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7049'scrollbind' 'scb' boolean (default off)
7050 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007051 See also |scroll-binding|. When this option is set, scrolling the
7052 current window also scrolls other scrollbind windows (windows that
7053 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 differences between two versions of a file, see 'diff'.
7055 See |'scrollopt'| for options that determine how this option should be
7056 interpreted.
7057 This option is mostly reset when splitting a window to edit another
7058 file. This means that ":split | edit file" results in two windows
7059 with scroll-binding, but ":split file" does not.
7060
Bram Moolenaarae20f342019-11-05 21:09:23 +01007061 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7062'scrollfocus' 'scf' boolean (default off)
7063 global
7064 {only for MS-Windows GUI}
7065 When using the scroll wheel and this option is set, the window under
7066 the mouse pointer is scrolled. With this option off the current
7067 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007068 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007069
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 *'scrolljump'* *'sj'*
7071'scrolljump' 'sj' number (default 1)
7072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 Minimal number of lines to scroll when the cursor gets off the
7074 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7075 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007076 When set to a negative number from -1 to -100 this is used as the
7077 percentage of the window height. Thus -50 scrolls half the window
7078 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 NOTE: This option is set to 1 when 'compatible' is set.
7080
7081 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007082'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007083 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 Minimal number of screen lines to keep above and below the cursor.
7085 This will make some context visible around where you are working. If
7086 you set it to a very large value (999) the cursor line will always be
7087 in the middle of the window (except at the start or end of the file or
7088 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007089 After using the local value, go back the global value with one of
7090 these two: >
7091 setlocal scrolloff<
7092 setlocal scrolloff=-1
7093< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 NOTE: This option is set to 0 when 'compatible' is set.
7095
7096 *'scrollopt'* *'sbo'*
7097'scrollopt' 'sbo' string (default "ver,jump")
7098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007100 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7101 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 The following words are available:
7103 ver Bind vertical scrolling for 'scrollbind' windows
7104 hor Bind horizontal scrolling for 'scrollbind' windows
7105 jump Applies to the offset between two windows for vertical
7106 scrolling. This offset is the difference in the first
7107 displayed line of the bound windows. When moving
7108 around in a window, another 'scrollbind' window may
7109 reach a position before the start or after the end of
7110 the buffer. The offset is not changed though, when
7111 moving back the 'scrollbind' window will try to scroll
7112 to the desired position when possible.
7113 When now making that window the current one, two
7114 things can be done with the relative offset:
7115 1. When "jump" is not included, the relative offset is
7116 adjusted for the scroll position in the new current
7117 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007118 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 2. When "jump" is included, the other windows are
7120 scrolled to keep the same relative offset. When
7121 going back to the other window, it still uses the
7122 same relative offset.
7123 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007124 When 'diff' mode is active there always is vertical scroll binding,
7125 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126
7127 *'sections'* *'sect'*
7128'sections' 'sect' string (default "SHNHH HUnhsh")
7129 global
7130 Specifies the nroff macros that separate sections. These are pairs of
7131 two letters (See |object-motions|). The default makes a section start
7132 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7133
7134 *'secure'* *'nosecure'* *E523*
7135'secure' boolean (default off)
7136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 When on, ":autocmd", shell and write commands are not allowed in
7138 ".vimrc" and ".exrc" in the current directory and map commands are
7139 displayed. Switch it off only if you know that you will not run into
7140 problems, or when the 'exrc' option is off. On Unix this option is
7141 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007142 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 'secure' at the end of your ~/.vimrc then.
7144 This option cannot be set from a |modeline| or in the |sandbox|, for
7145 security reasons.
7146
7147 *'selection'* *'sel'*
7148'selection' 'sel' string (default "inclusive")
7149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 This option defines the behavior of the selection. It is only used
7151 in Visual and Select mode.
7152 Possible values:
7153 value past line inclusive ~
7154 old no yes
7155 inclusive yes yes
7156 exclusive yes no
7157 "past line" means that the cursor is allowed to be positioned one
7158 character past the line.
7159 "inclusive" means that the last character of the selection is included
7160 in an operation. For example, when "x" is used to delete the
7161 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007162 When "old" is used and 'virtualedit' allows the cursor to move past
7163 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007164 When "exclusive" is used, cursor position in visual mode will be
7165 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 Note that when "exclusive" is used and selecting from the end
7167 backwards, you cannot include the last character of a line, when
7168 starting in Normal mode and 'virtualedit' empty.
7169
7170 The 'selection' option is set by the |:behave| command.
7171
7172 *'selectmode'* *'slm'*
7173'selectmode' 'slm' string (default "")
7174 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007175 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 Select mode instead of Visual mode, when a selection is started.
7177 Possible values:
7178 mouse when using the mouse
7179 key when using shifted special keys
7180 cmd when using "v", "V" or CTRL-V
7181 See |Select-mode|.
7182 The 'selectmode' option is set by the |:behave| command.
7183
7184 *'sessionoptions'* *'ssop'*
7185'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007186 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007188 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 feature}
7190 Changes the effect of the |:mksession| command. It is a comma
7191 separated list of words. Each word enables saving and restoring
7192 something:
7193 word save and restore ~
7194 blank empty windows
7195 buffers hidden and unloaded buffers, not just those in windows
7196 curdir the current directory
7197 folds manually created folds, opened/closed folds and local
7198 fold options
7199 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007200 and contain at least one lowercase letter. Only
7201 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 help the help window
7203 localoptions options and mappings local to a window or buffer (not
7204 global values for local options)
7205 options all options and mappings (also global values for local
7206 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007207 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 resize size of the Vim window: 'lines' and 'columns'
7209 sesdir the directory in which the session file is located
7210 will become the current directory (useful with
7211 projects accessed over a network from different
7212 systems)
7213 slash backslashes in file names replaced with forward
7214 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007215 tabpages all tab pages; without this only the current tab page
7216 is restored, so that you can make a session for each
7217 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007218 terminal include terminal windows where the command can be
7219 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 unix with Unix end-of-line format (single <NL>), even when
7221 on Windows or DOS
7222 winpos position of the whole Vim window
7223 winsize window sizes
7224
7225 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007226 When neither "curdir" nor "sesdir" is included, file names are stored
7227 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007228 If you leave out "options" many things won't work well after restoring
7229 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 "slash" and "unix" are useful on Windows when sharing session files
7231 with Unix. The Unix version of Vim cannot source dos format scripts,
7232 but the Windows version of Vim can source unix format scripts.
7233
7234 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007235'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 global
7237 Name of the shell to use for ! and :! commands. When changing the
7238 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7239 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007240 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 See |option-backslash| about including spaces and backslashes.
7242 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007243
Bram Moolenaara2baa732022-02-04 16:09:54 +00007244 In |restricted-mode| shell commands will not be possible. This mode
7245 is used if the value of $SHELL ends in "false" or "nologin".
7246
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007247 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007248 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7250< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007251 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007253 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007255 Example with escaped space (Vim will do this when initializing the
7256 option from $SHELL): >
7257 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007258< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007259 backslashes are consumed by `:set`.
7260
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 Under MS-Windows, when the executable ends in ".com" it must be
7262 included. Thus setting the shell to "command.com" or "4dos.com"
7263 works, but "command" and "4dos" do not work for all commands (e.g.,
7264 filtering).
7265 For unknown reasons, when using "4dos.com" the current directory is
7266 changed to "C:\". To avoid this set 'shell' like this: >
7267 :set shell=command.com\ /c\ 4dos
7268< This option cannot be set from a |modeline| or in the |sandbox|, for
7269 security reasons.
7270
7271 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007272'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007273 Win32, when 'shell' contains "powershell":
7274 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007275 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007278 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7279 For MS-Windows, the default is set according to the value of 'shell',
7280 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007281 On Unix it can have more than one flag. Each white space separated
7282 part is passed as an argument to the shell command.
7283 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007284 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 This option cannot be set from a |modeline| or in the |sandbox|, for
7286 security reasons.
7287
7288 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007289'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7290 "2>&1| tee", or
7291 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 {not available when compiled without the |+quickfix|
7294 feature}
7295 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007296 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 including spaces and backslashes.
7298 The name of the temporary file can be represented by "%s" if necessary
7299 (the file name is appended automatically if no %s appears in the value
7300 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007301 For the Amiga the default is ">". For MS-Windows using powershell the
7302 default is "2>&1 | Out-File -Encoding default", otherwise the default
7303 is ">%s 2>&1". The output is directly saved in a file and not echoed
7304 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007305 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 in a file and echoed to the screen. If the 'shell' option is "csh" or
7307 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007308 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007309 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7310 means that stderr is also included. Before using the 'shell' option a
7311 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007312 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7313 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 The initialization of this option is done after reading the ".vimrc"
7315 and the other initializations, so that when the 'shell' option is set
7316 there, the 'shellpipe' option changes automatically, unless it was
7317 explicitly set before.
7318 When 'shellpipe' is set to an empty string, no redirection of the
7319 ":make" output will be done. This is useful if you use a 'makeprg'
7320 that writes to 'makeef' by itself. If you want no piping, but do
7321 want to include the 'makeef', set 'shellpipe' to a single space.
7322 Don't forget to precede the space with a backslash: ":set sp=\ ".
7323 In the future pipes may be used for filtering and this option will
7324 become obsolete (at least for Unix).
7325 This option cannot be set from a |modeline| or in the |sandbox|, for
7326 security reasons.
7327
7328 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007329'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 Quoting character(s), put around the command passed to the shell, for
7332 the "!" and ":!" commands. The redirection is kept outside of the
7333 quoting. See 'shellxquote' to include the redirection. It's
7334 probably not useful to set both options.
7335 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007336 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007337 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 This option cannot be set from a |modeline| or in the |sandbox|, for
7339 security reasons.
7340
7341 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007342'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7343 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 String to be used to put the output of a filter command in a temporary
7346 file. See also |:!|. See |option-backslash| about including spaces
7347 and backslashes.
7348 The name of the temporary file can be represented by "%s" if necessary
7349 (the file name is appended automatically if no %s appears in the value
7350 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007351 The default is ">". For Unix, if the 'shell' option is "csh" or
7352 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007353 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007354 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7355 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007356 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7357 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007358 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7359 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 The initialization of this option is done after reading the ".vimrc"
7361 and the other initializations, so that when the 'shell' option is set
7362 there, the 'shellredir' option changes automatically unless it was
7363 explicitly set before.
7364 In the future pipes may be used for filtering and this option will
7365 become obsolete (at least for Unix).
7366 This option cannot be set from a |modeline| or in the |sandbox|, for
7367 security reasons.
7368
7369 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7370'shellslash' 'ssl' boolean (default off)
7371 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007372 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007374 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007375 powershell.exe. Backward slashes can still be typed, but they are
7376 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 Note that setting or resetting this option has no effect for some
7378 existing file names, thus this option needs to be set before opening
7379 any file for best results. This might change in the future.
7380 'shellslash' only works when a backslash can be used as a path
7381 separator. To test if this is so use: >
7382 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007383< Also see 'completeslash'.
7384
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007385 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7386'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7387 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007388 When on, use temp files for shell commands. When off use a pipe.
7389 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007390 Currently a pipe is only supported on Unix and MS-Windows 2K and
7391 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007392 :if has("filterpipe")
7393< The advantage of using a pipe is that nobody can read the temp file
7394 and the 'shell' command does not need to support redirection.
7395 The advantage of using a temp file is that the file type and encoding
7396 can be detected.
7397 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7398 |FilterWritePost| autocommands event are not triggered when
7399 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007400 The `system()` function does not respect this option and always uses
7401 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007402 NOTE: This option is set to the Vim default value when 'compatible'
7403 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007404
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 *'shelltype'* *'st'*
7406'shelltype' 'st' number (default 0)
7407 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007408 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 On the Amiga this option influences the way how the commands work
7410 which use a shell.
7411 0 and 1: always use the shell
7412 2 and 3: use the shell only to filter lines
7413 4 and 5: use shell only for ':sh' command
7414 When not using the shell, the command is executed directly.
7415
7416 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7417 1 and 3: use "shell cmd" to start external commands
7418
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007419 *'shellxescape'* *'sxe'*
7420'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007421 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007422 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007423 When 'shellxquote' is set to "(" then the characters listed in this
7424 option will be escaped with a '^' character. This makes it possible
7425 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007426 This option cannot be set from a |modeline| or in the |sandbox|, for
7427 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007428
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 *'shellxquote'* *'sxq'*
7430'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007431 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007432 for Win32, when 'shell' is
7433 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007434 for Win32, when 'shell' contains "sh"
7435 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 for Unix, when using system(): "\"")
7437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 Quoting character(s), put around the command passed to the shell, for
7439 the "!" and ":!" commands. Includes the redirection. See
7440 'shellquote' to exclude the redirection. It's probably not useful
7441 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007442 When the value is '(' then ')' is appended. When the value is '"('
7443 then ')"' is appended.
7444 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007445 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007446 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7447 pwsh.exe which automatically strips off the first and last quote on a
7448 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7449 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007450 'shell', to reduce the need to set this option by the user. See
7451 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 This option cannot be set from a |modeline| or in the |sandbox|, for
7453 security reasons.
7454
7455 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7456'shiftround' 'sr' boolean (default off)
7457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 Round indent to multiple of 'shiftwidth'. Applies to > and <
7459 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7460 a multiple of 'shiftwidth' (this is Vi compatible).
7461 NOTE: This option is reset when 'compatible' is set.
7462
7463 *'shiftwidth'* *'sw'*
7464'shiftwidth' 'sw' number (default 8)
7465 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007466 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007468 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007469 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470
7471 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007472'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7473 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007474 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007476 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 It is a list of flags:
7478 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007479 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7480 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7481 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7482 m use "[+]" instead of "[Modified]" *shm-m*
7483 n use "[New]" instead of "[New File]" *shm-n*
7484 r use "[RO]" instead of "[readonly]" *shm-r*
7485 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007487 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7488 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007489 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007490 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007492 o overwrite message for writing a file with subsequent *shm-o*
7493 message for reading a file (useful for ":wn" or when
7494 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007495 O message for reading a file overwrites any previous *shm-O*
7496 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007497 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7498 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007499 the search count do not show "W" before the count message
7500 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007501 t truncate file message at the start if it is too long *shm-t*
7502 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007503 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007504 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007505 long to fit on the command line; "..." will appear in the
7506 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007507 W don't give "written" or "[w]" when writing a file *shm-W*
7508 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007509 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007510 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007511 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007512 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007513 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7514 match", "Pattern not found", "Back at original", etc.
7515 C don't give messages while scanning for ins-completion *shm-C*
7516 items, for instance "scanning tags"
7517 q use "recording" instead of "recording @a" *shm-q*
7518 F don't give the file info when editing a file, like *shm-F*
7519 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007520 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007521 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007522 "[1/5]". When the "S" flag is not present (e.g. search count
7523 is shown), the "search hit BOTTOM, continuing at TOP" and
7524 "search hit TOP, continuing at BOTTOM" messages are only
7525 indicated by a "W" (Mnemonic: Wrapped) letter before the
7526 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527
7528 This gives you the opportunity to avoid that a change between buffers
7529 requires you to hit <Enter>, but still gives as useful a message as
7530 possible for the space available. To get the whole message that you
7531 would have got with 'shm' empty, use ":file!"
7532 Useful values:
7533 shm= No abbreviation of message.
7534 shm=a Abbreviation, but no loss of information.
7535 shm=at Abbreviation, and truncate message when necessary.
7536
7537 NOTE: This option is set to the Vi default value when 'compatible' is
7538 set and to the Vim default value when 'compatible' is reset.
7539
7540 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7541'shortname' 'sn' boolean (default off)
7542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 Filenames are assumed to be 8 characters plus one extension of 3
7544 characters. Multiple dots in file names are not allowed. When this
7545 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007546 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007548 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549
7550 *'showbreak'* *'sbr'* *E595*
7551'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007552 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007553 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 feature}
7555 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007556 values are "> " or "+++ ": >
7557 :set showbreak=>\
7558< Note the backslash to escape the trailing space. It's easier like
7559 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007560 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007561< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 comma (in a future version the comma might be used to separate the
7563 part that is shown at the end and at the start of a line).
7564 The characters are highlighted according to the '@' flag in
7565 'highlight'.
7566 Note that tabs after the showbreak will be displayed differently.
7567 If you want the 'showbreak' to appear in between line numbers, add the
7568 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007569 A window-local value overrules a global value. If the global value is
7570 set and you want no value in the current window use NONE: >
7571 :setlocal showbreak=NONE
7572<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007574'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7575 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007577 Show (partial) command in the last line of the screen. Set this
7578 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 In Visual mode the size of the selected area is shown:
7580 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007581 If the number of bytes is different it is also displayed: "2-6"
7582 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007584 - When selecting a block, the size in screen characters:
7585 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007586 This information can be displayed in an alternative location using the
7587 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 NOTE: This option is set to the Vi default value when 'compatible' is
7589 set and to the Vim default value when 'compatible' is reset.
7590
Luuk van Baalba936f62022-12-15 13:15:39 +00007591 *'showcmdloc'* *'sloc'*
7592'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007593 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007594 This option can be used to display the (partially) entered command in
7595 another location. Possible values are:
7596 last Last line of the screen (default).
7597 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007598 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007599 Setting this option to "statusline" or "tabline" means that these will
7600 be redrawn whenever the command changes, which can be on every key
7601 pressed.
7602 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7603 place the text. Without a custom 'statusline' or 'tabline' it will be
7604 displayed in a convenient location.
7605
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7607'showfulltag' 'sft' boolean (default off)
7608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 When completing a word in insert mode (see |ins-completion|) from the
7610 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 matched a C function, you can see a template for what arguments are
7613 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007614 Note that this doesn't work well together with having "longest" in
7615 'completeopt', because the completion from the search pattern may not
7616 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617
7618 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7619'showmatch' 'sm' boolean (default off)
7620 global
7621 When a bracket is inserted, briefly jump to the matching one. The
7622 jump is only done if the match can be seen on the screen. The time to
7623 show the match can be set with 'matchtime'.
7624 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007625 seen or not).
7626 This option is reset when 'paste' is set and restored when 'paste' is
7627 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 When the 'm' flag is not included in 'cpoptions', typing a character
7629 will immediately move the cursor back to where it belongs.
7630 See the "sm" field in 'guicursor' for setting the cursor shape and
7631 blinking when showing the match.
7632 The 'matchpairs' option can be used to specify the characters to show
7633 matches for. 'rightleft' and 'revins' are used to look for opposite
7634 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007635 Also see the matchparen plugin for highlighting the match when moving
7636 around |pi_paren.txt|.
7637 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638
7639 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7640'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7641 global
7642 If in Insert, Replace or Visual mode put a message on the last line.
7643 Use the 'M' flag in 'highlight' to set the type of highlighting for
7644 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007645 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 doesn't mean XIM is really active, especially when 'imactivatekey' is
7647 not set.
7648 NOTE: This option is set to the Vi default value when 'compatible' is
7649 set and to the Vim default value when 'compatible' is reset.
7650
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007651 *'showtabline'* *'stal'*
7652'showtabline' 'stal' number (default 1)
7653 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007654 The value of this option specifies when the line with tab page labels
7655 will be displayed:
7656 0: never
7657 1: only if there are at least two tab pages
7658 2: always
7659 This is both for the GUI and non-GUI implementation of the tab pages
7660 line.
7661 See |tab-page| for more information about tab pages.
7662
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 *'sidescroll'* *'ss'*
7664'sidescroll' 'ss' number (default 0)
7665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 The minimal number of columns to scroll horizontally. Used only when
7667 the 'wrap' option is off and the cursor is moved off of the screen.
7668 When it is zero the cursor will be put in the middle of the screen.
7669 When using a slow terminal set it to a large number or 0. When using
7670 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7671 commands.
7672
7673 *'sidescrolloff'* *'siso'*
7674'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007675 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007677 right of the cursor if 'nowrap' is set. Setting this option to a
7678 value greater than 0 while having |'sidescroll'| also at a non-zero
7679 value makes some context visible in the line you are scrolling in
7680 horizontally (except at beginning of the line). Setting this option
7681 to a large value (like 999) has the effect of keeping the cursor
7682 horizontally centered in the window, as long as one does not come too
7683 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007684 After using the local value, go back the global value with one of
7685 these two: >
7686 setlocal sidescrolloff<
7687 setlocal sidescrolloff=-1
7688< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689
7690 Example: Try this together with 'sidescroll' and 'listchars' as
7691 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007692 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693
7694 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7695 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007696<
7697 *'signcolumn'* *'scl'*
7698'signcolumn' 'scl' string (default "auto")
7699 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007700 {not available when compiled without the |+signs|
7701 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007702 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007703 "auto" only when there is a sign to display
7704 "no" never
7705 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007706 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007707 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7710'smartcase' 'scs' boolean (default off)
7711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 Override the 'ignorecase' option if the search pattern contains upper
7713 case characters. Only used when the search pattern is typed and
7714 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007715 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7717 recalling the search pattern from history and hitting <Enter>.
7718 NOTE: This option is reset when 'compatible' is set.
7719
7720 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7721'smartindent' 'si' boolean (default off)
7722 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 Do smart autoindenting when starting a new line. Works for C-like
7724 programs, but can also be used for other languages. 'cindent' does
7725 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007726 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007727 setting 'si' has no effect. 'indentexpr' is a more advanced
7728 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 Normally 'autoindent' should also be on when using 'smartindent'.
7730 An indent is automatically inserted:
7731 - After a line ending in '{'.
7732 - After a line starting with a keyword from 'cinwords'.
7733 - Before a line starting with '}' (only with the "O" command).
7734 When typing '}' as the first character in a new line, that line is
7735 given the same indent as the matching '{'.
7736 When typing '#' as the first character in a new line, the indent for
7737 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007738 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7740 When using the ">>" command, lines starting with '#' are not shifted
7741 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007742 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007743 This option is reset when 'paste' is set and restored when 'paste' is
7744 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745
7746 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7747'smarttab' 'sta' boolean (default off)
7748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007750 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7751 <BS> will delete a 'shiftwidth' worth of space at the start of the
7752 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007753 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007754 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7755 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007756 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007758 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007759 This option is reset when 'paste' is set and restored when 'paste' is
7760 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 NOTE: This option is reset when 'compatible' is set.
7762
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007763 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7764'smoothscroll' 'sms' boolean (default off)
7765 local to window
7766 Scrolling works with screen lines. When 'wrap' is set and the first
7767 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007768 above the window. "<<<" is displayed at the start of the first line,
7769 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007770 You may also want to add "lastline" to the 'display' option to show as
7771 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007772 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007773
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 *'softtabstop'* *'sts'*
7775'softtabstop' 'sts' number (default 0)
7776 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 Number of spaces that a <Tab> counts for while performing editing
7778 operations, like inserting a <Tab> or using <BS>. It "feels" like
7779 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7780 used. This is useful to keep the 'ts' setting at its standard value
7781 of 8, while being able to edit like it is set to 'sts'. However,
7782 commands like "x" still work on the actual characters.
7783 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007784 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007785 'softtabstop' is set to 0 when the 'paste' option is set and restored
7786 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7788 spaces is minimized by using <Tab>s.
7789 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7790 set.
7791 NOTE: This option is set to 0 when 'compatible' is set.
7792
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007793 If Vim is compiled with the |+vartabs| feature then the value of
7794 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7795 anything other than an empty string.
7796
Bram Moolenaar217ad922005-03-20 22:37:15 +00007797 *'spell'* *'nospell'*
7798'spell' boolean (default off)
7799 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007800 {not available when compiled without the |+syntax|
7801 feature}
7802 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007803 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007804
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007805 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007806'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007807 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007808 {not available when compiled without the |+syntax|
7809 feature}
7810 Pattern to locate the end of a sentence. The following word will be
7811 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007812 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007813 When this check is not wanted make this option empty.
7814 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007815 Be careful with special characters, see |option-backslash| about
7816 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007817 To set this option automatically depending on the language, see
7818 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007819
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007820 *'spellfile'* *'spf'*
7821'spellfile' 'spf' string (default empty)
7822 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007823 {not available when compiled without the |+syntax|
7824 feature}
7825 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007826 commands. It must end in ".{encoding}.add". You need to include the
7827 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007828 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007829 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007830 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007831 |zg| and |zw| commands can be used to access each. This allows using
7832 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007833 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007834 you: Using the first directory in 'runtimepath' that is writable. If
7835 there is no "spell" directory yet it will be created. For the file
7836 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007837 ignoring the region.
7838 The resulting ".spl" file will be used for spell checking, it does not
7839 have to appear in 'spelllang'.
7840 Normally one file is used for all regions, but you can add the region
7841 name if you want to. However, it will then only be used when
7842 'spellfile' is set to it, for entries in 'spelllang' only files
7843 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007844 This option cannot be set from a |modeline| or in the |sandbox|, for
7845 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007846
Bram Moolenaar217ad922005-03-20 22:37:15 +00007847 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007848'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007849 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007850 {not available when compiled without the |+syntax|
7851 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007852 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007853 on spellchecking will be done for these languages. Example: >
7854 set spelllang=en_us,nl,medical
7855< This means US English, Dutch and medical words are recognized. Words
7856 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007857 The word list name must consist of alphanumeric characters, a dash or
7858 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007859 recommended to separate the two letter language name from a
7860 specification. Thus "en-rare" is used for rare English words.
7861 A region name must come last and have the form "_xx", where "xx" is
7862 the two-letter, lower case region name. You can use more than one
7863 region by listing them: "en_us,en_ca" supports both US and Canadian
7864 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007865 Britain. (Note: currently en_au and en_nz dictionaries are older than
7866 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007867 If the name "cjk" is included East Asian characters are excluded from
7868 spell checking. This is useful when editing text that also has Asian
7869 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007870 Note that the "medical" dictionary does not exist, it is just an
7871 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007872 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007873 As a special case the name of a .spl file can be given as-is. The
7874 first "_xx" in the name is removed and used as the region name
7875 (_xx is an underscore, two letters and followed by a non-letter).
7876 This is mainly for testing purposes. You must make sure the correct
7877 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007878 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007879 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7880 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007881 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007882
Bram Moolenaar98692072006-02-04 00:57:42 +00007883 If the |spellfile.vim| plugin is active and you use a language name
7884 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7885 will ask you if you want to download the file.
7886
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007887 After this option has been set successfully, Vim will source the files
7888 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007889 up to the first character that is not an ASCII letter or number and
7890 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007891
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007892 *'spelloptions'* *'spo'*
7893'spelloptions' 'spo' string (default "")
7894 local to buffer
7895 {not available when compiled without the |+syntax|
7896 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007897 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007898 camel When a word is CamelCased, assume "Cased" is a
7899 separate word: every upper-case character in a word
7900 that comes after a lower case character indicates the
7901 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007902
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007903 *'spellsuggest'* *'sps'*
7904'spellsuggest' 'sps' string (default "best")
7905 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007906 {not available when compiled without the |+syntax|
7907 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007908 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007909 the |spellsuggest()| function. This is a comma-separated list of
7910 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007911
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007912 best Internal method that works best for English. Finds
7913 changes like "fast" and uses a bit of sound-a-like
7914 scoring to improve the ordering.
7915
7916 double Internal method that uses two methods and mixes the
7917 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007918 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007919 word. That only works when the language specifies
7920 sound folding. Can be slow and doesn't always give
7921 better results.
7922
7923 fast Internal method that only checks for simple changes:
7924 character inserts/deletes/swaps. Works well for
7925 simple typing mistakes.
7926
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007927 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007928 Not used for |spellsuggest()|. The number of
7929 suggestions is never more than the value of 'lines'
7930 minus two.
7931
Bram Moolenaar585ee072022-01-29 11:22:17 +00007932 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007933 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007934 methods. When omitted the limit is 5000. When
7935 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007936 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007937
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007938 file:{filename} Read file {filename}, which must have two columns,
7939 separated by a slash. The first column contains the
7940 bad word, the second column the suggested good word.
7941 Example:
7942 theribal/terrible ~
7943 Use this for common mistakes that do not appear at the
7944 top of the suggestion list with the internal methods.
7945 Lines without a slash are ignored, use this for
7946 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007947 The word in the second column must be correct,
7948 otherwise it will not be used. Add the word to an
7949 ".add" file if it is currently flagged as a spelling
7950 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007951 The file is used for all languages.
7952
7953 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007954 trouble with spaces. Best is to call a function
7955 without arguments, see |expr-option-function|.
7956 |v:val| holds the badly spelled word. The expression
7957 must evaluate to a List of Lists, each with a
7958 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007959 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007960 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007961 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007962 internal methods use. A lower score is better.
7963 This may invoke |spellsuggest()| if you temporarily
7964 set 'spellsuggest' to exclude the "expr:" part.
7965 Errors are silently ignored, unless you set the
7966 'verbose' option to a non-zero value.
7967
7968 Only one of "best", "double" or "fast" may be used. The others may
7969 appear several times in any order. Example: >
7970 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7971<
7972 This option cannot be set from a |modeline| or in the |sandbox|, for
7973 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007974
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7976'splitbelow' 'sb' boolean (default off)
7977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 When on, splitting a window will put the new window below the current
7979 one. |:split|
7980
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007981 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007982'splitkeep' 'spk' string (default "cursor")
7983 global
7984 The value of this option determines the scroll behavior when opening,
7985 closing or resizing horizontal splits.
7986
7987 Possible values are:
7988 cursor Keep the same relative cursor position.
7989 screen Keep the text on the same screen line.
7990 topline Keep the topline the same.
7991
7992 For the "screen" and "topline" values, the cursor position will be
7993 changed when necessary. In this case, the jumplist will be populated
7994 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007995 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007996
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7998'splitright' 'spr' boolean (default off)
7999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 When on, splitting a window will put the new window right of the
8001 current one. |:vsplit|
8002
8003 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8004'startofline' 'sol' boolean (default on)
8005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008007 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008008 (if possible). This applies to the commands:
8009 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008010 - "d", "<<", "==" and ">>" with a linewise operator
8011 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008012 - "%" with a count
8013 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8014 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 In case of buffer changing commands the cursor is placed at the column
8016 where it was the last time the buffer was edited.
8017 NOTE: This option is set when 'compatible' is set.
8018
Bram Moolenaar00654022011-02-25 14:42:19 +01008019 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008021 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 {not available when compiled without the |+statusline|
8023 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008024 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 Also see |status-line|.
8026
8027 The option consists of printf style '%' items interspersed with
8028 normal text. Each status line item is of the form:
8029 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008030 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008031 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008033 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008034 When the option starts with "%!" then it is used as an expression,
8035 evaluated and the result is used as the option value. Example: >
8036 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008037< The *g:statusline_winid* variable will be set to the |window-ID| of the
8038 window that the status line belongs to.
8039 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008040 Note that the "%!" expression is evaluated in the context of the
8041 current window and buffer, while %{} items are evaluated in the
8042 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008043
8044 When there is error while evaluating the option then it will be made
8045 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008046 When the result contains unprintable characters the result is
8047 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008048
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 Note that the only effect of 'ruler' when this option is set (and
8050 'laststatus' is 2) is controlling the output of |CTRL-G|.
8051
8052 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008053 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008055 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 minwid Minimum width of the item, padding as set by '-' & '0'.
8057 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008058 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 on the left for text items. Numeric items will be
8060 shifted down to maxwid-2 digits followed by '>'number
8061 where number is the amount of missing digits, much like
8062 an exponential notation.
8063 item A one letter code as described below.
8064
8065 Following is a description of the possible statusline items. The
8066 second character in "item" is the type:
8067 N for number
8068 S for string
8069 F for flags as described below
8070 - not applicable
8071
8072 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008073 f S Path to the file in the buffer, as typed or relative to current
8074 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 F S Full path to the file in the buffer.
8076 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008077 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008079 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008081 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008083 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008085 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008087 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8089 being used: "<keymap>"
8090 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008091 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 B N As above, in hexadecimal.
8093 o N Byte number in file of byte under cursor, first byte is 1.
8094 Mnemonic: Offset from start of file (with one added)
8095 {not available when compiled without |+byte_offset| feature}
8096 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008097 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 l N Line number.
8099 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008100 c N Column number (byte index).
8101 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008102 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 p N Percentage through file in lines as in |CTRL-G|.
8104 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008105 percentage described for 'ruler'. Always 3 in length, unless
8106 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008107 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008108 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008110 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008111 Note that there is no '%' before the closing '}'. The
8112 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008113 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008114 {% - This is almost same as { except the result of the expression is
8115 re-evaluated as a statusline format string. Thus if the
8116 return value of expr contains % items they will get expanded.
8117 The expression can contain the } character, the end of
8118 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008119 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008120 func! Stl_filename() abort
8121 return "%t"
8122 endfunc
8123< `stl=%{Stl_filename()}` results in `"%t"`
8124 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008125 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 ( - Start of item group. Can be used for setting the width and
8127 alignment of a section. Must be followed by %) somewhere.
8128 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008129 T N For 'tabline': start of tab page N label. Use %T after the last
8130 label. This information is used for mouse clicks.
8131 X N For 'tabline': start of close tab N label. Use %X after the
8132 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8133 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 < - Where to truncate line if too long. Default is at the start.
8135 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008136 = - Separation point between alignment sections. Each section will
8137 be separated by an equal number of spaces. With one %= what
8138 comes after it will be right-aligned. With two %= there is a
8139 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008141 # - Set highlight group. The name must follow and then a # again.
8142 Thus use %#HLname# for highlight group HLname. The same
8143 highlighting is used, also for the statusline of non-current
8144 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008146 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008147 The difference between User{N} and StatusLine will be applied to
8148 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 The number N must be between 1 and 9. See |hl-User1..9|
8150
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008151 When displaying a flag, Vim removes the leading comma, if any, when
8152 that flag comes right after plaintext. This will make a nice display
8153 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154
Bram Moolenaar582fd852005-03-28 20:58:01 +00008155 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 not set) and a minwid is not set for the group, the whole group will
8157 become empty. This will make a group like the following disappear
8158 completely from the statusline when none of the flags are set. >
8159 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008160< Beware that an expression is evaluated each and every time the status
8161 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008162 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008163 While evaluating %{} the current buffer and current window will be set
8164 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008165 currently being drawn. The expression will evaluate in this context.
8166 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8167 real current buffer and "g:actual_curwin" to the |window-ID| of the
8168 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008169
Bram Moolenaar30b65812012-07-12 22:01:11 +02008170 The 'statusline' option will be evaluated in the |sandbox| if set from
8171 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008172 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008173
8174 It is not allowed to change text or jump to another window while
8175 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176
8177 If the statusline is not updated when you want it (e.g., after setting
8178 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008179 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008181 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 Otherwise the result is taken as flag text and applied to the rules
8183 described above.
8184
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008185 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008187 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188
8189 Examples:
8190 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008191 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192< Similar, but add ASCII value of char under the cursor (like "ga") >
8193 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8194< Display byte count and byte value, modified flag in red. >
8195 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8196 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8197< Display a ,GZ flag if a compressed file is loaded >
8198 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8199< In the |:autocmd|'s: >
8200 :let b:gzflag = 1
8201< And: >
8202 :unlet b:gzflag
8203< And define this function: >
8204 :function VarExists(var, val)
8205 : if exists(a:var) | return a:val | else | return '' | endif
8206 :endfunction
8207<
8208 *'suffixes'* *'su'*
8209'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 Files with these suffixes get a lower priority when multiple files
8212 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008213 suffixes. Spaces after the comma are ignored. A dot is also seen as
8214 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 separator, precede it with a backslash (see |option-backslash| about
8216 including spaces and backslashes).
8217 See 'wildignore' for completely ignoring files.
8218 The use of |:set+=| and |:set-=| is preferred when adding or removing
8219 suffixes from the list. This avoids problems when a future version
8220 uses another default.
8221
8222 *'suffixesadd'* *'sua'*
8223'suffixesadd' 'sua' string (default "")
8224 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008225 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 file for the "gf", "[I", etc. commands. Example: >
8227 :set suffixesadd=.java
8228<
8229 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8230'swapfile' 'swf' boolean (default on)
8231 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008232 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 swapfile is not wanted for a specific buffer. For example, with
8234 confidential information that even root must not be able to access.
8235 Careful: All text will be in memory:
8236 - Don't use this for big files.
8237 - Recovery will be impossible!
8238 A swapfile will only be present when |'updatecount'| is non-zero and
8239 'swapfile' is set.
8240 When 'swapfile' is reset, the swap file for the current buffer is
8241 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8242 non-zero, a swap file is immediately created.
8243 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008244 If you want to open a new buffer without creating a swap file for it,
8245 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008246 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247
8248 This option is used together with 'bufhidden' and 'buftype' to
8249 specify special kinds of buffers. See |special-buffers|.
8250
8251 *'swapsync'* *'sws'*
8252'swapsync' 'sws' string (default "fsync")
8253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008255 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 When this option is empty parts of the swap file may be in memory and
8257 not written to disk. When the system crashes you may lose more work.
8258 On Unix the system does a sync now and then without Vim asking for it,
8259 so the disadvantage of setting this option off is small. On some
8260 systems the swap file will not be written at all. For a unix system
8261 setting it to "sync" will use the sync() call instead of the default
8262 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008263 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264
8265 *'switchbuf'* *'swb'*
8266'switchbuf' 'swb' string (default "")
8267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008269 This option is checked, when
8270 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008271 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008272 - jumping to a tag using the |:stag| command.
8273 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8274 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8275 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008276 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008277 useopen If included, jump to the first open window in the
8278 current tab page that contains the specified buffer
8279 (if there is one). Otherwise: Do not examine other
8280 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008281 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008282 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008284 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008285 Otherwise: do not split, use current window (when used
8286 in the quickfix window: the previously used window or
8287 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008288 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008289 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008290 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008291 uselast If included, jump to the previously used window when
8292 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008293 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8294 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008296 *'synmaxcol'* *'smc'*
8297'synmaxcol' 'smc' number (default 3000)
8298 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008299 {not available when compiled without the |+syntax|
8300 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008301 Maximum column in which to search for syntax items. In long lines the
8302 text after this column is not highlighted and following lines may not
8303 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008304 This helps to avoid very slow redrawing for an XML file that is one
8305 long line.
8306 Set to zero to remove the limit.
8307
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 *'syntax'* *'syn'*
8309'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008310 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 {not available when compiled without the |+syntax|
8312 feature}
8313 When this option is set, the syntax with this name is loaded, unless
8314 syntax highlighting has been switched off with ":syntax off".
8315 Otherwise this option does not always reflect the current syntax (the
8316 b:current_syntax variable does).
8317 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008318 not automatically recognized. Example, in an IDL file:
8319 /* vim: set syntax=idl : */ ~
8320 When a dot appears in the value then this separates two filetype
8321 names. Example:
8322 /* vim: set syntax=c.doxygen : */ ~
8323 This will use the "c" syntax first, then the "doxygen" syntax.
8324 Note that the second one must be prepared to be loaded as an addition,
8325 otherwise it will be skipped. More than one dot may appear.
8326 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 :set syntax=OFF
8328< To switch syntax highlighting on according to the current value of the
8329 'filetype' option: >
8330 :set syntax=ON
8331< What actually happens when setting the 'syntax' option is that the
8332 Syntax autocommand event is triggered with the value as argument.
8333 This option is not copied to another buffer, independent of the 's' or
8334 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008335 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336
LemonBoy5247b0b2024-07-12 19:30:58 +02008337 *'tabclose'* *'tcl'*
8338'tabclose' 'tcl' string (default "")
8339 global
8340 This option controls the behavior when closing tab pages (e.g., using
8341 |:tabclose|). When empty Vim goes to the next (right) tab page.
8342
8343 Possible values (comma-separated list):
8344 left If included, go to the previous tab page instead of
8345 the next one.
8346 uselast If included, go to the previously used tab page if
8347 possible. This option takes precedence over the
8348 others.
8349
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008350 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008351'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008352 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008353 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008354 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008355 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008356
8357 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008358 option and only when there is no GUI tab line. When 'e' is in
8359 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008360 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008361
8362 The value is evaluated like with 'statusline'. You can use
8363 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008364 the text to be displayed. Use "%1T" for the first label, "%2T" for
8365 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008366
Bram Moolenaare12bab32019-01-08 22:02:56 +01008367 When changing something that is used in 'tabline' that does not
8368 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008369 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008370
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008371 Keep in mind that only one of the tab pages is the current one, others
8372 are invisible and you can't jump to their windows.
8373
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008374 *'tabpagemax'* *'tpm'*
8375'tabpagemax' 'tpm' number (default 10)
8376 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008377 Maximum number of tab pages to be opened by the |-p| command line
8378 argument or the ":tab all" command. |tabpage|
8379
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008380 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381'tabstop' 'ts' number (default 8)
8382 local to buffer
8383 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008384 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385
8386 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008387 appear wrong in many places, e.g., when printing it.
8388 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008390 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8392 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008393 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008395 This is the recommended way, the file will look the same with other
8396 tools and when listing it in a terminal.
8397 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8398 'expandtab'. This way you will always insert spaces. The
8399 formatting will never be messed up when 'tabstop' is changed (leave
8400 it at 8 just in case). The file will be a bit larger.
8401 You do need to check if no Tabs exist in the file. You can get rid
8402 of them by first setting 'expandtab' and using `%retab!`, making
8403 sure the value of 'tabstop' is set correctly.
8404 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 'expandtab'. This way you will always insert spaces. The
8406 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008407 You do need to check if no Tabs exist in the file, just like in the
8408 item just above.
8409 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008410 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008411 works when using Vim to edit the file, other tools assume a tabstop
8412 is worth 8 spaces.
8413 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 'noexpandtab'. This should then work (for initial indents only)
8415 for any tabstop setting that people use. It might be nice to have
8416 tabs after the first non-blank inserted as spaces if you do this
8417 though. Otherwise aligned comments will be wrong when 'tabstop' is
8418 changed.
8419
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008420 If Vim is compiled with the |+vartabs| feature then the value of
8421 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8422 than an empty string.
8423
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8425'tagbsearch' 'tbs' boolean (default on)
8426 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008428 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 searching makes searching for a tag a LOT faster, but a linear search
8430 will find more tags if the tags file wasn't properly sorted.
8431 Vim normally assumes that your tags files are sorted, or indicate that
8432 they are not sorted. Only when this is not the case does the
8433 'tagbsearch' option need to be switched off.
8434
8435 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008436 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 certain files, or retry all files with a linear search. When
8438 'tagbsearch' is off, only a linear search is done.
8439
8440 Linear searching is done anyway, for one file, when Vim finds a line
8441 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008442 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443< [The whitespace before and after the '0' must be a single <Tab>]
8444
8445 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008446 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 instead of a normal tag name, a retry is done with a linear search.
8448 Tags in unsorted tags files, and matches with different case will only
8449 be found in the retry.
8450
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008451 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008452 linear search can be avoided when case is ignored. Use a value of '2'
8453 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8454 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008455 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8456 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8457 used for this as well. Note that case must be folded to uppercase for
8458 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008459
8460 By default, tag searches are case-sensitive. Case is ignored when
8461 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8462 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008463 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8464 'tagcase' is "smart", and the pattern contains only lowercase
8465 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466
8467 When 'tagbsearch' is off, tags searching is slower when a full match
8468 exists, but faster when no full match exists. Tags in unsorted tags
8469 files may only be found with 'tagbsearch' off.
8470 When the tags file is not sorted, or sorted in a wrong way (not on
8471 ASCII byte value), 'tagbsearch' should be off, or the line given above
8472 must be included in the tags file.
8473 This option doesn't affect commands that find all matching tags (e.g.,
8474 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008476 *'tagcase'* *'tc'*
8477'tagcase' 'tc' string (default "followic")
8478 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008479 This option specifies how case is handled when searching the tags
8480 file:
8481 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008482 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008483 ignore Ignore case
8484 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008485 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008486 NOTE: This option is set to the Vi default value when 'compatible' is
8487 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008488
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008489 *'tagfunc'* *'tfu'*
8490'tagfunc' 'tfu' string (default: empty)
8491 local to buffer
8492 {not available when compiled without the |+eval|
8493 feature}
8494 This option specifies a function to be used to perform tag searches.
8495 The function gets the tag pattern and should return a List of matching
8496 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008497 function and an example. The value can be the name of a function, a
8498 |lambda| or a |Funcref|. See |option-value-function| for more
8499 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008500 This option cannot be set from a |modeline| or in the |sandbox|, for
8501 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008502
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 *'taglength'* *'tl'*
8504'taglength' 'tl' number (default 0)
8505 global
8506 If non-zero, tags are significant up to this number of characters.
8507
8508 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8509'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8510 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008511 If on and using a tags file in another directory, file names in that
8512 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 NOTE: This option is set to the Vi default value when 'compatible' is
8514 set and to the Vim default value when 'compatible' is reset.
8515
8516 *'tags'* *'tag'* *E433*
8517'tags' 'tag' string (default "./tags,tags", when compiled with
8518 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8519 global or local to buffer |global-local|
8520 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008521 include a space or comma in a file name, precede it with backslashes
8522 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 When a file name starts with "./", the '.' is replaced with the path
8524 of the current file. But only when the 'd' flag is not included in
8525 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8526 |tags-option|.
8527 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008528 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8529 find all files named "tags" below "/lib". The filename itself cannot
8530 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008531 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008532 The |tagfiles()| function can be used to get a list of the file names
8533 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8535 files are also supported. They are automatically recognized. The
8536 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8537 differences are ignored (MS-Windows). |emacs-tags|
8538 The use of |:set+=| and |:set-=| is preferred when adding or removing
8539 file names from the list. This avoids problems when a future version
8540 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541
8542 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8543'tagstack' 'tgst' boolean (default on)
8544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 When on, the |tagstack| is used normally. When off, a ":tag" or
8546 ":tselect" command with an argument will not push the tag onto the
8547 tagstack. A following ":tag" without an argument, a ":pop" command or
8548 any other command that uses the tagstack will use the unmodified
8549 tagstack, but does change the pointer to the active entry.
8550 Resetting this option is useful when using a ":tag" command in a
8551 mapping which should not change the tagstack.
8552
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008553 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008554'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008555 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008556 {only available when compiled with the |+tcl/dyn|
8557 feature}
8558 Specifies the name of the Tcl shared library. The default is
8559 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008560 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008561 This option cannot be set from a |modeline| or in the |sandbox|, for
8562 security reasons.
8563
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 *'term'* *E529* *E530* *E531*
8565'term' string (default is $TERM, if that fails:
8566 in the GUI: "builtin_gui"
8567 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008568 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 on Unix: "ansi"
8571 on VMS: "ansi"
8572 on Win 32: "win32")
8573 global
8574 Name of the terminal. Used for choosing the terminal control
8575 characters. Environment variables are expanded |:set_env|.
8576 For example: >
8577 :set term=$TERM
8578< See |termcap|.
8579
8580 *'termbidi'* *'tbidi'*
8581 *'notermbidi'* *'notbidi'*
8582'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 {only available when compiled with the |+arabic|
8585 feature}
8586 The terminal is in charge of Bi-directionality of text (as specified
8587 by Unicode). The terminal is also expected to do the required shaping
8588 that some languages (such as Arabic) require.
8589 Setting this option implies that 'rightleft' will not be set when
8590 'arabic' is set and the value of 'arabicshape' will be ignored.
8591 Note that setting 'termbidi' has the immediate effect that
8592 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8593 This option is reset when the GUI is started.
8594 For further details see |arabic.txt|.
8595
8596 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008597'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 Encoding used for the terminal. This specifies what character
8600 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008601 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008602 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008603 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008604 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8606 Any attempts to set a different value will be rejected, and an error
8607 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008608 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 because the Win32 system always passes Unicode characters.
8610 When empty, the same encoding is used as for the 'encoding' option.
8611 This is the normal value.
8612 Not all combinations for 'termencoding' and 'encoding' are valid. See
8613 |encoding-table|.
8614 The value for this option must be supported by internal conversions or
8615 iconv(). When this is not possible no conversion will be done and you
8616 will probably experience problems with non-ASCII characters.
8617 Example: You are working with the locale set to euc-jp (Japanese) and
8618 want to edit a UTF-8 file: >
8619 :let &termencoding = &encoding
8620 :set encoding=utf-8
8621< You need to do this when your system has no locale support for UTF-8.
8622
Bram Moolenaar938ae282023-02-20 20:44:55 +00008623 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008624'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8625 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008626 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008627 {not available when compiled without the
8628 |+termguicolors| feature}
8629 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008630 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008631
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008632 Requires a ISO-8613-3 compatible terminal. If setting this option
8633 does not work (produces a colorless UI) reading |xterm-true-color|
8634 might help.
8635
8636 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8637 is required. Use this check to find out: >
8638 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008639< This requires Vim to be built with the |+vtp| feature.
8640
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008641 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008642
8643 When using Vim with Windows Terminal, the background of Windows
8644 Terminal is normally filled with the Vim background color. Setting
8645 'termguicolors' and the guibg of the Normal highlight group to NONE
8646 will make the background transparent: >
8647 :hi Normal guibg=NONE
8648<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008649 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008650
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008651 *'termwinkey'* *'twk'*
8652'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008653 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008654 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008655 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008656 The key can be specified as a single character, a |key-notation| (e.g.
8657 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8658 :set twk=X
8659 :set twk=^I
8660 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008661< The string must be one key stroke but can be multiple bytes.
8662 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008663 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008664 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008665
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008666 *'termwinscroll'* *'twsl'*
8667'termwinscroll' 'twsl' number (default 10000)
8668 local to buffer
8669 {not available when compiled without the
8670 |+terminal| feature}
8671 Number of scrollback lines to keep. When going over this limit the
8672 first 10% of the scrollback lines are deleted. This is just to reduce
8673 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008674 Also used as a limit for text sent to the terminal in one write,
8675 multiplied by the number of columns times 3 (average number of bytes
8676 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008677
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008678 *'termwinsize'* *'tws'*
8679'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008680 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008681 Size used when opening the |terminal| window. Format:
8682 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008683 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008684 - When set with a "x" (e.g., "24x80") the terminal size is not
8685 adjusted to the window size. If the window is smaller only the
8686 top-left part is displayed.
8687 - When set with a "*" (e.g., "10*50") the terminal size follows the
8688 window size, but will not be smaller than the specified rows and/or
8689 columns.
8690 - When rows is zero then use the height of the window.
8691 - When columns is zero then use the width of the window.
8692 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008693 - Can be overruled in the |term_start()| options with "term_rows" and
8694 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008695
8696 Examples:
8697 "30x0" uses 30 rows and the current window width.
8698 "20*0" uses at least 20 rows and the current window width.
8699 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008700 Note that the command running in the terminal window may still change
8701 the size of the terminal. In that case the Vim window will be
8702 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008703
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008704 *'termwintype'* *'twt'*
8705'termwintype' 'twt' string (default "")
8706 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008707 {only available when compiled with the |terminal|
8708 feature on MS-Windows}
8709 Specify the virtual console (pty) used when opening the terminal
8710 window.
8711
8712 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008713 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008714 "winpty" use winpty, fail if not supported
8715 "conpty" use |ConPTY|, fail if not supported
8716
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008717 |ConPTY| support depends on the platform. Windows 10 October 2018
8718 Update is the first version that supports ConPTY, however it is still
8719 considered unstable. ConPTY might become stable in the next release
8720 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008721 supported then you cannot open a terminal window.
8722
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 *'terse'* *'noterse'*
8724'terse' boolean (default off)
8725 global
8726 When set: Add 's' flag to 'shortmess' option (this makes the message
8727 for a search that hits the start or end of the file not being
8728 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8729 shortens a lot of messages}
8730
8731 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8732'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 This option is obsolete. Use 'fileformats'.
8735 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8736 set to the default value for the current system. When 'textauto' is
8737 reset, 'fileformats' is made empty.
8738 NOTE: This option is set to the Vi default value when 'compatible' is
8739 set and to the Vim default value when 'compatible' is reset.
8740
8741 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008742'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 others: default off)
8744 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 This option is obsolete. Use 'fileformat'.
8746 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8747 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8748 "unix".
8749
8750 *'textwidth'* *'tw'*
8751'textwidth' 'tw' number (default 0)
8752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 Maximum width of text that is being inserted. A longer line will be
8754 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008755 this.
8756 'textwidth' is set to 0 when the 'paste' option is set and restored
8757 when 'paste' is reset.
8758 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008760 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 NOTE: This option is set to 0 when 'compatible' is set.
8762
8763 *'thesaurus'* *'tsr'*
8764'thesaurus' 'tsr' string (default "")
8765 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008767 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8768 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008769
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008770 This option is not used if 'thesaurusfunc' is set, either for the
8771 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008772
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008773 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008775 name. See |option-backslash| about using backslashes. The use of
8776 |:set+=| and |:set-=| is preferred when adding or removing directories
8777 from the list. This avoids problems when a future version uses
8778 another default. Backticks cannot be used in this option for security
8779 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008781 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008782'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008783 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008784 {not available when compiled without the |+eval|
8785 feature}
8786 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008787 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008788 The value can be the name of a function, a |lambda| or a |Funcref|.
8789 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008790
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008791 This option cannot be set from a |modeline| or in the |sandbox|, for
8792 security reasons.
8793
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8795'tildeop' 'top' boolean (default off)
8796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 When on: The tilde command "~" behaves like an operator.
8798 NOTE: This option is reset when 'compatible' is set.
8799
8800 *'timeout'* *'to'* *'notimeout'* *'noto'*
8801'timeout' 'to' boolean (default on)
8802 global
laburnumT3f7855a2023-12-05 18:37:03 +01008803
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008805'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 These two options together determine the behavior when part of a
8808 mapped key sequence or keyboard code has been received:
8809
8810 'timeout' 'ttimeout' action ~
8811 off off do not time out
8812 on on or off time out on :mappings and key codes
8813 off on time out on key codes
8814
8815 If both options are off, Vim will wait until either the complete
8816 mapping or key sequence has been received, or it is clear that there
8817 is no mapping or key sequence for the received characters. For
8818 example: if you have mapped "vl" and Vim has received 'v', the next
8819 character is needed to see if the 'v' is followed by an 'l'.
8820 When one of the options is on, Vim will wait for about 1 second for
8821 the next character to arrive. After that the already received
8822 characters are interpreted as single characters. The waiting time can
8823 be changed with the 'timeoutlen' option.
8824 On slow terminals or very busy systems timing out may cause
8825 malfunctioning cursor keys. If both options are off, Vim waits
8826 forever after an entered <Esc> if there are key codes that start
8827 with <Esc>. You will have to type <Esc> twice. If you do not have
8828 problems with key codes, but would like to have :mapped key
8829 sequences not timing out in 1 second, set the 'ttimeout' option and
8830 reset the 'timeout' option.
8831
8832 NOTE: 'ttimeout' is reset when 'compatible' is set.
8833
8834 *'timeoutlen'* *'tm'*
8835'timeoutlen' 'tm' number (default 1000)
8836 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008837
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008839'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 The time in milliseconds that is waited for a key code or mapped key
8842 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8843 when part of a command has been typed.
8844 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8845 different timeout value for key codes is desired set 'ttimeoutlen' to
8846 a non-negative number.
8847
8848 ttimeoutlen mapping delay key code delay ~
8849 < 0 'timeoutlen' 'timeoutlen'
8850 >= 0 'timeoutlen' 'ttimeoutlen'
8851
8852 The timeout only happens when the 'timeout' and 'ttimeout' options
8853 tell so. A useful setting would be >
8854 :set timeout timeoutlen=3000 ttimeoutlen=100
8855< (time out on mapping after three seconds, time out on key codes after
8856 a tenth of a second).
8857
8858 *'title'* *'notitle'*
8859'title' boolean (default off, on when title can be restored)
8860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 When on, the title of the window will be set to the value of
8862 'titlestring' (if it is not empty), or to:
8863 filename [+=-] (path) - VIM
8864 Where:
8865 filename the name of the file being edited
8866 - indicates the file cannot be modified, 'ma' off
8867 + indicates the file was modified
8868 = indicates the file is read-only
8869 =+ indicates the file is read-only and modified
8870 (path) is the path of the file being edited
8871 - VIM the server name |v:servername| or "VIM"
8872 Only works if the terminal supports setting window titles
8873 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008874 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8876 *X11*
8877 When Vim was compiled with HAVE_X11 defined, the original title will
8878 be restored if possible. The output of ":version" will include "+X11"
8879 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8880 works for the icon name |'icon'|.
8881 But: When Vim was started with the |-X| argument, restoring the title
8882 will not work (except in the GUI).
8883 If the title cannot be restored, it is set to the value of 'titleold'.
8884 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008885 When using an xterm from a remote machine you can use this command: >
8886
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008888 ssh -X machine_name xterm &
8889<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 then the WINDOWID environment variable should be inherited and the
8891 title of the window should change back to what it should be after
8892 exiting Vim.
8893
8894 *'titlelen'*
8895'titlelen' number (default 85)
8896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008898 title. When the title is longer, only the end of the path name is
8899 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 Using a percentage makes this adapt to the width of the window. But
8901 it won't work perfectly, because the actual number of characters
8902 available also depends on the font used and other things in the title
8903 bar. When 'titlelen' is zero the full path is used. Otherwise,
8904 values from 1 to 30000 percent can be used.
8905 'titlelen' is also used for the 'titlestring' option.
8906
8907 *'titleold'*
8908'titleold' string (default "Thanks for flying Vim")
8909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 This option will be used for the window title when exiting Vim if the
8911 original title cannot be restored. Only happens if 'title' is on or
8912 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008913 This option cannot be set from a |modeline| or in the |sandbox|, for
8914 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 *'titlestring'*
8916'titlestring' string (default "")
8917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 When this option is not empty, it will be used for the title of the
8919 window. This happens only when the 'title' option is on.
8920 Only works if the terminal supports setting window titles (currently
8921 Amiga console, Win32 console, all GUI versions and terminals with a
8922 non-empty 't_ts' option).
8923 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008924 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008925
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008927 expanded according to the rules used for 'statusline'. If it contains
8928 an invalid '%' format, the value is used as-is and no error or warning
8929 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008930 This option cannot be set in a modeline when 'modelineexpr' is off.
8931
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008933 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8935< The value of 'titlelen' is used to align items in the middle or right
8936 of the available space.
8937 Some people prefer to have the file name first: >
8938 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8939< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008940 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 separating space only when needed.
8942 NOTE: Use of special characters in 'titlestring' may cause the display
8943 to be garbled (e.g., when it contains a CR or NL character).
8944 {not available when compiled without the |+statusline| feature}
8945
8946 *'toolbar'* *'tb'*
8947'toolbar' 'tb' string (default "icons,tooltips")
8948 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008949 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008950 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 possible values are:
8952 icons Toolbar buttons are shown with icons.
8953 text Toolbar buttons shown with text.
8954 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008955 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 tooltips Tooltips are active for toolbar buttons.
8957 Tooltips refer to the popup help text which appears after the mouse
8958 cursor is placed over a toolbar button for a brief moment.
8959
8960 If you want the toolbar to be shown with icons as well as text, do the
8961 following: >
8962 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008963< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 will show icons if both are requested.
8965
8966 If none of the strings specified in 'toolbar' are valid or if
8967 'toolbar' is empty, this option is ignored. If you want to disable
8968 the toolbar, you need to set the 'guioptions' option. For example: >
8969 :set guioptions-=T
8970< Also see |gui-toolbar|.
8971
8972 *'toolbariconsize'* *'tbis'*
8973'toolbariconsize' 'tbis' string (default "small")
8974 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008975 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008977 tiny Use tiny icons.
8978 small Use small icons (default).
8979 medium Use medium-sized icons.
8980 large Use large icons.
8981 huge Use even larger icons.
8982 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008984 the current theme. Common dimensions are giant=48x48, huge=32x32,
8985 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986
8987 If 'toolbariconsize' is empty, the global default size as determined
8988 by user preferences or the current theme is used.
8989
8990 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8991'ttybuiltin' 'tbi' boolean (default on)
8992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 When on, the builtin termcaps are searched before the external ones.
8994 When off the builtin termcaps are searched after the external ones.
8995 When this option is changed, you should set the 'term' option next for
8996 the change to take effect, for example: >
8997 :set notbi term=$TERM
8998< See also |termcap|.
8999 Rationale: The default for this option is "on", because the builtin
9000 termcap entries are generally better (many systems contain faulty
9001 xterm entries...).
9002
9003 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009004'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 Indicates a fast terminal connection. More characters will be sent to
9007 the screen for redrawing, instead of using insert/delete line
9008 commands. Improves smoothness of redrawing when there are multiple
9009 windows and the terminal does not support a scrolling region.
9010 Also enables the extra writing of characters at the end of each screen
9011 line for lines that wrap. This helps when using copy/paste with the
9012 mouse in an xterm and other terminals.
9013
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009014 The default used to be set only for some terminal names, but these
9015 days nearly all terminals are fast, therefore the default is now "on".
9016 If you have a slow connection you may want to set this option off,
9017 e.g. depending on the host name: >
9018 if hostname() =~ 'faraway'
9019 set nottyfast
9020 endif
9021<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 *'ttymouse'* *'ttym'*
9023'ttymouse' 'ttym' string (default depends on 'term')
9024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 {only in Unix and VMS, doesn't work in the GUI; not
9026 available when compiled without |+mouse|}
9027 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009028 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 *xterm-mouse*
9030 xterm xterm-like mouse handling. The mouse generates
9031 "<Esc>[Mscr", where "scr" is three bytes:
9032 "s" = button state
9033 "c" = column plus 33
9034 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009035 This only works up to 223 columns! See "dec",
9036 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 xterm2 Works like "xterm", but with the xterm reporting the
9038 mouse position while the mouse is dragged. This works
9039 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009040 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 work. See below for how Vim detects this
9042 automatically.
9043 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009044 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009046 for the row and column. No other mouse events are
9047 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 *dec-mouse*
9049 dec DEC terminal mouse handling. The mouse generates a
9050 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009051 This is also available for an Xterm, if it was
9052 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 *jsbterm-mouse*
9054 jsbterm JSB term mouse handling.
9055 *pterm-mouse*
9056 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009057 *urxvt-mouse*
9058 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009059 The mouse works only if the terminal supports this
9060 encoding style, but it does not have 223 columns limit
9061 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009062 *sgr-mouse*
9063 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009064 mouse reporting. The mouse works even in columns
9065 beyond 223. This option is backward compatible with
9066 "xterm2" because it can also decode "xterm2" style
9067 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068
9069 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009070 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9071 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9073 recognized, if enabled at compile time. DEC terminal mouse codes
9074 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009075 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9076 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009078 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9079 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9080 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009081 If the terminfo/termcap entry "XM" exists and the first number is
9082 "1006" then 'ttymouse' will be set to "sgr". This works for many
9083 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009084 Additionally, if vim is compiled with the |+termresponse| feature and
9085 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009086 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009088 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9089 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9090 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009091 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9092 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 :set t_RV=
9094<
9095 *'ttyscroll'* *'tsl'*
9096'ttyscroll' 'tsl' number (default 999)
9097 global
9098 Maximum number of lines to scroll the screen. If there are more lines
9099 to scroll the window is redrawn. For terminals where scrolling is
9100 very slow and redrawing is not slow this can be set to a small number,
9101 e.g., 3, to speed up displaying.
9102
9103 *'ttytype'* *'tty'*
9104'ttytype' 'tty' string (default from $TERM)
9105 global
9106 Alias for 'term', see above.
9107
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009108 *'undodir'* *'udir'*
9109'undodir' 'udir' string (default ".")
9110 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009111 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009112 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009113 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009114 "." means using the directory of the file. The undo file name for
9115 "file.txt" is ".file.txt.un~".
9116 For other directories the file name is the full path of the edited
9117 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009118 When writing: The first directory that exists is used. "." always
9119 works, no directories after "." will be used for writing.
9120 When reading all entries are tried to find an undo file. The first
9121 undo file that exists is used. When it cannot be read an error is
9122 given, no further entry is used.
9123 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009124 This option cannot be set from a |modeline| or in the |sandbox|, for
9125 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009126
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009127 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009128'undofile' 'udf' boolean (default off)
9129 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009130 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009131 When on, Vim automatically saves undo history to an undo file when
9132 writing a buffer to a file, and restores undo history from the same
9133 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009134 The directory where the undo file is stored is specified by 'undodir'.
9135 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009136 The undo file is not read when 'undoreload' causes the buffer from
9137 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009138 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009139 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009140
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009142'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009143 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009145 is kept in memory, higher numbers will cause more memory to be used.
9146 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9148 itself: >
9149 set ul=0
9150< But you can also get Vi compatibility by including the 'u' flag in
9151 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009152 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009153 Set to -1 for no undo at all. You might want to do this only for the
9154 current buffer: >
9155 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009157
9158 The local value is set to -123456 when the global value is to be used.
9159
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009160 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009162 *'undoreload'* *'ur'*
9163'undoreload' 'ur' number (default 10000)
9164 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009165 Save the whole buffer for undo when reloading it. This applies to the
9166 ":e!" command and reloading for when the buffer changed outside of
9167 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009168 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009169 of lines is smaller than the value of this option.
9170 Set this option to zero to disable undo for a reload.
9171
9172 When saving undo for a reload, any undo file is not read.
9173
9174 Note that this causes the whole buffer to be stored in memory. Set
9175 this option to a lower value if you run out of memory.
9176
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 *'updatecount'* *'uc'*
9178'updatecount' 'uc' number (default: 200)
9179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 After typing this many characters the swap file will be written to
9181 disk. When zero, no swap file will be created at all (see chapter on
9182 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9183 Vim with the "-n" option, see |startup|. When editing in readonly
9184 mode this option will be initialized to 10000.
9185 The swapfile can be disabled per buffer with |'swapfile'|.
9186 When 'updatecount' is set from zero to non-zero, swap files are
9187 created for all buffers that have 'swapfile' set. When 'updatecount'
9188 is set to zero, existing swap files are not deleted.
9189 Also see |'swapsync'|.
9190 This option has no meaning in buffers where |'buftype'| is "nofile"
9191 or "nowrite".
9192
9193 *'updatetime'* *'ut'*
9194'updatetime' 'ut' number (default 4000)
9195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 If this many milliseconds nothing is typed the swap file will be
9197 written to disk (see |crash-recovery|). Also used for the
9198 |CursorHold| autocommand event.
9199
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009200 *'varsofttabstop'* *'vsts'*
9201'varsofttabstop' 'vsts' string (default "")
9202 local to buffer
9203 {only available when compiled with the |+vartabs|
9204 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009205 A list of the number of spaces that a <Tab> counts for while editing,
9206 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9207 width <Tab>s are being inserted, while in fact a mixture of spaces
9208 and <Tab>s is used. Tab widths are separated with commas, with the
9209 final value applying to all subsequent tabs.
9210
9211 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009212 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009213 to use the following: >
9214 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009215< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9216 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009217
9218 Note that the value of |'softtabstop'| will be ignored while
9219 'varsofttabstop' is set.
9220
9221 *'vartabstop'* *'vts'*
9222'vartabstop' 'vts' string (default "")
9223 local to buffer
9224 {only available when compiled with the |+vartabs|
9225 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009226 A list of the number of spaces that a <Tab> in the file counts for,
9227 separated by commas. Each value corresponds to one tab, with the
9228 final value applying to all subsequent tabs. For example: >
9229 :set vartabstop=4,20,10,8
9230< This will make the first tab 4 spaces wide, the second 20 spaces,
9231 the third 10 spaces, and all following tabs 8 spaces.
9232
9233 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9234 is set.
9235
Bram Moolenaar071d4272004-06-13 20:20:40 +00009236 *'verbose'* *'vbs'*
9237'verbose' 'vbs' number (default 0)
9238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 When bigger than zero, Vim will give messages about what it is doing.
9240 Currently, these messages are given:
9241 >= 1 When the viminfo file is read or written.
9242 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009243 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009244 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 >= 8 Files for which a group of autocommands is executed.
9246 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009247 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 >= 12 Every executed function.
9249 >= 13 When an exception is thrown, caught, finished, or discarded.
9250 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009251 >= 15 Every executed Ex command from a script (truncated at 200
9252 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009253 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254
9255 This option can also be set with the "-V" argument. See |-V|.
9256 This option is also set by the |:verbose| command.
9257
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009258 When the 'verbosefile' option is set then the verbose messages are not
9259 displayed.
9260
9261 *'verbosefile'* *'vfile'*
9262'verbosefile' 'vfile' string (default empty)
9263 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009264 When not empty all messages are written in a file with this name.
9265 When the file exists messages are appended.
9266 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009267 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009268 Setting 'verbosefile' to a new value is like making it empty first.
9269 The difference with |:redir| is that verbose messages are not
9270 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009271 This option cannot be set from a |modeline| or in the |sandbox|, for
9272 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009273
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009275'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009276 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009277 for Unix: "$HOME/.vim/view" or
9278 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009279 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009281 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009282 feature}
9283 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009284 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 This option cannot be set from a |modeline| or in the |sandbox|, for
9286 security reasons.
9287
9288 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009289'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009291 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009293 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009294 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 word save and restore ~
9296 cursor cursor position in file and in window
9297 folds manually created folds, opened/closed folds and local
9298 fold options
9299 options options and mappings local to a window or buffer (not
9300 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009301 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 slash backslashes in file names replaced with forward
9303 slashes
9304 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009305 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009306 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009308 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009310 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009311
9312 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009313'viminfo' 'vi' string (Vi default: "", Vim default for
9314 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009315 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9316 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009318 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 feature}
9320 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009321 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9322 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009323 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009324 consisting of a single character identifying the particular parameter,
9325 followed by a number or string which specifies the value of that
9326 parameter. If a particular character is left out, then the default
9327 value is used for that parameter. The following is a list of the
9328 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009330 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 ! When included, save and restore global variables that start
9332 with an uppercase letter, and don't contain a lowercase
9333 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009334 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009335 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009336 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009337 " Maximum number of lines saved for each register. Old name of
9338 the '<' item, with the disadvantage that you need to put a
9339 backslash before the ", otherwise it will be recognized as the
9340 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009341 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342 % When included, save and restore the buffer list. If Vim is
9343 started with a file name argument, the buffer list is not
9344 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009345 buffer list is restored from the viminfo file. Quickfix
9346 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9347 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009348 When followed by a number, the number specifies the maximum
9349 number of buffers that are stored. Without a number all
9350 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009351 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352 ' Maximum number of previously edited files for which the marks
9353 are remembered. This parameter must always be included when
9354 'viminfo' is non-empty.
9355 Including this item also means that the |jumplist| and the
9356 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009357 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009358 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009359 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360 patterns are also saved. When not included, the value of
9361 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009362 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009364 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009365 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366 < Maximum number of lines saved for each register. If zero then
9367 registers are not saved. When not included, all lines are
9368 saved. '"' is the old name for this item.
9369 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009370 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009371 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009372 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009373 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 c When included, convert the text in the viminfo file from the
9375 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009376 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009377 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 f Whether file marks need to be stored. If zero, file marks ('0
9379 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009380 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009382 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 h Disable the effect of 'hlsearch' when loading the viminfo
9384 file. When not included, it depends on whether ":nohlsearch"
9385 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009386 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009387 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009388 the 'n'. Must be at the end of the option! If the
9389 'viminfofile' option is set, that file name overrides the one
9390 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009391 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009392 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009393 r Removable media. The argument is a string (up to the next
9394 ','). This parameter can be given several times. Each
9395 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009396 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009397 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9398 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9399 ignored. Maximum length of each 'r' argument is 50
9400 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009401 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402 s Maximum size of an item in Kbyte. If zero then registers are
9403 not saved. Currently only applies to registers. The default
9404 "s10" will exclude registers with more than 10 Kbyte of text.
9405 Also see the '<' item above: line count limit.
9406
9407 Example: >
9408 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9409<
9410 '50 Marks will be remembered for the last 50 files you
9411 edited.
9412 <1000 Contents of registers (up to 1000 lines each) will be
9413 remembered.
9414 s100 Registers with more than 100 Kbyte text are skipped.
9415 :0 Command-line history will not be saved.
9416 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9417 no / Since '/' is not specified, the default will be used,
9418 that is, save all of the search history, and also the
9419 previous search and substitute patterns.
9420 no % The buffer list will not be saved nor read back.
9421 no h 'hlsearch' highlighting will be restored.
9422
9423 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9424 load the contents of the file, this is not done automatically.
9425
9426 This option cannot be set from a |modeline| or in the |sandbox|, for
9427 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009428 NOTE: This option is set to the Vim default value when 'compatible'
9429 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009431 *'viminfofile'* *'vif'*
9432'viminfofile' 'vif' string (default: "")
9433 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009434 {not available when compiled without the |+viminfo|
9435 feature}
9436 When non-empty, overrides the file name used for viminfo.
9437 When equal to "NONE" no viminfo file will be read or written.
9438 This option can be set with the |-i| command line flag. The |--clean|
9439 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009440 This option cannot be set from a |modeline| or in the |sandbox|, for
9441 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009442
Bram Moolenaar071d4272004-06-13 20:20:40 +00009443 *'virtualedit'* *'ve'*
9444'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009445 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009446 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009447 block Allow virtual editing in Visual block mode.
9448 insert Allow virtual editing in Insert mode.
9449 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009450 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009451 none When used as the local value, do not allow virtual
9452 editing even when the global value is set. When used
9453 as the global value, "none" is the same as "".
9454 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009455
Bram Moolenaar071d4272004-06-13 20:20:40 +00009456 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009457 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009458 of the line. Useful for selecting a rectangle in Visual mode and
9459 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009460 "onemore" is not the same, it will only allow moving the cursor just
9461 after the last character of the line. This makes some commands more
9462 consistent. Previously the cursor was always past the end of the line
9463 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009464 break some plugins or Vim scripts. For example because |l| can move
9465 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009466 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009467 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009468 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009469 It doesn't make sense to combine "all" with "onemore", but you will
9470 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009471 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009472 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009473
9474 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9475'visualbell' 'vb' boolean (default off)
9476 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009477 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009478 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009479 use: >
9480 :set vb t_vb=
9481< If you want a short flash, you can use this on many terminals: >
9482 :set vb t_vb=[?5h$<100>[?5l
9483< Here $<100> specifies the time, you can use a smaller or bigger value
9484 to get a shorter or longer flash.
9485
9486 Note: Vim will limit the bell to once per half a second. This avoids
9487 having to wait for the flashing to finish when there are lots of
9488 bells, e.g. on key repeat. This also happens without 'visualbell'
9489 set.
9490
Bram Moolenaar071d4272004-06-13 20:20:40 +00009491 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9492 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9493 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009494
9495 Note: When the GUI starts, 't_vb' is reset to its default value. You
9496 might want to set it again in your |gvimrc|.
9497
Bram Moolenaar071d4272004-06-13 20:20:40 +00009498 Does not work on the Amiga, you always get a screen flash.
9499 Also see 'errorbells'.
9500
9501 *'warn'* *'nowarn'*
9502'warn' boolean (default on)
9503 global
9504 Give a warning message when a shell command is used while the buffer
9505 has been changed.
9506
9507 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9508'weirdinvert' 'wiv' boolean (default off)
9509 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009510 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511 It is provided for backwards compatibility with version 4.x.
9512 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9513 vice versa. Has no effect when the GUI is running.
9514
9515 *'whichwrap'* *'ww'*
9516'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009518 Allow specified keys that move the cursor left/right to move to the
9519 previous/next line when the cursor is on the first/last character in
9520 the line. Concatenate characters to allow this for these keys:
9521 char key mode ~
9522 b <BS> Normal and Visual
9523 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009524 h "h" Normal and Visual (not recommended)
9525 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 < <Left> Normal and Visual
9527 > <Right> Normal and Visual
9528 ~ "~" Normal
9529 [ <Left> Insert and Replace
9530 ] <Right> Insert and Replace
9531 For example: >
9532 :set ww=<,>,[,]
9533< allows wrap only when cursor keys are used.
9534 When the movement keys are used in combination with a delete or change
9535 operator, the <EOL> also counts for a character. This makes "3h"
9536 different from "3dh" when the cursor crosses the end of a line. This
9537 is also true for "x" and "X", because they do the same as "dl" and
9538 "dh". If you use this, you may also want to use the mapping
9539 ":map <BS> X" to make backspace delete the character in front of the
9540 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009541 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009542 line (not an empty line) then it will not move to the next line. This
9543 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009544 NOTE: This option is set to the Vi default value when 'compatible' is
9545 set and to the Vim default value when 'compatible' is reset.
9546
9547 *'wildchar'* *'wc'*
9548'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009550 Character you have to type to start wildcard expansion in the
9551 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009552 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009553 The character is not recognized when used inside a macro. See
9554 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009555 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009556 <Esc> can be used, but hitting it twice in a row will still exit
9557 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009558 Although 'wc' is a number option, it can be specified as a number, a
9559 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9560 preceded with a caret (e.g. `^F` is CTRL-F): >
9561 :set wc=27
9562 :set wc=X
9563 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009564 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565< NOTE: This option is set to the Vi default value when 'compatible' is
9566 set and to the Vim default value when 'compatible' is reset.
9567
9568 *'wildcharm'* *'wcm'*
9569'wildcharm' 'wcm' number (default: none (0))
9570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009571 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009572 recognized when used inside a macro. You can find "spare" command-line
9573 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009574 you'll never actually type 'wildcharm', just use it in mappings that
9575 automatically invoke completion mode, e.g.: >
9576 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009577 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578< Then after typing :ss you can use CTRL-P & CTRL-N.
9579
9580 *'wildignore'* *'wig'*
9581'wildignore' 'wig' string (default "")
9582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009583 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009584 patterns is ignored when expanding |wildcards|, completing file or
9585 directory names, and influences the result of |expand()|, |glob()| and
9586 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009587 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9588 Also see 'suffixes'.
9589 Example: >
9590 :set wildignore=*.o,*.obj
9591< The use of |:set+=| and |:set-=| is preferred when adding or removing
9592 a pattern from the list. This avoids problems when a future version
9593 uses another default.
9594
h_east596a9f22023-11-21 21:24:23 +09009595 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009596'wildignorecase' 'wic' boolean (default off)
9597 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009598 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009599 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009600 Does not apply when the shell is used to expand wildcards, which
9601 happens when there are special characters.
9602
Bram Moolenaar071d4272004-06-13 20:20:40 +00009603 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009604'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009606 When 'wildmenu' is on, command-line completion operates in an enhanced
9607 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009608 the possible matches are shown.
9609 When 'wildoptions' contains "pum", then the completion matches are
9610 shown in a popup menu. Otherwise they are displayed just above the
9611 command line, with the first match highlighted (overwriting the status
9612 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009613 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9615 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9616 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009617 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 If there are more matches than can fit in the line, a ">" is shown on
9619 the right and/or a "<" is shown on the left. The status line scrolls
9620 as needed.
9621 The "wildmenu" mode is abandoned when a key is hit that is not used
9622 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009623 While the "wildmenu" is active, the following keys have special
9624 meanings:
9625 CTRL-P - go to the previous entry
9626 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009627 <CR> - in menu completion, when the cursor is just after a
9628 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009629 CTRL-E - end completion, go back to what was there before
9630 selecting a match.
9631 CTRL-Y - accept the currently selected match and stop
9632 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009633
9634 When not using the popup menu for command line completion, the
9635 following keys have special meanings:
9636 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637 <Up> - in filename/menu name completion: move up into
9638 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009639 <Down> - in filename/menu name completion: move into a
9640 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009641
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009642 When using the popup menu for command line completion, the following
9643 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009644 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009645 <PageUp> - select a match several entries back
9646 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009647 <Left> - in filename/menu name completion: move up into
9648 parent directory or parent menu.
9649 <Right> - in filename/menu name completion: move into a
9650 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009651
Bram Moolenaar071d4272004-06-13 20:20:40 +00009652 This makes the menus accessible from the console |console-menus|.
9653
9654 If you prefer the <Left> and <Right> keys to move the cursor instead
9655 of selecting a different match, use this: >
9656 :cnoremap <Left> <Space><BS><Left>
9657 :cnoremap <Right> <Space><BS><Right>
9658<
9659 The "WildMenu" highlighting is used for displaying the current match
9660 |hl-WildMenu|.
9661
9662 *'wildmode'* *'wim'*
9663'wildmode' 'wim' string (Vim default: "full")
9664 global
Girish Palyaeded3362025-04-12 18:03:32 +02009665 Completion mode used for the character specified with 'wildchar'.
9666 This option is a comma-separated list of up to four parts,
9667 corresponding to the first, second, third, and fourth presses of
9668 'wildchar'. Each part is a colon-separated list of completion
9669 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009670
Girish Palyaeded3362025-04-12 18:03:32 +02009671 The possible behavior values are:
9672 "" Only complete (insert) the first match. No further
9673 matches are cycled or listed.
9674 "full" Complete the next full match. Cycles through all
9675 matches, returning to the original input after the
9676 last match. If 'wildmenu' is enabled, it will be
9677 shown.
9678 "longest" Complete to the longest common substring. If this
9679 doesn't extend the input, the next 'wildmode' part is
9680 used.
9681 "list" If multiple matches are found, list all of them.
9682 "lastused" When completing buffer names, sort them by most
9683 recently used (excluding the current buffer). Only
9684 applies to buffer name completion.
9685 "noselect" If 'wildmenu' is enabled, show the menu but do not
9686 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009687 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009688 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009689
Girish Palyaeded3362025-04-12 18:03:32 +02009690 Some useful combinations of colon-separated values:
9691 "longest:full" Start with the longest common string and show
9692 'wildmenu' (if enabled). Does not cycle
9693 through full matches.
9694 "list:full" List all matches and complete first match.
9695 "list:longest" List all matches and complete till the longest
9696 common prefix.
9697 "list:lastused" List all matches. When completing buffers,
9698 sort them by most recently used (excluding the
9699 current buffer).
9700 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9701 if it is active. When completing buffers,
9702 sort them by most recently used (excluding the
9703 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009704
9705 Examples: >
9706 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009707< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009708 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009709< First press: longest common substring
9710 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009711 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009712< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009713 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009714< First press: list matches only
9715 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009716 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009717< First press: longest common substring
9718 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009719 :set wildmode=noselect:full
Girish Palyaeded3362025-04-12 18:03:32 +02009720< Show 'wildmenu' without completing or selecting on first press
9721 Cycle full matches on second press >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009722 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009723< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009724 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009725
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009726 *'wildoptions'* *'wop'*
9727'wildoptions' 'wop' string (default "")
9728 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009729 A list of words that change how |cmdline-completion| is done.
9730 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009731 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009732 this value is specified, wildcard expansion will not
9733 be used for completion. The matches will be sorted by
9734 the "best match" rather than alphabetically sorted.
9735 This will find more matches than the wildcard
9736 expansion. Currently fuzzy matching based completion
9737 is not supported for file and directory names and
9738 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009739 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009740 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009741 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009742 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009743 is displayed per line. Often used tag kinds are:
9744 d #define
9745 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009746
Bram Moolenaar071d4272004-06-13 20:20:40 +00009747 *'winaltkeys'* *'wak'*
9748'winaltkeys' 'wak' string (default "menu")
9749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009750 {only used in Win32, Motif, GTK and Photon GUI}
9751 Some GUI versions allow the access to menu entries by using the ALT
9752 key in combination with a character that appears underlined in the
9753 menu. This conflicts with the use of the ALT key for mappings and
9754 entering special characters. This option tells what to do:
9755 no Don't use ALT keys for menus. ALT key combinations can be
9756 mapped, but there is no automatic handling. This can then be
9757 done with the |:simalt| command.
9758 yes ALT key handling is done by the windowing system. ALT key
9759 combinations cannot be mapped.
9760 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009761 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009762 keys can be mapped.
9763 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9764 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009765 This option is not used for <F10>; on Win32 and with GTK <F10> will
9766 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009767
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009768 *'wincolor'* *'wcr'*
9769'wincolor' 'wcr' string (default empty)
9770 local to window
9771 Highlight group name to use for this window instead of the Normal
9772 color |hl-Normal|.
9773
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009774 *'window'* *'wi'*
9775'window' 'wi' number (default screen height - 1)
9776 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009777 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9778 window and the value is smaller than 'lines' minus one. The screen
9779 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009780 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9781 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009782 When resizing the Vim window, and the value is smaller than 1 or more
9783 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009784 Note: Do not confuse this with the height of the Vim window, use
9785 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009786
Colin Kennedy21570352024-03-03 16:16:47 +01009787 *'winfixbuf'*
9788'winfixbuf' 'wfb' boolean (default off)
9789 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009790 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009791 For example, attempting to change the buffer with |:edit| will fail.
9792 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009793 also skip any window with 'winfixbuf' enabled. However if an Ex
9794 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009795
laburnumT3f7855a2023-12-05 18:37:03 +01009796 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9797'winfixheight' 'wfh' boolean (default off)
9798 local to window |local-noglobal|
9799 Keep the window height when windows are opened or closed and
9800 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9801 |preview-window| and |quickfix-window|.
9802 The height may be changed anyway when running out of room.
9803
9804 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9805'winfixwidth' 'wfw' boolean (default off)
9806 local to window |local-noglobal|
9807 Keep the window width when windows are opened or closed and
9808 'equalalways' is set. Also for |CTRL-W_=|.
9809 The width may be changed anyway when running out of room.
9810
Bram Moolenaar071d4272004-06-13 20:20:40 +00009811 *'winheight'* *'wh'* *E591*
9812'winheight' 'wh' number (default 1)
9813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009814 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009815 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009816 focus goes to a window that is smaller, its size is increased, at the
9817 cost of the height of other windows.
9818 Set 'winheight' to a small number for normal editing.
9819 Set it to 999 to make the current window fill most of the screen.
9820 Other windows will be only 'winminheight' high. This has the drawback
9821 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9822 to create only two windows, set the option after startup is done,
9823 using the |VimEnter| event: >
9824 au VimEnter * set winheight=999
9825< Minimum value is 1.
9826 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009827 height of the current window.
9828 'winheight' applies to the current window. Use 'winminheight' to set
9829 the minimal height for other windows.
9830
Bram Moolenaar071d4272004-06-13 20:20:40 +00009831 *'winminheight'* *'wmh'*
9832'winminheight' 'wmh' number (default 1)
9833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009834 The minimal height of a window, when it's not the current window.
9835 This is a hard minimum, windows will never become smaller.
9836 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9837 status bar) if necessary. They will return to at least one line when
9838 they become active (since the cursor has to have somewhere to go.)
9839 Use 'winheight' to set the minimal height of the current window.
9840 This option is only checked when making a window smaller. Don't use a
9841 large number, it will cause errors when opening more than a few
9842 windows. A value of 0 to 3 is reasonable.
9843
9844 *'winminwidth'* *'wmw'*
9845'winminwidth' 'wmw' number (default 1)
9846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009847 The minimal width of a window, when it's not the current window.
9848 This is a hard minimum, windows will never become smaller.
9849 When set to zero, windows may be "squashed" to zero columns (i.e. just
9850 a vertical separator) if necessary. They will return to at least one
9851 line when they become active (since the cursor has to have somewhere
9852 to go.)
9853 Use 'winwidth' to set the minimal width of the current window.
9854 This option is only checked when making a window smaller. Don't use a
9855 large number, it will cause errors when opening more than a few
9856 windows. A value of 0 to 12 is reasonable.
9857
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009858 *'winptydll'*
9859'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9860 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009861 {only available when compiled with the |terminal|
9862 feature on MS-Windows}
9863 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009864 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009865 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009866 a fallback.
9867 Environment variables are expanded |:set_env|.
9868 This option cannot be set from a |modeline| or in the |sandbox|, for
9869 security reasons.
9870
Bram Moolenaar071d4272004-06-13 20:20:40 +00009871 *'winwidth'* *'wiw'* *E592*
9872'winwidth' 'wiw' number (default 20)
9873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009874 Minimal number of columns for the current window. This is not a hard
9875 minimum, Vim will use fewer columns if there is not enough room. If
9876 the current window is smaller, its size is increased, at the cost of
9877 the width of other windows. Set it to 999 to make the current window
9878 always fill the screen. Set it to a small number for normal editing.
9879 The width is not adjusted after one of the commands to change the
9880 width of the current window.
9881 'winwidth' applies to the current window. Use 'winminwidth' to set
9882 the minimal width for other windows.
9883
9884 *'wrap'* *'nowrap'*
9885'wrap' boolean (default on)
9886 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009887 This option changes how text is displayed. It doesn't change the text
9888 in the buffer, see 'textwidth' for that.
9889 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009890 displaying continues on the next line. When off lines will not wrap
9891 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009892 moved to a part that is not shown, the screen will scroll
9893 horizontally.
9894 The line will be broken in the middle of a word if necessary. See
9895 'linebreak' to get the break at a word boundary.
9896 To make scrolling horizontally a bit more useful, try this: >
9897 :set sidescroll=5
9898 :set listchars+=precedes:<,extends:>
9899< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009900 This option can't be set from a |modeline| when the 'diff' option is
9901 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009902
9903 *'wrapmargin'* *'wm'*
9904'wrapmargin' 'wm' number (default 0)
9905 local to buffer
9906 Number of characters from the right window border where wrapping
9907 starts. When typing text beyond this limit, an <EOL> will be inserted
9908 and inserting continues on the next line.
9909 Options that add a margin, such as 'number' and 'foldcolumn', cause
9910 the text width to be further reduced. This is Vi compatible.
9911 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009912 This option is set to 0 when 'paste' is set and restored when 'paste'
9913 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009914 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009915
9916 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9917'wrapscan' 'ws' boolean (default on) *E384* *E385*
9918 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009919 Searches wrap around the end of the file. Also applies to |]s| and
9920 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009921
9922 *'write'* *'nowrite'*
9923'write' boolean (default on)
9924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009925 Allows writing files. When not set, writing a file is not allowed.
9926 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009927 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009928 argument. Filtering text is still possible, even though this requires
9929 writing a temporary file.
9930
9931 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9932'writeany' 'wa' boolean (default off)
9933 global
9934 Allows writing to any file with no need for "!" override.
9935
9936 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9937'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9938 otherwise)
9939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009940 Make a backup before overwriting a file. The backup is removed after
9941 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009942 also on.
9943 WARNING: Switching this option off means that when Vim fails to write
9944 your buffer correctly and then, for whatever reason, Vim exits, you
9945 lose both the original file and what you were writing. Only reset
9946 this option if your file system is almost full and it makes the write
9947 fail (and make sure not to exit Vim until the write was successful).
9948 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009949 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009950 Depending on 'backupcopy' the backup is a new file or the original
9951 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009952 NOTE: This option is set to the default value when 'compatible' is
9953 set.
9954
9955 *'writedelay'* *'wd'*
9956'writedelay' 'wd' number (default 0)
9957 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009958 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009959 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009960 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009961
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009962 *'xtermcodes'* *'noxtermcodes'*
9963'xtermcodes' boolean (default on)
9964 global
9965 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009966 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009967 key codes and number of colors from the terminal. This takes care of
9968 various configuration options of the terminal that cannot be obtained
9969 from the termlib/terminfo entry, see |xterm-codes|.
9970 A side effect may be that t_Co changes and Vim will redraw the
9971 display.
9972
9973
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009974 vim:tw=78:ts=8:noet:ft=help:norl: