blob: 8ab0dcc8bda472e19f1856065348878d38e39484 [file] [log] [blame]
Girish Palya0ac1eb32025-04-16 20:18:33 +02001*options.txt* For Vim version 9.1. Last change: 2025 Apr 16
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
Girish Palya0ac1eb32025-04-16 20:18:33 +02002128 An optional match limit can be specified for a completion source by
2129 appending a caret ("^") followed by a {count} to the source flag.
2130 For example: ".^9,w,u,t^5" limits matches from the current buffer
2131 to 9 and from tags to 5. Other sources remain unlimited.
2132 The match limit takes effect only during forward completion (CTRL-N)
2133 and is ignored during backward completion (CTRL-P).
2134
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002135 *'completefunc'* *'cfu'*
2136'completefunc' 'cfu' string (default: empty)
2137 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002138 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002139 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002140 This option specifies a function to be used for Insert mode completion
2141 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002142 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002143 invoked and what it should return. The value can be the name of a
2144 function, a |lambda| or a |Funcref|. See |option-value-function| for
2145 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002146 This option cannot be set from a |modeline| or in the |sandbox|, for
2147 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002148
glepnirf31cfa22025-03-06 21:59:13 +01002149 *'completefuzzycollect'* *'cfc'*
2150'completefuzzycollect' 'cfc' string (default: empty)
2151 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002152 A comma-separated list of strings to enable fuzzy collection for
2153 specific |ins-completion| modes, affecting how matches are gathered
2154 during completion. For specified modes, fuzzy matching is used to
2155 find completion candidates instead of the standard prefix-based
2156 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002157
glepnir58760162025-03-13 21:39:51 +01002158 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2159 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2160 "b", "u", "U" and "k{dict}" in 'complete'
2161 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002162
glepnir58760162025-03-13 21:39:51 +01002163 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002164
glepnir58760162025-03-13 21:39:51 +01002165 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002166
Christian Brabandtf22580e2025-03-14 12:05:52 +01002167 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002168 can identify the longest common string among the best fuzzy matches
2169 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002170
glepnir6a89c942024-10-01 20:32:12 +02002171 *'completeitemalign'* *'cia'*
2172'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2173 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002174 A comma-separated list of strings that controls the alignment and
2175 display order of items in the popup menu during Insert mode
2176 completion. The supported values are "abbr", "kind", and "menu".
2177 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002178 popup menu. Note: must always contain those three values in any
2179 order.
2180
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002181 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002182'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002183 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002184 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002185 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002186
glepnira2c55592025-02-28 17:43:42 +01002187 fuzzy Enable |fuzzy-matching| for completion candidates. This
2188 allows for more flexible and intuitive matching, where
2189 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002190 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002191 does not affect the collection of candidate list, it only
2192 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002193 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002194 to gather more alternatives for your candidate list,
2195 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002196
2197 longest Only insert the longest common text of the matches. If
2198 the menu is displayed you can use CTRL-L to add more
2199 characters. Whether case is ignored depends on the kind
2200 of completion. For buffer text the 'ignorecase' option is
2201 used.
2202
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002203 menu Use a popup menu to show the possible completions. The
2204 menu is only shown when there is more than one match and
2205 sufficient colors are available. |ins-completion-menu|
2206
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002207 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002208 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002209 match, e.g., what file it comes from.
2210
Girish Palyab1565882025-04-15 20:16:00 +02002211 nearest Matches are presented in order of proximity to the cursor
2212 position. This applies only to matches from the current
2213 buffer. No effect if "fuzzy" is present.
2214
glepnira2c55592025-02-28 17:43:42 +01002215 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002216 a match from the menu. Only works in combination with
2217 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002218
glepnira2c55592025-02-28 17:43:42 +01002219 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002220 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002221 present, "noselect" has precedence.
2222
2223 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002224 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002225 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002226
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002227 popup Show extra information about the currently selected
2228 completion in a popup window. Only works in combination
2229 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002230 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002231 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002232
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002233 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002234 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002235 |CompleteChanged| autocommand to fetch the info and call
2236 |popup_show()| once the popup has been filled.
2237 See the example at |complete-popuphidden|.
2238 {only works when compiled with the |+textprop| feature}
2239
glepniredd4ac32025-01-29 18:53:51 +01002240 preinsert
2241 Preinsert the portion of the first candidate word that is
2242 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002243 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002244 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002245
2246 preview Show extra information about the currently selected
2247 completion in the preview window. Only works in
2248 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002249
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002250 *'completepopup'* *'cpp'*
2251'completepopup' 'cpp' string (default empty)
2252 global
2253 {not available when compiled without the |+textprop|
2254 or |+quickfix| feature}
2255 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002256 properties of the info popup when it is created. If an info popup
2257 window already exists it is closed, so that the option value is
2258 applied when it is created again.
2259 You can also use |popup_findinfo()| and then set properties for an
2260 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002261
laburnumT3f7855a2023-12-05 18:37:03 +01002262 *'completeslash'* *'csl'*
2263'completeslash' 'csl' string (default: "")
2264 local to buffer
2265 {only for MS-Windows}
2266 When this option is set it overrules 'shellslash' for completion:
2267 - When this option is set to "slash", a forward slash is used for path
2268 completion in insert mode. This is useful when editing HTML tag, or
2269 Makefile with 'noshellslash' on MS-Windows.
2270 - When this option is set to "backslash", backslash is used. This is
2271 useful when editing a batch file with 'shellslash' set on MS-Windows.
2272 - When this option is empty, same character is used as for
2273 'shellslash'.
2274 For Insert mode completion the buffer-local value is used. For
2275 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002276
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002277 *'concealcursor'* *'cocu'*
2278'concealcursor' 'cocu' string (default: "")
2279 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002280 {not available when compiled without the |+conceal|
2281 feature}
2282 Sets the modes in which text in the cursor line can also be concealed.
2283 When the current mode is listed then concealing happens just like in
2284 other lines.
2285 n Normal mode
2286 v Visual mode
2287 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002288 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002289
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002290 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002291 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002292 are moving around text is concealed, but when starting to insert text
2293 or selecting a Visual area the concealed text is displayed, so that
2294 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002295 Keep in mind that the cursor position is not always where it's
2296 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002297
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002298 *'conceallevel'* *'cole'*
2299'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002300 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002301 {not available when compiled without the |+conceal|
2302 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002303 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2304 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002305
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002306 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002307 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002308 1 Each block of concealed text is replaced with one
2309 character. If the syntax item does not have a custom
2310 replacement character defined (see |:syn-cchar|) the
2311 character defined in 'listchars' is used (default is a
2312 space).
2313 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002314 2 Concealed text is completely hidden unless it has a
2315 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002316 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002317 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002318
Bram Moolenaara7781e02010-07-19 20:13:22 +02002319 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002320 edit and copy the text. This can be changed with the 'concealcursor'
2321 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002322
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2324'confirm' 'cf' boolean (default off)
2325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 When 'confirm' is on, certain operations that would normally
2327 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2328 instead raise a |dialog| asking if you wish to save the current
2329 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2330 If 'confirm' is off you can still activate confirmation for one
2331 command only (this is most useful in mappings) with the |:confirm|
2332 command.
2333 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2334
2335 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2336'conskey' 'consk' boolean (default off)
2337 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002338 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339
2340 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2341'copyindent' 'ci' boolean (default off)
2342 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 Copy the structure of the existing lines indent when autoindenting a
2344 new line. Normally the new indent is reconstructed by a series of
2345 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2346 in which case only spaces are used). Enabling this option makes the
2347 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002348 existing line. 'expandtab' has no effect on these characters, a Tab
2349 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002351 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 Also see 'preserveindent'.
2353
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002354 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002355'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2356 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002357 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002360 this indicates Vi-compatible behavior. This is used for things where
2361 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 'cpoptions' stands for "compatible-options".
2363 Commas can be added for readability.
2364 To avoid problems with flags that are added in the future, use the
2365 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002366
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 NOTE: This option is set to the Vi default value when 'compatible' is
2368 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002369
2370 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2371 is saved, 'cpoptions' is set to the Vim default, and the saved value
2372 is restored at the end of the script. Changes to the value of
2373 'cpoptions' will be applied to the saved value, but keep in mind that
2374 removing a flag that is not present when 'cpoptions' is changed has no
2375 effect. In the |.vimrc| file the value is not restored, thus using
2376 `vim9script` in the |.vimrc| file results in using the Vim default.
2377
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002378 NOTE: This option is set to the POSIX default value at startup when
2379 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002380 variable exists |posix|. This means Vim tries to behave like the
2381 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382
2383 contains behavior ~
2384 *cpo-a*
2385 a When included, a ":read" command with a file name
2386 argument will set the alternate file name for the
2387 current window.
2388 *cpo-A*
2389 A When included, a ":write" command with a file name
2390 argument will set the alternate file name for the
2391 current window.
2392 *cpo-b*
2393 b "\|" in a ":map" command is recognized as the end of
2394 the map command. The '\' is included in the mapping,
2395 the text after the '|' is interpreted as the next
2396 command. Use a CTRL-V instead of a backslash to
2397 include the '|' in the mapping. Applies to all
2398 mapping, abbreviation, menu and autocmd commands.
2399 See also |map_bar|.
2400 *cpo-B*
2401 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002402 abbreviations, user commands and the "to" part of the
2403 menu commands. Remove this flag to be able to use a
2404 backslash like a CTRL-V. For example, the command
2405 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 'B' included: "\^[" (^[ is a real <Esc>)
2407 'B' excluded: "<Esc>" (5 characters)
2408 ('<' excluded in both cases)
2409 *cpo-c*
2410 c Searching continues at the end of any match at the
2411 cursor position, but not further than the start of the
2412 next line. When not present searching continues
2413 one character from the cursor position. With 'c'
2414 "abababababab" only gets three matches when repeating
2415 "/abab", without 'c' there are five matches.
2416 *cpo-C*
2417 C Do not concatenate sourced lines that start with a
2418 backslash. See |line-continuation|.
2419 *cpo-d*
2420 d Using "./" in the 'tags' option doesn't mean to use
2421 the tags file relative to the current file, but the
2422 tags file in the current directory.
2423 *cpo-D*
2424 D Can't use CTRL-K to enter a digraph after Normal mode
2425 commands with a character argument, like |r|, |f| and
2426 |t|.
2427 *cpo-e*
2428 e When executing a register with ":@r", always add a
2429 <CR> to the last line, also when the register is not
2430 linewise. If this flag is not present, the register
2431 is not linewise and the last line does not end in a
2432 <CR>, then the last line is put on the command-line
2433 and can be edited before hitting <CR>.
2434 *cpo-E*
2435 E It is an error when using "y", "d", "c", "g~", "gu" or
2436 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002437 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 This makes "y0" fail in the first column.
2439 *cpo-f*
2440 f When included, a ":read" command with a file name
2441 argument will set the file name for the current buffer,
2442 if the current buffer doesn't have a file name yet.
2443 *cpo-F*
2444 F When included, a ":write" command with a file name
2445 argument will set the file name for the current
2446 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002447 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 *cpo-g*
2449 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002450 *cpo-H*
2451 H When using "I" on a line with only blanks, insert
2452 before the last blank. Without this flag insert after
2453 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454 *cpo-i*
2455 i When included, interrupting the reading of a file will
2456 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 *cpo-I*
2458 I When moving the cursor up or down just after inserting
2459 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 *cpo-j*
2461 j When joining lines, only add two spaces after a '.',
2462 not after '!' or '?'. Also see 'joinspaces'.
2463 *cpo-J*
2464 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002465 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 white space.
2467 *cpo-k*
2468 k Disable the recognition of raw key codes in
2469 mappings, abbreviations, and the "to" part of menu
2470 commands. For example, if <Key> sends ^[OA (where ^[
2471 is <Esc>), the command ":map X ^[OA" results in X
2472 being mapped to:
2473 'k' included: "^[OA" (3 characters)
2474 'k' excluded: "<Key>" (one key code)
2475 Also see the '<' flag below.
2476 *cpo-K*
2477 K Don't wait for a key code to complete when it is
2478 halfway a mapping. This breaks mapping <F1><F1> when
2479 only part of the second <F1> has been read. It
2480 enables cancelling the mapping by typing <F1><Esc>.
2481 *cpo-l*
2482 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002483 literally, only "\]", "\^", "\-" and "\\" are special.
2484 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2486 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002487 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 *cpo-L*
2489 L When the 'list' option is set, 'wrapmargin',
2490 'textwidth', 'softtabstop' and Virtual Replace mode
2491 (see |gR|) count a <Tab> as two characters, instead of
2492 the normal behavior of a <Tab>.
2493 *cpo-m*
2494 m When included, a showmatch will always wait half a
2495 second. When not included, a showmatch will wait half
2496 a second or until a character is typed. |'showmatch'|
2497 *cpo-M*
2498 M When excluded, "%" matching will take backslashes into
2499 account. Thus in "( \( )" and "\( ( \)" the outer
2500 parenthesis match. When included "%" ignores
2501 backslashes, which is Vi compatible.
2502 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002503 n When included, the column used for 'number' and
2504 'relativenumber' will also be used for text of wrapped
2505 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 *cpo-o*
2507 o Line offset to search command is not remembered for
2508 next search.
2509 *cpo-O*
2510 O Don't complain if a file is being overwritten, even
2511 when it didn't exist when editing it. This is a
2512 protection against a file unexpectedly created by
2513 someone else. Vi didn't complain about this.
2514 *cpo-p*
2515 p Vi compatible Lisp indenting. When not present, a
2516 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002517 *cpo-P*
2518 P When included, a ":write" command that appends to a
2519 file will set the file name for the current buffer, if
2520 the current buffer doesn't have a file name yet and
2521 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002522 *cpo-q*
2523 q When joining multiple lines leave the cursor at the
2524 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 *cpo-r*
2526 r Redo ("." command) uses "/" to repeat a search
2527 command, instead of the actually used search string.
2528 *cpo-R*
2529 R Remove marks from filtered lines. Without this flag
2530 marks are kept like |:keepmarks| was used.
2531 *cpo-s*
2532 s Set buffer options when entering the buffer for the
2533 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002534 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 set when the buffer is created.
2536 *cpo-S*
2537 S Set buffer options always when entering a buffer
2538 (except 'readonly', 'fileformat', 'filetype' and
2539 'syntax'). This is the (most) Vi compatible setting.
2540 The options are set to the values in the current
2541 buffer. When you change an option and go to another
2542 buffer, the value is copied. Effectively makes the
2543 buffer options global to all buffers.
2544
2545 's' 'S' copy buffer options
2546 no no when buffer created
2547 yes no when buffer first entered (default)
2548 X yes each time when buffer entered (vi comp.)
2549 *cpo-t*
2550 t Search pattern for the tag command is remembered for
2551 "n" command. Otherwise Vim only puts the pattern in
2552 the history for search pattern, but doesn't change the
2553 last used search pattern.
2554 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002555 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 *cpo-v*
2557 v Backspaced characters remain visible on the screen in
2558 Insert mode. Without this flag the characters are
2559 erased from the screen right away. With this flag the
2560 screen newly typed text overwrites backspaced
2561 characters.
2562 *cpo-w*
2563 w When using "cw" on a blank character, only change one
2564 character and not all blanks until the start of the
2565 next word.
2566 *cpo-W*
2567 W Don't overwrite a readonly file. When omitted, ":w!"
2568 overwrites a readonly file, if possible.
2569 *cpo-x*
2570 x <Esc> on the command-line executes the command-line.
2571 The default in Vim is to abandon the command-line,
2572 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002573 *cpo-X*
2574 X When using a count with "R" the replaced text is
2575 deleted only once. Also when repeating "R" with "."
2576 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002578 y A yank command can be redone with ".". Think twice if
2579 you really want to use this, it may break some
2580 plugins, since most people expect "." to only repeat a
2581 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002582 *cpo-Z*
2583 Z When using "w!" while the 'readonly' option is set,
2584 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002585 *cpo-z*
2586 z Special casing the "cw" and "d" command (see |cw| and
2587 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 *cpo-!*
2589 ! When redoing a filter command, use the last used
2590 external command, whatever it was. Otherwise the last
2591 used -filter- command is used.
2592 *cpo-$*
2593 $ When making a change to one line, don't redisplay the
2594 line, but put a '$' at the end of the changed text.
2595 The changed text will be overwritten when you type the
2596 new text. The line is redisplayed if you type any
2597 command that moves the cursor from the insertion
2598 point.
2599 *cpo-%*
2600 % Vi-compatible matching is done for the "%" command.
2601 Does not recognize "#if", "#endif", etc.
2602 Does not recognize "/*" and "*/".
2603 Parens inside single and double quotes are also
2604 counted, causing a string that contains a paren to
2605 disturb the matching. For example, in a line like
2606 "if (strcmp("foo(", s))" the first paren does not
2607 match the last one. When this flag is not included,
2608 parens inside single and double quotes are treated
2609 specially. When matching a paren outside of quotes,
2610 everything inside quotes is ignored. When matching a
2611 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002613 This flag is also used for other features, such as
2614 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002615 *cpo--*
2616 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002617 it would go above the first line or below the last
2618 line. Without it the cursor moves to the first or
2619 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002620 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002621 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002622 *cpo-+*
2623 + When included, a ":write file" command will reset the
2624 'modified' flag of the buffer, even though the buffer
2625 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002626 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 * Use ":*" in the same way as ":@". When not included,
2628 ":*" is an alias for ":'<,'>", select the Visual area.
2629 *cpo-<*
2630 < Disable the recognition of special key codes in |<>|
2631 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 ":map X <Tab>" results in X being mapped to:
2634 '<' included: "<Tab>" (5 characters)
2635 '<' excluded: "^I" (^I is a real <Tab>)
2636 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002637 *cpo->*
2638 > When appending to a register, put a line break before
2639 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002640 *cpo-;*
2641 ; When using |,| or |;| to repeat the last |t| search
2642 and the cursor is right in front of the searched
2643 character, the cursor won't move. When not included,
2644 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002645 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002646
2647 POSIX flags. These are not included in the Vi default value, except
2648 when $VIM_POSIX was set on startup. |posix|
2649
2650 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002651 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002652 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002653 *cpo-&*
2654 & When ":preserve" was used keep the swap file when
2655 exiting normally while this buffer is still loaded.
2656 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002657 *cpo-\*
2658 \ Backslash in a [] range in a search pattern is taken
2659 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002660 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2661 '\' excluded: "/[ \-]" finds <Space> and '-'
2662 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002663 *cpo-/*
2664 / When "%" is used as the replacement string in a |:s|
2665 command, use the previous replacement string. |:s%|
2666 *cpo-{*
2667 { The |{| and |}| commands also stop at a "{" character
2668 at the start of a line.
2669 *cpo-.*
2670 . The ":chdir" and ":cd" commands fail if the current
2671 buffer is modified, unless ! is used. Vim doesn't
2672 need this, since it remembers the full path of an
2673 opened file.
2674 *cpo-bar*
2675 | The value of the $LINES and $COLUMNS environment
2676 variables overrule the terminal size values obtained
2677 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002678
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002679 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002680'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002681 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002682 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002683 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002684 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002685 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002686 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002687 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002688 blowfish Blowfish method. Medium strong encryption but it has
2689 an implementation flaw. Requires Vim 7.3 or later,
2690 files can NOT be read by Vim 7.2 and older. This adds
2691 a "seed" to the file, every time you write the file
2692 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002693 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002694 *blowfish2*
2695 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002696 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002697 and older. This adds a "seed" to the file, every time
2698 you write the file the encrypted bytes will be
2699 different. The whole undo file is encrypted, not just
2700 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002701 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002702 *E1197* *E1198* *E1199* *E1200* *E1201*
2703 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002704 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002705 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002706 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002707 It adds a seed and a message authentication code (MAC)
2708 to the file. This needs at least a Vim 8.2.3022 to
2709 read the encrypted file.
2710 Encryption of swap files is not supported, therefore
2711 no swap file will be used when xchacha20 encryption is
2712 enabled.
2713 Encryption of undo files is not yet supported,
2714 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002715 CAREFUL: Files written with this method might have to
2716 be read back with the same version of Vim if the
2717 binary format changes later.
2718 Obsolete, please do no longer use.
2719 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2720 stores the key derivation parameters together with the
2721 encrypted file. Should work better in case the
2722 parameters in the libsodium library ever change.
2723 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002724 might have to be read back with the same version of
2725 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002726
Christian Brabandtaae58342023-04-23 17:50:22 +01002727 You should use "blowfish2", also to re-encrypt older files. The
2728 "xchacha20" method provides better encryption, but it does not work
2729 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002730
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002731 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002732 to the detected method of the file being read. Thus if you write it
2733 without changing 'cryptmethod' the same method will be used.
2734 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002735 explicitly write it, you don't get a warning unless there are other
2736 modifications. Also see |:X|.
2737
2738 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002739 the value "blowfish2". When setting the local value to an empty
2740 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002741
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002742 When a new encryption method is added in a later version of Vim, and
2743 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002744 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002745
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 *'cscopepathcomp'* *'cspc'*
2747'cscopepathcomp' 'cspc' number (default 0)
2748 global
2749 {not available when compiled without the |+cscope|
2750 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 Determines how many components of the path to show in a list of tags.
2752 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002753 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
2755 *'cscopeprg'* *'csprg'*
2756'cscopeprg' 'csprg' string (default "cscope")
2757 global
2758 {not available when compiled without the |+cscope|
2759 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 Specifies the command to execute cscope. See |cscopeprg|.
2761 This option cannot be set from a |modeline| or in the |sandbox|, for
2762 security reasons.
2763
2764 *'cscopequickfix'* *'csqf'*
2765'cscopequickfix' 'csqf' string (default "")
2766 global
2767 {not available when compiled without the |+cscope|
2768 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 Specifies whether to use quickfix window to show cscope results.
2770 See |cscopequickfix|.
2771
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002772 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002773'cscoperelative' 'csre' boolean (default off)
2774 global
2775 {not available when compiled without the |+cscope|
2776 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002777 In the absence of a prefix (-P) for cscope. setting this option enables
2778 to use the basename of cscope.out path as the prefix.
2779 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002780 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002781
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2783'cscopetag' 'cst' boolean (default off)
2784 global
2785 {not available when compiled without the |+cscope|
2786 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 Use cscope for tag commands. See |cscope-options|.
2788 NOTE: This option is reset when 'compatible' is set.
2789
2790 *'cscopetagorder'* *'csto'*
2791'cscopetagorder' 'csto' number (default 0)
2792 global
2793 {not available when compiled without the |+cscope|
2794 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 Determines the order in which ":cstag" performs a search. See
2796 |cscopetagorder|.
2797 NOTE: This option is set to 0 when 'compatible' is set.
2798
2799 *'cscopeverbose'* *'csverb'*
2800 *'nocscopeverbose'* *'nocsverb'*
2801'cscopeverbose' 'csverb' boolean (default off)
2802 global
2803 {not available when compiled without the |+cscope|
2804 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 Give messages when adding a cscope database. See |cscopeverbose|.
2806 NOTE: This option is reset when 'compatible' is set.
2807
Bram Moolenaar860cae12010-06-05 23:22:07 +02002808 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2809'cursorbind' 'crb' boolean (default off)
2810 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002811 When this option is set, as the cursor in the current
2812 window moves other cursorbound windows (windows that also have
2813 this option set) move their cursors to the corresponding line and
2814 column. This option is useful for viewing the
2815 differences between two versions of a file (see 'diff'); in diff mode,
2816 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002817 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002818
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002819 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2820'cursorcolumn' 'cuc' boolean (default off)
2821 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002822 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002823 feature}
2824 Highlight the screen column of the cursor with CursorColumn
2825 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2826 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002827 If you only want the highlighting in the current window you can use
2828 these autocommands: >
2829 au WinLeave * set nocursorline nocursorcolumn
2830 au WinEnter * set cursorline cursorcolumn
2831<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002832
2833 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2834'cursorline' 'cul' boolean (default off)
2835 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002836 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002837 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002838 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2839 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002840 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002841 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002842
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002843 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002844'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002845 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002846 {not available when compiled without the |+syntax|
2847 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002848 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002849 Valid values:
2850 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002851 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002852 "screenline" Highlight only the screen line of the cursor with
2853 CursorLine |hl-CursorLine|.
2854 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002855 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002856
2857 Special value:
2858 "both" Alias for the values "line,number".
2859
2860 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002861
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 *'debug'*
2863'debug' string (default "")
2864 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002865 These values can be used:
2866 msg Error messages that would otherwise be omitted will be given
2867 anyway.
2868 throw Error messages that would otherwise be omitted will be given
2869 anyway and also throw an exception and set |v:errmsg|.
2870 beep A message will be given when otherwise only a beep would be
2871 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002872 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002873 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2874 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875
2876 *'define'* *'def'*
2877'define' 'def' string (default "^\s*#\s*define")
2878 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002879 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 pattern, just like for the "/" command. This option is used for the
2881 commands like "[i" and "[d" |include-search|. The 'isident' option is
2882 used to recognize the defined name after the match:
2883 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2884 See |option-backslash| about inserting backslashes to include a space
2885 or backslash.
2886 The default value is for C programs. For C++ this value would be
2887 useful, to include const type declarations: >
2888 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002889< You can also use "\ze" just before the name and continue the pattern
2890 to check what is following. E.g. for Javascript, if a function is
2891 defined with "func_name = function(args)": >
2892 ^\s*\ze\i\+\s*=\s*function(
2893< If the function is defined with "func_name : function() {...": >
2894 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002896 To avoid that use `:let` with a single quote string: >
2897 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002898<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899
2900 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2901'delcombine' 'deco' boolean (default off)
2902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 If editing Unicode and this option is set, backspace and Normal mode
2904 "x" delete each combining character on its own. When it is off (the
2905 default) the character along with its combining characters are
2906 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002907 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908
2909 This is useful for Arabic, Hebrew and many other languages where one
2910 may have combining characters overtop of base characters, and want
2911 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002912 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913
2914 *'dictionary'* *'dict'*
2915'dictionary' 'dict' string (default "")
2916 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 List of file names, separated by commas, that are used to lookup words
2918 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2919 contain a list of words. This can be one word per line, or several
2920 words per line, separated by non-keyword characters (white space is
2921 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002922
2923 When this option is empty or an entry "spell" is present, and spell
2924 checking is enabled, words in the word lists for the currently active
2925 'spelllang' are used. See |spell|.
2926
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002927 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 after a comma are ignored, otherwise spaces are included in the file
2929 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002930 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 Where to find a list of words?
2932 - On FreeBSD, there is the file "/usr/share/dict/words".
2933 - In the Simtel archive, look in the "msdos/linguist" directory.
2934 - In "miscfiles" of the GNU collection.
2935 The use of |:set+=| and |:set-=| is preferred when adding or removing
2936 directories from the list. This avoids problems when a future version
2937 uses another default.
2938 Backticks cannot be used in this option for security reasons.
2939
2940 *'diff'* *'nodiff'*
2941'diff' boolean (default off)
2942 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 {not available when compiled without the |+diff|
2944 feature}
2945 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002946 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947
2948 *'dex'* *'diffexpr'*
2949'diffexpr' 'dex' string (default "")
2950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 {not available when compiled without the |+diff|
2952 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002953 Expression which is evaluated to obtain a diff file (either ed-style
2954 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 This option cannot be set from a |modeline| or in the |sandbox|, for
2956 security reasons.
2957
2958 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002959'diffopt' 'dip' string (default
2960 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 {not available when compiled without the |+diff|
2963 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002964 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 All are optional. Items must be separated by a comma.
2966
Jonathon7c7a4e62025-01-12 09:58:00 +01002967 algorithm:{text} Use the specified diff algorithm with the
2968 internal diff engine. Currently supported
2969 algorithms are:
2970 myers the default algorithm
2971 minimal spend extra time to generate the
2972 smallest possible diff
2973 patience patience diff algorithm
2974 histogram histogram diff algorithm
2975
2976 closeoff When a window is closed where 'diff' is set
2977 and there is only one window remaining in the
2978 same tab page with 'diff' set, execute
2979 `:diffoff` in that window. This undoes a
2980 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981
2982 context:{n} Use a context of {n} lines between a change
2983 and a fold that contains unchanged lines.
2984 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002985 When using zero the context is actually one,
2986 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002987 for a deleted line. Set it to a very large
2988 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 See |fold-diff|.
2990
Jonathon7c7a4e62025-01-12 09:58:00 +01002991 filler Show filler lines, to keep the text
2992 synchronized with a window that has inserted
2993 lines at the same position. Mostly useful
2994 when windows are side-by-side and 'scrollbind'
2995 is set.
2996
2997 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2998 starting diff mode. Without this 2 is used.
2999
3000 followwrap Follow the 'wrap' option and leave as it is.
3001
3002 horizontal Start diff mode with horizontal splits (unless
3003 explicitly specified otherwise).
3004
3005 hiddenoff Do not use diff mode for a buffer when it
3006 becomes hidden.
3007
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003008 iblank Ignore changes where lines are all blank. Adds
3009 the "-B" flag to the "diff" command if
3010 'diffexpr' is empty. Check the documentation
3011 of the "diff" command for what this does
3012 exactly.
3013 NOTE: the diff windows will get out of sync,
3014 because no differences between blank lines are
3015 taken into account.
3016
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 icase Ignore changes in case of text. "a" and "A"
3018 are considered the same. Adds the "-i" flag
3019 to the "diff" command if 'diffexpr' is empty.
3020
Jonathon7c7a4e62025-01-12 09:58:00 +01003021 indent-heuristic
3022 Use the indent heuristic for the internal
3023 diff library.
3024
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003025 inline:{text} Highlight inline differences within a change.
3026 See |view-diffs|. Supported values are:
3027
3028 none Do not perform inline highlighting.
3029 simple Highlight from first different
3030 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003031 line. This is the default if no
3032 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003033 char Use internal diff to perform a
3034 character-wise diff and highlight the
3035 difference.
3036 word Use internal diff to perform a
3037 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003038 difference. Non-alphanumeric
3039 multi-byte characters such as emoji
3040 and CJK characters are considered
3041 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003042
Jonathon7c7a4e62025-01-12 09:58:00 +01003043 internal Use the internal diff library. This is
3044 ignored when 'diffexpr' is set. *E960*
3045 When running out of memory when writing a
3046 buffer this item will be ignored for diffs
3047 involving that buffer. Set the 'verbose'
3048 option to see when this happens.
3049
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 iwhite Ignore changes in amount of white space. Adds
3051 the "-b" flag to the "diff" command if
3052 'diffexpr' is empty. Check the documentation
3053 of the "diff" command for what this does
3054 exactly. It should ignore adding trailing
3055 white space, but not leading white space.
3056
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003057 iwhiteall Ignore all white space changes. Adds
3058 the "-w" flag to the "diff" command if
3059 'diffexpr' is empty. Check the documentation
3060 of the "diff" command for what this does
3061 exactly.
3062
3063 iwhiteeol Ignore white space changes at end of line.
3064 Adds the "-Z" flag to the "diff" command if
3065 'diffexpr' is empty. Check the documentation
3066 of the "diff" command for what this does
3067 exactly.
3068
Jonathon7c7a4e62025-01-12 09:58:00 +01003069 linematch:{n} Align and mark changes between the most
3070 similar lines between the buffers. When the
3071 total number of lines in the diff hunk exceeds
3072 {n}, the lines will not be aligned because for
3073 very large diff hunks there will be a
3074 noticeable lag. A reasonable setting is
3075 "linematch:60", as this will enable alignment
3076 for a 2 buffer diff hunk of 30 lines each,
3077 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003078
3079 vertical Start diff mode with vertical splits (unless
3080 explicitly specified otherwise).
3081
Bram Moolenaare828b762018-09-10 17:51:58 +02003082 Examples: >
3083 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003085 :set diffopt=internal,filler,foldcolumn:3
3086 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087<
3088 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3089'digraph' 'dg' boolean (default off)
3090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 {not available when compiled without the |+digraphs|
3092 feature}
3093 Enable the entering of digraphs in Insert mode with {char1} <BS>
3094 {char2}. See |digraphs|.
3095 NOTE: This option is reset when 'compatible' is set.
3096
3097 *'directory'* *'dir'*
3098'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003099 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 for Unix: ".,~/tmp,/var/tmp,/tmp")
3101 global
3102 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003103 Recommended value: ".,~/vimswap//" - this will put the swap file next
3104 to the edited file if possible, and in your personal swap directory
3105 otherwise. Make sure "~/vimswap//" is only readable for you.
3106
3107 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 - The swap file will be created in the first directory where this is
3109 possible.
3110 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003111 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 - A directory "." means to put the swap file in the same directory as
3113 the edited file. On Unix, a dot is prepended to the file name, so
3114 it doesn't show in a directory listing. On MS-Windows the "hidden"
3115 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003116 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3117 the swap file relative to where the edited file is. The leading "."
3118 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003119 - For Unix and Win32, if a directory ends in two path separators "//",
3120 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003121 with all path separators replaced by percent '%' signs (including
3122 the colon following the drive letter on Win32). This will ensure
3123 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003124 On Win32, it is also possible to end with "\\". However, When a
3125 separating comma is following, you must use "//", since "\\" will
3126 include the comma in the file name. Therefore it is recommended to
3127 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 - Spaces after the comma are ignored, other spaces are considered part
3129 of the directory name. To have a space at the start of a directory
3130 name, precede it with a backslash.
3131 - To include a comma in a directory name precede it with a backslash.
3132 - A directory name may end in an ':' or '/'.
3133 - Environment variables are expanded |:set_env|.
3134 - Careful with '\' characters, type one before a space, type two to
3135 get one in the option (see |option-backslash|), for example: >
3136 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3137< - For backwards compatibility with Vim version 3.0 a '>' at the start
3138 of the option is removed.
3139 Using "." first in the list is recommended. This means that editing
3140 the same file twice will result in a warning. Using "/tmp" on Unix is
3141 discouraged: When the system crashes you lose the swap file.
3142 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003143 choice than "/tmp". But others on the computer may be able to see the
3144 files, and it can contain a lot of files, your swap files get lost in
3145 the crowd. That is why a "tmp" directory in your home directory is
3146 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 The use of |:set+=| and |:set-=| is preferred when adding or removing
3148 directories from the list. This avoids problems when a future version
3149 uses another default.
3150 This option cannot be set from a |modeline| or in the |sandbox|, for
3151 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152
3153 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003154'display' 'dy' string (default "", set to "truncate" in
3155 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003157 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 flags:
3159 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003160 in a window will be displayed. "@@@" is put in the
3161 last columns of the last screen line to indicate the
3162 rest of the line is not displayed.
3163 truncate Like "lastline", but "@@@" is displayed in the first
3164 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 uhex Show unprintable characters hexadecimal as <xx>
3166 instead of using ^C and ~C.
3167
Bram Moolenaard0796902016-09-16 20:02:31 +02003168 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003169 doesn't fit is replaced with "@" lines.
3170
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003171 The "@" character can be changed by setting the "lastline" item in
3172 'fillchars'. The character is highlighted with |hl-NonText|.
3173
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 *'eadirection'* *'ead'*
3175'eadirection' 'ead' string (default "both")
3176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 Tells when the 'equalalways' option applies:
3178 ver vertically, width of windows is not affected
3179 hor horizontally, height of windows is not affected
3180 both width and height of windows is affected
3181
3182 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3183'edcompatible' 'ed' boolean (default off)
3184 global
3185 Makes the 'g' and 'c' flags of the ":substitute" command to be
3186 toggled each time the flag is given. See |complex-change|. See
3187 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003188 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003189 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190
Bram Moolenaar03413f42016-04-12 21:07:15 +02003191 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003192'emoji' 'emo' boolean (default: on)
3193 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003194 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003195 This excludes "text emoji" characters, which are normally displayed as
3196 single width. Unfortunately there is no good specification for this
3197 and it has been determined on trial-and-error basis. Use the
3198 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003201'encoding' 'enc' string (default for MS-Windows: "utf-8",
3202 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 Sets the character encoding used inside Vim. It applies to text in
3205 the buffers, registers, Strings in expressions, text stored in the
3206 viminfo file, etc. It sets the kind of characters which Vim can work
3207 with. See |encoding-names| for the possible values.
3208
3209 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003210 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003212 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213
Bram Moolenaar865242e2010-07-14 21:12:05 +02003214 This option cannot be set from a |modeline|. It would most likely
3215 corrupt the text.
3216
Bram Moolenaar3df01732017-02-17 22:47:16 +01003217 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3218 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 'encoding', "utf-8" is the natural choice for the environment and
3220 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003221 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 versions, and to avoid changing the encoding of newly created files
3223 without your knowledge (in case 'fileencodings' is empty).
3224
3225 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 iconv() or as specified with 'charconvert'.
3228
Bram Moolenaar207f0092020-08-30 17:20:20 +02003229 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003230 can use: >
3231 if has("multi_byte_encoding")
3232<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 Normally 'encoding' will be equal to your current locale. This will
3234 be the default if Vim recognizes your environment settings. If
3235 'encoding' is not set to the current locale, 'termencoding' must be
3236 set to convert typed and displayed text. See |encoding-table|.
3237
3238 When you set this option, it fires the |EncodingChanged| autocommand
3239 event so that you can set up fonts if necessary.
3240
3241 When the option is set, the value is converted to lowercase. Thus
3242 you can set it with uppercase values too. Underscores are translated
3243 to '-' signs.
3244 When the encoding is recognized, it is changed to the standard name.
3245 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3246 "iso-8859-2" and "utf8" becomes "utf-8".
3247
3248 Note: "latin1" is also used when the encoding could not be detected.
3249 This only works when editing files in the same encoding! When the
3250 actual character set is not latin1, make sure 'fileencoding' and
3251 'fileencodings' are empty. When conversion is needed, switch to using
3252 utf-8.
3253
3254 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3255 You don't notice this while editing, but it does matter for the
3256 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3257 setting 'encoding' to one of these values instead of utf-8 only has
3258 effect for encoding used for files when 'fileencoding' is empty.
3259
Bram Moolenaar661b1822005-07-28 22:36:45 +00003260 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3261 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003263 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003264'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003266 Indicates that a CTRL-Z character was found at the end of the file
3267 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003269 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003270 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003271 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003272
3273 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3274'endofline' 'eol' boolean (default on)
3275 local to buffer
3276 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003277 is on, or 'fixeol' option is off, no <EOL> will be written for the
3278 last line in the file. This option is automatically set or reset when
3279 starting to edit a new file, depending on whether file has an <EOL>
3280 for the last line in the file. Normally you don't have to set or
3281 reset this option.
3282 When 'binary' is off and 'fixeol' is on the value is not used when
3283 writing the file. When 'binary' is on or 'fixeol' is off it is used
3284 to remember the presence of a <EOL> for the last line in the file, so
3285 that when you write the file the situation from the original file can
3286 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003287 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3290'equalalways' 'ea' boolean (default on)
3291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003293 splitting or closing a window. This also happens the moment the
3294 option is switched on. When off, splitting a window will reduce the
3295 size of the current window and leave the other windows the same. When
3296 closing a window the extra lines are given to the window next to it
3297 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 When mixing vertically and horizontally split windows, a minimal size
3299 is computed and some windows may be larger if there is room. The
3300 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003301 Changing the height and width of a window can be avoided by setting
3302 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003303 If a window size is specified when creating a new window sizes are
3304 currently not equalized (it's complicated, but may be implemented in
3305 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306
3307 *'equalprg'* *'ep'*
3308'equalprg' 'ep' string (default "")
3309 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003311 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003312 or 'indentexpr'. When Vim was compiled without internal formatting,
3313 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003314 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 about including spaces and backslashes.
3316 This option cannot be set from a |modeline| or in the |sandbox|, for
3317 security reasons.
3318
3319 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3320'errorbells' 'eb' boolean (default off)
3321 global
3322 Ring the bell (beep or screen flash) for error messages. This only
3323 makes a difference for error messages, the bell will be used always
3324 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003325 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003326 screen flash or do nothing. See 'belloff' to finetune when to ring the
3327 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328
3329 *'errorfile'* *'ef'*
3330'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3331 others: "errors.err")
3332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 {not available when compiled without the |+quickfix|
3334 feature}
3335 Name of the errorfile for the QuickFix mode (see |:cf|).
3336 When the "-q" command-line argument is used, 'errorfile' is set to the
3337 following argument. See |-q|.
3338 NOT used for the ":make" command. See 'makeef' for that.
3339 Environment variables are expanded |:set_env|.
3340 See |option-backslash| about including spaces and backslashes.
3341 This option cannot be set from a |modeline| or in the |sandbox|, for
3342 security reasons.
3343
3344 *'errorformat'* *'efm'*
3345'errorformat' 'efm' string (default is very long)
3346 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 {not available when compiled without the |+quickfix|
3348 feature}
3349 Scanf-like description of the format for the lines in the error file
3350 (see |errorformat|).
3351
3352 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3353'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 Function keys that start with an <Esc> are recognized in Insert
3356 mode. When this option is off, the cursor and function keys cannot be
3357 used in Insert mode if they start with an <Esc>. The advantage of
3358 this is that the single <Esc> is recognized immediately, instead of
3359 after one second. Instead of resetting this option, you might want to
3360 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3361 when 'esckeys' is off, you can still map anything, but the cursor keys
3362 won't work by default.
3363 NOTE: This option is set to the Vi default value when 'compatible' is
3364 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003365 NOTE: when this option is off then the |modifyOtherKeys| and
3366 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3367 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368
3369 *'eventignore'* *'ei'*
3370'eventignore' 'ei' string (default "")
3371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003373 When set to "all" or when "all" is one of the items, all autocommand
3374 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003375 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 :set ei=WinEnter,WinLeave
3377<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003378 *'eventignorewin'* *'eiw'*
3379'eventignorewin' 'eiw' string (default "")
3380 window-local
3381 Similar to 'eventignore' but applies to a particular window and its
3382 buffers, for which window and buffer related autocommands can be
3383 ignored indefinitely without affecting the global 'eventignore'.
3384
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3386'expandtab' 'et' boolean (default off)
3387 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003389 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3391 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003392 This option is reset when the 'paste' option is set and restored when
3393 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 NOTE: This option is reset when 'compatible' is set.
3395
3396 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3397'exrc' 'ex' boolean (default off)
3398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003400 directory.
3401
3402 Setting this option is a potential security leak. E.g., consider
3403 unpacking a package or fetching files from github, a .vimrc in there
3404 might be a trojan horse. BETTER NOT SET THIS OPTION!
3405 Instead, define an autocommand in your .vimrc to set options for a
3406 matching directory.
3407
3408 If you do switch this option on you should also consider setting the
3409 'secure' option (see |initialization|).
3410 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 This option cannot be set from a |modeline| or in the |sandbox|, for
3412 security reasons.
3413
3414 *'fileencoding'* *'fenc'* *E213*
3415'fileencoding' 'fenc' string (default: "")
3416 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003418
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003420 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 When 'fileencoding' is empty, the same value as 'encoding' will be
3422 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003423 No error will be given when the value is set, only when it is used,
3424 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003425 Conversion will also be done when 'encoding' and 'fileencoding' are
3426 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3427 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003429 'encoding' is "utf-8" or another Unicode encoding, conversion
3430 is most likely done in a way that the reverse conversion
3431 results in the same text. When 'encoding' is not "utf-8" some
3432 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 See 'encoding' for the possible values. Additionally, values may be
3435 specified that can be handled by the converter, see
3436 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003437
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 When reading a file 'fileencoding' will be set from 'fileencodings'.
3439 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003440 'fileencoding', use the |++enc| argument. One exception: when
3441 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003442 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003443
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3445 When the option is set, the value is converted to lowercase. Thus
3446 you can set it with uppercase values too. '_' characters are
3447 replaced with '-'. If a name is recognized from the list for
3448 'encoding', it is replaced by the standard name. For example
3449 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003450
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 When this option is set, after starting to edit a file, the 'modified'
3452 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003453
3454 Keep in mind that changing 'fenc' from a modeline happens
3455 AFTER the text has been read, thus it applies to when the file will be
3456 written. If you do set 'fenc' in a modeline, you might want to set
3457 'nomodified' to avoid not being able to ":q".
3458
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 This option can not be changed when 'modifiable' is off.
3460
3461 *'fe'*
3462 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003463 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 old short name was 'fe', which is no longer used.
3465
3466 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003467'fileencodings' 'fencs' string (default: "ucs-bom",
3468 "ucs-bom,utf-8,default,latin1" when
3469 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 This is a list of character encodings considered when starting to edit
3472 an existing file. When a file is read, Vim tries to use the first
3473 mentioned character encoding. If an error is detected, the next one
3474 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003475 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 an empty string, which means the value of 'encoding' is used.
3477 WARNING: Conversion can cause loss of information! When
3478 'encoding' is "utf-8" (or one of the other Unicode variants)
3479 conversion is most likely done in a way that the reverse
3480 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003481 "utf-8" some non-ASCII characters may be lost! You can use
3482 the |++bad| argument to specify what is done with characters
3483 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 For an empty file or a file with only ASCII characters most encodings
3485 will work and the first entry of 'fileencodings' will be used (except
3486 "ucs-bom", which requires the BOM to be present). If you prefer
3487 another encoding use an BufReadPost autocommand event to test if your
3488 preferred encoding is to be used. Example: >
3489 au BufReadPost * if search('\S', 'w') == 0 |
3490 \ set fenc=iso-2022-jp | endif
3491< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3492 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003493 When the |++enc| argument is used then the value of 'fileencodings' is
3494 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003495 Note that 'fileencodings' is not used for a new file, the global value
3496 of 'fileencoding' is used instead. You can set it with: >
3497 :setglobal fenc=iso-8859-2
3498< This means that a non-existing file may get a different encoding than
3499 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 The special value "ucs-bom" can be used to check for a Unicode BOM
3501 (Byte Order Mark) at the start of the file. It must not be preceded
3502 by "utf-8" or another Unicode encoding for this to work properly.
3503 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3504 because Vim cannot detect an error, thus the encoding is always
3505 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003506 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003507 environment. On MS-Windows this is the system encoding. Otherwise
3508 this is the default value for 'encoding'. It is useful when
3509 'encoding' is set to "utf-8" and your environment uses a non-latin1
3510 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003511 When 'encoding' is "utf-8" and a file contains an illegal byte
3512 sequence it won't be recognized as UTF-8. You can use the |8g8|
3513 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 WRONG VALUES: WHAT'S WRONG:
3515 latin1,utf-8 "latin1" will always be used
3516 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3517 file
3518 cp1250,latin1 "cp1250" will always be used
3519 If 'fileencodings' is empty, 'fileencoding' is not modified.
3520 See 'fileencoding' for the possible values.
3521 Setting this option does not have an effect until the next time a file
3522 is read.
3523
3524 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003525'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003526 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 This gives the <EOL> of the current buffer, which is used for
3529 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003530 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 unix <NL>
3532 mac <CR>
3533 When "dos" is used, CTRL-Z at the end of a file is ignored.
3534 See |file-formats| and |file-read|.
3535 For the character encoding of the file see 'fileencoding'.
3536 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003537 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 This option is set automatically when starting to edit a file and
3539 'fileformats' is not empty and 'binary' is off.
3540 When this option is set, after starting to edit a file, the 'modified'
3541 option is set, because the file would be different when written.
3542 This option can not be changed when 'modifiable' is off.
3543 For backwards compatibility: When this option is set to "dos",
3544 'textmode' is set, otherwise 'textmode' is reset.
3545
3546 *'fileformats'* *'ffs'*
3547'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003548 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003549 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 Vi Cygwin: "unix,dos",
3551 Vi others: "")
3552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 This gives the end-of-line (<EOL>) formats that will be tried when
3554 starting to edit a new buffer and when reading a file into an existing
3555 buffer:
3556 - When empty, the format defined with 'fileformat' will be used
3557 always. It is not set automatically.
3558 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003559 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 'fileformats' name will be used when a file is read into an existing
3561 buffer, no matter what 'fileformat' for that buffer is set to.
3562 - When more than one name is present, separated by commas, automatic
3563 <EOL> detection will be done when reading a file. When starting to
3564 edit a file, a check is done for the <EOL>:
3565 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3566 'fileformat' is set to "dos".
3567 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003568 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003570 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3571 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003572 This means that "mac" is only chosen when:
3573 "unix" is not present or no <NL> is found in the file, and
3574 "dos" is not present or no <CR><NL> is found in the file.
3575 Except: if "unix" was chosen, but there is a <CR> before
3576 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003577 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 4. If 'fileformat' is still not set, the first name from
3579 'fileformats' is used.
3580 When reading a file into an existing buffer, the same is done, but
3581 this happens like 'fileformat' has been set appropriately for that
3582 file only, the option is not changed.
3583 When 'binary' is set, the value of 'fileformats' is not used.
3584
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003585 When Vim starts up with an empty buffer the first item is used. You
3586 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003587
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3589 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3590 done:
3591 - When 'fileformats' is empty, there is no automatic detection. Dos
3592 format will be used.
3593 - When 'fileformats' is set to one or more names, automatic detection
3594 is done. This is based on the first <NL> in the file: If there is a
3595 <CR> in front of it, Dos format is used, otherwise Unix format is
3596 used.
3597 Also see |file-formats|.
3598 For backwards compatibility: When this option is set to an empty
3599 string or one format (no comma is included), 'textauto' is reset,
3600 otherwise 'textauto' is set.
3601 NOTE: This option is set to the Vi default value when 'compatible' is
3602 set and to the Vim default value when 'compatible' is reset.
3603
Bram Moolenaarbf884932013-04-05 22:26:15 +02003604 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3605'fileignorecase' 'fic' boolean (default on for systems where case in file
3606 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003607 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003608 When set case is ignored when using file names and directories.
3609 See 'wildignorecase' for only ignoring case when doing completion.
3610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 *'filetype'* *'ft'*
3612'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003613 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 When this option is set, the FileType autocommand event is triggered.
3615 All autocommands that match with the value of this option will be
3616 executed. Thus the value of 'filetype' is used in place of the file
3617 name.
3618 Otherwise this option does not always reflect the current file type.
3619 This option is normally set when the file type is detected. To enable
3620 this use the ":filetype on" command. |:filetype|
3621 Setting this option to a different value is most useful in a modeline,
3622 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003623 Example, for in an IDL file:
3624 /* vim: set filetype=idl : */ ~
3625 |FileType| |filetypes|
3626 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003627 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003628 /* vim: set filetype=c.doxygen : */ ~
3629 This will use the "c" filetype first, then the "doxygen" filetype.
3630 This works both for filetype plugins and for syntax files. More than
3631 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 This option is not copied to another buffer, independent of the 's' or
3633 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003634 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635
3636 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003637'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003638 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003639 Characters to fill the statuslines, vertical separators, special
3640 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003641 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003642 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003644 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003645 stl ' ' statusline of the current window
3646 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003647 vert '|' vertical separators |:vsplit|
3648 fold '-' filling 'foldtext'
3649 foldopen '-' mark the beginning of a fold
3650 foldclose '+' show a closed fold
3651 foldsep '|' open fold middle character
3652 diff '-' deleted lines of the 'diff' option
3653 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003654 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003655 trunc '>' truncated text in the
3656 |ins-completion-menu|.
glepnird4dbf822025-04-12 18:35:34 +02003657 truncrl '<' same as "trunc' in 'rightleft' mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003659 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660
3661 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003662 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3663<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003664 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3665 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003666 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003667
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003669 item name highlight group ~
3670 stl StatusLine |hl-StatusLine|
3671 stlnc StatusLineNC |hl-StatusLineNC|
3672 vert VertSplit |hl-VertSplit|
3673 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003674 foldopen FoldColumn |hl-FoldColumn|
3675 foldclose FoldColumn |hl-FoldColumn|
3676 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003677 diff DiffDelete |hl-DiffDelete|
3678 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003679 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003680 trunc one of the many Popup menu highlighting groups like
3681 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003682 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003684 *'findfunc'* *'ffu'* *E1514*
3685'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003686 global or local to buffer |global-local|
3687 {not available when compiled without the |+eval|
3688 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003689 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003690 command. When this option is empty, the internal |file-searching|
3691 mechanism is used.
3692
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003693 The value can be the name of a function, a |lambda| or a |Funcref|.
3694 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003695
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003696 The function is called with two arguments. The first argument is a
3697 |String| and is the |:find| command argument. The second argument is
3698 a |Boolean| and is set to |v:true| when the function is called to get
3699 a List of command-line completion matches for the |:find| command.
3700 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003701
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003702 The function is called only once per |:find| command invocation.
3703 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003704
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003705 If a match is found, the function should return a |List| containing
3706 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003707 should return an empty List.
3708
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003709 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003710 empty List is used as the return value.
3711
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003712 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003713 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003714
3715 This option cannot be set from a |modeline| or in the |sandbox|, for
3716 security reasons.
3717
3718 Examples:
3719>
3720 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003721 func FindFuncGlob(cmdarg, cmdcomplete)
3722 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003723 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003724 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003725 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003726
3727 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003728 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003729 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003730 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003731 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003732 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003733<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003734 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3735'fixendofline' 'fixeol' boolean (default on)
3736 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003737 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003738 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003739 preserve the situation from the original file.
3740 When the 'binary' option is set the value of this option doesn't
3741 matter.
3742 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003743 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003744
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003746'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 {only available when compiled with the |+rightleft|
3749 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003750 This option was for using Farsi, which has been removed. See
3751 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752
3753 *'foldclose'* *'fcl'*
3754'foldclose' 'fcl' string (default "")
3755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 {not available when compiled without the |+folding|
3757 feature}
3758 When set to "all", a fold is closed when the cursor isn't in it and
3759 its level is higher than 'foldlevel'. Useful if you want folds to
3760 automatically close when moving out of them.
3761
3762 *'foldcolumn'* *'fdc'*
3763'foldcolumn' 'fdc' number (default 0)
3764 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 {not available when compiled without the |+folding|
3766 feature}
3767 When non-zero, a column with the specified width is shown at the side
3768 of the window which indicates open and closed folds. The maximum
3769 value is 12.
3770 See |folding|.
3771
3772 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3773'foldenable' 'fen' boolean (default on)
3774 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 {not available when compiled without the |+folding|
3776 feature}
3777 When off, all folds are open. This option can be used to quickly
3778 switch between showing all text unfolded and viewing the text with
3779 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003780 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 'foldenable' is off.
3782 This option is set by commands that create a new fold or close a fold.
3783 See |folding|.
3784
3785 *'foldexpr'* *'fde'*
3786'foldexpr' 'fde' string (default: "0")
3787 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003789 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003791 for each line to obtain its fold level. The context is set to the
3792 script where 'foldexpr' was set, script-local items can be accessed.
3793 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003794
Bram Moolenaar30b65812012-07-12 22:01:11 +02003795 The expression will be evaluated in the |sandbox| if set from a
3796 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003797 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003798 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003799
3800 It is not allowed to change text or jump to another window while
3801 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802
3803 *'foldignore'* *'fdi'*
3804'foldignore' 'fdi' string (default: "#")
3805 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 {not available when compiled without the |+folding|
3807 feature}
3808 Used only when 'foldmethod' is "indent". Lines starting with
3809 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003810 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 The default "#" works well for C programs. See |fold-indent|.
3812
3813 *'foldlevel'* *'fdl'*
3814'foldlevel' 'fdl' number (default: 0)
3815 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {not available when compiled without the |+folding|
3817 feature}
3818 Sets the fold level: Folds with a higher level will be closed.
3819 Setting this option to zero will close all folds. Higher numbers will
3820 close fewer folds.
3821 This option is set by commands like |zm|, |zM| and |zR|.
3822 See |fold-foldlevel|.
3823
3824 *'foldlevelstart'* *'fdls'*
3825'foldlevelstart' 'fdls' number (default: -1)
3826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 {not available when compiled without the |+folding|
3828 feature}
3829 Sets 'foldlevel' when starting to edit another buffer in a window.
3830 Useful to always start editing with all folds closed (value zero),
3831 some folds closed (one) or no folds closed (99).
3832 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 ignores this option and closes all folds.
3835 It is also done before BufReadPre autocommands, to allow an autocmd to
3836 overrule the 'foldlevel' value for specific files.
3837 When the value is negative, it is not used.
3838
3839 *'foldmarker'* *'fmr'* *E536*
3840'foldmarker' 'fmr' string (default: "{{{,}}}")
3841 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 {not available when compiled without the |+folding|
3843 feature}
3844 The start and end marker used when 'foldmethod' is "marker". There
3845 must be one comma, which separates the start and end marker. The
3846 marker is a literal string (a regular expression would be too slow).
3847 See |fold-marker|.
3848
3849 *'foldmethod'* *'fdm'*
3850'foldmethod' 'fdm' string (default: "manual")
3851 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 {not available when compiled without the |+folding|
3853 feature}
3854 The kind of folding used for the current window. Possible values:
3855 |fold-manual| manual Folds are created manually.
3856 |fold-indent| indent Lines with equal indent form a fold.
3857 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3858 |fold-marker| marker Markers are used to specify folds.
3859 |fold-syntax| syntax Syntax highlighting items specify folds.
3860 |fold-diff| diff Fold text that is not changed.
3861
3862 *'foldminlines'* *'fml'*
3863'foldminlines' 'fml' number (default: 1)
3864 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 {not available when compiled without the |+folding|
3866 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003867 Sets the number of screen lines above which a fold can be displayed
3868 closed. Also for manually closed folds. With the default value of
3869 one a fold can only be closed if it takes up two or more screen lines.
3870 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003871 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 "zc" to close a fold, which is displayed open because it's smaller
3873 than 'foldminlines', a following "zc" may close a containing fold.
3874
3875 *'foldnestmax'* *'fdn'*
3876'foldnestmax' 'fdn' number (default: 20)
3877 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 {not available when compiled without the |+folding|
3879 feature}
3880 Sets the maximum nesting of folds for the "indent" and "syntax"
3881 methods. This avoids that too many folds will be created. Using more
3882 than 20 doesn't work, because the internal limit is 20.
3883
3884 *'foldopen'* *'fdo'*
3885'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3886 search,tag,undo")
3887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 {not available when compiled without the |+folding|
3889 feature}
3890 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003891 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003893 NOTE: When the command is part of a mapping this option is not used.
3894 Add the |zv| command to the mapping to get the same effect.
3895 (rationale: the mapping may want to control opening folds itself)
3896
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 item commands ~
3898 all any
3899 block "(", "{", "[[", "[{", etc.
3900 hor horizontal movements: "l", "w", "fx", etc.
3901 insert any command in Insert mode
3902 jump far jumps: "G", "gg", etc.
3903 mark jumping to a mark: "'m", CTRL-O, etc.
3904 percent "%"
3905 quickfix ":cn", ":crew", ":make", etc.
3906 search search for a pattern: "/", "n", "*", "gd", etc.
3907 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003908 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 tag jumping to a tag: ":ta", CTRL-T, etc.
3910 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 When a movement command is used for an operator (e.g., "dl" or "y%")
3912 this option is not used. This means the operator will include the
3913 whole closed fold.
3914 Note that vertical movements are not here, because it would make it
3915 very difficult to move onto a closed fold.
3916 In insert mode the folds containing the cursor will always be open
3917 when text is inserted.
3918 To close folds you can re-apply 'foldlevel' with the |zx| command or
3919 set the 'foldclose' option to "all".
3920
3921 *'foldtext'* *'fdt'*
3922'foldtext' 'fdt' string (default: "foldtext()")
3923 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 {not available when compiled without the |+folding|
3925 feature}
3926 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003927 fold. The context is set to the script where 'foldexpr' was set,
3928 script-local items can be accessed. See |fold-foldtext| for the
3929 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930
Bram Moolenaar30b65812012-07-12 22:01:11 +02003931 The expression will be evaluated in the |sandbox| if set from a
3932 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003933 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003934
3935 It is not allowed to change text or jump to another window while
3936 evaluating 'foldtext' |textlock|.
3937
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003938 *'formatexpr'* *'fex'*
3939'formatexpr' 'fex' string (default "")
3940 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003941 {not available when compiled without the |+eval|
3942 feature}
3943 Expression which is evaluated to format a range of lines for the |gq|
3944 operator or automatic formatting (see 'formatoptions'). When this
3945 option is empty 'formatprg' is used.
3946
3947 The |v:lnum| variable holds the first line to be formatted.
3948 The |v:count| variable holds the number of lines to be formatted.
3949 The |v:char| variable holds the character that is going to be
3950 inserted if the expression is being evaluated due to
3951 automatic formatting. This can be empty. Don't insert
3952 it yet!
3953
3954 Example: >
3955 :set formatexpr=mylang#Format()
3956< This will invoke the mylang#Format() function in the
3957 autoload/mylang.vim file in 'runtimepath'. |autoload|
3958
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003959 The advantage of using a function call without arguments is that it is
3960 faster, see |expr-option-function|.
3961
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003962 The expression is also evaluated when 'textwidth' is set and adding
3963 text beyond that limit. This happens under the same conditions as
3964 when internal formatting is used. Make sure the cursor is kept in the
3965 same spot relative to the text then! The |mode()| function will
3966 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003967
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003968 When the expression evaluates to non-zero Vim will fall back to using
3969 the internal format mechanism.
3970
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003971 If the expression starts with s: or |<SID>|, then it is replaced with
3972 the script ID (|local-function|). Example: >
3973 set formatexpr=s:MyFormatExpr()
3974 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003975< Otherwise, the expression is evaluated in the context of the script
3976 where the option was set, thus script-local items are available.
3977
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003978 The expression will be evaluated in the |sandbox| when set from a
3979 modeline, see |sandbox-option|. That stops the option from working,
3980 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003981 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003982 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003983
Bram Moolenaar86b68352004-12-27 21:59:20 +00003984 *'formatlistpat'* *'flp'*
3985'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3986 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003987 A pattern that is used to recognize a list header. This is used for
3988 the "n" flag in 'formatoptions'.
3989 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003990 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003991 while still checking more characters. There must be a character
3992 following the pattern, when it matches the whole line it is handled
3993 like there is no match.
3994 The default recognizes a number, followed by an optional punctuation
3995 character and white space.
3996
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003997 *'formatoptions'* *'fo'*
3998'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3999 local to buffer
4000 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01004001 formatting is to be done.
4002 See |fo-table| for possible values and |gq| for how to format text.
4003 When the 'paste' option is on, no formatting is done (like
4004 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004005 To avoid problems with flags that are added in the future, use the
4006 "+=" and "-=" feature of ":set" |add-option-flags|.
4007 NOTE: This option is set to the Vi default value when 'compatible' is
4008 set and to the Vim default value when 'compatible' is reset.
4009
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 *'formatprg'* *'fp'*
4011'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004012 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004014 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004016 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004017 If the 'formatexpr' option is not empty it will be used instead.
4018 Otherwise, if 'formatprg' option is an empty string, the internal
4019 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004020 Environment variables are expanded |:set_env|. See |option-backslash|
4021 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004022 This option cannot be set from a |modeline| or in the |sandbox|, for
4023 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024
Bram Moolenaard94464e2015-11-02 15:28:18 +01004025 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004026'fsync' 'fs' boolean (default on)
4027 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004028 When on, the library function fsync() will be called after writing a
4029 file. This will flush a file to disk, ensuring that it is safely
4030 written even on filesystems which do metadata-only journaling. This
4031 will force the harddrive to spin up on Linux systems running in laptop
4032 mode, so it may be undesirable in some situations. Be warned that
4033 turning this off increases the chances of data loss after a crash. On
4034 systems without an fsync() implementation, this variable is always
4035 off.
4036 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004037 'fsync' also applies to |writefile()| (unless a flag is used to
4038 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004039 This option cannot be set from a |modeline| or in the |sandbox|, for
4040 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004041
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4043'gdefault' 'gd' boolean (default off)
4044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 When on, the ":substitute" flag 'g' is default on. This means that
4046 all matches in a line are substituted instead of one. When a 'g' flag
4047 is given to a ":substitute" command, this will toggle the substitution
4048 of all or one match. See |complex-change|.
4049
4050 command 'gdefault' on 'gdefault' off ~
4051 :s/// subst. all subst. one
4052 :s///g subst. one subst. all
4053 :s///gg subst. all subst. one
4054
4055 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004056 Setting this option may break plugins that rely on the default
4057 behavior of the 'g' flag. This will also make the 'g' flag have the
4058 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004059 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060
4061 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004062'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 Format to recognize for the ":grep" command output.
4065 This is a scanf-like string that uses the same format as the
4066 'errorformat' option: see |errorformat|.
4067
4068 *'grepprg'* *'gp'*
4069'grepprg' 'gp' string (default "grep -n ",
4070 Unix: "grep -n $* /dev/null",
4071 Win32: "findstr /n" or "grep -n",
4072 VMS: "SEARCH/NUMBERS ")
4073 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004074 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 and '#' characters, which are expanded like when used in a command-
4076 line. The placeholder "$*" is allowed to specify where the arguments
4077 will be included. Environment variables are expanded |:set_env|. See
4078 |option-backslash| about including spaces and backslashes.
4079 When your "grep" accepts the "-H" argument, use this to make ":grep"
4080 also work well with a single file: >
4081 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004082< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004083 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4084 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004085 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 apply equally to 'grepprg'.
4087 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4088 otherwise it's "grep -n".
4089 This option cannot be set from a |modeline| or in the |sandbox|, for
4090 security reasons.
4091
4092 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4093'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4094 ve:ver35-Cursor,
4095 o:hor50-Cursor,
4096 i-ci:ver25-Cursor/lCursor,
4097 r-cr:hor20-Cursor/lCursor,
4098 sm:block-Cursor
4099 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004100 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 "n-v-c:block,o:hor50,i-ci:hor15,
4102 r-cr:hor30,sm:block")
4103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004105 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004107 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004108 height of the cursor can be changed. This can be done by specifying a
4109 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004110 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4111 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004113 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 mode-list and an argument-list:
4115 mode-list:argument-list,mode-list:argument-list,..
4116 The mode-list is a dash separated list of these modes:
4117 n Normal mode
4118 v Visual mode
4119 ve Visual mode with 'selection' "exclusive" (same as 'v',
4120 if not specified)
4121 o Operator-pending mode
4122 i Insert mode
4123 r Replace mode
4124 c Command-line Normal (append) mode
4125 ci Command-line Insert mode
4126 cr Command-line Replace mode
4127 sm showmatch in Insert mode
4128 a all modes
4129 The argument-list is a dash separated list of these arguments:
4130 hor{N} horizontal bar, {N} percent of the character height
4131 ver{N} vertical bar, {N} percent of the character width
4132 block block cursor, fills the whole character
4133 [only one of the above three should be present]
4134 blinkwait{N} *cursor-blinking*
4135 blinkon{N}
4136 blinkoff{N}
4137 blink times for cursor: blinkwait is the delay before
4138 the cursor starts blinking, blinkon is the time that
4139 the cursor is shown and blinkoff is the time that the
4140 cursor is not shown. The times are in msec. When one
4141 of the numbers is zero, there is no blinking. The
4142 default is: "blinkwait700-blinkon400-blinkoff250".
4143 These numbers are used for a missing entry. This
4144 means that blinking is enabled by default. To switch
4145 blinking off you can use "blinkon0". The cursor only
4146 blinks when Vim is waiting for input, not while
4147 executing a command.
4148 To make the cursor blink in an xterm, see
4149 |xterm-blink|.
4150 {group-name}
4151 a highlight group name, that sets the color and font
4152 for the cursor
4153 {group-name}/{group-name}
4154 Two highlight group names, the first is used when
4155 no language mappings are used, the other when they
4156 are. |language-mapping|
4157
4158 Examples of parts:
4159 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4160 block cursor with colors from the "nCursor"
4161 highlight group
4162 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4163 In Insert and Command-line Insert mode, use a
4164 30% vertical bar cursor with colors from the
4165 "iCursor" highlight group. Blink a bit
4166 faster.
4167
4168 The 'a' mode is different. It will set the given argument-list for
4169 all modes. It does not reset anything to defaults. This can be used
4170 to do a common setting for all modes. For example, to switch off
4171 blinking: "a:blinkon0"
4172
4173 Examples of cursor highlighting: >
4174 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4175 :highlight Cursor gui=NONE guifg=bg guibg=fg
4176<
4177 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004178 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179'guifont' 'gfn' string (default "")
4180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 {only available when compiled with GUI enabled}
4182 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004183 In its simplest form the value is just one font name.
4184 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185
4186 *'guifontset'* *'gfs'*
4187 *E250* *E252* *E234* *E597* *E598*
4188'guifontset' 'gfs' string (default "")
4189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 {only available when compiled with GUI enabled and
4191 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004192 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When not empty, specifies two (or more) fonts to be used. The first
4194 one for normal English, the second one for your special language. See
4195 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004196
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4198'guifontwide' 'gfw' string (default "")
4199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 {only available when compiled with GUI enabled}
4201 When not empty, specifies a comma-separated list of fonts to be used
4202 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004203 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004204
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 *'guiheadroom'* *'ghr'*
4206'guiheadroom' 'ghr' number (default 50)
4207 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004208 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 The number of pixels subtracted from the screen height when fitting
4210 the GUI window on the screen. Set this before the GUI is started,
4211 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004212 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 lines will be left for window decorations and other items on the
4214 screen. Set it to a negative value to allow windows taller than the
4215 screen.
4216
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004217 *'guiligatures'* *'gli'* *E1243*
4218'guiligatures' 'gli' string (default "")
4219 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004220 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004221 List of ASCII characters that, when combined together, can create more
4222 complex shapes. Each character must be a printable ASCII character
4223 with a value in the 32-127 range.
4224 Example: >
4225 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4226< Changing this option updates screen output immediately. Set it to an
4227 empty string to disable ligatures.
4228
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004230'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4231 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004232 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004233 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004236 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 sequence of letters which describes what components and options of the
4238 GUI should be used.
4239 To avoid problems with flags that are added in the future, use the
4240 "+=" and "-=" feature of ":set" |add-option-flags|.
4241
Bram Moolenaar13568252018-03-16 20:46:58 +01004242 Valid characters are as follows:
4243 *'go-!'*
4244 '!' External commands are executed in a terminal window. Without
4245 this flag the MS-Windows GUI will open a console window to
4246 execute the command. The Unix GUI will simulate a dumb
4247 terminal to list the command output.
4248 The terminal window will be positioned at the bottom, and grow
4249 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004250 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 'a' Autoselect: If present, then whenever VISUAL mode is started,
4252 or the Visual area extended, Vim tries to become the owner of
4253 the windowing system's global selection. This means that the
4254 Visually highlighted text is available for pasting into other
4255 applications as well as into Vim itself. When the Visual mode
4256 ends, possibly due to an operation on the text, or when an
4257 application wants to paste the selection, the highlighted text
4258 is automatically yanked into the "* selection register.
4259 Thus the selection is still available for pasting into other
4260 applications after the VISUAL mode has ended.
4261 If not present, then Vim won't become the owner of the
4262 windowing system's global selection unless explicitly told to
4263 by a yank or delete operation for the "* register.
4264 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004265 *'go-P'*
4266 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004267 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004268 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004269 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 applies to the modeless selection.
4271
4272 'guioptions' autoselect Visual autoselect modeless ~
4273 "" - -
4274 "a" yes yes
4275 "A" - yes
4276 "aA" yes yes
4277
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004278 When using a terminal see the 'clipboard' option.
4279
Bram Moolenaar02467872007-05-06 13:22:01 +00004280 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 'c' Use console dialogs instead of popup dialogs for simple
4282 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004283 *'go-d'*
4284 'd' Use dark theme variant if available. Currently only works for
4285 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004286 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004287 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004288 'guitablabel' can be used to change the text in the labels.
4289 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004290 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004291 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004292 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 'f' Foreground: Don't use fork() to detach the GUI from the shell
4294 where it was started. Use this for programs that wait for the
4295 editor to finish (e.g., an e-mail program). Alternatively you
4296 can use "gvim -f" or ":gui -f" to start the GUI in the
4297 foreground. |gui-fork|
4298 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004299 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004300 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4302 corner of the window. It's black&white on non-GTK, because of
4303 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004304 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004306 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004307 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004309 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004311 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004312 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 'g' Grey menu items: Make menu items that are not active grey. If
4314 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004315 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 't' Include tearoff menu items. Currently only works for Win32,
4317 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004318 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004319 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4320 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004321 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004323 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 'R' Right-hand scrollbar is present when there is a vertically
4325 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004326 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004328 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 'L' Left-hand scrollbar is present when there is a vertically
4330 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004331 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4333 the longest visible line, or on the cursor line if the 'h'
4334 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004335 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 'h' Limit horizontal scrollbar size to the length of the cursor
4337 line. Reduces computations. |gui-horiz-scroll|
4338
4339 And yes, you may even have scrollbars on the left AND the right if
4340 you really want to :-). See |gui-scrollbars| for more information.
4341
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004342 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 'v' Use a vertical button layout for dialogs. When not included,
4344 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004345 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004346 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 'p' Use Pointer callbacks for X11 GUI. This is required for some
4348 window managers. If the cursor is not blinking or hollow at
4349 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004350 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004352 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004353 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004354 *'go-k'*
4355 'k' Keep the GUI window size when adding/removing a scrollbar, or
4356 toolbar, tabline, etc. Instead, the behavior is similar to
4357 when the window is maximized and will adjust 'lines' and
4358 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004359 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004360 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004361
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 *'guipty'* *'noguipty'*
4363'guipty' boolean (default on)
4364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 {only available when compiled with GUI enabled}
4366 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4367 I/O to/from shell commands. See |gui-pty|.
4368
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004369 *'guitablabel'* *'gtl'*
4370'guitablabel' 'gtl' string (default empty)
4371 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004372 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004373 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004374 pages line. When empty and when the result is empty Vim will use a
4375 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004376
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004377 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004378 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004379 The expression will be evaluated in the |sandbox| when set from a
4380 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004381 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004382
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004383 Only used when the GUI tab pages line is displayed. 'e' must be
4384 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4385 used.
4386
Bram Moolenaar57657d82006-04-21 22:12:41 +00004387 *'guitabtooltip'* *'gtt'*
4388'guitabtooltip' 'gtt' string (default empty)
4389 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004390 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004391 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004392 pages line. When empty Vim will use a default tooltip.
4393 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004394 You can include a line break. Simplest method is to use |:let|: >
4395 :let &guitabtooltip = "line one\nline two"
4396<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004397
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004399'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 (others) "$VIMRUNTIME/doc/help.txt")
4401 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 Name of the main help file. All distributed help files should be
4403 placed together in one directory. Additionally, all "doc" directories
4404 in 'runtimepath' will be used.
4405 Environment variables are expanded |:set_env|. For example:
4406 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 spaces and backslashes.
4409 This option cannot be set from a |modeline| or in the |sandbox|, for
4410 security reasons.
4411
4412 *'helpheight'* *'hh'*
4413'helpheight' 'hh' number (default 20)
4414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 Minimal initial height of the help window when it is opened with the
4416 ":help" command. The initial height of the help window is half of the
4417 current window, or (when the 'ea' option is on) the same as other
4418 windows. When the height is less than 'helpheight', the height is
4419 set to 'helpheight'. Set to zero to disable.
4420
4421 *'helplang'* *'hlg'*
4422'helplang' 'hlg' string (default: messages language or empty)
4423 global
4424 {only available when compiled with the |+multi_lang|
4425 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004426 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 for which the desired help can be found. The English help will always
4428 be used as a last resort. You can add "en" to prefer English over
4429 another language, but that will only find tags that exist in that
4430 language and not in the English help.
4431 Example: >
4432 :set helplang=de,it
4433< This will first search German, then Italian and finally English help
4434 files.
4435 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4436 try to find the tag in the current language before using this option.
4437 See |help-translated|.
4438
4439 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4440'hidden' 'hid' boolean (default off)
4441 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 When off a buffer is unloaded when it is |abandon|ed. When on a
4443 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4444 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004445
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004447 hidden even if the 'hidden' option is off when these three are true:
4448 - the buffer is modified
4449 - 'autowrite' is off or writing is not possible
4450 - the '!' flag was used
4451 Also see |windows.txt|.
4452
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004453 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 This option is set for one command with ":hide {command}" |:hide|.
4455 WARNING: It's easy to forget that you have changes in hidden buffers.
4456 Think twice when using ":q!" or ":qa!".
4457
4458 *'highlight'* *'hl'*
4459'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004460 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4461 d:Directory,e:ErrorMsg,i:IncSearch,
4462 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004463 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004464 N:CursorLineNr,r:Question,s:StatusLine,
4465 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004466 v:Visual,V:VisualNOS,w:WarningMsg,
4467 W:WildMenu,f:Folded,F:FoldColumn,
4468 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004469 T:DiffText,E:DiffTextAdd,>:SignColumn,
4470 -:Conceal,B:SpellBad,P:SpellCap,
4471 R:SpellRare, L:SpellLocal,+:Pmenu,
4472 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004473 [:PmenuKind,]:PmenuKindSel,
4474 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004475 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4476 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004477 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004478 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004479 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004482 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004484 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004486 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4487 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 characters from 'showbreak'
4489 |hl-Directory| d directories in CTRL-D listing and other special
4490 things in listings
4491 |hl-ErrorMsg| e error messages
4492 h (obsolete, ignored)
4493 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004494 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4496 |hl-MoreMsg| m |more-prompt|
4497 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004498 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004499 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004500 |hl-LineNr| n line number for ":number" and ":#" commands, and
4501 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004502 |hl-LineNrAbove| a line number above the cursor for when the
4503 'relativenumber' option is set.
4504 |hl-LineNrBelow| b line number below the cursor for when the
4505 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004506 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4507 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 |hl-Question| r |hit-enter| prompt and yes/no questions
4509 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004510 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4512 |hl-VertSplit| c column used to separate vertically split windows
4513 |hl-Visual| v Visual mode
4514 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4515 Selection" Only X11 Gui's |gui-x11| and
4516 |xterm-clipboard|.
4517 |hl-WarningMsg| w warning messages
4518 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4519 |hl-Folded| f line used for closed folds
4520 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004521 |hl-DiffAdd| A added line in diff mode
4522 |hl-DiffChange| C changed line in diff mode
4523 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004524 |hl-DiffText| T changed text in diff mode
4525 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004527 |hl-Conceal| - the placeholders used for concealed characters
4528 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004529 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004530 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004531 |hl-SpellRare| R rare word |spell|
4532 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004533 |hl-Pmenu| + popup menu normal line
4534 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004535 |hl-PmenuKind| [ popup menu "kind" normal line
4536 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004537 |hl-PmenuExtra| { popup menu "extra" normal line
4538 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004539 |hl-PmenuSbar| x popup menu scrollbar
4540 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004541 |hl-PmenuMatch| k popup menu matched text
4542 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
4544 The display modes are:
4545 r reverse (termcap entry "mr" and "me")
4546 i italic (termcap entry "ZH" and "ZR")
4547 b bold (termcap entry "md" and "me")
4548 s standout (termcap entry "so" and "se")
4549 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004550 c undercurl (termcap entry "Us" and "Ce")
4551 2 double underline (termcap entry "Ds" and "Ce")
4552 d dotted underline (termcap entry "ds" and "Ce")
4553 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004554 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 n no highlighting
4556 - no highlighting
4557 : use a highlight group
4558 The default is used for occasions that are not included.
4559 If you want to change what the display modes do, see |dos-colors|
4560 for an example.
4561 When using the ':' display mode, this must be followed by the name of
4562 a highlight group. A highlight group can be used to define any type
4563 of highlighting, including using color. See |:highlight| on how to
4564 define one. The default uses a different group for each occasion.
4565 See |highlight-default| for the default highlight groups.
4566
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004568'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004571 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004572 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004573 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004574 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 NOTE: This option is set to the Vi default value when 'compatible' is
4576 set and to the Vim default value when 'compatible' is reset.
4577
4578 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4579'hkmap' 'hk' boolean (default off)
4580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 {only available when compiled with the |+rightleft|
4582 feature}
4583 When on, the keyboard is mapped for the Hebrew character set.
4584 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4585 toggle this option. See |rileft.txt|.
4586 NOTE: This option is reset when 'compatible' is set.
4587
4588 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4589'hkmapp' 'hkp' boolean (default off)
4590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 {only available when compiled with the |+rightleft|
4592 feature}
4593 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4594 This is useful if you have a non-Hebrew keyboard.
4595 See |rileft.txt|.
4596 NOTE: This option is reset when 'compatible' is set.
4597
Bram Moolenaar036986f2017-03-16 17:41:02 +01004598 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4599'hlsearch' 'hls' boolean (default off)
4600 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004601 {not available when compiled without the
4602 |+extra_search| feature}
4603 When there is a previous search pattern, highlight all its matches.
4604 The type of highlighting used can be set with the 'l' occasion in the
4605 'highlight' option. This uses the "Search" highlight group by
4606 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004607 are not applied. If the "CurSearch" highlight group is set then the
4608 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004609 See also: 'incsearch' and |:match|.
4610 When you get bored looking at the highlighted matches, you can turn it
4611 off with |:nohlsearch|. This does not change the option value, as
4612 soon as you use a search command, the highlighting comes back.
4613 'redrawtime' specifies the maximum time spent on finding matches.
4614 When the search pattern can match an end-of-line, Vim will try to
4615 highlight all of the matched text. However, this depends on where the
4616 search starts. This will be the first line in the window or the first
4617 line below a closed fold. A match in a previous line which is not
4618 drawn may not continue in a newly drawn line.
4619 You can specify whether the highlight status is restored on startup
4620 with the 'h' flag in 'viminfo' |viminfo-h|.
4621 NOTE: This option is reset when 'compatible' is set.
4622
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 *'icon'* *'noicon'*
4624'icon' boolean (default off, on when title can be restored)
4625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 When on, the icon text of the window will be set to the value of
4627 'iconstring' (if it is not empty), or to the name of the file
4628 currently being edited. Only the last part of the name is used.
4629 Overridden by the 'iconstring' option.
4630 Only works if the terminal supports setting window icons (currently
4631 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4632 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4633 builtin termcap).
4634 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004635 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004637 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638
4639 *'iconstring'*
4640'iconstring' string (default "")
4641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 When this option is not empty, it will be used for the icon text of
4643 the window. This happens only when the 'icon' option is on.
4644 Only works if the terminal supports setting window icon text
4645 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004646 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 When Vim was compiled with HAVE_X11 defined, the original icon will be
4648 restored if possible |X11|.
4649 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004650 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004652 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 {not available when compiled without the |+statusline| feature}
4654
4655 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4656'ignorecase' 'ic' boolean (default off)
4657 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004658 Ignore case in search patterns, |cmdline-completion|, when
4659 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004660 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 Can be overruled by using "\c" or "\C" in the pattern, see
4662 |/ignorecase|.
4663
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004664 *'imactivatefunc'* *'imaf'*
4665'imactivatefunc' 'imaf' string (default "")
4666 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004667 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004668 activate or deactivate the Input Method. The value can be the name of
4669 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4670 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004671 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004672 The expression will be evaluated in the |sandbox| when set from a
4673 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004674
4675 Example: >
4676 function ImActivateFunc(active)
4677 if a:active
4678 ... do something
4679 else
4680 ... do something
4681 endif
4682 " return value is not used
4683 endfunction
4684 set imactivatefunc=ImActivateFunc
4685<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 *'imactivatekey'* *'imak'*
4687'imactivatekey' 'imak' string (default "")
4688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004690 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 Specifies the key that your Input Method in X-Windows uses for
4692 activation. When this is specified correctly, vim can fully control
4693 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4694 You can't use this option to change the activation key, the option
4695 tells Vim what the key is.
4696 Format:
4697 [MODIFIER_FLAG-]KEY_STRING
4698
4699 These characters can be used for MODIFIER_FLAG (case is ignored):
4700 S Shift key
4701 L Lock key
4702 C Control key
4703 1 Mod1 key
4704 2 Mod2 key
4705 3 Mod3 key
4706 4 Mod4 key
4707 5 Mod5 key
4708 Combinations are allowed, for example "S-C-space" or "SC-space" are
4709 both shift+ctrl+space.
4710 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4711
4712 Example: >
4713 :set imactivatekey=S-space
4714< "S-space" means shift+space. This is the activation key for kinput2 +
4715 canna (Japanese), and ami (Korean).
4716
4717 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4718'imcmdline' 'imc' boolean (default off)
4719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 When set the Input Method is always on when starting to edit a command
4721 line, unless entering a search pattern (see 'imsearch' for that).
4722 Setting this option is useful when your input method allows entering
4723 English characters directly, e.g., when it's used to type accented
4724 characters with dead keys.
4725
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004726 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 When set the Input Method is never used. This is useful to disable
4730 the IM when it doesn't work properly.
4731 Currently this option is on by default for SGI/IRIX machines. This
4732 may change in later releases.
4733
4734 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004735'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 Specifies whether :lmap or an Input Method (IM) is to be used in
4738 Insert mode. Valid values:
4739 0 :lmap is off and IM is off
4740 1 :lmap is ON and IM is off
4741 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 To always reset the option to zero when leaving Insert mode with <Esc>
4743 this can be used: >
4744 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4745< This makes :lmap and IM turn off automatically when leaving Insert
4746 mode.
4747 Note that this option changes when using CTRL-^ in Insert mode
4748 |i_CTRL-^|.
4749 The value is set to 1 when setting 'keymap' to a valid keymap name.
4750 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004751 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 methods. Use 'imdisable' to disable XIM then.
4753
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004754 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004755 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004756 |+multi_byte_ime| or |global-ime|.
4757
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004759'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 Specifies whether :lmap or an Input Method (IM) is to be used when
4762 entering a search pattern. Valid values:
4763 -1 the value of 'iminsert' is used, makes it look like
4764 'iminsert' is also used when typing a search pattern
4765 0 :lmap is off and IM is off
4766 1 :lmap is ON and IM is off
4767 2 :lmap is off and IM is ON
4768 Note that this option changes when using CTRL-^ in Command-line mode
4769 |c_CTRL-^|.
4770 The value is set to 1 when it is not -1 and setting the 'keymap'
4771 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004772 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 methods. Use 'imdisable' to disable XIM then.
4774
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004775 *'imstatusfunc'* *'imsf'*
4776'imstatusfunc' 'imsf' string (default "")
4777 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004778 This option specifies a function that is called to obtain the status
4779 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004780 The value can be the name of a function, a |lambda| or a |Funcref|.
4781 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004782 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004783
4784 Example: >
4785 function ImStatusFunc()
4786 let is_active = ...do something
4787 return is_active ? 1 : 0
4788 endfunction
4789 set imstatusfunc=ImStatusFunc
4790<
4791 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004792 The expression will be evaluated in the |sandbox| when set from a
4793 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004794
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004795 *'imstyle'* *'imst'*
4796'imstyle' 'imst' number (default 1)
4797 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004798 {only available when compiled with |+xim| and
4799 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004800 This option specifies the input style of Input Method:
4801 0 use on-the-spot style
4802 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004803 See: |xim-input-style|
4804
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004805 For a long time on-the-spot style had been used in the GTK version of
4806 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004807 |single-repeat|, etc. Therefore over-the-spot style becomes the
4808 default now. This should work fine for most people, however if you
4809 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004810 The expression will be evaluated in the |sandbox| when set from a
4811 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004812
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 *'include'* *'inc'*
4814'include' 'inc' string (default "^\s*#\s*include")
4815 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 {not available when compiled without the
4817 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004818 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 pattern, just like for the "/" command (See |pattern|). The default
4820 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004821 "]I", "[d", etc.
4822 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004823 comes after the matched pattern. But if "\zs" appears in the pattern
4824 then the text matched from "\zs" to the end, or until "\ze" if it
4825 appears, is used as the file name. Use this to include characters
4826 that are not in 'isfname', such as a space. You can then use
4827 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004828 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829
4830 *'includeexpr'* *'inex'*
4831'includeexpr' 'inex' string (default "")
4832 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004834 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004836 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004837 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004839 Note the double backslash: the `:set` command first halves them, then
4840 one remains it the value, where "\." matches a dot literally. For
4841 simple character replacements `tr()` avoids the need for escaping: >
4842 :setlocal includeexpr=tr(v:fname,'.','/')
4843<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 Also used for |<cfile>|.
4847
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004848 If the expression starts with s: or |<SID>|, then it is replaced with
4849 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004850 setlocal includeexpr=s:MyIncludeExpr()
4851 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004852< Otherwise, the expression is evaluated in the context of the script
4853 where the option was set, thus script-local items are available.
4854
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004855 It is more efficient if the value is just a function call without
4856 arguments, see |expr-option-function|.
4857
Bram Moolenaar30b65812012-07-12 22:01:11 +02004858 The expression will be evaluated in the |sandbox| when set from a
4859 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004860 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004861
4862 It is not allowed to change text or jump to another window while
4863 evaluating 'includeexpr' |textlock|.
4864
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004866'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004867 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004870 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004871 While typing a search command, show where the pattern, as it was typed
4872 so far, matches. The matched string is highlighted. If the pattern
4873 is invalid or not found, nothing is shown. The screen will be updated
4874 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004875 Also applies to the pattern in commands: >
4876 :global
4877 :lvimgrep
4878 :lvimgrepadd
4879 :smagic
4880 :snomagic
4881 :sort
4882 :substitute
4883 :vglobal
4884 :vimgrep
4885 :vimgrepadd
4886< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004887 original position when no match is found and when pressing <Esc>. You
4888 still need to finish the search command with <Enter> to move the
4889 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004890 You can use the CTRL-G and CTRL-T keys to move to the next and
4891 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004892 When compiled with the |+reltime| feature Vim only searches for about
4893 half a second. With a complicated pattern and/or a lot of text the
4894 match may not be found. This is to avoid that Vim hangs while you
4895 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004896 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004897 When 'hlsearch' is on, all matched strings are highlighted too while
4898 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004899 If you don't want to turn 'hlsearch' on, but want to highlight all
4900 matches while searching, you can turn on and off 'hlsearch' with
4901 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004902 augroup vimrc-incsearch-highlight
4903 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004904 autocmd CmdlineEnter /,\? :set hlsearch
4905 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004906 augroup END
4907<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004908 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004909 to the command line. If 'ignorecase' and 'smartcase' are set and the
4910 command line has no uppercase characters, the added character is
4911 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004912 CTRL-R CTRL-W can be used to add the word at the end of the current
4913 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 NOTE: This option is reset when 'compatible' is set.
4915
4916 *'indentexpr'* *'inde'*
4917'indentexpr' 'inde' string (default "")
4918 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004919 {not available when compiled without the |+eval|
4920 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 Expression which is evaluated to obtain the proper indent for a line.
4922 It is used when a new line is created, for the |=| operator and
4923 in Insert mode as specified with the 'indentkeys' option.
4924 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004925 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004926 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 When 'paste' is set this option is not used for indenting.
4928 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004929 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004931
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004932 If the expression starts with s: or |<SID>|, then it is replaced with
4933 the script ID (|local-function|). Example: >
4934 set indentexpr=s:MyIndentExpr()
4935 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004936< Otherwise, the expression is evaluated in the context of the script
4937 where the option was set, thus script-local items are available.
4938
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004939 The advantage of using a function call without arguments is that it is
4940 faster, see |expr-option-function|.
4941
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 The expression must return the number of spaces worth of indent. It
4943 can return "-1" to keep the current indent (this means 'autoindent' is
4944 used for the indent).
4945 Functions useful for computing the indent are |indent()|, |cindent()|
4946 and |lispindent()|.
4947 The evaluation of the expression must not have side effects! It must
4948 not change the text, jump to another window, etc. Afterwards the
4949 cursor position is always restored, thus the cursor may be moved.
4950 Normally this option would be set to call a function: >
4951 :set indentexpr=GetMyIndent()
4952< Error messages will be suppressed, unless the 'debug' option contains
4953 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004954 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004955 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
Bram Moolenaar30b65812012-07-12 22:01:11 +02004957 The expression will be evaluated in the |sandbox| when set from a
4958 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004959 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004960
4961 It is not allowed to change text or jump to another window while
4962 evaluating 'indentexpr' |textlock|.
4963
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004965'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 A list of keys that, when typed in Insert mode, cause reindenting of
4968 the current line. Only happens if 'indentexpr' isn't empty.
4969 The format is identical to 'cinkeys', see |indentkeys-format|.
4970 See |C-indenting| and |indent-expression|.
4971
4972 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4973'infercase' 'inf' boolean (default off)
4974 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004976 'ignorecase' is also on, the case of the match is adjusted depending
4977 on the typed text. If the typed text contains a lowercase letter
4978 where the match has an upper case letter, the completed part is made
4979 lowercase. If the typed text has no lowercase letters and the match
4980 has a lowercase letter where the typed text has an uppercase letter,
4981 and there is a letter before it, the completed part is made uppercase.
4982 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
4984 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4985'insertmode' 'im' boolean (default off)
4986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 Makes Vim work in a way that Insert mode is the default mode. Useful
4988 if you want to use Vim as a modeless editor. Used for |evim|.
4989 These Insert mode commands will be useful:
4990 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004991 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 this is a mapping, it is executed as if 'insertmode' was off.
4993 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004995 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4996 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997
4998 These items change when 'insertmode' is set:
4999 - when starting to edit of a file, Vim goes to Insert mode.
5000 - <Esc> in Insert mode is a no-op and beeps.
5001 - <Esc> in Normal mode makes Vim go to Insert mode.
5002 - CTRL-L in Insert mode is a command, it is not inserted.
5003 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
5004 However, when <Esc> is used inside a mapping, it behaves like
5005 'insertmode' was not set. This was done to be able to use the same
5006 mappings with 'insertmode' set or not set.
5007 When executing commands with |:normal| 'insertmode' is not used.
5008
5009 NOTE: This option is reset when 'compatible' is set.
5010
5011 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005012'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5014 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5015 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5016 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5017 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 The characters specified by this option are included in file names and
5020 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005021 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 Multi-byte characters 256 and above are always included, only the
5023 characters up to 255 are specified with this option.
5024 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005025 Think twice before adding white space to this option. Although a
5026 space may appear inside a file name, the effect will be that Vim
5027 doesn't know where a file name starts or ends when doing completion.
5028 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029
5030 Note that on systems using a backslash as path separator, Vim tries to
5031 do its best to make it work as you would expect. That is a bit
5032 tricky, since Vi originally used the backslash to escape special
5033 characters. Vim will not remove a backslash in front of a normal file
5034 name character on these systems, but it will on Unix and alikes. The
5035 '&' and '^' are not included by default, because these are special for
5036 cmd.exe.
5037
5038 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005039 Each part can be a single character number or a range. A range is two
5040 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 decimal number between 0 and 255 or the ASCII character itself (does
5042 not work for digits). Example:
5043 "_,-,128-140,#-43" (include '_' and '-' and the range
5044 128 to 140 and '#' to 43)
5045 If a part starts with '^', the following character number or range
5046 will be excluded from the option. The option is interpreted from left
5047 to right. Put the excluded character after the range where it is
5048 included. To include '^' itself use it as the last character of the
5049 option or the end of a range. Example:
5050 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5051 If the character is '@', all characters where isalpha() returns TRUE
5052 are included. Normally these are the characters a to z and A to Z,
5053 plus accented characters. To include '@' itself use "@-@". Examples:
5054 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005055 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 "a-z,A-Z,@-@" All letters plus the '@' character.
5057 A comma can be included by using it where a character number is
5058 expected. Example:
5059 "48-57,,,_" Digits, comma and underscore.
5060 A comma can be excluded by prepending a '^'. Example:
5061 " -~,^,,9" All characters from space to '~', excluding
5062 comma, plus <Tab>.
5063 See |option-backslash| about including spaces and backslashes.
5064
5065 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005066'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 "@,48-57,_,128-167,224-235"
5068 otherwise: "@,48-57,_,192-255")
5069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 The characters given by this option are included in identifiers.
5071 Identifiers are used in recognizing environment variables and after a
5072 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005073 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005074 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005076 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5078
5079 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005080'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 "@,48-57,_,128-167,224-235"
5082 otherwise: "@,48-57,_,192-255"
5083 Vi default: "@,48-57,_")
5084 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005086 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005087 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005088 characters above 255 check the "word" character class (any character
5089 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005090 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 For a help file it is set to all non-blank printable characters except
5092 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5093 command).
5094 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005095 This option also influences syntax highlighting, unless the syntax
5096 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 NOTE: This option is set to the Vi default value when 'compatible' is
5098 set and to the Vim default value when 'compatible' is reset.
5099
5100 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005101'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 "@,~-255"; otherwise: "@,161-255")
5103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 The characters given by this option are displayed directly on the
5105 screen. It is also used for "\p" in a |pattern|. The characters from
5106 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5107 even when they are not included in 'isprint' or excluded. See
5108 'isfname' for a description of the format of this option.
5109
5110 Non-printable characters are displayed with two characters:
5111 0 - 31 "^@" - "^_"
5112 32 - 126 always single characters
5113 127 "^?"
5114 128 - 159 "~@" - "~_"
5115 160 - 254 "| " - "|~"
5116 255 "~?"
5117 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5118 displayed as <xx>, with the hexadecimal value of the byte.
5119 When 'display' contains "uhex" all unprintable characters are
5120 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005121 The SpecialKey highlighting will be used for unprintable characters.
5122 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 Multi-byte characters 256 and above are always included, only the
5125 characters up to 255 are specified with this option. When a character
5126 is printable but it is not available in the current font, a
5127 replacement character will be shown.
5128 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5129 There is no option to specify these characters.
5130
5131 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5132'joinspaces' 'js' boolean (default on)
5133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 Insert two spaces after a '.', '?' and '!' with a join command.
5135 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5136 Otherwise only one space is inserted.
5137 NOTE: This option is set when 'compatible' is set.
5138
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005139 *'jumpoptions'* *'jop'*
5140'jumpoptions' 'jop' string (default "")
5141 global
5142 List of words that change the behavior of the |jumplist|.
5143 stack Make the jumplist behave like the tagstack.
5144 Relative location of entries in the jumplist is
5145 preserved at the cost of discarding subsequent entries
5146 when navigating backwards in the jumplist and then
5147 jumping to a location. |jumplist-stack|
5148
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 *'key'*
5150'key' string (default "")
5151 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005152 {only available when compiled with the |+cryptv|
5153 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005155 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 Careful: Do not set the key value by hand, someone might see the typed
5157 key. Use the |:X| command. But you can make 'key' empty: >
5158 :set key=
5159< It is not possible to get the value of this option with ":set key" or
5160 "echo &key". This is to avoid showing it to someone who shouldn't
5161 know. It also means you cannot see it yourself once you have set it,
5162 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005163 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5164 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005165 You can use "&key" in an expression to detect whether encryption is
5166 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167
5168 *'keymap'* *'kmp'* *E544*
5169'keymap' 'kmp' string (default "")
5170 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 {only available when compiled with the |+keymap|
5172 feature}
5173 Name of a keyboard mapping. See |mbyte-keymap|.
5174 Setting this option to a valid keymap name has the side effect of
5175 setting 'iminsert' to one, so that the keymap becomes effective.
5176 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005177 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
5179 *'keymodel'* *'km'*
5180'keymodel' 'km' string (default "")
5181 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005182 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 can do. These values can be used:
5184 startsel Using a shifted special key starts selection (either
5185 Select mode or Visual mode, depending on "key" being
5186 present in 'selectmode').
5187 stopsel Using a not-shifted special key stops selection.
5188 Special keys in this context are the cursor keys, <End>, <Home>,
5189 <PageUp> and <PageDown>.
5190 The 'keymodel' option is set by the |:behave| command.
5191
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005192 *'keyprotocol'* *'kpc'*
5193'keyprotocol' 'kpc' string (default: see below)
5194 global
5195 Specifies what keyboard protocol to use depending on the value of
5196 'term'. The supported keyboard protocols names are:
5197 none whatever the terminal uses
5198 mok2 modifyOtherKeys level 2, as supported by xterm
5199 kitty Kitty keyboard protocol, as supported by Kitty
5200
Bram Moolenaara87749e2022-11-30 10:23:17 +00005201 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005202 a pattern that is matched against the 'term' option, a colon and the
5203 protocol name to be used. To illustrate this, the default value would
5204 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005205 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5206 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005207
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005208< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005209 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5210 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005211
5212 The first match is used, thus if you want to have "kitty" use the
5213 kitty protocol, but "badkitty" not, then you should match "badkitty"
5214 first and use the "none" value: >
5215 set keyprotocol=badkitty:none,kitty:kitty
5216<
5217 The option is used after 'term' has been changed. First the termcap
5218 entries are set, possibly using the builtin list, see |builtin-terms|.
5219 Then this option is inspected and if there is a match and a protocol
5220 is specified the following happens:
5221 none Nothing, the regular t_TE and t_TI values remain
5222
5223 mok2 The t_TE value is changed to:
5224 CSI >4;m disables modifyOtherKeys
5225 The t_TI value is changed to:
5226 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005227 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005228
5229 kitty The t_TE value is changed to:
5230 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005231 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005232 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005233 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005234 CSI ?u request kitty keyboard protocol state
5235 CSI >c request the termresponse
5236
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005237 If you notice problems, such as characters being displayed that
5238 disappear after `CTRL-L`, you might want to try making this option
5239 empty. Then set the 'term' option to have it take effect: >
5240 set keyprotocol=
5241 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005242<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005243
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 *'keywordprg'* *'kp'*
5245'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005246 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 Program to use for the |K| command. Environment variables are
5249 expanded |:set_env|. ":help" may be used to access the Vim internal
5250 help. (Note that previously setting the global option to the empty
5251 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005252 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005253 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005254 When "man", "man -s" or an Ex command is used, Vim will automatically
5255 translate a count for the "K" command and pass it as the first
5256 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 See |option-backslash| about including spaces and backslashes.
5258 Example: >
5259 :set keywordprg=man\ -s
5260< This option cannot be set from a |modeline| or in the |sandbox|, for
5261 security reasons.
5262
5263 *'langmap'* *'lmap'* *E357* *E358*
5264'langmap' 'lmap' string (default "")
5265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 {only available when compiled with the |+langmap|
5267 feature}
5268 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005269 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005270 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 care of translating these special characters to the original meaning
5272 of the key. This means you don't have to change the keyboard mode to
5273 be able to execute Normal mode commands.
5274 This is the opposite of the 'keymap' option, where characters are
5275 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005276 Also consider setting 'langremap' to off, to prevent 'langmap' from
5277 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005278 This option cannot be set from a |modeline| or in the |sandbox|, for
5279 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005281 Example (for Greek, in UTF-8): *greek* >
5282 :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 +00005283< Example (exchanges meaning of z and y for commands): >
5284 :set langmap=zy,yz,ZY,YZ
5285<
5286 The 'langmap' option is a list of parts, separated with commas. Each
5287 part can be in one of two forms:
5288 1. A list of pairs. Each pair is a "from" character immediately
5289 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005290 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 characters. Example: "abc;ABC"
5292 Example: "aA,fgh;FGH,cCdDeE"
5293 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005294 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295
5296 This will allow you to activate vim actions without having to switch
5297 back and forth between the languages. Your language characters will
5298 be understood as normal vim English characters (according to the
5299 langmap mappings) in the following cases:
5300 o Normal/Visual mode (commands, buffer/register names, user mappings)
5301 o Insert/Replace Mode: Register names after CTRL-R
5302 o Insert/Replace Mode: Mappings
5303 Characters entered in Command-line mode will NOT be affected by
5304 this option. Note that this option can be changed at any time
5305 allowing to switch between mappings for different languages/encodings.
5306 Use a mapping to avoid having to type it each time!
5307
5308 *'langmenu'* *'lm'*
5309'langmenu' 'lm' string (default "")
5310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 {only available when compiled with the |+menu| and
5312 |+multi_lang| features}
5313 Language to use for menu translation. Tells which file is loaded
5314 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005315 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316< (without the spaces). For example, to always use the Dutch menus, no
5317 matter what $LANG is set to: >
5318 :set langmenu=nl_NL.ISO_8859-1
5319< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005320 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 If your $LANG is set to a non-English language but you do want to use
5322 the English menus: >
5323 :set langmenu=none
5324< This option must be set before loading menus, switching on filetype
5325 detection or syntax highlighting. Once the menus are defined setting
5326 this option has no effect. But you could do this: >
5327 :source $VIMRUNTIME/delmenu.vim
5328 :set langmenu=de_DE.ISO_8859-1
5329 :source $VIMRUNTIME/menu.vim
5330< Warning: This deletes all menus that you defined yourself!
5331
Bram Moolenaard94464e2015-11-02 15:28:18 +01005332 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005333'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005334 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005335 {only available when compiled with the |+langmap|
5336 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005337 This is just like 'langremap' but with the value inverted. It only
5338 exists for backwards compatibility. When setting 'langremap' then
5339 'langnoremap' is set to the inverted value, and the other way around.
5340
5341 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005342'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005343 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005344 {only available when compiled with the |+langmap|
5345 feature}
5346 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005347 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005348 'langmap' disables some of your mappings, try resetting this option.
5349 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005350 that works for you to avoid mappings to break.
5351
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 *'laststatus'* *'ls'*
5353'laststatus' 'ls' number (default 1)
5354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 The value of this option influences when the last window will have a
5356 status line:
5357 0: never
5358 1: only if there are at least two windows
5359 2: always
5360 The screen looks nicer with a status line if you have several
5361 windows, but it takes another screen line. |status-line|
5362
5363 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5364'lazyredraw' 'lz' boolean (default off)
5365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 When this option is set, the screen will not be redrawn while
5367 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005368 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005370 This may occasionally cause display errors. It is only meant to be set
5371 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005372 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373
64-bitman88d41ab2025-04-06 17:20:39 +02005374 *'lhistory'* *'lhi'*
5375'lhistory' 'lhi' number (default: 10)
5376 local to window
5377 {only available when compiled with the |+quickfix|
5378 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005379 Like 'chistory', but for the location list stack associated with a
5380 window. If the option is changed in either the location list window
5381 itself or the window that is associated with the location list stack,
5382 the new value will also be applied to the other one. This means this
5383 value will always be the same for a given location list window and its
5384 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005385
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5387'linebreak' 'lbr' boolean (default off)
5388 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005389 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005391 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 than at the last character that fits on the screen. Unlike
5393 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005394 it only affects the way the file is displayed, not its contents.
5395 If 'breakindent' is set, line is visually indented. Then, the value
5396 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005397 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 Note that <Tab> characters after an <EOL> are mostly not displayed
5399 with the right amount of white space.
5400
5401 *'lines'* *E593*
5402'lines' number (default 24 or terminal height)
5403 global
5404 Number of lines of the Vim window.
5405 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005406 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 When Vim is running in the GUI or in a resizable window, setting this
5408 option will cause the window size to be changed. When you only want
5409 to use the size for the GUI, put the command in your |gvimrc| file.
5410 Vim limits the number of lines to what fits on the screen. You can
5411 use this command to get the tallest window possible: >
5412 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005413< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005414 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 When you set this option and Vim is unable to change the physical
5416 number of lines of the display, the display may be messed up.
5417
5418 *'linespace'* *'lsp'*
5419'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5420 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 {only in the GUI}
5422 Number of pixel lines inserted between characters. Useful if the font
5423 uses the full character cell height, making lines touch each other.
5424 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005425 With some fonts there can be too much room between lines (to have
5426 space for ascents and descents). Then it makes sense to set
5427 'linespace' to a negative value. This may cause display problems
5428 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429
5430 *'lisp'* *'nolisp'*
5431'lisp' boolean (default off)
5432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 Lisp mode: When <Enter> is typed in insert mode set the indent for
5434 the next line to Lisp standards (well, sort of). Also happens with
5435 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5436 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5437 better. Also see 'lispwords'.
5438 The '-' character is included in keyword characters. Redefines the
5439 "=" operator to use this same indentation algorithm rather than
5440 calling an external program if 'equalprg' is empty.
5441 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005443 *'lispoptions'* *'lop'*
5444'lispoptions' 'lop' string (default "")
5445 local to buffer
5446 Comma-separated list of items that influence the Lisp indenting when
5447 enabled with the |'lisp'| option. Currently only one item is
5448 supported:
5449 expr:1 use 'indentexpr' for Lisp indenting when it is set
5450 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5451 Note that when using 'indentexpr' the `=` operator indents all the
5452 lines, otherwise the first line is not indented (Vi-compatible).
5453
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 *'lispwords'* *'lw'*
5455'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005456 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005457 Comma-separated list of words that influence the Lisp indenting when
5458 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459
5460 *'list'* *'nolist'*
5461'list' boolean (default off)
5462 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005463 List mode: By default show tabs as CTRL-I is displayed, display $
5464 after end of line. Useful to see the difference between tabs and
5465 spaces and for trailing blanks. Further changed by the 'listchars'
5466 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005467
5468 The cursor is displayed at the start of the space a Tab character
5469 occupies, not at the end as usual in Normal mode. To get this cursor
5470 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005471 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005472<
5473 Note that list mode will also affect formatting (set with 'textwidth'
5474 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 changing the way tabs are displayed.
5476
5477 *'listchars'* *'lcs'*
5478'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005479 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005480 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005481 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005482 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 eol:c Character to show at the end of each line. When
5484 omitted, there is no extra character at the end of the
5485 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005486 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005487 tab:xy[z] Two or three characters to be used to show a tab.
5488 The third character is optional.
5489
5490 tab:xy The 'x' is always used, then 'y' as many times as will
5491 fit. Thus "tab:>-" displays:
5492 >
5493 >-
5494 >--
5495 etc.
5496
5497 tab:xyz The 'z' is always used, then 'x' is prepended, and
5498 then 'y' is used as many times as will fit. Thus
5499 "tab:<->" displays:
5500 >
5501 <>
5502 <->
5503 <-->
5504 etc.
5505
5506 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005507 *lcs-space*
5508 space:c Character to show for a space. When omitted, spaces
5509 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005510 *lcs-multispace*
5511 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005512 One or more characters to use cyclically to show for
5513 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005514 setting, except for single spaces. When omitted, the
5515 "space" setting is used. For example,
5516 `:set listchars=multispace:---+` shows ten consecutive
5517 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005518 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005519 *lcs-lead*
5520 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005521 leading spaces are blank. Overrides the "space" and
5522 "multispace" settings for leading spaces. You can
5523 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005524 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005525< *lcs-leadmultispace*
5526 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005527 Like the |lcs-multispace| value, but for leading
5528 spaces only. Also overrides |lcs-lead| for leading
5529 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005530 `:set listchars=leadmultispace:---+` shows ten
5531 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005532 ---+---+--XXX ~
5533 Where "XXX" denotes the first non-blank characters in
5534 the line.
5535 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005536 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005537 trailing spaces are blank. Overrides the "space" and
5538 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005539 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 extends:c Character to show in the last column, when 'wrap' is
5541 off and the line continues beyond the right of the
5542 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005543 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005544 precedes:c Character to show in the first visible column of the
5545 physical line, when there is text preceding the
5546 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005547 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005548 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005549 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005550 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005551 nbsp:c Character to show for a non-breakable space character
5552 (0xA0 (160 decimal) and U+202F). Left blank when
5553 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005557 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005559 Each character can be specified as hex: >
5560 set listchars=eol:\\x24
5561 set listchars=eol:\\u21b5
5562 set listchars=eol:\\U000021b5
5563< Note that a double backslash is used. The number of hex characters
5564 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5565
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 Examples: >
5567 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005568 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 :set lcs=extends:>,precedes:<
5570< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005571 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5572 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005573 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574
5575 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5576'loadplugins' 'lpl' boolean (default on)
5577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 When on the plugin scripts are loaded when starting up |load-plugins|.
5579 This option can be reset in your |vimrc| file to disable the loading
5580 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005581 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5582 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583
Bram Moolenaard94464e2015-11-02 15:28:18 +01005584 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005585'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005586 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005587 {only available when compiled with the |+lua/dyn|
5588 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005589 Specifies the name of the Lua shared library. The default is
5590 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005591 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005592 This option cannot be set from a |modeline| or in the |sandbox|, for
5593 security reasons.
5594
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005595 *'macatsui'* *'nomacatsui'*
5596'macatsui' boolean (default on)
5597 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005598 {not supported}
5599 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005600
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 *'magic'* *'nomagic'*
5602'magic' boolean (default on)
5603 global
5604 Changes the special characters that can be used in search patterns.
5605 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005606 WARNING: Switching this option off most likely breaks plugins! That
5607 is because many patterns assume it's on and will fail when it's off.
5608 Only switch it off when working with old Vi scripts. In any other
5609 situation write patterns that work when 'magic' is on. Include "\M"
5610 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005611 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5612 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
5614 *'makeef'* *'mef'*
5615'makeef' 'mef' string (default: "")
5616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 {not available when compiled without the |+quickfix|
5618 feature}
5619 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5620 and the |:grep| command.
5621 When it is empty, an internally generated temp file will be used.
5622 When "##" is included, it is replaced by a number to make the name
5623 unique. This makes sure that the ":make" command doesn't overwrite an
5624 existing file.
5625 NOT used for the ":cf" command. See 'errorfile' for that.
5626 Environment variables are expanded |:set_env|.
5627 See |option-backslash| about including spaces and backslashes.
5628 This option cannot be set from a |modeline| or in the |sandbox|, for
5629 security reasons.
5630
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005631 *'makeencoding'* *'menc'*
5632'makeencoding' 'menc' string (default "")
5633 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005634 Encoding used for reading the output of external commands. When empty,
5635 encoding is not converted.
5636 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5637 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5638 and `:laddfile`.
5639
5640 This would be mostly useful when you use MS-Windows and set 'encoding'
5641 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5642 'makeencoding' to "char" has the same effect as setting to the system
5643 locale encoding. Example: >
5644 :set encoding=utf-8
5645 :set makeencoding=char " system locale is used
5646<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 *'makeprg'* *'mp'*
5648'makeprg' 'mp' string (default "make", VMS: "MMS")
5649 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005650 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005651 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5652 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005653 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005654 Environment variables are expanded |:set_env|. See |option-backslash|
5655 about including spaces and backslashes.
5656 Note that a '|' must be escaped twice: once for ":set" and once for
5657 the interpretation of a command. When you use a filter called
5658 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 :set makeprg=gmake\ \\\|\ myfilter
5660< The placeholder "$*" can be given (even multiple times) to specify
5661 where the arguments will be included, for example: >
5662 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5663< This option cannot be set from a |modeline| or in the |sandbox|, for
5664 security reasons.
5665
5666 *'matchpairs'* *'mps'*
5667'matchpairs' 'mps' string (default "(:),{:},[:]")
5668 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005670 other.
5671 Only character pairs are allowed that are different, thus you cannot
5672 jump between two double quotes.
5673 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005674 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005675 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 :set mps+=<:>
5677
5678< A more exotic example, to jump between the '=' and ';' in an
5679 assignment, useful for languages like C and Java: >
5680 :au FileType c,cpp,java set mps+==:;
5681
5682< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005683 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684
5685 *'matchtime'* *'mat'*
5686'matchtime' 'mat' number (default 5)
5687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 Tenths of a second to show the matching paren, when 'showmatch' is
5689 set. Note that this is not in milliseconds, like other options that
5690 set a time. This is to be compatible with Nvi.
5691
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005692 *'maxcombine'* *'mco'*
5693'maxcombine' 'mco' number (default 2)
5694 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005695 The maximum number of combining characters supported for displaying.
5696 Only used when 'encoding' is "utf-8".
5697 The default is OK for most languages. Hebrew may require 4.
5698 Maximum value is 6.
5699 Even when this option is set to 2 you can still edit text with more
5700 combining characters, you just can't see them. Use |g8| or |ga|.
5701 See |mbyte-combining|.
5702
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 *'maxfuncdepth'* *'mfd'*
5704'maxfuncdepth' 'mfd' number (default 100)
5705 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005706 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005707 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 Maximum depth of function calls for user functions. This normally
5709 catches endless recursion. When using a recursive function with
5710 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5711 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005712 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005713 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005715 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716
5717 *'maxmapdepth'* *'mmd'* *E223*
5718'maxmapdepth' 'mmd' number (default 1000)
5719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Maximum number of times a mapping is done without resulting in a
5721 character to be used. This normally catches endless mappings, like
5722 ":map x y" with ":map y x". It still does not catch ":map g wg",
5723 because the 'w' is used before the next mapping is done. See also
5724 |key-mapping|.
5725
5726 *'maxmem'* *'mm'*
5727'maxmem' 'mm' number (default between 256 to 5120 (system
5728 dependent) or half the amount of memory
5729 available)
5730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5732 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005733 other memory to be freed.
5734 The maximum usable value is about 2000000. Use this to work without a
5735 limit.
5736 The value is ignored when 'swapfile' is off.
5737 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005739 *'maxmempattern'* *'mmp'*
5740'maxmempattern' 'mmp' number (default 1000)
5741 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005742 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005743 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005744 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005745 When Vim runs into the limit it gives an error message and mostly
5746 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005747 Running into the limit often means that the pattern is very
5748 inefficient or too complex. This may already happen with the pattern
5749 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005750 Might also happen on redraw, when syntax rules try to match a complex
5751 text structure.
5752 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5753 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005754
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 *'maxmemtot'* *'mmt'*
5756'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5757 dependent) or half the amount of memory
5758 available)
5759 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005760 Maximum amount of memory in Kbyte to use for all buffers together.
5761 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005762 without a limit.
5763 On 64 bit machines higher values might work. But hey, do you really
5764 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005765 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005766 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005767 Buffers with 'swapfile' off still count to the total amount of memory
5768 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005769 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
5771 *'menuitems'* *'mis'*
5772'menuitems' 'mis' number (default 25)
5773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 {not available when compiled without the |+menu|
5775 feature}
5776 Maximum number of items to use in a menu. Used for menus that are
5777 generated from a list of items, e.g., the Buffers menu. Changing this
5778 option has no direct effect, the menu must be refreshed first.
5779
Christian Brabandt51d4d842024-12-06 17:26:25 +01005780 *'messagesopt'* *'mopt'*
5781'messagesopt' 'mopt' string (default "hit-enter,history:500")
5782 global
5783
zeertzjq8cc43da2024-12-07 16:09:08 +01005784 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005785 following items. Items must be separated by a comma.
5786
zeertzjq8cc43da2024-12-07 16:09:08 +01005787 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005788 'cmdheight' size.
5789
zeertzjq8cc43da2024-12-07 16:09:08 +01005790 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5791 {n} milliseconds so that the user has a chance to read
5792 the message. The maximum value of {n} is 10000. Use
5793 0 to disable the wait (but then the user may miss an
5794 important message).
5795 This item is ignored when "hit-enter" is present, but
5796 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005797
5798 history:{n} Determines how many entries are remembered in the
5799 |:messages| history. The maximum value is 10000.
5800 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005801 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005802
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005803 *'mkspellmem'* *'msm'*
5804'mkspellmem' 'msm' string (default "460000,2000,500")
5805 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005806 {not available when compiled without the |+syntax|
5807 feature}
5808 Parameters for |:mkspell|. This tunes when to start compressing the
5809 word tree. Compression can be slow when there are many words, but
5810 it's needed to avoid running out of memory. The amount of memory used
5811 per word depends very much on how similar the words are, that's why
5812 this tuning is complicated.
5813
5814 There are three numbers, separated by commas:
5815 {start},{inc},{added}
5816
5817 For most languages the uncompressed word tree fits in memory. {start}
5818 gives the amount of memory in Kbyte that can be used before any
5819 compression is done. It should be a bit smaller than the amount of
5820 memory that is available to Vim.
5821
5822 When going over the {start} limit the {inc} number specifies the
5823 amount of memory in Kbyte that can be allocated before another
5824 compression is done. A low number means compression is done after
5825 less words are added, which is slow. A high number means more memory
5826 will be allocated.
5827
5828 After doing compression, {added} times 1024 words can be added before
5829 the {inc} limit is ignored and compression is done when any extra
5830 amount of memory is needed. A low number means there is a smaller
5831 chance of hitting the {inc} limit, less memory is used but it's
5832 slower.
5833
5834 The languages for which these numbers are important are Italian and
5835 Hungarian. The default works for when you have about 512 Mbyte. If
5836 you have 1 Gbyte you could use: >
5837 :set mkspellmem=900000,3000,800
5838< If you have less than 512 Mbyte |:mkspell| may fail for some
5839 languages, no matter what you set 'mkspellmem' to.
5840
dkearns8ebdbc92023-10-29 06:26:19 +11005841 This option cannot be set from a |modeline| or in the |sandbox|, for
5842 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005843
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005845'modeline' 'ml' boolean (Vim default: on (off for root),
5846 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005848 If 'modeline' is on 'modelines' gives the number of lines that is
5849 checked for set commands. If 'modeline' is off or 'modelines' is zero
5850 no lines are checked. See |modeline|.
5851
5852 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5853'modelineexpr' 'mle' boolean (default: off)
5854 global
5855 When on allow some options that are an expression to be set in the
5856 modeline. Check the option for whether it is affected by
5857 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005860
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 *'modelines'* *'mls'*
5862'modelines' 'mls' number (default 5)
5863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 If 'modeline' is on 'modelines' gives the number of lines that is
5865 checked for set commands. If 'modeline' is off or 'modelines' is zero
5866 no lines are checked. See |modeline|.
5867 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5868 set and to the Vim default value when 'compatible' is reset.
5869
5870 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005871 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872'modifiable' 'ma' boolean (default on)
5873 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 When off the buffer contents cannot be changed. The 'fileformat' and
5875 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005876 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877
5878 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5879'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005880 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 When on, the buffer is considered to be modified. This option is set
5882 when:
5883 1. A change was made to the text since it was last written. Using the
5884 |undo| command to go back to the original text will reset the
5885 option. But undoing changes that were made before writing the
5886 buffer will set the option again, since the text is different from
5887 when it was written.
5888 2. 'fileformat' or 'fileencoding' is different from its original
5889 value. The original value is set when the buffer is read or
5890 written. A ":set nomodified" command also resets the original
5891 values to the current values and the 'modified' option will be
5892 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005893 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005894 This option is not set when a change is made to the buffer as the
5895 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5896 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5897 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5899 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005900 Note that the text may actually be the same, e.g. 'modified' is set
5901 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902
5903 *'more'* *'nomore'*
5904'more' boolean (Vim default: on, Vi default: off)
5905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 When on, listings pause when the whole screen is filled. You will get
5907 the |more-prompt|. When this option is off there are no pauses, the
5908 listing continues until finished.
5909 NOTE: This option is set to the Vi default value when 'compatible' is
5910 set and to the Vim default value when 'compatible' is reset.
5911
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005912 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005913'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005914 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005916 Enable the use of the mouse. Works for most terminals (xterm, Win32
5917 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5918 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5919 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005920 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 v Visual mode
5922 i Insert mode
5923 c Command-line mode
5924 h all previous modes when editing a help file
5925 a all previous modes
5926 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005927 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005929< If your terminal can't overrule the mouse events going to the
5930 application, use: >
5931 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005932< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005933 back to Vim using the mouse events.
5934 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5935 "xterm".
5936
5937 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 modeless selection. This doesn't move the text cursor.
5939
5940 See |mouse-using|. Also see |'clipboard'|.
5941
5942 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005943 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 the mouse buttons can still be used by keeping the shift key pressed.
5945 Also see the 'clipboard' option.
5946
5947 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5948'mousefocus' 'mousef' boolean (default off)
5949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 {only works in the GUI}
5951 The window that the mouse pointer is on is automatically activated.
5952 When changing the window layout or window focus in another way, the
5953 mouse pointer is moved to the window with keyboard focus. Off is the
5954 default because it makes using the pull down menus a little goofy, as
5955 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005956 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005957 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958
5959 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5960'mousehide' 'mh' boolean (default on)
5961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 {only works in the GUI}
5963 When on, the mouse pointer is hidden when characters are typed.
5964 The mouse pointer is restored when the mouse is moved.
5965
5966 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005967'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 Sets the model to use for the mouse. The name mostly specifies what
5970 the right mouse button is used for:
5971 extend Right mouse button extends a selection. This works
5972 like in an xterm.
5973 popup Right mouse button pops up a menu. The shifted left
5974 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005975 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 popup_setpos Like "popup", but the cursor will be moved to the
5977 position where the mouse was clicked, and thus the
5978 selected operation will act upon the clicked object.
5979 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005980 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 course, that right clicking outside a selection will
5982 end Visual mode.
5983 Overview of what button does what for each model:
5984 mouse extend popup(_setpos) ~
5985 left click place cursor place cursor
5986 left drag start selection start selection
5987 shift-left search word extend selection
5988 right click extend selection popup menu (place cursor)
5989 right drag extend selection -
5990 middle click paste paste
5991
5992 In the "popup" model the right mouse button produces a pop-up menu.
5993 You need to define this first, see |popup-menu|.
5994
5995 Note that you can further refine the meaning of buttons with mappings.
5996 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5997 selection (because that's handled in the GUI code directly).
5998
5999 The 'mousemodel' option is set by the |:behave| command.
6000
h_east59858792023-10-25 22:47:05 +09006001 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01006002'mousemoveevent' 'mousemev' boolean (default off)
6003 global
6004 {only works in the GUI}
6005 When on, mouse move events are delivered to the input queue and are
6006 available for mapping. The default, off, avoids the mouse movement
6007 overhead except when needed. See |gui-mouse-mapping|.
6008 Warning: Setting this option can make pending mappings to be aborted
6009 when the mouse is moved.
6010 Currently only works in the GUI, may be made to work in a terminal
6011 later.
6012
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006014'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6015 vs:leftright,vd:lrsizing,m:no,
6016 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 {only available when compiled with the |+mouseshape|
6019 feature}
6020 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006021 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 like used for 'guicursor'. Each part consist of a mode/location-list
6023 and an argument-list:
6024 mode-list:shape,mode-list:shape,..
6025 The mode-list is a dash separated list of these modes/locations:
6026 In a normal window: ~
6027 n Normal mode
6028 v Visual mode
6029 ve Visual mode with 'selection' "exclusive" (same as 'v',
6030 if not specified)
6031 o Operator-pending mode
6032 i Insert mode
6033 r Replace mode
6034
6035 Others: ~
6036 c appending to the command-line
6037 ci inserting in the command-line
6038 cr replacing in the command-line
6039 m at the 'Hit ENTER' or 'More' prompts
6040 ml idem, but cursor in the last line
6041 e any mode, pointer below last window
6042 s any mode, pointer on a status line
6043 sd any mode, while dragging a status line
6044 vs any mode, pointer on a vertical separator line
6045 vd any mode, while dragging a vertical separator line
6046 a everywhere
6047
6048 The shape is one of the following:
6049 avail name looks like ~
6050 w x arrow Normal mouse pointer
6051 w x blank no pointer at all (use with care!)
6052 w x beam I-beam
6053 w x updown up-down sizing arrows
6054 w x leftright left-right sizing arrows
6055 w x busy The system's usual busy pointer
6056 w x no The system's usual 'no input' pointer
6057 x udsizing indicates up-down resizing
6058 x lrsizing indicates left-right resizing
6059 x crosshair like a big thin +
6060 x hand1 black hand
6061 x hand2 white hand
6062 x pencil what you write with
6063 x question big ?
6064 x rightup-arrow arrow pointing right-up
6065 w x up-arrow arrow pointing up
6066 x <number> any X11 pointer number (see X11/cursorfont.h)
6067
6068 The "avail" column contains a 'w' if the shape is available for Win32,
6069 x for X11.
6070 Any modes not specified or shapes not available use the normal mouse
6071 pointer.
6072
6073 Example: >
6074 :set mouseshape=s:udsizing,m:no
6075< will make the mouse turn to a sizing arrow over the status lines and
6076 indicate no input when the hit-enter prompt is displayed (since
6077 clicking the mouse has no effect in this state.)
6078
6079 *'mousetime'* *'mouset'*
6080'mousetime' 'mouset' number (default 500)
6081 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006082 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 time in msec between two mouse clicks for the second click to be
6084 recognized as a multi click.
6085
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006086
laburnumT3f7855a2023-12-05 18:37:03 +01006087 *'mzquantum'* *'mzq'*
6088'mzquantum' 'mzq' number (default 100)
6089 global
6090 {not available when compiled without the |+mzscheme|
6091 feature}
6092 The number of milliseconds between polls for MzScheme threads.
6093 Negative or zero value means no thread scheduling.
6094 NOTE: This option is set to the Vim default value when 'compatible'
6095 is reset.
6096
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006097 *'mzschemedll'*
6098'mzschemedll' string (default depends on the build)
6099 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006100 {only available when compiled with the |+mzscheme/dyn|
6101 feature}
6102 Specifies the name of the MzScheme shared library. The default is
6103 DYNAMIC_MZSCH_DLL which was specified at compile time.
6104 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006105 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006106 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006107 This option cannot be set from a |modeline| or in the |sandbox|, for
6108 security reasons.
6109
6110 *'mzschemegcdll'*
6111'mzschemegcdll' string (default depends on the build)
6112 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006113 {only available when compiled with the |+mzscheme/dyn|
6114 feature}
6115 Specifies the name of the MzScheme GC shared library. The default is
6116 DYNAMIC_MZGC_DLL which was specified at compile time.
6117 The value can be equal to 'mzschemedll' if it includes the GC code.
6118 Environment variables are expanded |:set_env|.
6119 This option cannot be set from a |modeline| or in the |sandbox|, for
6120 security reasons.
6121
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006123'nrformats' 'nf' string (default "bin,octal,hex",
6124 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 This defines what bases Vim will consider for numbers when using the
6127 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6128 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006129 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006131 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006132 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006134 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 considered to be hexadecimal. Example: Using CTRL-X on
6136 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006137 bin If included, numbers starting with "0b" or "0B" will be
6138 considered to be binary. Example: Using CTRL-X on
6139 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006140 unsigned If included, numbers are recognized as unsigned. Thus a
6141 leading dash or negative sign won't be considered as part of
6142 the number. Examples:
6143 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6144 (without "unsigned" it would become "9-2021").
6145 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6146 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006147 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6148 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006149 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006150 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006151 dash immediately preceded by a non-whitespace character (i.e.,
6152 not a tab or a " "), the negative sign won't be considered as
6153 part of the number. For example:
6154 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6155 (without "blank" it would become "Carbon-13").
6156 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006157 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006158 set, it would result in "Carbon -7").
6159 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006160 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006161 included, "unsigned" will take precedence.
6162
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 Numbers which simply begin with a digit in the range 1-9 are always
6164 considered decimal. This also happens for numbers that are not
6165 recognized as octal or hex.
6166
6167 *'number'* *'nu'* *'nonumber'* *'nonu'*
6168'number' 'nu' boolean (default off)
6169 local to window
6170 Print the line number in front of each line. When the 'n' option is
6171 excluded from 'cpoptions' a wrapped line will not use the column of
6172 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006173 The 'numberwidth' option can be used to set the room used for the line
6174 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 When a long, wrapped line doesn't start with the first character, '-'
6176 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006177 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6178 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006179 *number_relativenumber*
6180 The 'relativenumber' option changes the displayed number to be
6181 relative to the cursor. Together with 'number' there are these
6182 four combinations (cursor in line 3):
6183
Bram Moolenaar3848e002016-03-19 18:42:29 +01006184 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006185 'nornu' 'nornu' 'rnu' 'rnu'
6186
6187 |apple | 1 apple | 2 apple | 2 apple
6188 |pear | 2 pear | 1 pear | 1 pear
6189 |nobody | 3 nobody | 0 nobody |3 nobody
6190 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006192 *'numberwidth'* *'nuw'*
6193'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6194 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006195 {only available when compiled with the |+linebreak|
6196 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006197 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006198 when the 'number' or 'relativenumber' option is set or printing lines
6199 with a line number. Since one space is always between the number and
6200 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006201 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006202 fit the highest line number in the buffer respectively the number of
6203 rows in the window, depending on whether 'number' or 'relativenumber'
6204 is set. Thus with the Vim default of 4 there is room for a line number
6205 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006206 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006207 NOTE: This option is set to the Vi default value when 'compatible' is
6208 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006209
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006210 *'omnifunc'* *'ofu'*
6211'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006212 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006213 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006214 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006215 This option specifies a function to be used for Insert mode omni
6216 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006217 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006218 invoked and what it should return. The value can be the name of a
6219 function, a |lambda| or a |Funcref|. See |option-value-function| for
6220 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006221 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006222 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006225
Bram Moolenaar02467872007-05-06 13:22:01 +00006226 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006227'opendevice' 'odev' boolean (default off)
6228 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006229 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006230 Enable reading and writing from devices. This may get Vim stuck on a
6231 device that can be opened but doesn't actually do the I/O. Therefore
6232 it is off by default.
6233 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6234 result in editing a device.
6235
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006236 *'operatorfunc'* *'opfunc'*
6237'operatorfunc' 'opfunc' string (default: empty)
6238 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006239 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006240 See |:map-operator| for more info and an example. The value can be
6241 the name of a function, a |lambda| or a |Funcref|. See
6242 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006243
6244 This option cannot be set from a |modeline| or in the |sandbox|, for
6245 security reasons.
6246
Bram Moolenaar251e1912011-06-19 05:09:16 +02006247 *'osfiletype'* *'oft'*
6248'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006250 This option was supported on RISC OS, which has been removed.
6251
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006252 *'packpath'* *'pp'*
6253'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006254 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006255 This option cannot be set from a |modeline| or in the |sandbox|, for
6256 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006257
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006259'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 global
6261 Specifies the nroff macros that separate paragraphs. These are pairs
6262 of two letters (see |object-motions|).
6263
6264 *'paste'* *'nopaste'*
6265'paste' boolean (default off)
6266 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006267 Put Vim in Paste mode. This is useful if you want to cut or copy
6268 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 unexpected effects.
6270 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006271 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 knows about pasting and will mostly do the right thing without 'paste'
6273 being set. The same is true for a terminal where Vim handles the
6274 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006275 This option is reset when starting the GUI. Thus if you set it in
6276 your .vimrc it will work in a terminal, but not in the GUI. Setting
6277 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6278 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 When the 'paste' option is switched on (also when it was already on):
6280 - mapping in Insert mode and Command-line mode is disabled
6281 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006283 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006284 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 - 'revins' is reset
6286 - 'ruler' is reset
6287 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006288 - 'smarttab' is reset
6289 - 'softtabstop' is set to 0
6290 - 'textwidth' is set to 0
6291 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006292 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006295 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006296 - 'indentexpr'
6297 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006298 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 NOTE: When you start editing another file while the 'paste' option is
6300 on, settings from the modelines or autocommands may change the
6301 settings again, causing trouble when pasting text. You might want to
6302 set the 'paste' option again.
6303 When the 'paste' option is reset the mentioned options are restored to
6304 the value before the moment 'paste' was switched from off to on.
6305 Resetting 'paste' before ever setting it does not have any effect.
6306 Since mapping doesn't work while 'paste' is active, you need to use
6307 the 'pastetoggle' option to toggle the 'paste' option with some key.
6308
6309 *'pastetoggle'* *'pt'*
6310'pastetoggle' 'pt' string (default "")
6311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 When non-empty, specifies the key sequence that toggles the 'paste'
6313 option. This is like specifying a mapping: >
6314 :map {keys} :set invpaste<CR>
6315< Where {keys} is the value of 'pastetoggle'.
6316 The difference is that it will work even when 'paste' is set.
6317 'pastetoggle' works in Insert mode and Normal mode, but not in
6318 Command-line mode.
6319 Mappings are checked first, thus overrule 'pastetoggle'. However,
6320 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6321 this: >
6322 :map <F10> :set paste<CR>
6323 :map <F11> :set nopaste<CR>
6324 :imap <F10> <C-O>:set paste<CR>
6325 :imap <F11> <nop>
6326 :set pastetoggle=<F11>
6327< This will make <F10> start paste mode and <F11> stop paste mode.
6328 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6329 mode everything is inserted literally, except the 'pastetoggle' key
6330 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006331 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332
6333 *'pex'* *'patchexpr'*
6334'patchexpr' 'pex' string (default "")
6335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 {not available when compiled without the |+diff|
6337 feature}
6338 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006339 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006340 This option cannot be set from a |modeline| or in the |sandbox|, for
6341 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342
Bram Moolenaardbc28022014-07-26 13:40:44 +02006343 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344'patchmode' 'pm' string (default "")
6345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 When non-empty the oldest version of a file is kept. This can be used
6347 to keep the original version of a file if you are changing files in a
6348 source distribution. Only the first time that a file is written a
6349 copy of the original file will be kept. The name of the copy is the
6350 name of the original file with the string in the 'patchmode' option
6351 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006352 ".orig" or ".org". 'backupdir' must not be empty for this to work
6353 (Detail: The backup file is renamed to the patchmode file after the
6354 new file has been successfully written, that's why it must be possible
6355 to write a backup file). If there was no file to be backed up, an
6356 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 When the 'backupskip' pattern matches, a patchmode file is not made.
6358 Using 'patchmode' for compressed files appends the extension at the
6359 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6360 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006361 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006363 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 other systems: ".,,")
6366 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006368 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6369 provided that the file being searched for has a relative path (not
6370 starting with "/", "./" or "../"). The directories in the 'path'
6371 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 - Use commas to separate directory names: >
6373 :set path=.,/usr/local/include,/usr/include
6374< - Spaces can also be used to separate directory names (for backwards
6375 compatibility with version 3.0). To have a space in a directory
6376 name, precede it with an extra backslash, and escape the space: >
6377 :set path=.,/dir/with\\\ space
6378< - To include a comma in a directory name precede it with an extra
6379 backslash: >
6380 :set path=.,/dir/with\\,comma
6381< - To search relative to the directory of the current file, use: >
6382 :set path=.
6383< - To search in the current directory use an empty string between two
6384 commas: >
6385 :set path=,,
6386< - A directory name may end in a ':' or '/'.
6387 - Environment variables are expanded |:set_env|.
6388 - When using |netrw.vim| URLs can be used. For example, adding
6389 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006390 - Search upwards and downwards in a directory tree using "*", "**" and
6391 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 - Careful with '\' characters, type two to get one in the option: >
6393 :set path=.,c:\\include
6394< Or just use '/' instead: >
6395 :set path=.,c:/include
6396< Don't forget "." or files won't even be found in the same directory as
6397 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 it is something like 256 or 1024 characters.
6400 You can check if all the include files are found, using the value of
6401 'path', see |:checkpath|.
6402 The use of |:set+=| and |:set-=| is preferred when adding or removing
6403 directories from the list. This avoids problems when a future version
6404 uses another default. To remove the current directory use: >
6405 :set path-=
6406< To add the current directory use: >
6407 :set path+=
6408< To use an environment variable, you probably need to replace the
6409 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006410 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006411 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412< Replace the ';' with a ':' or whatever separator is used. Note that
6413 this doesn't work when $INCL contains a comma or white space.
6414
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006415 *'perldll'*
6416'perldll' string (default depends on the build)
6417 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006418 {only available when compiled with the |+perl/dyn|
6419 feature}
6420 Specifies the name of the Perl shared library. The default is
6421 DYNAMIC_PERL_DLL, which was specified at compile time.
6422 Environment variables are expanded |:set_env|.
6423 This option cannot be set from a |modeline| or in the |sandbox|, for
6424 security reasons.
6425
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6427'preserveindent' 'pi' boolean (default off)
6428 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 When changing the indent of the current line, preserve as much of the
6430 indent structure as possible. Normally the indent is replaced by a
6431 series of tabs followed by spaces as required (unless |'expandtab'| is
6432 enabled, in which case only spaces are used). Enabling this option
6433 means the indent will preserve as many existing characters as possible
6434 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006435 'expandtab' does not apply to the preserved white space, a Tab remains
6436 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 NOTE: When using ">>" multiple times the resulting indent is a mix of
6438 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006439 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 Also see 'copyindent'.
6441 Use |:retab| to clean up white space.
6442
6443 *'previewheight'* *'pvh'*
6444'previewheight' 'pvh' number (default 12)
6445 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006446 {not available when compiled without the |+quickfix|
6447 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006449 commands. Used for |CTRL-W_}| when no count is given. Not used when
6450 'previewpopup' is set.
6451
6452 *'previewpopup'* *'pvp'*
6453'previewpopup' 'pvp' string (default empty)
6454 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006455 {not available when compiled without the |+textprop|
6456 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006457 When not empty a popup window is used for commands that would open a
6458 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006459 Not used for the insert completion info, add "popup" to
6460 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461
6462 *'previewwindow'* *'nopreviewwindow'*
6463 *'pvw'* *'nopvw'* *E590*
6464'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006465 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006466 {not available when compiled without the |+quickfix|
6467 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006468 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 set. It's normally not set directly, but by using one of the commands
6470 |:ptag|, |:pedit|, etc.
6471
6472 *'printdevice'* *'pdev'*
6473'printdevice' 'pdev' string (default empty)
6474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 {only available when compiled with the |+printer|
6476 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006477 The name of the printer to be used for |:hardcopy|.
6478 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006479 This option cannot be set from a |modeline| or in the |sandbox|, for
6480 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481
Bram Moolenaar8299df92004-07-10 09:47:34 +00006482 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006483'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 {only available when compiled with the |+printer|
6486 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006487 Sets the character encoding used when printing.
6488 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489
6490 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006491'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 {only available when compiled with the |+printer|
6494 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006495 Expression used to print the PostScript produced with |:hardcopy|.
6496 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006497 This option cannot be set from a |modeline| or in the |sandbox|, for
6498 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499
Bram Moolenaar8299df92004-07-10 09:47:34 +00006500 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501'printfont' 'pfn' string (default "courier")
6502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 {only available when compiled with the |+printer|
6504 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006505 The name of the font that will be used for |:hardcopy|.
6506 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507
6508 *'printheader'* *'pheader'*
6509'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 {only available when compiled with the |+printer|
6512 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006513 The format of the header produced in |:hardcopy| output.
6514 See |pheader-option|.
6515
6516 *'printmbcharset'* *'pmbcs'*
6517'printmbcharset' 'pmbcs' string (default "")
6518 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006519 {only available when compiled with the |+printer|
6520 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006521 The CJK character set to be used for CJK output from |:hardcopy|.
6522 See |pmbcs-option|.
6523
6524 *'printmbfont'* *'pmbfn'*
6525'printmbfont' 'pmbfn' string (default "")
6526 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006527 {only available when compiled with the |+printer|
6528 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006529 List of font names to be used for CJK output from |:hardcopy|.
6530 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531
6532 *'printoptions'* *'popt'*
6533'printoptions' 'popt' string (default "")
6534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006536 List of items that control the format of the output of |:hardcopy|.
6537 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006539 *'prompt'* *'noprompt'*
6540'prompt' boolean (default on)
6541 global
6542 When on a ":" prompt is used in Ex mode.
6543
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006544 *'pumheight'* *'ph'*
6545'pumheight' 'ph' number (default 0)
6546 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006547 Determines the maximum number of items to show in the popup menu for
6548 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006549 |ins-completion-menu|.
6550
glepnir88d75932025-03-27 20:09:07 +01006551 *'pummaxwidth'* *'pmw'*
6552'pummaxwidth' 'pmw' number (default 0)
6553 global
6554 Determines the maximum width to use for the popup menu for completion.
6555 When zero, there is no maximum width limit, otherwise the popup menu
6556 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006557 by "trunc" value of 'fillchars' option.
6558
6559 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006560 |ins-completion-menu|.
6561
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006562 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006563'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006564 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006565 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006566 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006567
Bram Moolenaard94464e2015-11-02 15:28:18 +01006568 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006569'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006570 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006571 {only available when compiled with the |+python/dyn|
6572 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006573 Specifies the name of the Python 2.x shared library. The default is
6574 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006575 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006576 This option cannot be set from a |modeline| or in the |sandbox|, for
6577 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006578
Bram Moolenaar94073162018-01-31 21:49:05 +01006579 *'pythonhome'*
6580'pythonhome' string (default "")
6581 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006582 {only available when compiled with the |+python/dyn|
6583 feature}
6584 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6585 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6586 which was specified at compile time, will be used for the Python 2.x
6587 home directory.
6588 Environment variables are expanded |:set_env|.
6589 This option cannot be set from a |modeline| or in the |sandbox|, for
6590 security reasons.
6591
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006592 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006593'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006594 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006595 {only available when compiled with the |+python3/dyn|
6596 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006597 Specifies the name of the Python 3 shared library. The default is
6598 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006599 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006600 This option cannot be set from a |modeline| or in the |sandbox|, for
6601 security reasons.
6602
Bram Moolenaar94073162018-01-31 21:49:05 +01006603 *'pythonthreehome'*
6604'pythonthreehome' string (default "")
6605 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006606 {only available when compiled with the |+python3/dyn|
6607 feature}
6608 Specifies the name of the Python 3 home directory. When
6609 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6610 PYTHON3_HOME, which was specified at compile time, will be used for
6611 the Python 3 home directory.
6612 Environment variables are expanded |:set_env|.
6613 This option cannot be set from a |modeline| or in the |sandbox|, for
6614 security reasons.
6615
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006616 *'pyxversion'* *'pyx'*
6617'pyxversion' 'pyx' number (default depends on the build)
6618 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006619 {only available when compiled with the |+python| or
6620 the |+python3| feature}
6621 Specifies the python version used for pyx* functions and commands
6622 |python_x|. The default value is as follows:
6623
6624 Compiled with Default ~
6625 |+python| and |+python3| 0
6626 only |+python| 2
6627 only |+python3| 3
6628
6629 Available values are 0, 2 and 3.
6630 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6631 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6632 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6633 to 2 if Python 2 is available.
6634 See also: |has-pythonx|
6635
6636 If Vim is compiled with only |+python| or |+python3| setting
6637 'pyxversion' has no effect. The pyx* functions and commands are
6638 always the same as the compiled version.
6639
6640 This option cannot be set from a |modeline| or in the |sandbox|, for
6641 security reasons.
6642
Bram Moolenaar858ba062020-05-31 23:11:59 +02006643 *'quickfixtextfunc'* *'qftf'*
6644'quickfixtextfunc' 'qftf' string (default "")
6645 global
6646 {only available when compiled with the |+quickfix|
6647 feature}
6648 This option specifies a function to be used to get the text to display
6649 in the quickfix and location list windows. This can be used to
6650 customize the information displayed in the quickfix or location window
6651 for each entry in the corresponding quickfix or location list. See
6652 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006653 function and an example. The value can be the name of a function, a
6654 |lambda| or a |Funcref|. See |option-value-function| for more
6655 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006656
6657 This option cannot be set from a |modeline| or in the |sandbox|, for
6658 security reasons.
6659
Bram Moolenaar677ee682005-01-27 14:41:15 +00006660 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006661'quoteescape' 'qe' string (default "\")
6662 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006663 The characters that are used to escape quotes in a string. Used for
6664 objects like a', a" and a` |a'|.
6665 When one of the characters in this option is found inside a string,
6666 the following character will be skipped. The default value makes the
6667 text "foo\"bar\\" considered to be one string.
6668
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6670'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006671 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 If on, writes fail unless you use a '!'. Protects you from
6673 accidentally overwriting a file. Default on when Vim is started
6674 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006675 When using ":w!" the 'readonly' option is reset for the current
6676 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006677 When using the ":view" command the 'readonly' option is set for the
6678 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006679 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006681 *'redrawtime'* *'rdt'*
6682'redrawtime' 'rdt' number (default 2000)
6683 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006684 {only available when compiled with the |+reltime|
6685 feature}
6686 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006687 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006688 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006689 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006690 matches will be highlighted.
6691 For syntax highlighting the time applies per window. When over the
6692 limit syntax highlighting is disabled until |CTRL-L| is used.
6693 This is used to avoid that Vim hangs when using a very complicated
6694 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006695
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006696 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006697'regexpengine' 're' number (default 0)
6698 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006699 This selects the default regexp engine. |two-engines|
6700 The possible values are:
6701 0 automatic selection
6702 1 old engine
6703 2 NFA engine
6704 Note that when using the NFA engine and the pattern contains something
6705 that is not supported the pattern will not match. This is only useful
6706 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006707 Using automatic selection enables Vim to switch the engine, if the
6708 default engine becomes too costly. E.g., when the NFA engine uses too
6709 many states. This should prevent Vim from hanging on a combination of
6710 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006711
Bram Moolenaar64486672010-05-16 15:46:46 +02006712 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6713'relativenumber' 'rnu' boolean (default off)
6714 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006715 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006716 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006717 precede some vertical motion commands (e.g. j k + -) with, without
6718 having to calculate it yourself. Especially useful in combination with
6719 other commands (e.g. y d c < > gq gw =).
6720 When the 'n' option is excluded from 'cpoptions' a wrapped
6721 line will not use the column of line numbers (this is the default when
6722 'compatible' isn't set).
6723 The 'numberwidth' option can be used to set the room used for the line
6724 number.
6725 When a long, wrapped line doesn't start with the first character, '-'
6726 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006727 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6728 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006729
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006730 The number in front of the cursor line also depends on the value of
6731 'number', see |number_relativenumber| for all combinations of the two
6732 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006733
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 *'remap'* *'noremap'*
6735'remap' boolean (default on)
6736 global
6737 Allows for mappings to work recursively. If you do not want this for
6738 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006739 NOTE: To avoid portability problems with Vim scripts, always keep
6740 this option at the default "on". Only switch it off when working with
6741 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742
zeertzjqd086b8f2024-02-25 15:42:52 +08006743 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006744'renderoptions' 'rop' string (default: empty)
6745 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006746 {only available when compiled with GUI and DIRECTX on
6747 MS-Windows}
6748 Select a text renderer and set its options. The options depend on the
6749 renderer.
6750
6751 Syntax: >
6752 set rop=type:{renderer}(,{name}:{value})*
6753<
6754 Currently, only one optional renderer is available.
6755
6756 render behavior ~
6757 directx Vim will draw text using DirectX (DirectWrite). It makes
6758 drawn glyphs more beautiful than default GDI.
6759 It requires 'encoding' is "utf-8", and only works on
6760 MS-Windows Vista or newer version.
6761
6762 Options:
6763 name meaning type value ~
6764 gamma gamma float 1.0 - 2.2 (maybe)
6765 contrast enhancedContrast float (unknown)
6766 level clearTypeLevel float (unknown)
6767 geom pixelGeometry int 0 - 2 (see below)
6768 renmode renderingMode int 0 - 6 (see below)
6769 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006770 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006771
Bram Moolenaar92467d32017-12-05 13:22:16 +01006772 See this URL for detail (except for scrlines):
6773 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006774
6775 For geom: structure of a device pixel.
6776 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6777 1 - DWRITE_PIXEL_GEOMETRY_RGB
6778 2 - DWRITE_PIXEL_GEOMETRY_BGR
6779
6780 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006781 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006782
6783 For renmode: method of rendering glyphs.
6784 0 - DWRITE_RENDERING_MODE_DEFAULT
6785 1 - DWRITE_RENDERING_MODE_ALIASED
6786 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6787 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6788 4 - DWRITE_RENDERING_MODE_NATURAL
6789 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6790 6 - DWRITE_RENDERING_MODE_OUTLINE
6791
6792 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006793 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006794
6795 For taamode: antialiasing mode used for drawing text.
6796 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6797 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6798 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6799 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6800
6801 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006802 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6803
Bram Moolenaara338adc2018-01-31 20:51:47 +01006804 For scrlines:
6805 This was used for optimizing scrolling behavior, however this
6806 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006807
6808 Example: >
6809 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006810 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006811 set rop=type:directx
6812<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006813 If select a raster font (Courier, Terminal or FixedSys which
6814 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006815 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006816
6817 NOTE: It is known that some fonts and options combination
6818 causes trouble on drawing glyphs.
6819
Bram Moolenaar92467d32017-12-05 13:22:16 +01006820 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006821 special made fonts (True-Type fonts which includes only
6822 bitmap glyphs).
6823 - 'taamode:3' will not work with some vector fonts.
6824
6825 NOTE: With this option, you can display colored emoji
6826 (emoticon) in Windows 8.1 or later. To display colored emoji,
6827 there are some conditions which you should notice.
6828
6829 - If your font includes non-colored emoji already, it will
6830 be used.
6831 - If your font doesn't have emoji, the system chooses an
6832 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6833 will be used.
6834 - When this alternative font didn't have fixed width glyph,
6835 emoji might be rendered beyond the bounding box of drawing
6836 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006837
6838 Other render types are currently not supported.
6839
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 *'report'*
6841'report' number (default 2)
6842 global
6843 Threshold for reporting number of lines changed. When the number of
6844 changed lines is more than 'report' a message will be given for most
6845 ":" commands. If you want it always, set 'report' to 0.
6846 For the ":substitute" command the number of substitutions is used
6847 instead of the number of lines.
6848
6849 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6850'restorescreen' 'rs' boolean (default on)
6851 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006852 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 When set, the screen contents is restored when exiting Vim. This also
6854 happens when executing external commands.
6855
6856 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6857 options in your .vimrc. To disable restoring:
6858 set t_ti= t_te=
6859 To enable restoring (for an xterm):
6860 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6861 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6862
6863 *'revins'* *'ri'* *'norevins'* *'nori'*
6864'revins' 'ri' boolean (default off)
6865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 {only available when compiled with the |+rightleft|
6867 feature}
6868 Inserting characters in Insert mode will work backwards. See "typing
6869 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6870 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006871 NOTE: This option is reset when 'compatible' is set.
6872 This option is reset when 'paste' is set and restored when 'paste' is
6873 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874
6875 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6876'rightleft' 'rl' boolean (default off)
6877 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 {only available when compiled with the |+rightleft|
6879 feature}
6880 When on, display orientation becomes right-to-left, i.e., characters
6881 that are stored in the file appear from the right to the left.
6882 Using this option, it is possible to edit files for languages that
6883 are written from the right to the left such as Hebrew and Arabic.
6884 This option is per window, so it is possible to edit mixed files
6885 simultaneously, or to view the same file in both ways (this is
6886 useful whenever you have a mixed text file with both right-to-left
6887 and left-to-right strings so that both sets are displayed properly
6888 in different windows). Also see |rileft.txt|.
6889
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006890 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891'rightleftcmd' 'rlc' string (default "search")
6892 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 {only available when compiled with the |+rightleft|
6894 feature}
6895 Each word in this option enables the command line editing to work in
6896 right-to-left mode for a group of commands:
6897
6898 search "/" and "?" commands
6899
6900 This is useful for languages such as Hebrew, Arabic and Farsi.
6901 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6902
Bram Moolenaard94464e2015-11-02 15:28:18 +01006903 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006904'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006905 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006906 {only available when compiled with the |+ruby/dyn|
6907 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006908 Specifies the name of the Ruby shared library. The default is
6909 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006910 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006911 This option cannot be set from a |modeline| or in the |sandbox|, for
6912 security reasons.
6913
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006915'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006918 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 text in the file is shown on the far right:
6920 Top first line is visible
6921 Bot last line is visible
6922 All first and last line are visible
6923 45% relative position in the file
6924 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006925 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006926 ruler is shown there. Otherwise it is shown in the last line of the
6927 screen. If the statusline is given by 'statusline' (i.e. not empty),
6928 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006930 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 the text column (byte number) and the screen column are shown,
6932 separated with a dash.
6933 For an empty line "0-1" is shown.
6934 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006935 This option is reset when 'paste' is set and restored when 'paste' is
6936 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 If you don't want to see the ruler all the time but want to know where
6938 you are, use "g CTRL-G" |g_CTRL-G|.
6939 NOTE: This option is reset when 'compatible' is set.
6940
6941 *'rulerformat'* *'ruf'*
6942'rulerformat' 'ruf' string (default empty)
6943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 {not available when compiled without the |+statusline|
6945 feature}
6946 When this option is not empty, it determines the content of the ruler
6947 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006948 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006949 This option cannot be set in a modeline when 'modelineexpr' is off.
6950
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 The default ruler width is 17 characters. To make the ruler 15
6952 characters wide, put "%15(" at the start and "%)" at the end.
6953 Example: >
6954 :set rulerformat=%15(%c%V\ %p%%%)
6955<
6956 *'runtimepath'* *'rtp'* *vimfiles*
6957'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006958 Unix: "$HOME/.vim or
6959 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 $VIM/vimfiles,
6961 $VIMRUNTIME,
6962 $VIM/vimfiles/after,
6963 $HOME/.vim/after"
6964 Amiga: "home:vimfiles,
6965 $VIM/vimfiles,
6966 $VIMRUNTIME,
6967 $VIM/vimfiles/after,
6968 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006969 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 $VIM/vimfiles,
6971 $VIMRUNTIME,
6972 $VIM/vimfiles/after,
6973 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006974 Haiku: "$BE_USER_SETTINGS/vim,
6975 $VIM/vimfiles,
6976 $VIMRUNTIME,
6977 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006978 $BE_USER_SETTINGS/vim/after"
6979 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 $VIM/vimfiles,
6981 $VIMRUNTIME,
6982 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006983 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 This is a list of directories which will be searched for runtime
6986 files:
6987 filetype.vim filetypes by file name |new-filetype|
6988 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006989 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 colors/ color scheme files |:colorscheme|
6991 compiler/ compiler files |:compiler|
6992 doc/ documentation |write-local-help|
6993 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006994 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 indent/ indent scripts |indent-expression|
6996 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006997 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006999 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 plugin/ plugin scripts |write-plugin|
7001 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007002 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 syntax/ syntax files |mysyntaxfile|
7004 tutor/ files for vimtutor |tutor|
7005
7006 And any other file searched for with the |:runtime| command.
7007
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007008 For $XDG_CONFIG_HOME see |xdg-base-dir|.
7009
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 The defaults for most systems are setup to search five locations:
7011 1. In your home directory, for your personal preferences.
7012 2. In a system-wide Vim directory, for preferences from the system
7013 administrator.
7014 3. In $VIMRUNTIME, for files distributed with Vim.
7015 *after-directory*
7016 4. In the "after" directory in the system-wide Vim directory. This is
7017 for the system administrator to overrule or add to the distributed
7018 defaults (rarely needed)
7019 5. In the "after" directory in your home directory. This is for
7020 personal preferences to overrule or add to the distributed defaults
7021 or system-wide settings (rarely needed).
7022
Bram Moolenaard0796902016-09-16 20:02:31 +02007023 More entries are added when using |packages|. If it gets very long
7024 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7025 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007026
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7028 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007029 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 wildcards.
7031 See |:runtime|.
7032 Example: >
7033 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7034< This will use the directory "~/vimruntime" first (containing your
7035 personal Vim runtime files), then "/mygroup/vim" (shared between a
7036 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7037 files).
7038 You probably should always include $VIMRUNTIME somewhere, to use the
7039 distributed runtime files. You can put a directory before $VIMRUNTIME
7040 to find files which replace a distributed runtime files. You can put
7041 a directory after $VIMRUNTIME to find files which add to distributed
7042 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007043 When Vim is started with |--clean| the home directory entries are not
7044 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 This option cannot be set from a |modeline| or in the |sandbox|, for
7046 security reasons.
7047
7048 *'scroll'* *'scr'*
7049'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007050 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7052 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007053 changes. This may happen when enabling the |status-line| or
7054 'tabline' option after setting the 'scroll' option.
7055 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007056 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007057 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058
7059 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7060'scrollbind' 'scb' boolean (default off)
7061 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007062 See also |scroll-binding|. When this option is set, scrolling the
7063 current window also scrolls other scrollbind windows (windows that
7064 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 differences between two versions of a file, see 'diff'.
7066 See |'scrollopt'| for options that determine how this option should be
7067 interpreted.
7068 This option is mostly reset when splitting a window to edit another
7069 file. This means that ":split | edit file" results in two windows
7070 with scroll-binding, but ":split file" does not.
7071
Bram Moolenaarae20f342019-11-05 21:09:23 +01007072 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7073'scrollfocus' 'scf' boolean (default off)
7074 global
7075 {only for MS-Windows GUI}
7076 When using the scroll wheel and this option is set, the window under
7077 the mouse pointer is scrolled. With this option off the current
7078 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007079 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007080
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 *'scrolljump'* *'sj'*
7082'scrolljump' 'sj' number (default 1)
7083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 Minimal number of lines to scroll when the cursor gets off the
7085 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7086 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007087 When set to a negative number from -1 to -100 this is used as the
7088 percentage of the window height. Thus -50 scrolls half the window
7089 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 NOTE: This option is set to 1 when 'compatible' is set.
7091
7092 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007093'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007094 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 Minimal number of screen lines to keep above and below the cursor.
7096 This will make some context visible around where you are working. If
7097 you set it to a very large value (999) the cursor line will always be
7098 in the middle of the window (except at the start or end of the file or
7099 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007100 After using the local value, go back the global value with one of
7101 these two: >
7102 setlocal scrolloff<
7103 setlocal scrolloff=-1
7104< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 NOTE: This option is set to 0 when 'compatible' is set.
7106
7107 *'scrollopt'* *'sbo'*
7108'scrollopt' 'sbo' string (default "ver,jump")
7109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007111 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7112 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 The following words are available:
7114 ver Bind vertical scrolling for 'scrollbind' windows
7115 hor Bind horizontal scrolling for 'scrollbind' windows
7116 jump Applies to the offset between two windows for vertical
7117 scrolling. This offset is the difference in the first
7118 displayed line of the bound windows. When moving
7119 around in a window, another 'scrollbind' window may
7120 reach a position before the start or after the end of
7121 the buffer. The offset is not changed though, when
7122 moving back the 'scrollbind' window will try to scroll
7123 to the desired position when possible.
7124 When now making that window the current one, two
7125 things can be done with the relative offset:
7126 1. When "jump" is not included, the relative offset is
7127 adjusted for the scroll position in the new current
7128 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007129 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 2. When "jump" is included, the other windows are
7131 scrolled to keep the same relative offset. When
7132 going back to the other window, it still uses the
7133 same relative offset.
7134 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007135 When 'diff' mode is active there always is vertical scroll binding,
7136 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137
7138 *'sections'* *'sect'*
7139'sections' 'sect' string (default "SHNHH HUnhsh")
7140 global
7141 Specifies the nroff macros that separate sections. These are pairs of
7142 two letters (See |object-motions|). The default makes a section start
7143 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7144
7145 *'secure'* *'nosecure'* *E523*
7146'secure' boolean (default off)
7147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 When on, ":autocmd", shell and write commands are not allowed in
7149 ".vimrc" and ".exrc" in the current directory and map commands are
7150 displayed. Switch it off only if you know that you will not run into
7151 problems, or when the 'exrc' option is off. On Unix this option is
7152 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007153 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 'secure' at the end of your ~/.vimrc then.
7155 This option cannot be set from a |modeline| or in the |sandbox|, for
7156 security reasons.
7157
7158 *'selection'* *'sel'*
7159'selection' 'sel' string (default "inclusive")
7160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 This option defines the behavior of the selection. It is only used
7162 in Visual and Select mode.
7163 Possible values:
7164 value past line inclusive ~
7165 old no yes
7166 inclusive yes yes
7167 exclusive yes no
7168 "past line" means that the cursor is allowed to be positioned one
7169 character past the line.
7170 "inclusive" means that the last character of the selection is included
7171 in an operation. For example, when "x" is used to delete the
7172 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007173 When "old" is used and 'virtualedit' allows the cursor to move past
7174 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007175 When "exclusive" is used, cursor position in visual mode will be
7176 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 Note that when "exclusive" is used and selecting from the end
7178 backwards, you cannot include the last character of a line, when
7179 starting in Normal mode and 'virtualedit' empty.
7180
7181 The 'selection' option is set by the |:behave| command.
7182
7183 *'selectmode'* *'slm'*
7184'selectmode' 'slm' string (default "")
7185 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007186 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 Select mode instead of Visual mode, when a selection is started.
7188 Possible values:
7189 mouse when using the mouse
7190 key when using shifted special keys
7191 cmd when using "v", "V" or CTRL-V
7192 See |Select-mode|.
7193 The 'selectmode' option is set by the |:behave| command.
7194
7195 *'sessionoptions'* *'ssop'*
7196'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007197 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007199 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 feature}
7201 Changes the effect of the |:mksession| command. It is a comma
7202 separated list of words. Each word enables saving and restoring
7203 something:
7204 word save and restore ~
7205 blank empty windows
7206 buffers hidden and unloaded buffers, not just those in windows
7207 curdir the current directory
7208 folds manually created folds, opened/closed folds and local
7209 fold options
7210 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007211 and contain at least one lowercase letter. Only
7212 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 help the help window
7214 localoptions options and mappings local to a window or buffer (not
7215 global values for local options)
7216 options all options and mappings (also global values for local
7217 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007218 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 resize size of the Vim window: 'lines' and 'columns'
7220 sesdir the directory in which the session file is located
7221 will become the current directory (useful with
7222 projects accessed over a network from different
7223 systems)
7224 slash backslashes in file names replaced with forward
7225 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007226 tabpages all tab pages; without this only the current tab page
7227 is restored, so that you can make a session for each
7228 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007229 terminal include terminal windows where the command can be
7230 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 unix with Unix end-of-line format (single <NL>), even when
7232 on Windows or DOS
7233 winpos position of the whole Vim window
7234 winsize window sizes
7235
7236 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007237 When neither "curdir" nor "sesdir" is included, file names are stored
7238 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007239 If you leave out "options" many things won't work well after restoring
7240 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 "slash" and "unix" are useful on Windows when sharing session files
7242 with Unix. The Unix version of Vim cannot source dos format scripts,
7243 but the Windows version of Vim can source unix format scripts.
7244
7245 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007246'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 global
7248 Name of the shell to use for ! and :! commands. When changing the
7249 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7250 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007251 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 See |option-backslash| about including spaces and backslashes.
7253 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007254
Bram Moolenaara2baa732022-02-04 16:09:54 +00007255 In |restricted-mode| shell commands will not be possible. This mode
7256 is used if the value of $SHELL ends in "false" or "nologin".
7257
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007258 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007259 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7261< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007262 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007264 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007266 Example with escaped space (Vim will do this when initializing the
7267 option from $SHELL): >
7268 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007269< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007270 backslashes are consumed by `:set`.
7271
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 Under MS-Windows, when the executable ends in ".com" it must be
7273 included. Thus setting the shell to "command.com" or "4dos.com"
7274 works, but "command" and "4dos" do not work for all commands (e.g.,
7275 filtering).
7276 For unknown reasons, when using "4dos.com" the current directory is
7277 changed to "C:\". To avoid this set 'shell' like this: >
7278 :set shell=command.com\ /c\ 4dos
7279< This option cannot be set from a |modeline| or in the |sandbox|, for
7280 security reasons.
7281
7282 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007283'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007284 Win32, when 'shell' contains "powershell":
7285 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007286 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007289 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7290 For MS-Windows, the default is set according to the value of 'shell',
7291 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007292 On Unix it can have more than one flag. Each white space separated
7293 part is passed as an argument to the shell command.
7294 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007295 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 This option cannot be set from a |modeline| or in the |sandbox|, for
7297 security reasons.
7298
7299 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007300'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7301 "2>&1| tee", or
7302 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 {not available when compiled without the |+quickfix|
7305 feature}
7306 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007307 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 including spaces and backslashes.
7309 The name of the temporary file can be represented by "%s" if necessary
7310 (the file name is appended automatically if no %s appears in the value
7311 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007312 For the Amiga the default is ">". For MS-Windows using powershell the
7313 default is "2>&1 | Out-File -Encoding default", otherwise the default
7314 is ">%s 2>&1". The output is directly saved in a file and not echoed
7315 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007316 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 in a file and echoed to the screen. If the 'shell' option is "csh" or
7318 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007319 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007320 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7321 means that stderr is also included. Before using the 'shell' option a
7322 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007323 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7324 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 The initialization of this option is done after reading the ".vimrc"
7326 and the other initializations, so that when the 'shell' option is set
7327 there, the 'shellpipe' option changes automatically, unless it was
7328 explicitly set before.
7329 When 'shellpipe' is set to an empty string, no redirection of the
7330 ":make" output will be done. This is useful if you use a 'makeprg'
7331 that writes to 'makeef' by itself. If you want no piping, but do
7332 want to include the 'makeef', set 'shellpipe' to a single space.
7333 Don't forget to precede the space with a backslash: ":set sp=\ ".
7334 In the future pipes may be used for filtering and this option will
7335 become obsolete (at least for Unix).
7336 This option cannot be set from a |modeline| or in the |sandbox|, for
7337 security reasons.
7338
7339 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007340'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 Quoting character(s), put around the command passed to the shell, for
7343 the "!" and ":!" commands. The redirection is kept outside of the
7344 quoting. See 'shellxquote' to include the redirection. It's
7345 probably not useful to set both options.
7346 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007347 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007348 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 This option cannot be set from a |modeline| or in the |sandbox|, for
7350 security reasons.
7351
7352 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007353'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7354 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 String to be used to put the output of a filter command in a temporary
7357 file. See also |:!|. See |option-backslash| about including spaces
7358 and backslashes.
7359 The name of the temporary file can be represented by "%s" if necessary
7360 (the file name is appended automatically if no %s appears in the value
7361 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007362 The default is ">". For Unix, if the 'shell' option is "csh" or
7363 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007364 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007365 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7366 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007367 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7368 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007369 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7370 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 The initialization of this option is done after reading the ".vimrc"
7372 and the other initializations, so that when the 'shell' option is set
7373 there, the 'shellredir' option changes automatically unless it was
7374 explicitly set before.
7375 In the future pipes may be used for filtering and this option will
7376 become obsolete (at least for Unix).
7377 This option cannot be set from a |modeline| or in the |sandbox|, for
7378 security reasons.
7379
7380 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7381'shellslash' 'ssl' boolean (default off)
7382 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007383 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007385 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007386 powershell.exe. Backward slashes can still be typed, but they are
7387 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 Note that setting or resetting this option has no effect for some
7389 existing file names, thus this option needs to be set before opening
7390 any file for best results. This might change in the future.
7391 'shellslash' only works when a backslash can be used as a path
7392 separator. To test if this is so use: >
7393 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007394< Also see 'completeslash'.
7395
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007396 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7397'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7398 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007399 When on, use temp files for shell commands. When off use a pipe.
7400 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007401 Currently a pipe is only supported on Unix and MS-Windows 2K and
7402 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007403 :if has("filterpipe")
7404< The advantage of using a pipe is that nobody can read the temp file
7405 and the 'shell' command does not need to support redirection.
7406 The advantage of using a temp file is that the file type and encoding
7407 can be detected.
7408 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7409 |FilterWritePost| autocommands event are not triggered when
7410 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007411 The `system()` function does not respect this option and always uses
7412 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007413 NOTE: This option is set to the Vim default value when 'compatible'
7414 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007415
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 *'shelltype'* *'st'*
7417'shelltype' 'st' number (default 0)
7418 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007419 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 On the Amiga this option influences the way how the commands work
7421 which use a shell.
7422 0 and 1: always use the shell
7423 2 and 3: use the shell only to filter lines
7424 4 and 5: use shell only for ':sh' command
7425 When not using the shell, the command is executed directly.
7426
7427 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7428 1 and 3: use "shell cmd" to start external commands
7429
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007430 *'shellxescape'* *'sxe'*
7431'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007432 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007433 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007434 When 'shellxquote' is set to "(" then the characters listed in this
7435 option will be escaped with a '^' character. This makes it possible
7436 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007437 This option cannot be set from a |modeline| or in the |sandbox|, for
7438 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007439
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 *'shellxquote'* *'sxq'*
7441'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007442 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007443 for Win32, when 'shell' is
7444 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007445 for Win32, when 'shell' contains "sh"
7446 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 for Unix, when using system(): "\"")
7448 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 Quoting character(s), put around the command passed to the shell, for
7450 the "!" and ":!" commands. Includes the redirection. See
7451 'shellquote' to exclude the redirection. It's probably not useful
7452 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007453 When the value is '(' then ')' is appended. When the value is '"('
7454 then ')"' is appended.
7455 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007456 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007457 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7458 pwsh.exe which automatically strips off the first and last quote on a
7459 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7460 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007461 'shell', to reduce the need to set this option by the user. See
7462 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 This option cannot be set from a |modeline| or in the |sandbox|, for
7464 security reasons.
7465
7466 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7467'shiftround' 'sr' boolean (default off)
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 Round indent to multiple of 'shiftwidth'. Applies to > and <
7470 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7471 a multiple of 'shiftwidth' (this is Vi compatible).
7472 NOTE: This option is reset when 'compatible' is set.
7473
7474 *'shiftwidth'* *'sw'*
7475'shiftwidth' 'sw' number (default 8)
7476 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007477 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007479 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007480 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481
7482 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007483'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7484 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007485 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007487 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 It is a list of flags:
7489 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007490 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7491 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7492 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7493 m use "[+]" instead of "[Modified]" *shm-m*
7494 n use "[New]" instead of "[New File]" *shm-n*
7495 r use "[RO]" instead of "[readonly]" *shm-r*
7496 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007498 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7499 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007500 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007501 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007503 o overwrite message for writing a file with subsequent *shm-o*
7504 message for reading a file (useful for ":wn" or when
7505 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007506 O message for reading a file overwrites any previous *shm-O*
7507 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007508 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7509 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007510 the search count do not show "W" before the count message
7511 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007512 t truncate file message at the start if it is too long *shm-t*
7513 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007514 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007515 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007516 long to fit on the command line; "..." will appear in the
7517 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007518 W don't give "written" or "[w]" when writing a file *shm-W*
7519 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007520 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007521 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007522 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007523 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007524 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7525 match", "Pattern not found", "Back at original", etc.
7526 C don't give messages while scanning for ins-completion *shm-C*
7527 items, for instance "scanning tags"
7528 q use "recording" instead of "recording @a" *shm-q*
7529 F don't give the file info when editing a file, like *shm-F*
7530 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007531 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007532 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007533 "[1/5]". When the "S" flag is not present (e.g. search count
7534 is shown), the "search hit BOTTOM, continuing at TOP" and
7535 "search hit TOP, continuing at BOTTOM" messages are only
7536 indicated by a "W" (Mnemonic: Wrapped) letter before the
7537 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
7539 This gives you the opportunity to avoid that a change between buffers
7540 requires you to hit <Enter>, but still gives as useful a message as
7541 possible for the space available. To get the whole message that you
7542 would have got with 'shm' empty, use ":file!"
7543 Useful values:
7544 shm= No abbreviation of message.
7545 shm=a Abbreviation, but no loss of information.
7546 shm=at Abbreviation, and truncate message when necessary.
7547
7548 NOTE: This option is set to the Vi default value when 'compatible' is
7549 set and to the Vim default value when 'compatible' is reset.
7550
7551 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7552'shortname' 'sn' boolean (default off)
7553 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 Filenames are assumed to be 8 characters plus one extension of 3
7555 characters. Multiple dots in file names are not allowed. When this
7556 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007557 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007559 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560
7561 *'showbreak'* *'sbr'* *E595*
7562'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007563 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007564 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 feature}
7566 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007567 values are "> " or "+++ ": >
7568 :set showbreak=>\
7569< Note the backslash to escape the trailing space. It's easier like
7570 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007571 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007572< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 comma (in a future version the comma might be used to separate the
7574 part that is shown at the end and at the start of a line).
7575 The characters are highlighted according to the '@' flag in
7576 'highlight'.
7577 Note that tabs after the showbreak will be displayed differently.
7578 If you want the 'showbreak' to appear in between line numbers, add the
7579 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007580 A window-local value overrules a global value. If the global value is
7581 set and you want no value in the current window use NONE: >
7582 :setlocal showbreak=NONE
7583<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007585'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7586 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007588 Show (partial) command in the last line of the screen. Set this
7589 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 In Visual mode the size of the selected area is shown:
7591 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007592 If the number of bytes is different it is also displayed: "2-6"
7593 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007595 - When selecting a block, the size in screen characters:
7596 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007597 This information can be displayed in an alternative location using the
7598 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 NOTE: This option is set to the Vi default value when 'compatible' is
7600 set and to the Vim default value when 'compatible' is reset.
7601
Luuk van Baalba936f62022-12-15 13:15:39 +00007602 *'showcmdloc'* *'sloc'*
7603'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007604 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007605 This option can be used to display the (partially) entered command in
7606 another location. Possible values are:
7607 last Last line of the screen (default).
7608 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007609 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007610 Setting this option to "statusline" or "tabline" means that these will
7611 be redrawn whenever the command changes, which can be on every key
7612 pressed.
7613 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7614 place the text. Without a custom 'statusline' or 'tabline' it will be
7615 displayed in a convenient location.
7616
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7618'showfulltag' 'sft' boolean (default off)
7619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 When completing a word in insert mode (see |ins-completion|) from the
7621 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007622 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 matched a C function, you can see a template for what arguments are
7624 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007625 Note that this doesn't work well together with having "longest" in
7626 'completeopt', because the completion from the search pattern may not
7627 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628
7629 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7630'showmatch' 'sm' boolean (default off)
7631 global
7632 When a bracket is inserted, briefly jump to the matching one. The
7633 jump is only done if the match can be seen on the screen. The time to
7634 show the match can be set with 'matchtime'.
7635 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007636 seen or not).
7637 This option is reset when 'paste' is set and restored when 'paste' is
7638 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 When the 'm' flag is not included in 'cpoptions', typing a character
7640 will immediately move the cursor back to where it belongs.
7641 See the "sm" field in 'guicursor' for setting the cursor shape and
7642 blinking when showing the match.
7643 The 'matchpairs' option can be used to specify the characters to show
7644 matches for. 'rightleft' and 'revins' are used to look for opposite
7645 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007646 Also see the matchparen plugin for highlighting the match when moving
7647 around |pi_paren.txt|.
7648 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649
7650 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7651'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7652 global
7653 If in Insert, Replace or Visual mode put a message on the last line.
7654 Use the 'M' flag in 'highlight' to set the type of highlighting for
7655 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007656 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 doesn't mean XIM is really active, especially when 'imactivatekey' is
7658 not set.
7659 NOTE: This option is set to the Vi default value when 'compatible' is
7660 set and to the Vim default value when 'compatible' is reset.
7661
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007662 *'showtabline'* *'stal'*
7663'showtabline' 'stal' number (default 1)
7664 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007665 The value of this option specifies when the line with tab page labels
7666 will be displayed:
7667 0: never
7668 1: only if there are at least two tab pages
7669 2: always
7670 This is both for the GUI and non-GUI implementation of the tab pages
7671 line.
7672 See |tab-page| for more information about tab pages.
7673
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 *'sidescroll'* *'ss'*
7675'sidescroll' 'ss' number (default 0)
7676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 The minimal number of columns to scroll horizontally. Used only when
7678 the 'wrap' option is off and the cursor is moved off of the screen.
7679 When it is zero the cursor will be put in the middle of the screen.
7680 When using a slow terminal set it to a large number or 0. When using
7681 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7682 commands.
7683
7684 *'sidescrolloff'* *'siso'*
7685'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007686 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007688 right of the cursor if 'nowrap' is set. Setting this option to a
7689 value greater than 0 while having |'sidescroll'| also at a non-zero
7690 value makes some context visible in the line you are scrolling in
7691 horizontally (except at beginning of the line). Setting this option
7692 to a large value (like 999) has the effect of keeping the cursor
7693 horizontally centered in the window, as long as one does not come too
7694 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007695 After using the local value, go back the global value with one of
7696 these two: >
7697 setlocal sidescrolloff<
7698 setlocal sidescrolloff=-1
7699< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700
7701 Example: Try this together with 'sidescroll' and 'listchars' as
7702 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007703 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704
7705 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7706 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007707<
7708 *'signcolumn'* *'scl'*
7709'signcolumn' 'scl' string (default "auto")
7710 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007711 {not available when compiled without the |+signs|
7712 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007713 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007714 "auto" only when there is a sign to display
7715 "no" never
7716 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007717 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007718 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7721'smartcase' 'scs' boolean (default off)
7722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 Override the 'ignorecase' option if the search pattern contains upper
7724 case characters. Only used when the search pattern is typed and
7725 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007726 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7728 recalling the search pattern from history and hitting <Enter>.
7729 NOTE: This option is reset when 'compatible' is set.
7730
7731 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7732'smartindent' 'si' boolean (default off)
7733 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 Do smart autoindenting when starting a new line. Works for C-like
7735 programs, but can also be used for other languages. 'cindent' does
7736 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007737 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007738 setting 'si' has no effect. 'indentexpr' is a more advanced
7739 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 Normally 'autoindent' should also be on when using 'smartindent'.
7741 An indent is automatically inserted:
7742 - After a line ending in '{'.
7743 - After a line starting with a keyword from 'cinwords'.
7744 - Before a line starting with '}' (only with the "O" command).
7745 When typing '}' as the first character in a new line, that line is
7746 given the same indent as the matching '{'.
7747 When typing '#' as the first character in a new line, the indent for
7748 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007749 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7751 When using the ">>" command, lines starting with '#' are not shifted
7752 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007753 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007754 This option is reset when 'paste' is set and restored when 'paste' is
7755 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756
7757 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7758'smarttab' 'sta' boolean (default off)
7759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007761 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7762 <BS> will delete a 'shiftwidth' worth of space at the start of the
7763 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007764 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007765 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7766 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007767 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007769 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007770 This option is reset when 'paste' is set and restored when 'paste' is
7771 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 NOTE: This option is reset when 'compatible' is set.
7773
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007774 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7775'smoothscroll' 'sms' boolean (default off)
7776 local to window
7777 Scrolling works with screen lines. When 'wrap' is set and the first
7778 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007779 above the window. "<<<" is displayed at the start of the first line,
7780 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007781 You may also want to add "lastline" to the 'display' option to show as
7782 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007783 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007784
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 *'softtabstop'* *'sts'*
7786'softtabstop' 'sts' number (default 0)
7787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 Number of spaces that a <Tab> counts for while performing editing
7789 operations, like inserting a <Tab> or using <BS>. It "feels" like
7790 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7791 used. This is useful to keep the 'ts' setting at its standard value
7792 of 8, while being able to edit like it is set to 'sts'. However,
7793 commands like "x" still work on the actual characters.
7794 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007795 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007796 'softtabstop' is set to 0 when the 'paste' option is set and restored
7797 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7799 spaces is minimized by using <Tab>s.
7800 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7801 set.
7802 NOTE: This option is set to 0 when 'compatible' is set.
7803
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007804 If Vim is compiled with the |+vartabs| feature then the value of
7805 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7806 anything other than an empty string.
7807
Bram Moolenaar217ad922005-03-20 22:37:15 +00007808 *'spell'* *'nospell'*
7809'spell' boolean (default off)
7810 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007811 {not available when compiled without the |+syntax|
7812 feature}
7813 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007814 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007815
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007816 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007817'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007818 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007819 {not available when compiled without the |+syntax|
7820 feature}
7821 Pattern to locate the end of a sentence. The following word will be
7822 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007823 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007824 When this check is not wanted make this option empty.
7825 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007826 Be careful with special characters, see |option-backslash| about
7827 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007828 To set this option automatically depending on the language, see
7829 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007830
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007831 *'spellfile'* *'spf'*
7832'spellfile' 'spf' string (default empty)
7833 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007834 {not available when compiled without the |+syntax|
7835 feature}
7836 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007837 commands. It must end in ".{encoding}.add". You need to include the
7838 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007839 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007840 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007841 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007842 |zg| and |zw| commands can be used to access each. This allows using
7843 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007844 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007845 you: Using the first directory in 'runtimepath' that is writable. If
7846 there is no "spell" directory yet it will be created. For the file
7847 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007848 ignoring the region.
7849 The resulting ".spl" file will be used for spell checking, it does not
7850 have to appear in 'spelllang'.
7851 Normally one file is used for all regions, but you can add the region
7852 name if you want to. However, it will then only be used when
7853 'spellfile' is set to it, for entries in 'spelllang' only files
7854 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007855 This option cannot be set from a |modeline| or in the |sandbox|, for
7856 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007857
Bram Moolenaar217ad922005-03-20 22:37:15 +00007858 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007859'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007860 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007861 {not available when compiled without the |+syntax|
7862 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007863 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007864 on spellchecking will be done for these languages. Example: >
7865 set spelllang=en_us,nl,medical
7866< This means US English, Dutch and medical words are recognized. Words
7867 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007868 The word list name must consist of alphanumeric characters, a dash or
7869 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007870 recommended to separate the two letter language name from a
7871 specification. Thus "en-rare" is used for rare English words.
7872 A region name must come last and have the form "_xx", where "xx" is
7873 the two-letter, lower case region name. You can use more than one
7874 region by listing them: "en_us,en_ca" supports both US and Canadian
7875 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007876 Britain. (Note: currently en_au and en_nz dictionaries are older than
7877 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007878 If the name "cjk" is included East Asian characters are excluded from
7879 spell checking. This is useful when editing text that also has Asian
7880 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007881 Note that the "medical" dictionary does not exist, it is just an
7882 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007883 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007884 As a special case the name of a .spl file can be given as-is. The
7885 first "_xx" in the name is removed and used as the region name
7886 (_xx is an underscore, two letters and followed by a non-letter).
7887 This is mainly for testing purposes. You must make sure the correct
7888 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007889 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007890 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7891 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007892 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007893
Bram Moolenaar98692072006-02-04 00:57:42 +00007894 If the |spellfile.vim| plugin is active and you use a language name
7895 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7896 will ask you if you want to download the file.
7897
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007898 After this option has been set successfully, Vim will source the files
7899 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007900 up to the first character that is not an ASCII letter or number and
7901 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007902
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007903 *'spelloptions'* *'spo'*
7904'spelloptions' 'spo' string (default "")
7905 local to buffer
7906 {not available when compiled without the |+syntax|
7907 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007908 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007909 camel When a word is CamelCased, assume "Cased" is a
7910 separate word: every upper-case character in a word
7911 that comes after a lower case character indicates the
7912 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007913
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007914 *'spellsuggest'* *'sps'*
7915'spellsuggest' 'sps' string (default "best")
7916 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007917 {not available when compiled without the |+syntax|
7918 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007919 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007920 the |spellsuggest()| function. This is a comma-separated list of
7921 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007922
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007923 best Internal method that works best for English. Finds
7924 changes like "fast" and uses a bit of sound-a-like
7925 scoring to improve the ordering.
7926
7927 double Internal method that uses two methods and mixes the
7928 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007929 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007930 word. That only works when the language specifies
7931 sound folding. Can be slow and doesn't always give
7932 better results.
7933
7934 fast Internal method that only checks for simple changes:
7935 character inserts/deletes/swaps. Works well for
7936 simple typing mistakes.
7937
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007938 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007939 Not used for |spellsuggest()|. The number of
7940 suggestions is never more than the value of 'lines'
7941 minus two.
7942
Bram Moolenaar585ee072022-01-29 11:22:17 +00007943 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007944 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007945 methods. When omitted the limit is 5000. When
7946 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007947 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007948
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007949 file:{filename} Read file {filename}, which must have two columns,
7950 separated by a slash. The first column contains the
7951 bad word, the second column the suggested good word.
7952 Example:
7953 theribal/terrible ~
7954 Use this for common mistakes that do not appear at the
7955 top of the suggestion list with the internal methods.
7956 Lines without a slash are ignored, use this for
7957 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007958 The word in the second column must be correct,
7959 otherwise it will not be used. Add the word to an
7960 ".add" file if it is currently flagged as a spelling
7961 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007962 The file is used for all languages.
7963
7964 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007965 trouble with spaces. Best is to call a function
7966 without arguments, see |expr-option-function|.
7967 |v:val| holds the badly spelled word. The expression
7968 must evaluate to a List of Lists, each with a
7969 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007970 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007971 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007972 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007973 internal methods use. A lower score is better.
7974 This may invoke |spellsuggest()| if you temporarily
7975 set 'spellsuggest' to exclude the "expr:" part.
7976 Errors are silently ignored, unless you set the
7977 'verbose' option to a non-zero value.
7978
7979 Only one of "best", "double" or "fast" may be used. The others may
7980 appear several times in any order. Example: >
7981 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7982<
7983 This option cannot be set from a |modeline| or in the |sandbox|, for
7984 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007985
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7987'splitbelow' 'sb' boolean (default off)
7988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 When on, splitting a window will put the new window below the current
7990 one. |:split|
7991
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007992 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007993'splitkeep' 'spk' string (default "cursor")
7994 global
7995 The value of this option determines the scroll behavior when opening,
7996 closing or resizing horizontal splits.
7997
7998 Possible values are:
7999 cursor Keep the same relative cursor position.
8000 screen Keep the text on the same screen line.
8001 topline Keep the topline the same.
8002
8003 For the "screen" and "topline" values, the cursor position will be
8004 changed when necessary. In this case, the jumplist will be populated
8005 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008006 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008007
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
8009'splitright' 'spr' boolean (default off)
8010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 When on, splitting a window will put the new window right of the
8012 current one. |:vsplit|
8013
8014 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8015'startofline' 'sol' boolean (default on)
8016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008018 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008019 (if possible). This applies to the commands:
8020 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008021 - "d", "<<", "==" and ">>" with a linewise operator
8022 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008023 - "%" with a count
8024 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8025 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 In case of buffer changing commands the cursor is placed at the column
8027 where it was the last time the buffer was edited.
8028 NOTE: This option is set when 'compatible' is set.
8029
Bram Moolenaar00654022011-02-25 14:42:19 +01008030 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008032 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 {not available when compiled without the |+statusline|
8034 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008035 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 Also see |status-line|.
8037
8038 The option consists of printf style '%' items interspersed with
8039 normal text. Each status line item is of the form:
8040 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008041 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008042 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008044 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008045 When the option starts with "%!" then it is used as an expression,
8046 evaluated and the result is used as the option value. Example: >
8047 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008048< The *g:statusline_winid* variable will be set to the |window-ID| of the
8049 window that the status line belongs to.
8050 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008051 Note that the "%!" expression is evaluated in the context of the
8052 current window and buffer, while %{} items are evaluated in the
8053 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008054
8055 When there is error while evaluating the option then it will be made
8056 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008057 When the result contains unprintable characters the result is
8058 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008059
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 Note that the only effect of 'ruler' when this option is set (and
8061 'laststatus' is 2) is controlling the output of |CTRL-G|.
8062
8063 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008064 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008066 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 minwid Minimum width of the item, padding as set by '-' & '0'.
8068 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008069 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 on the left for text items. Numeric items will be
8071 shifted down to maxwid-2 digits followed by '>'number
8072 where number is the amount of missing digits, much like
8073 an exponential notation.
8074 item A one letter code as described below.
8075
8076 Following is a description of the possible statusline items. The
8077 second character in "item" is the type:
8078 N for number
8079 S for string
8080 F for flags as described below
8081 - not applicable
8082
8083 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008084 f S Path to the file in the buffer, as typed or relative to current
8085 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 F S Full path to the file in the buffer.
8087 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008088 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008090 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008092 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008094 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008096 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008098 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8100 being used: "<keymap>"
8101 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008102 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 B N As above, in hexadecimal.
8104 o N Byte number in file of byte under cursor, first byte is 1.
8105 Mnemonic: Offset from start of file (with one added)
8106 {not available when compiled without |+byte_offset| feature}
8107 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008108 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 l N Line number.
8110 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008111 c N Column number (byte index).
8112 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008113 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 p N Percentage through file in lines as in |CTRL-G|.
8115 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008116 percentage described for 'ruler'. Always 3 in length, unless
8117 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008118 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008119 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008121 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008122 Note that there is no '%' before the closing '}'. The
8123 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008124 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008125 {% - This is almost same as { except the result of the expression is
8126 re-evaluated as a statusline format string. Thus if the
8127 return value of expr contains % items they will get expanded.
8128 The expression can contain the } character, the end of
8129 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008130 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008131 func! Stl_filename() abort
8132 return "%t"
8133 endfunc
8134< `stl=%{Stl_filename()}` results in `"%t"`
8135 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008136 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 ( - Start of item group. Can be used for setting the width and
8138 alignment of a section. Must be followed by %) somewhere.
8139 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008140 T N For 'tabline': start of tab page N label. Use %T after the last
8141 label. This information is used for mouse clicks.
8142 X N For 'tabline': start of close tab N label. Use %X after the
8143 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8144 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 < - Where to truncate line if too long. Default is at the start.
8146 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008147 = - Separation point between alignment sections. Each section will
8148 be separated by an equal number of spaces. With one %= what
8149 comes after it will be right-aligned. With two %= there is a
8150 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008152 # - Set highlight group. The name must follow and then a # again.
8153 Thus use %#HLname# for highlight group HLname. The same
8154 highlighting is used, also for the statusline of non-current
8155 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008157 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008158 The difference between User{N} and StatusLine will be applied to
8159 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 The number N must be between 1 and 9. See |hl-User1..9|
8161
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008162 When displaying a flag, Vim removes the leading comma, if any, when
8163 that flag comes right after plaintext. This will make a nice display
8164 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165
Bram Moolenaar582fd852005-03-28 20:58:01 +00008166 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 not set) and a minwid is not set for the group, the whole group will
8168 become empty. This will make a group like the following disappear
8169 completely from the statusline when none of the flags are set. >
8170 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008171< Beware that an expression is evaluated each and every time the status
8172 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008173 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008174 While evaluating %{} the current buffer and current window will be set
8175 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008176 currently being drawn. The expression will evaluate in this context.
8177 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8178 real current buffer and "g:actual_curwin" to the |window-ID| of the
8179 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008180
Bram Moolenaar30b65812012-07-12 22:01:11 +02008181 The 'statusline' option will be evaluated in the |sandbox| if set from
8182 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008183 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008184
8185 It is not allowed to change text or jump to another window while
8186 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187
8188 If the statusline is not updated when you want it (e.g., after setting
8189 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008190 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008192 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 Otherwise the result is taken as flag text and applied to the rules
8194 described above.
8195
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008196 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008198 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199
8200 Examples:
8201 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008202 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203< Similar, but add ASCII value of char under the cursor (like "ga") >
8204 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8205< Display byte count and byte value, modified flag in red. >
8206 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8207 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8208< Display a ,GZ flag if a compressed file is loaded >
8209 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8210< In the |:autocmd|'s: >
8211 :let b:gzflag = 1
8212< And: >
8213 :unlet b:gzflag
8214< And define this function: >
8215 :function VarExists(var, val)
8216 : if exists(a:var) | return a:val | else | return '' | endif
8217 :endfunction
8218<
8219 *'suffixes'* *'su'*
8220'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8221 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 Files with these suffixes get a lower priority when multiple files
8223 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008224 suffixes. Spaces after the comma are ignored. A dot is also seen as
8225 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 separator, precede it with a backslash (see |option-backslash| about
8227 including spaces and backslashes).
8228 See 'wildignore' for completely ignoring files.
8229 The use of |:set+=| and |:set-=| is preferred when adding or removing
8230 suffixes from the list. This avoids problems when a future version
8231 uses another default.
8232
8233 *'suffixesadd'* *'sua'*
8234'suffixesadd' 'sua' string (default "")
8235 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008236 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237 file for the "gf", "[I", etc. commands. Example: >
8238 :set suffixesadd=.java
8239<
8240 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8241'swapfile' 'swf' boolean (default on)
8242 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008243 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 swapfile is not wanted for a specific buffer. For example, with
8245 confidential information that even root must not be able to access.
8246 Careful: All text will be in memory:
8247 - Don't use this for big files.
8248 - Recovery will be impossible!
8249 A swapfile will only be present when |'updatecount'| is non-zero and
8250 'swapfile' is set.
8251 When 'swapfile' is reset, the swap file for the current buffer is
8252 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8253 non-zero, a swap file is immediately created.
8254 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008255 If you want to open a new buffer without creating a swap file for it,
8256 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008257 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258
8259 This option is used together with 'bufhidden' and 'buftype' to
8260 specify special kinds of buffers. See |special-buffers|.
8261
8262 *'swapsync'* *'sws'*
8263'swapsync' 'sws' string (default "fsync")
8264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008266 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267 When this option is empty parts of the swap file may be in memory and
8268 not written to disk. When the system crashes you may lose more work.
8269 On Unix the system does a sync now and then without Vim asking for it,
8270 so the disadvantage of setting this option off is small. On some
8271 systems the swap file will not be written at all. For a unix system
8272 setting it to "sync" will use the sync() call instead of the default
8273 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008274 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275
8276 *'switchbuf'* *'swb'*
8277'switchbuf' 'swb' string (default "")
8278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008280 This option is checked, when
8281 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008282 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008283 - jumping to a tag using the |:stag| command.
8284 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8285 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8286 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008287 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008288 useopen If included, jump to the first open window in the
8289 current tab page that contains the specified buffer
8290 (if there is one). Otherwise: Do not examine other
8291 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008292 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008293 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008295 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008296 Otherwise: do not split, use current window (when used
8297 in the quickfix window: the previously used window or
8298 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008299 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008300 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008301 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008302 uselast If included, jump to the previously used window when
8303 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008304 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8305 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008307 *'synmaxcol'* *'smc'*
8308'synmaxcol' 'smc' number (default 3000)
8309 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008310 {not available when compiled without the |+syntax|
8311 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008312 Maximum column in which to search for syntax items. In long lines the
8313 text after this column is not highlighted and following lines may not
8314 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008315 This helps to avoid very slow redrawing for an XML file that is one
8316 long line.
8317 Set to zero to remove the limit.
8318
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 *'syntax'* *'syn'*
8320'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008321 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 {not available when compiled without the |+syntax|
8323 feature}
8324 When this option is set, the syntax with this name is loaded, unless
8325 syntax highlighting has been switched off with ":syntax off".
8326 Otherwise this option does not always reflect the current syntax (the
8327 b:current_syntax variable does).
8328 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008329 not automatically recognized. Example, in an IDL file:
8330 /* vim: set syntax=idl : */ ~
8331 When a dot appears in the value then this separates two filetype
8332 names. Example:
8333 /* vim: set syntax=c.doxygen : */ ~
8334 This will use the "c" syntax first, then the "doxygen" syntax.
8335 Note that the second one must be prepared to be loaded as an addition,
8336 otherwise it will be skipped. More than one dot may appear.
8337 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 :set syntax=OFF
8339< To switch syntax highlighting on according to the current value of the
8340 'filetype' option: >
8341 :set syntax=ON
8342< What actually happens when setting the 'syntax' option is that the
8343 Syntax autocommand event is triggered with the value as argument.
8344 This option is not copied to another buffer, independent of the 's' or
8345 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008346 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347
LemonBoy5247b0b2024-07-12 19:30:58 +02008348 *'tabclose'* *'tcl'*
8349'tabclose' 'tcl' string (default "")
8350 global
8351 This option controls the behavior when closing tab pages (e.g., using
8352 |:tabclose|). When empty Vim goes to the next (right) tab page.
8353
8354 Possible values (comma-separated list):
8355 left If included, go to the previous tab page instead of
8356 the next one.
8357 uselast If included, go to the previously used tab page if
8358 possible. This option takes precedence over the
8359 others.
8360
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008361 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008362'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008363 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008364 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008365 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008366 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008367
8368 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008369 option and only when there is no GUI tab line. When 'e' is in
8370 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008371 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008372
8373 The value is evaluated like with 'statusline'. You can use
8374 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008375 the text to be displayed. Use "%1T" for the first label, "%2T" for
8376 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008377
Bram Moolenaare12bab32019-01-08 22:02:56 +01008378 When changing something that is used in 'tabline' that does not
8379 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008380 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008381
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008382 Keep in mind that only one of the tab pages is the current one, others
8383 are invisible and you can't jump to their windows.
8384
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008385 *'tabpagemax'* *'tpm'*
8386'tabpagemax' 'tpm' number (default 10)
8387 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008388 Maximum number of tab pages to be opened by the |-p| command line
8389 argument or the ":tab all" command. |tabpage|
8390
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008391 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392'tabstop' 'ts' number (default 8)
8393 local to buffer
8394 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008395 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396
8397 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008398 appear wrong in many places, e.g., when printing it.
8399 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008401 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8403 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008404 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008406 This is the recommended way, the file will look the same with other
8407 tools and when listing it in a terminal.
8408 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8409 'expandtab'. This way you will always insert spaces. The
8410 formatting will never be messed up when 'tabstop' is changed (leave
8411 it at 8 just in case). The file will be a bit larger.
8412 You do need to check if no Tabs exist in the file. You can get rid
8413 of them by first setting 'expandtab' and using `%retab!`, making
8414 sure the value of 'tabstop' is set correctly.
8415 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 'expandtab'. This way you will always insert spaces. The
8417 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008418 You do need to check if no Tabs exist in the file, just like in the
8419 item just above.
8420 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008421 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008422 works when using Vim to edit the file, other tools assume a tabstop
8423 is worth 8 spaces.
8424 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 'noexpandtab'. This should then work (for initial indents only)
8426 for any tabstop setting that people use. It might be nice to have
8427 tabs after the first non-blank inserted as spaces if you do this
8428 though. Otherwise aligned comments will be wrong when 'tabstop' is
8429 changed.
8430
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008431 If Vim is compiled with the |+vartabs| feature then the value of
8432 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8433 than an empty string.
8434
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8436'tagbsearch' 'tbs' boolean (default on)
8437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008439 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 searching makes searching for a tag a LOT faster, but a linear search
8441 will find more tags if the tags file wasn't properly sorted.
8442 Vim normally assumes that your tags files are sorted, or indicate that
8443 they are not sorted. Only when this is not the case does the
8444 'tagbsearch' option need to be switched off.
8445
8446 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008447 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 certain files, or retry all files with a linear search. When
8449 'tagbsearch' is off, only a linear search is done.
8450
8451 Linear searching is done anyway, for one file, when Vim finds a line
8452 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008453 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454< [The whitespace before and after the '0' must be a single <Tab>]
8455
8456 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008457 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 instead of a normal tag name, a retry is done with a linear search.
8459 Tags in unsorted tags files, and matches with different case will only
8460 be found in the retry.
8461
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008462 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008463 linear search can be avoided when case is ignored. Use a value of '2'
8464 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8465 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008466 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8467 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8468 used for this as well. Note that case must be folded to uppercase for
8469 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008470
8471 By default, tag searches are case-sensitive. Case is ignored when
8472 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8473 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008474 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8475 'tagcase' is "smart", and the pattern contains only lowercase
8476 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477
8478 When 'tagbsearch' is off, tags searching is slower when a full match
8479 exists, but faster when no full match exists. Tags in unsorted tags
8480 files may only be found with 'tagbsearch' off.
8481 When the tags file is not sorted, or sorted in a wrong way (not on
8482 ASCII byte value), 'tagbsearch' should be off, or the line given above
8483 must be included in the tags file.
8484 This option doesn't affect commands that find all matching tags (e.g.,
8485 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008487 *'tagcase'* *'tc'*
8488'tagcase' 'tc' string (default "followic")
8489 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008490 This option specifies how case is handled when searching the tags
8491 file:
8492 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008493 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008494 ignore Ignore case
8495 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008496 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008497 NOTE: This option is set to the Vi default value when 'compatible' is
8498 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008499
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008500 *'tagfunc'* *'tfu'*
8501'tagfunc' 'tfu' string (default: empty)
8502 local to buffer
8503 {not available when compiled without the |+eval|
8504 feature}
8505 This option specifies a function to be used to perform tag searches.
8506 The function gets the tag pattern and should return a List of matching
8507 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008508 function and an example. The value can be the name of a function, a
8509 |lambda| or a |Funcref|. See |option-value-function| for more
8510 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008511 This option cannot be set from a |modeline| or in the |sandbox|, for
8512 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008513
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 *'taglength'* *'tl'*
8515'taglength' 'tl' number (default 0)
8516 global
8517 If non-zero, tags are significant up to this number of characters.
8518
8519 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8520'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8521 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008522 If on and using a tags file in another directory, file names in that
8523 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 NOTE: This option is set to the Vi default value when 'compatible' is
8525 set and to the Vim default value when 'compatible' is reset.
8526
8527 *'tags'* *'tag'* *E433*
8528'tags' 'tag' string (default "./tags,tags", when compiled with
8529 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8530 global or local to buffer |global-local|
8531 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008532 include a space or comma in a file name, precede it with backslashes
8533 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 When a file name starts with "./", the '.' is replaced with the path
8535 of the current file. But only when the 'd' flag is not included in
8536 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8537 |tags-option|.
8538 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008539 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8540 find all files named "tags" below "/lib". The filename itself cannot
8541 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008542 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008543 The |tagfiles()| function can be used to get a list of the file names
8544 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8546 files are also supported. They are automatically recognized. The
8547 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8548 differences are ignored (MS-Windows). |emacs-tags|
8549 The use of |:set+=| and |:set-=| is preferred when adding or removing
8550 file names from the list. This avoids problems when a future version
8551 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552
8553 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8554'tagstack' 'tgst' boolean (default on)
8555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 When on, the |tagstack| is used normally. When off, a ":tag" or
8557 ":tselect" command with an argument will not push the tag onto the
8558 tagstack. A following ":tag" without an argument, a ":pop" command or
8559 any other command that uses the tagstack will use the unmodified
8560 tagstack, but does change the pointer to the active entry.
8561 Resetting this option is useful when using a ":tag" command in a
8562 mapping which should not change the tagstack.
8563
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008564 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008565'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008566 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008567 {only available when compiled with the |+tcl/dyn|
8568 feature}
8569 Specifies the name of the Tcl shared library. The default is
8570 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008571 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008572 This option cannot be set from a |modeline| or in the |sandbox|, for
8573 security reasons.
8574
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 *'term'* *E529* *E530* *E531*
8576'term' string (default is $TERM, if that fails:
8577 in the GUI: "builtin_gui"
8578 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008579 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 on Unix: "ansi"
8582 on VMS: "ansi"
8583 on Win 32: "win32")
8584 global
8585 Name of the terminal. Used for choosing the terminal control
8586 characters. Environment variables are expanded |:set_env|.
8587 For example: >
8588 :set term=$TERM
8589< See |termcap|.
8590
8591 *'termbidi'* *'tbidi'*
8592 *'notermbidi'* *'notbidi'*
8593'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 {only available when compiled with the |+arabic|
8596 feature}
8597 The terminal is in charge of Bi-directionality of text (as specified
8598 by Unicode). The terminal is also expected to do the required shaping
8599 that some languages (such as Arabic) require.
8600 Setting this option implies that 'rightleft' will not be set when
8601 'arabic' is set and the value of 'arabicshape' will be ignored.
8602 Note that setting 'termbidi' has the immediate effect that
8603 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8604 This option is reset when the GUI is started.
8605 For further details see |arabic.txt|.
8606
8607 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008608'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 Encoding used for the terminal. This specifies what character
8611 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008612 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008613 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008614 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008615 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8617 Any attempts to set a different value will be rejected, and an error
8618 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008619 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 because the Win32 system always passes Unicode characters.
8621 When empty, the same encoding is used as for the 'encoding' option.
8622 This is the normal value.
8623 Not all combinations for 'termencoding' and 'encoding' are valid. See
8624 |encoding-table|.
8625 The value for this option must be supported by internal conversions or
8626 iconv(). When this is not possible no conversion will be done and you
8627 will probably experience problems with non-ASCII characters.
8628 Example: You are working with the locale set to euc-jp (Japanese) and
8629 want to edit a UTF-8 file: >
8630 :let &termencoding = &encoding
8631 :set encoding=utf-8
8632< You need to do this when your system has no locale support for UTF-8.
8633
Bram Moolenaar938ae282023-02-20 20:44:55 +00008634 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008635'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8636 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008637 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008638 {not available when compiled without the
8639 |+termguicolors| feature}
8640 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008641 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008642
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008643 Requires a ISO-8613-3 compatible terminal. If setting this option
8644 does not work (produces a colorless UI) reading |xterm-true-color|
8645 might help.
8646
8647 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8648 is required. Use this check to find out: >
8649 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008650< This requires Vim to be built with the |+vtp| feature.
8651
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008652 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008653
8654 When using Vim with Windows Terminal, the background of Windows
8655 Terminal is normally filled with the Vim background color. Setting
8656 'termguicolors' and the guibg of the Normal highlight group to NONE
8657 will make the background transparent: >
8658 :hi Normal guibg=NONE
8659<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008660 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008661
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008662 *'termwinkey'* *'twk'*
8663'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008664 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008665 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008666 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008667 The key can be specified as a single character, a |key-notation| (e.g.
8668 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8669 :set twk=X
8670 :set twk=^I
8671 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008672< The string must be one key stroke but can be multiple bytes.
8673 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008674 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008675 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008676
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008677 *'termwinscroll'* *'twsl'*
8678'termwinscroll' 'twsl' number (default 10000)
8679 local to buffer
8680 {not available when compiled without the
8681 |+terminal| feature}
8682 Number of scrollback lines to keep. When going over this limit the
8683 first 10% of the scrollback lines are deleted. This is just to reduce
8684 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008685 Also used as a limit for text sent to the terminal in one write,
8686 multiplied by the number of columns times 3 (average number of bytes
8687 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008688
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008689 *'termwinsize'* *'tws'*
8690'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008691 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008692 Size used when opening the |terminal| window. Format:
8693 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008694 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008695 - When set with a "x" (e.g., "24x80") the terminal size is not
8696 adjusted to the window size. If the window is smaller only the
8697 top-left part is displayed.
8698 - When set with a "*" (e.g., "10*50") the terminal size follows the
8699 window size, but will not be smaller than the specified rows and/or
8700 columns.
8701 - When rows is zero then use the height of the window.
8702 - When columns is zero then use the width of the window.
8703 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008704 - Can be overruled in the |term_start()| options with "term_rows" and
8705 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008706
8707 Examples:
8708 "30x0" uses 30 rows and the current window width.
8709 "20*0" uses at least 20 rows and the current window width.
8710 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008711 Note that the command running in the terminal window may still change
8712 the size of the terminal. In that case the Vim window will be
8713 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008714
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008715 *'termwintype'* *'twt'*
8716'termwintype' 'twt' string (default "")
8717 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008718 {only available when compiled with the |terminal|
8719 feature on MS-Windows}
8720 Specify the virtual console (pty) used when opening the terminal
8721 window.
8722
8723 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008724 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008725 "winpty" use winpty, fail if not supported
8726 "conpty" use |ConPTY|, fail if not supported
8727
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008728 |ConPTY| support depends on the platform. Windows 10 October 2018
8729 Update is the first version that supports ConPTY, however it is still
8730 considered unstable. ConPTY might become stable in the next release
8731 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008732 supported then you cannot open a terminal window.
8733
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 *'terse'* *'noterse'*
8735'terse' boolean (default off)
8736 global
8737 When set: Add 's' flag to 'shortmess' option (this makes the message
8738 for a search that hits the start or end of the file not being
8739 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8740 shortens a lot of messages}
8741
8742 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8743'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 This option is obsolete. Use 'fileformats'.
8746 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8747 set to the default value for the current system. When 'textauto' is
8748 reset, 'fileformats' is made empty.
8749 NOTE: This option is set to the Vi default value when 'compatible' is
8750 set and to the Vim default value when 'compatible' is reset.
8751
8752 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008753'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 others: default off)
8755 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 This option is obsolete. Use 'fileformat'.
8757 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8758 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8759 "unix".
8760
8761 *'textwidth'* *'tw'*
8762'textwidth' 'tw' number (default 0)
8763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 Maximum width of text that is being inserted. A longer line will be
8765 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008766 this.
8767 'textwidth' is set to 0 when the 'paste' option is set and restored
8768 when 'paste' is reset.
8769 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008771 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 NOTE: This option is set to 0 when 'compatible' is set.
8773
8774 *'thesaurus'* *'tsr'*
8775'thesaurus' 'tsr' string (default "")
8776 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008778 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8779 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008780
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008781 This option is not used if 'thesaurusfunc' is set, either for the
8782 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008783
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008784 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008786 name. See |option-backslash| about using backslashes. The use of
8787 |:set+=| and |:set-=| is preferred when adding or removing directories
8788 from the list. This avoids problems when a future version uses
8789 another default. Backticks cannot be used in this option for security
8790 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008792 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008793'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008794 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008795 {not available when compiled without the |+eval|
8796 feature}
8797 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008798 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008799 The value can be the name of a function, a |lambda| or a |Funcref|.
8800 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008801
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008802 This option cannot be set from a |modeline| or in the |sandbox|, for
8803 security reasons.
8804
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8806'tildeop' 'top' boolean (default off)
8807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 When on: The tilde command "~" behaves like an operator.
8809 NOTE: This option is reset when 'compatible' is set.
8810
8811 *'timeout'* *'to'* *'notimeout'* *'noto'*
8812'timeout' 'to' boolean (default on)
8813 global
laburnumT3f7855a2023-12-05 18:37:03 +01008814
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008816'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 These two options together determine the behavior when part of a
8819 mapped key sequence or keyboard code has been received:
8820
8821 'timeout' 'ttimeout' action ~
8822 off off do not time out
8823 on on or off time out on :mappings and key codes
8824 off on time out on key codes
8825
8826 If both options are off, Vim will wait until either the complete
8827 mapping or key sequence has been received, or it is clear that there
8828 is no mapping or key sequence for the received characters. For
8829 example: if you have mapped "vl" and Vim has received 'v', the next
8830 character is needed to see if the 'v' is followed by an 'l'.
8831 When one of the options is on, Vim will wait for about 1 second for
8832 the next character to arrive. After that the already received
8833 characters are interpreted as single characters. The waiting time can
8834 be changed with the 'timeoutlen' option.
8835 On slow terminals or very busy systems timing out may cause
8836 malfunctioning cursor keys. If both options are off, Vim waits
8837 forever after an entered <Esc> if there are key codes that start
8838 with <Esc>. You will have to type <Esc> twice. If you do not have
8839 problems with key codes, but would like to have :mapped key
8840 sequences not timing out in 1 second, set the 'ttimeout' option and
8841 reset the 'timeout' option.
8842
8843 NOTE: 'ttimeout' is reset when 'compatible' is set.
8844
8845 *'timeoutlen'* *'tm'*
8846'timeoutlen' 'tm' number (default 1000)
8847 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008848
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008850'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 The time in milliseconds that is waited for a key code or mapped key
8853 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8854 when part of a command has been typed.
8855 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8856 different timeout value for key codes is desired set 'ttimeoutlen' to
8857 a non-negative number.
8858
8859 ttimeoutlen mapping delay key code delay ~
8860 < 0 'timeoutlen' 'timeoutlen'
8861 >= 0 'timeoutlen' 'ttimeoutlen'
8862
8863 The timeout only happens when the 'timeout' and 'ttimeout' options
8864 tell so. A useful setting would be >
8865 :set timeout timeoutlen=3000 ttimeoutlen=100
8866< (time out on mapping after three seconds, time out on key codes after
8867 a tenth of a second).
8868
8869 *'title'* *'notitle'*
8870'title' boolean (default off, on when title can be restored)
8871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 When on, the title of the window will be set to the value of
8873 'titlestring' (if it is not empty), or to:
8874 filename [+=-] (path) - VIM
8875 Where:
8876 filename the name of the file being edited
8877 - indicates the file cannot be modified, 'ma' off
8878 + indicates the file was modified
8879 = indicates the file is read-only
8880 =+ indicates the file is read-only and modified
8881 (path) is the path of the file being edited
8882 - VIM the server name |v:servername| or "VIM"
8883 Only works if the terminal supports setting window titles
8884 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008885 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8887 *X11*
8888 When Vim was compiled with HAVE_X11 defined, the original title will
8889 be restored if possible. The output of ":version" will include "+X11"
8890 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8891 works for the icon name |'icon'|.
8892 But: When Vim was started with the |-X| argument, restoring the title
8893 will not work (except in the GUI).
8894 If the title cannot be restored, it is set to the value of 'titleold'.
8895 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008896 When using an xterm from a remote machine you can use this command: >
8897
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008899 ssh -X machine_name xterm &
8900<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 then the WINDOWID environment variable should be inherited and the
8902 title of the window should change back to what it should be after
8903 exiting Vim.
8904
8905 *'titlelen'*
8906'titlelen' number (default 85)
8907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008909 title. When the title is longer, only the end of the path name is
8910 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 Using a percentage makes this adapt to the width of the window. But
8912 it won't work perfectly, because the actual number of characters
8913 available also depends on the font used and other things in the title
8914 bar. When 'titlelen' is zero the full path is used. Otherwise,
8915 values from 1 to 30000 percent can be used.
8916 'titlelen' is also used for the 'titlestring' option.
8917
8918 *'titleold'*
8919'titleold' string (default "Thanks for flying Vim")
8920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 This option will be used for the window title when exiting Vim if the
8922 original title cannot be restored. Only happens if 'title' is on or
8923 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008924 This option cannot be set from a |modeline| or in the |sandbox|, for
8925 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 *'titlestring'*
8927'titlestring' string (default "")
8928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 When this option is not empty, it will be used for the title of the
8930 window. This happens only when the 'title' option is on.
8931 Only works if the terminal supports setting window titles (currently
8932 Amiga console, Win32 console, all GUI versions and terminals with a
8933 non-empty 't_ts' option).
8934 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008935 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008936
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008938 expanded according to the rules used for 'statusline'. If it contains
8939 an invalid '%' format, the value is used as-is and no error or warning
8940 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008941 This option cannot be set in a modeline when 'modelineexpr' is off.
8942
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008944 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8946< The value of 'titlelen' is used to align items in the middle or right
8947 of the available space.
8948 Some people prefer to have the file name first: >
8949 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8950< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008951 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 separating space only when needed.
8953 NOTE: Use of special characters in 'titlestring' may cause the display
8954 to be garbled (e.g., when it contains a CR or NL character).
8955 {not available when compiled without the |+statusline| feature}
8956
8957 *'toolbar'* *'tb'*
8958'toolbar' 'tb' string (default "icons,tooltips")
8959 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008960 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008961 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 possible values are:
8963 icons Toolbar buttons are shown with icons.
8964 text Toolbar buttons shown with text.
8965 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008966 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 tooltips Tooltips are active for toolbar buttons.
8968 Tooltips refer to the popup help text which appears after the mouse
8969 cursor is placed over a toolbar button for a brief moment.
8970
8971 If you want the toolbar to be shown with icons as well as text, do the
8972 following: >
8973 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008974< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 will show icons if both are requested.
8976
8977 If none of the strings specified in 'toolbar' are valid or if
8978 'toolbar' is empty, this option is ignored. If you want to disable
8979 the toolbar, you need to set the 'guioptions' option. For example: >
8980 :set guioptions-=T
8981< Also see |gui-toolbar|.
8982
8983 *'toolbariconsize'* *'tbis'*
8984'toolbariconsize' 'tbis' string (default "small")
8985 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008986 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008988 tiny Use tiny icons.
8989 small Use small icons (default).
8990 medium Use medium-sized icons.
8991 large Use large icons.
8992 huge Use even larger icons.
8993 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008995 the current theme. Common dimensions are giant=48x48, huge=32x32,
8996 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008997
8998 If 'toolbariconsize' is empty, the global default size as determined
8999 by user preferences or the current theme is used.
9000
9001 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
9002'ttybuiltin' 'tbi' boolean (default on)
9003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 When on, the builtin termcaps are searched before the external ones.
9005 When off the builtin termcaps are searched after the external ones.
9006 When this option is changed, you should set the 'term' option next for
9007 the change to take effect, for example: >
9008 :set notbi term=$TERM
9009< See also |termcap|.
9010 Rationale: The default for this option is "on", because the builtin
9011 termcap entries are generally better (many systems contain faulty
9012 xterm entries...).
9013
9014 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009015'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 Indicates a fast terminal connection. More characters will be sent to
9018 the screen for redrawing, instead of using insert/delete line
9019 commands. Improves smoothness of redrawing when there are multiple
9020 windows and the terminal does not support a scrolling region.
9021 Also enables the extra writing of characters at the end of each screen
9022 line for lines that wrap. This helps when using copy/paste with the
9023 mouse in an xterm and other terminals.
9024
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009025 The default used to be set only for some terminal names, but these
9026 days nearly all terminals are fast, therefore the default is now "on".
9027 If you have a slow connection you may want to set this option off,
9028 e.g. depending on the host name: >
9029 if hostname() =~ 'faraway'
9030 set nottyfast
9031 endif
9032<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 *'ttymouse'* *'ttym'*
9034'ttymouse' 'ttym' string (default depends on 'term')
9035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 {only in Unix and VMS, doesn't work in the GUI; not
9037 available when compiled without |+mouse|}
9038 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009039 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 *xterm-mouse*
9041 xterm xterm-like mouse handling. The mouse generates
9042 "<Esc>[Mscr", where "scr" is three bytes:
9043 "s" = button state
9044 "c" = column plus 33
9045 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009046 This only works up to 223 columns! See "dec",
9047 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 xterm2 Works like "xterm", but with the xterm reporting the
9049 mouse position while the mouse is dragged. This works
9050 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009051 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 work. See below for how Vim detects this
9053 automatically.
9054 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009055 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009057 for the row and column. No other mouse events are
9058 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 *dec-mouse*
9060 dec DEC terminal mouse handling. The mouse generates a
9061 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009062 This is also available for an Xterm, if it was
9063 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 *jsbterm-mouse*
9065 jsbterm JSB term mouse handling.
9066 *pterm-mouse*
9067 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009068 *urxvt-mouse*
9069 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009070 The mouse works only if the terminal supports this
9071 encoding style, but it does not have 223 columns limit
9072 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009073 *sgr-mouse*
9074 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009075 mouse reporting. The mouse works even in columns
9076 beyond 223. This option is backward compatible with
9077 "xterm2" because it can also decode "xterm2" style
9078 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079
9080 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009081 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9082 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9084 recognized, if enabled at compile time. DEC terminal mouse codes
9085 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009086 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9087 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009089 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9090 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9091 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009092 If the terminfo/termcap entry "XM" exists and the first number is
9093 "1006" then 'ttymouse' will be set to "sgr". This works for many
9094 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009095 Additionally, if vim is compiled with the |+termresponse| feature and
9096 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009097 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009099 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9100 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9101 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009102 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9103 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 :set t_RV=
9105<
9106 *'ttyscroll'* *'tsl'*
9107'ttyscroll' 'tsl' number (default 999)
9108 global
9109 Maximum number of lines to scroll the screen. If there are more lines
9110 to scroll the window is redrawn. For terminals where scrolling is
9111 very slow and redrawing is not slow this can be set to a small number,
9112 e.g., 3, to speed up displaying.
9113
9114 *'ttytype'* *'tty'*
9115'ttytype' 'tty' string (default from $TERM)
9116 global
9117 Alias for 'term', see above.
9118
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009119 *'undodir'* *'udir'*
9120'undodir' 'udir' string (default ".")
9121 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009122 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009123 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009124 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009125 "." means using the directory of the file. The undo file name for
9126 "file.txt" is ".file.txt.un~".
9127 For other directories the file name is the full path of the edited
9128 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009129 When writing: The first directory that exists is used. "." always
9130 works, no directories after "." will be used for writing.
9131 When reading all entries are tried to find an undo file. The first
9132 undo file that exists is used. When it cannot be read an error is
9133 given, no further entry is used.
9134 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009135 This option cannot be set from a |modeline| or in the |sandbox|, for
9136 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009137
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009138 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009139'undofile' 'udf' boolean (default off)
9140 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009141 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009142 When on, Vim automatically saves undo history to an undo file when
9143 writing a buffer to a file, and restores undo history from the same
9144 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009145 The directory where the undo file is stored is specified by 'undodir'.
9146 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009147 The undo file is not read when 'undoreload' causes the buffer from
9148 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009149 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009150 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009151
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009153'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009154 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009156 is kept in memory, higher numbers will cause more memory to be used.
9157 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9159 itself: >
9160 set ul=0
9161< But you can also get Vi compatibility by including the 'u' flag in
9162 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009163 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009164 Set to -1 for no undo at all. You might want to do this only for the
9165 current buffer: >
9166 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009168
9169 The local value is set to -123456 when the global value is to be used.
9170
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009171 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009173 *'undoreload'* *'ur'*
9174'undoreload' 'ur' number (default 10000)
9175 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009176 Save the whole buffer for undo when reloading it. This applies to the
9177 ":e!" command and reloading for when the buffer changed outside of
9178 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009179 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009180 of lines is smaller than the value of this option.
9181 Set this option to zero to disable undo for a reload.
9182
9183 When saving undo for a reload, any undo file is not read.
9184
9185 Note that this causes the whole buffer to be stored in memory. Set
9186 this option to a lower value if you run out of memory.
9187
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188 *'updatecount'* *'uc'*
9189'updatecount' 'uc' number (default: 200)
9190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191 After typing this many characters the swap file will be written to
9192 disk. When zero, no swap file will be created at all (see chapter on
9193 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9194 Vim with the "-n" option, see |startup|. When editing in readonly
9195 mode this option will be initialized to 10000.
9196 The swapfile can be disabled per buffer with |'swapfile'|.
9197 When 'updatecount' is set from zero to non-zero, swap files are
9198 created for all buffers that have 'swapfile' set. When 'updatecount'
9199 is set to zero, existing swap files are not deleted.
9200 Also see |'swapsync'|.
9201 This option has no meaning in buffers where |'buftype'| is "nofile"
9202 or "nowrite".
9203
9204 *'updatetime'* *'ut'*
9205'updatetime' 'ut' number (default 4000)
9206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 If this many milliseconds nothing is typed the swap file will be
9208 written to disk (see |crash-recovery|). Also used for the
9209 |CursorHold| autocommand event.
9210
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009211 *'varsofttabstop'* *'vsts'*
9212'varsofttabstop' 'vsts' string (default "")
9213 local to buffer
9214 {only available when compiled with the |+vartabs|
9215 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009216 A list of the number of spaces that a <Tab> counts for while editing,
9217 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9218 width <Tab>s are being inserted, while in fact a mixture of spaces
9219 and <Tab>s is used. Tab widths are separated with commas, with the
9220 final value applying to all subsequent tabs.
9221
9222 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009223 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009224 to use the following: >
9225 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009226< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9227 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009228
9229 Note that the value of |'softtabstop'| will be ignored while
9230 'varsofttabstop' is set.
9231
9232 *'vartabstop'* *'vts'*
9233'vartabstop' 'vts' string (default "")
9234 local to buffer
9235 {only available when compiled with the |+vartabs|
9236 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009237 A list of the number of spaces that a <Tab> in the file counts for,
9238 separated by commas. Each value corresponds to one tab, with the
9239 final value applying to all subsequent tabs. For example: >
9240 :set vartabstop=4,20,10,8
9241< This will make the first tab 4 spaces wide, the second 20 spaces,
9242 the third 10 spaces, and all following tabs 8 spaces.
9243
9244 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9245 is set.
9246
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247 *'verbose'* *'vbs'*
9248'verbose' 'vbs' number (default 0)
9249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 When bigger than zero, Vim will give messages about what it is doing.
9251 Currently, these messages are given:
9252 >= 1 When the viminfo file is read or written.
9253 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009254 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009255 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 >= 8 Files for which a group of autocommands is executed.
9257 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009258 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 >= 12 Every executed function.
9260 >= 13 When an exception is thrown, caught, finished, or discarded.
9261 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009262 >= 15 Every executed Ex command from a script (truncated at 200
9263 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009264 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265
9266 This option can also be set with the "-V" argument. See |-V|.
9267 This option is also set by the |:verbose| command.
9268
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009269 When the 'verbosefile' option is set then the verbose messages are not
9270 displayed.
9271
9272 *'verbosefile'* *'vfile'*
9273'verbosefile' 'vfile' string (default empty)
9274 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009275 When not empty all messages are written in a file with this name.
9276 When the file exists messages are appended.
9277 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009278 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009279 Setting 'verbosefile' to a new value is like making it empty first.
9280 The difference with |:redir| is that verbose messages are not
9281 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009282 This option cannot be set from a |modeline| or in the |sandbox|, for
9283 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009284
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009286'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009287 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009288 for Unix: "$HOME/.vim/view" or
9289 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009290 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009292 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293 feature}
9294 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009295 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 This option cannot be set from a |modeline| or in the |sandbox|, for
9297 security reasons.
9298
9299 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009300'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009301 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009302 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009303 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009304 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009305 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009306 word save and restore ~
9307 cursor cursor position in file and in window
9308 folds manually created folds, opened/closed folds and local
9309 fold options
9310 options options and mappings local to a window or buffer (not
9311 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009312 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 slash backslashes in file names replaced with forward
9314 slashes
9315 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009316 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009317 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009319 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009321 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009322
9323 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009324'viminfo' 'vi' string (Vi default: "", Vim default for
9325 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009326 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9327 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009329 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330 feature}
9331 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009332 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9333 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009334 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009335 consisting of a single character identifying the particular parameter,
9336 followed by a number or string which specifies the value of that
9337 parameter. If a particular character is left out, then the default
9338 value is used for that parameter. The following is a list of the
9339 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009341 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342 ! When included, save and restore global variables that start
9343 with an uppercase letter, and don't contain a lowercase
9344 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009345 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009346 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009347 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348 " Maximum number of lines saved for each register. Old name of
9349 the '<' item, with the disadvantage that you need to put a
9350 backslash before the ", otherwise it will be recognized as the
9351 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009352 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009353 % When included, save and restore the buffer list. If Vim is
9354 started with a file name argument, the buffer list is not
9355 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009356 buffer list is restored from the viminfo file. Quickfix
9357 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9358 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009359 When followed by a number, the number specifies the maximum
9360 number of buffers that are stored. Without a number all
9361 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009362 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 ' Maximum number of previously edited files for which the marks
9364 are remembered. This parameter must always be included when
9365 'viminfo' is non-empty.
9366 Including this item also means that the |jumplist| and the
9367 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009368 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009370 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009371 patterns are also saved. When not included, the value of
9372 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009373 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009375 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009376 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009377 < Maximum number of lines saved for each register. If zero then
9378 registers are not saved. When not included, all lines are
9379 saved. '"' is the old name for this item.
9380 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009381 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009382 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009383 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009384 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 c When included, convert the text in the viminfo file from the
9386 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009387 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009388 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009389 f Whether file marks need to be stored. If zero, file marks ('0
9390 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009391 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009392 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009393 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009394 h Disable the effect of 'hlsearch' when loading the viminfo
9395 file. When not included, it depends on whether ":nohlsearch"
9396 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009397 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009398 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009399 the 'n'. Must be at the end of the option! If the
9400 'viminfofile' option is set, that file name overrides the one
9401 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009402 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009403 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009404 r Removable media. The argument is a string (up to the next
9405 ','). This parameter can be given several times. Each
9406 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009407 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009408 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9409 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9410 ignored. Maximum length of each 'r' argument is 50
9411 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009412 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009413 s Maximum size of an item in Kbyte. If zero then registers are
9414 not saved. Currently only applies to registers. The default
9415 "s10" will exclude registers with more than 10 Kbyte of text.
9416 Also see the '<' item above: line count limit.
9417
9418 Example: >
9419 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9420<
9421 '50 Marks will be remembered for the last 50 files you
9422 edited.
9423 <1000 Contents of registers (up to 1000 lines each) will be
9424 remembered.
9425 s100 Registers with more than 100 Kbyte text are skipped.
9426 :0 Command-line history will not be saved.
9427 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9428 no / Since '/' is not specified, the default will be used,
9429 that is, save all of the search history, and also the
9430 previous search and substitute patterns.
9431 no % The buffer list will not be saved nor read back.
9432 no h 'hlsearch' highlighting will be restored.
9433
9434 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9435 load the contents of the file, this is not done automatically.
9436
9437 This option cannot be set from a |modeline| or in the |sandbox|, for
9438 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009439 NOTE: This option is set to the Vim default value when 'compatible'
9440 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009441
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009442 *'viminfofile'* *'vif'*
9443'viminfofile' 'vif' string (default: "")
9444 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009445 {not available when compiled without the |+viminfo|
9446 feature}
9447 When non-empty, overrides the file name used for viminfo.
9448 When equal to "NONE" no viminfo file will be read or written.
9449 This option can be set with the |-i| command line flag. The |--clean|
9450 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009451 This option cannot be set from a |modeline| or in the |sandbox|, for
9452 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009453
Bram Moolenaar071d4272004-06-13 20:20:40 +00009454 *'virtualedit'* *'ve'*
9455'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009456 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009457 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009458 block Allow virtual editing in Visual block mode.
9459 insert Allow virtual editing in Insert mode.
9460 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009461 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009462 none When used as the local value, do not allow virtual
9463 editing even when the global value is set. When used
9464 as the global value, "none" is the same as "".
9465 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009466
Bram Moolenaar071d4272004-06-13 20:20:40 +00009467 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009468 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009469 of the line. Useful for selecting a rectangle in Visual mode and
9470 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009471 "onemore" is not the same, it will only allow moving the cursor just
9472 after the last character of the line. This makes some commands more
9473 consistent. Previously the cursor was always past the end of the line
9474 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009475 break some plugins or Vim scripts. For example because |l| can move
9476 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009477 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009478 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009479 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009480 It doesn't make sense to combine "all" with "onemore", but you will
9481 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009482 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009483 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009484
9485 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9486'visualbell' 'vb' boolean (default off)
9487 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009488 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009489 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009490 use: >
9491 :set vb t_vb=
9492< If you want a short flash, you can use this on many terminals: >
9493 :set vb t_vb=[?5h$<100>[?5l
9494< Here $<100> specifies the time, you can use a smaller or bigger value
9495 to get a shorter or longer flash.
9496
9497 Note: Vim will limit the bell to once per half a second. This avoids
9498 having to wait for the flashing to finish when there are lots of
9499 bells, e.g. on key repeat. This also happens without 'visualbell'
9500 set.
9501
Bram Moolenaar071d4272004-06-13 20:20:40 +00009502 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9503 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9504 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009505
9506 Note: When the GUI starts, 't_vb' is reset to its default value. You
9507 might want to set it again in your |gvimrc|.
9508
Bram Moolenaar071d4272004-06-13 20:20:40 +00009509 Does not work on the Amiga, you always get a screen flash.
9510 Also see 'errorbells'.
9511
9512 *'warn'* *'nowarn'*
9513'warn' boolean (default on)
9514 global
9515 Give a warning message when a shell command is used while the buffer
9516 has been changed.
9517
9518 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9519'weirdinvert' 'wiv' boolean (default off)
9520 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009521 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009522 It is provided for backwards compatibility with version 4.x.
9523 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9524 vice versa. Has no effect when the GUI is running.
9525
9526 *'whichwrap'* *'ww'*
9527'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009529 Allow specified keys that move the cursor left/right to move to the
9530 previous/next line when the cursor is on the first/last character in
9531 the line. Concatenate characters to allow this for these keys:
9532 char key mode ~
9533 b <BS> Normal and Visual
9534 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009535 h "h" Normal and Visual (not recommended)
9536 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009537 < <Left> Normal and Visual
9538 > <Right> Normal and Visual
9539 ~ "~" Normal
9540 [ <Left> Insert and Replace
9541 ] <Right> Insert and Replace
9542 For example: >
9543 :set ww=<,>,[,]
9544< allows wrap only when cursor keys are used.
9545 When the movement keys are used in combination with a delete or change
9546 operator, the <EOL> also counts for a character. This makes "3h"
9547 different from "3dh" when the cursor crosses the end of a line. This
9548 is also true for "x" and "X", because they do the same as "dl" and
9549 "dh". If you use this, you may also want to use the mapping
9550 ":map <BS> X" to make backspace delete the character in front of the
9551 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009552 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009553 line (not an empty line) then it will not move to the next line. This
9554 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 NOTE: This option is set to the Vi default value when 'compatible' is
9556 set and to the Vim default value when 'compatible' is reset.
9557
9558 *'wildchar'* *'wc'*
9559'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009561 Character you have to type to start wildcard expansion in the
9562 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009563 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009564 The character is not recognized when used inside a macro. See
9565 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009566 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009567 <Esc> can be used, but hitting it twice in a row will still exit
9568 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009569 Although 'wc' is a number option, it can be specified as a number, a
9570 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9571 preceded with a caret (e.g. `^F` is CTRL-F): >
9572 :set wc=27
9573 :set wc=X
9574 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009575 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576< NOTE: This option is set to the Vi default value when 'compatible' is
9577 set and to the Vim default value when 'compatible' is reset.
9578
9579 *'wildcharm'* *'wcm'*
9580'wildcharm' 'wcm' number (default: none (0))
9581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009582 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009583 recognized when used inside a macro. You can find "spare" command-line
9584 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009585 you'll never actually type 'wildcharm', just use it in mappings that
9586 automatically invoke completion mode, e.g.: >
9587 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009588 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009589< Then after typing :ss you can use CTRL-P & CTRL-N.
9590
9591 *'wildignore'* *'wig'*
9592'wildignore' 'wig' string (default "")
9593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009594 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009595 patterns is ignored when expanding |wildcards|, completing file or
9596 directory names, and influences the result of |expand()|, |glob()| and
9597 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009598 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9599 Also see 'suffixes'.
9600 Example: >
9601 :set wildignore=*.o,*.obj
9602< The use of |:set+=| and |:set-=| is preferred when adding or removing
9603 a pattern from the list. This avoids problems when a future version
9604 uses another default.
9605
h_east596a9f22023-11-21 21:24:23 +09009606 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009607'wildignorecase' 'wic' boolean (default off)
9608 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009609 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009610 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009611 Does not apply when the shell is used to expand wildcards, which
9612 happens when there are special characters.
9613
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009615'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617 When 'wildmenu' is on, command-line completion operates in an enhanced
9618 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009619 the possible matches are shown.
9620 When 'wildoptions' contains "pum", then the completion matches are
9621 shown in a popup menu. Otherwise they are displayed just above the
9622 command line, with the first match highlighted (overwriting the status
9623 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009624 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009625 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9626 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9627 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009628 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009629 If there are more matches than can fit in the line, a ">" is shown on
9630 the right and/or a "<" is shown on the left. The status line scrolls
9631 as needed.
9632 The "wildmenu" mode is abandoned when a key is hit that is not used
9633 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009634 While the "wildmenu" is active, the following keys have special
9635 meanings:
9636 CTRL-P - go to the previous entry
9637 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638 <CR> - in menu completion, when the cursor is just after a
9639 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009640 CTRL-E - end completion, go back to what was there before
9641 selecting a match.
9642 CTRL-Y - accept the currently selected match and stop
9643 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009644
9645 When not using the popup menu for command line completion, the
9646 following keys have special meanings:
9647 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009648 <Up> - in filename/menu name completion: move up into
9649 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009650 <Down> - in filename/menu name completion: move into a
9651 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009652
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009653 When using the popup menu for command line completion, the following
9654 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009655 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009656 <PageUp> - select a match several entries back
9657 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009658 <Left> - in filename/menu name completion: move up into
9659 parent directory or parent menu.
9660 <Right> - in filename/menu name completion: move into a
9661 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009662
Bram Moolenaar071d4272004-06-13 20:20:40 +00009663 This makes the menus accessible from the console |console-menus|.
9664
9665 If you prefer the <Left> and <Right> keys to move the cursor instead
9666 of selecting a different match, use this: >
9667 :cnoremap <Left> <Space><BS><Left>
9668 :cnoremap <Right> <Space><BS><Right>
9669<
9670 The "WildMenu" highlighting is used for displaying the current match
9671 |hl-WildMenu|.
9672
9673 *'wildmode'* *'wim'*
9674'wildmode' 'wim' string (Vim default: "full")
9675 global
Girish Palyaeded3362025-04-12 18:03:32 +02009676 Completion mode used for the character specified with 'wildchar'.
9677 This option is a comma-separated list of up to four parts,
9678 corresponding to the first, second, third, and fourth presses of
9679 'wildchar'. Each part is a colon-separated list of completion
9680 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009681
Girish Palyaeded3362025-04-12 18:03:32 +02009682 The possible behavior values are:
9683 "" Only complete (insert) the first match. No further
9684 matches are cycled or listed.
9685 "full" Complete the next full match. Cycles through all
9686 matches, returning to the original input after the
9687 last match. If 'wildmenu' is enabled, it will be
9688 shown.
9689 "longest" Complete to the longest common substring. If this
9690 doesn't extend the input, the next 'wildmode' part is
9691 used.
9692 "list" If multiple matches are found, list all of them.
9693 "lastused" When completing buffer names, sort them by most
9694 recently used (excluding the current buffer). Only
9695 applies to buffer name completion.
9696 "noselect" If 'wildmenu' is enabled, show the menu but do not
9697 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009698 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009699 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009700
Girish Palyaeded3362025-04-12 18:03:32 +02009701 Some useful combinations of colon-separated values:
9702 "longest:full" Start with the longest common string and show
9703 'wildmenu' (if enabled). Does not cycle
9704 through full matches.
9705 "list:full" List all matches and complete first match.
9706 "list:longest" List all matches and complete till the longest
9707 common prefix.
9708 "list:lastused" List all matches. When completing buffers,
9709 sort them by most recently used (excluding the
9710 current buffer).
9711 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9712 if it is active. When completing buffers,
9713 sort them by most recently used (excluding the
9714 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009715
9716 Examples: >
9717 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009718< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009719 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009720< First press: longest common substring
9721 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009722 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009723< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009724 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009725< First press: list matches only
9726 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009727 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009728< First press: longest common substring
9729 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009730 :set wildmode=noselect:full
Girish Palyaeded3362025-04-12 18:03:32 +02009731< Show 'wildmenu' without completing or selecting on first press
9732 Cycle full matches on second press >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009733 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009734< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009735 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009736
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009737 *'wildoptions'* *'wop'*
9738'wildoptions' 'wop' string (default "")
9739 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009740 A list of words that change how |cmdline-completion| is done.
9741 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009742 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009743 this value is specified, wildcard expansion will not
9744 be used for completion. The matches will be sorted by
9745 the "best match" rather than alphabetically sorted.
9746 This will find more matches than the wildcard
9747 expansion. Currently fuzzy matching based completion
9748 is not supported for file and directory names and
9749 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009750 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009751 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009752 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009753 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009754 is displayed per line. Often used tag kinds are:
9755 d #define
9756 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009757
Bram Moolenaar071d4272004-06-13 20:20:40 +00009758 *'winaltkeys'* *'wak'*
9759'winaltkeys' 'wak' string (default "menu")
9760 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009761 {only used in Win32, Motif, GTK and Photon GUI}
9762 Some GUI versions allow the access to menu entries by using the ALT
9763 key in combination with a character that appears underlined in the
9764 menu. This conflicts with the use of the ALT key for mappings and
9765 entering special characters. This option tells what to do:
9766 no Don't use ALT keys for menus. ALT key combinations can be
9767 mapped, but there is no automatic handling. This can then be
9768 done with the |:simalt| command.
9769 yes ALT key handling is done by the windowing system. ALT key
9770 combinations cannot be mapped.
9771 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009772 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009773 keys can be mapped.
9774 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9775 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009776 This option is not used for <F10>; on Win32 and with GTK <F10> will
9777 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009778
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009779 *'wincolor'* *'wcr'*
9780'wincolor' 'wcr' string (default empty)
9781 local to window
9782 Highlight group name to use for this window instead of the Normal
9783 color |hl-Normal|.
9784
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009785 *'window'* *'wi'*
9786'window' 'wi' number (default screen height - 1)
9787 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009788 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9789 window and the value is smaller than 'lines' minus one. The screen
9790 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009791 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9792 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009793 When resizing the Vim window, and the value is smaller than 1 or more
9794 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009795 Note: Do not confuse this with the height of the Vim window, use
9796 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009797
Colin Kennedy21570352024-03-03 16:16:47 +01009798 *'winfixbuf'*
9799'winfixbuf' 'wfb' boolean (default off)
9800 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009801 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009802 For example, attempting to change the buffer with |:edit| will fail.
9803 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009804 also skip any window with 'winfixbuf' enabled. However if an Ex
9805 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009806
laburnumT3f7855a2023-12-05 18:37:03 +01009807 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9808'winfixheight' 'wfh' boolean (default off)
9809 local to window |local-noglobal|
9810 Keep the window height when windows are opened or closed and
9811 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9812 |preview-window| and |quickfix-window|.
9813 The height may be changed anyway when running out of room.
9814
9815 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9816'winfixwidth' 'wfw' boolean (default off)
9817 local to window |local-noglobal|
9818 Keep the window width when windows are opened or closed and
9819 'equalalways' is set. Also for |CTRL-W_=|.
9820 The width may be changed anyway when running out of room.
9821
Bram Moolenaar071d4272004-06-13 20:20:40 +00009822 *'winheight'* *'wh'* *E591*
9823'winheight' 'wh' number (default 1)
9824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009825 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009826 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009827 focus goes to a window that is smaller, its size is increased, at the
9828 cost of the height of other windows.
9829 Set 'winheight' to a small number for normal editing.
9830 Set it to 999 to make the current window fill most of the screen.
9831 Other windows will be only 'winminheight' high. This has the drawback
9832 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9833 to create only two windows, set the option after startup is done,
9834 using the |VimEnter| event: >
9835 au VimEnter * set winheight=999
9836< Minimum value is 1.
9837 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009838 height of the current window.
9839 'winheight' applies to the current window. Use 'winminheight' to set
9840 the minimal height for other windows.
9841
Bram Moolenaar071d4272004-06-13 20:20:40 +00009842 *'winminheight'* *'wmh'*
9843'winminheight' 'wmh' number (default 1)
9844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009845 The minimal height of a window, when it's not the current window.
9846 This is a hard minimum, windows will never become smaller.
9847 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9848 status bar) if necessary. They will return to at least one line when
9849 they become active (since the cursor has to have somewhere to go.)
9850 Use 'winheight' to set the minimal height of the current window.
9851 This option is only checked when making a window smaller. Don't use a
9852 large number, it will cause errors when opening more than a few
9853 windows. A value of 0 to 3 is reasonable.
9854
9855 *'winminwidth'* *'wmw'*
9856'winminwidth' 'wmw' number (default 1)
9857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009858 The minimal width of a window, when it's not the current window.
9859 This is a hard minimum, windows will never become smaller.
9860 When set to zero, windows may be "squashed" to zero columns (i.e. just
9861 a vertical separator) if necessary. They will return to at least one
9862 line when they become active (since the cursor has to have somewhere
9863 to go.)
9864 Use 'winwidth' to set the minimal width of the current window.
9865 This option is only checked when making a window smaller. Don't use a
9866 large number, it will cause errors when opening more than a few
9867 windows. A value of 0 to 12 is reasonable.
9868
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009869 *'winptydll'*
9870'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9871 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009872 {only available when compiled with the |terminal|
9873 feature on MS-Windows}
9874 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009875 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009876 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009877 a fallback.
9878 Environment variables are expanded |:set_env|.
9879 This option cannot be set from a |modeline| or in the |sandbox|, for
9880 security reasons.
9881
Bram Moolenaar071d4272004-06-13 20:20:40 +00009882 *'winwidth'* *'wiw'* *E592*
9883'winwidth' 'wiw' number (default 20)
9884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009885 Minimal number of columns for the current window. This is not a hard
9886 minimum, Vim will use fewer columns if there is not enough room. If
9887 the current window is smaller, its size is increased, at the cost of
9888 the width of other windows. Set it to 999 to make the current window
9889 always fill the screen. Set it to a small number for normal editing.
9890 The width is not adjusted after one of the commands to change the
9891 width of the current window.
9892 'winwidth' applies to the current window. Use 'winminwidth' to set
9893 the minimal width for other windows.
9894
9895 *'wrap'* *'nowrap'*
9896'wrap' boolean (default on)
9897 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009898 This option changes how text is displayed. It doesn't change the text
9899 in the buffer, see 'textwidth' for that.
9900 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009901 displaying continues on the next line. When off lines will not wrap
9902 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009903 moved to a part that is not shown, the screen will scroll
9904 horizontally.
9905 The line will be broken in the middle of a word if necessary. See
9906 'linebreak' to get the break at a word boundary.
9907 To make scrolling horizontally a bit more useful, try this: >
9908 :set sidescroll=5
9909 :set listchars+=precedes:<,extends:>
9910< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009911 This option can't be set from a |modeline| when the 'diff' option is
9912 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009913
9914 *'wrapmargin'* *'wm'*
9915'wrapmargin' 'wm' number (default 0)
9916 local to buffer
9917 Number of characters from the right window border where wrapping
9918 starts. When typing text beyond this limit, an <EOL> will be inserted
9919 and inserting continues on the next line.
9920 Options that add a margin, such as 'number' and 'foldcolumn', cause
9921 the text width to be further reduced. This is Vi compatible.
9922 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009923 This option is set to 0 when 'paste' is set and restored when 'paste'
9924 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009925 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009926
9927 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9928'wrapscan' 'ws' boolean (default on) *E384* *E385*
9929 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009930 Searches wrap around the end of the file. Also applies to |]s| and
9931 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009932
9933 *'write'* *'nowrite'*
9934'write' boolean (default on)
9935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009936 Allows writing files. When not set, writing a file is not allowed.
9937 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009938 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009939 argument. Filtering text is still possible, even though this requires
9940 writing a temporary file.
9941
9942 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9943'writeany' 'wa' boolean (default off)
9944 global
9945 Allows writing to any file with no need for "!" override.
9946
9947 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9948'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9949 otherwise)
9950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009951 Make a backup before overwriting a file. The backup is removed after
9952 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009953 also on.
9954 WARNING: Switching this option off means that when Vim fails to write
9955 your buffer correctly and then, for whatever reason, Vim exits, you
9956 lose both the original file and what you were writing. Only reset
9957 this option if your file system is almost full and it makes the write
9958 fail (and make sure not to exit Vim until the write was successful).
9959 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009960 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009961 Depending on 'backupcopy' the backup is a new file or the original
9962 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009963 NOTE: This option is set to the default value when 'compatible' is
9964 set.
9965
9966 *'writedelay'* *'wd'*
9967'writedelay' 'wd' number (default 0)
9968 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009969 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009970 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009971 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009972
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009973 *'xtermcodes'* *'noxtermcodes'*
9974'xtermcodes' boolean (default on)
9975 global
9976 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009977 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009978 key codes and number of colors from the terminal. This takes care of
9979 various configuration options of the terminal that cannot be obtained
9980 from the termlib/terminfo entry, see |xterm-codes|.
9981 A side effect may be that t_Co changes and Vim will redraw the
9982 display.
9983
9984
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009985 vim:tw=78:ts=8:noet:ft=help:norl: