blob: 49087d37324cc80b36b227517c2b6a3229c7434f [file] [log] [blame]
Milly25732432024-10-01 19:30:20 +02001*options.txt* For Vim version 9.1. Last change: 2024 Oct 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
215 :set tags=tags\\,file results in "tags,file"
216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
Millyd9af78b2024-09-26 15:54:43 +0200399 Command global value local value condition ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display local value is set
404 :set option? display - local value is not set
405 :setlocal option? - display
406:setglobal option? display -
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408
409Global options with a local value *global-local*
410
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000411Options are global when you mostly use one value for all buffers and windows.
412For some global options it's useful to sometimes have a different local value.
413You can set the local value with ":setlocal". That buffer or window will then
414use the local value, while other buffers and windows continue using the global
415value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416
417For example, you have two windows, both on C source code. They use the global
418'makeprg' option. If you do this in one of the two windows: >
419 :set makeprg=gmake
420then the other window will switch to the same value. There is no need to set
421the 'makeprg' option in the other C source window too.
422However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000423another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000424files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 :setlocal makeprg=perlmake
426You can switch back to using the global value by making the local value empty: >
427 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428This only works for a string option. For a number or boolean option you need
429to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100431Note that for non-boolean and non-number options using "<" copies the global
432value to the local value, it doesn't switch back to using the global value
433(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000434 :set path<
435This will make the local value of 'path' empty, so that the global value is
436used. Thus it does the same as: >
437 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000438Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439":setlocal" on a global option might work differently then.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441 *option-value-function*
442Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000443'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000444a function name or a function reference or a lambda function. When using a
445lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000446>
447 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000448 set opfunc=function('MyOpFunc')
449 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000450 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000451
452Set to a script-local function: >
453 set opfunc=s:MyLocalFunc
454 set opfunc=<SID>MyLocalFunc
455In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
456the script: >
457 set opfunc=MyLocalFunc
458
459Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000460 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000461 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000462
463Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000464 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000465
466Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000467 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000468 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000469
470In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300471closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000472context of where it was defined.
473
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475Setting the filetype
476
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200477:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478 Set the 'filetype' option to {filetype}, but only if
479 not done yet in a sequence of (nested) autocommands.
480 This is short for: >
481 :if !did_filetype()
482 : setlocal filetype={filetype}
483 :endif
484< This command is used in a filetype.vim file to avoid
485 setting the 'filetype' option twice, causing different
486 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200487
488 When the optional FALLBACK argument is present, a
489 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100490 'filetype'. This is to be used for filetype
491 detections that are just a guess. |did_filetype()|
492 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200493
Bram Moolenaard58e9292011-02-09 17:07:58 +0100494 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
496:opt[ions] Open a window for viewing and setting all options.
497 Options are grouped by function.
498 Offers short help for each option. Hit <CR> on the
499 short help to open a help window with more help for
500 the option.
501 Modify the value of the option and hit <CR> on the
502 "set" line to set the new value. For window and
503 buffer specific options, the last accessed window is
504 used to set the option value in, unless this is a help
505 window, in which case the window below help window is
506 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100507 {not available when compiled without the |+eval|
508 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
510 *$HOME*
511Using "~" is like using "$HOME", but it is only recognized at the start of an
512option and after a space or comma.
513
514On Unix systems "~user" can be used too. It is replaced by the home directory
515of user "user". Example: >
516 :set path=~mool/include,/usr/include,.
517
518On Unix systems the form "${HOME}" can be used too. The name between {} can
519contain non-id characters then. Note that if you want to use this for the
520"gf" command, you need to add the '{' and '}' characters to 'isfname'.
521
522NOTE: expanding environment variables and "~/" is only done with the ":set"
523command, not when assigning a value to an option with ":let".
524
Bram Moolenaarc572da52017-08-27 16:52:01 +0200525 *$HOME-windows*
526On MS-Windows, if $HOME is not defined as an environment variable, then
527at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200528If $HOMEDRIVE is not set then $USERPROFILE is used.
529
530This expanded value is not exported to the environment, this matters when
531running an external command: >
532 :echo system('set | findstr ^HOME=')
533and >
534 :echo luaeval('os.getenv("HOME")')
535should echo nothing (an empty string) despite exists('$HOME') being true.
536When setting $HOME to a non-empty string it will be exported to the
537subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200538
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
540Note the maximum length of an expanded option is limited. How much depends on
541the system, mostly it is something like 256 or 1024 characters.
542
543 *:fix* *:fixdel*
544:fix[del] Set the value of 't_kD':
545 't_kb' is 't_kD' becomes ~
546 CTRL-? CTRL-H
547 not CTRL-? CTRL-?
548
Bram Moolenaar82be4842021-01-11 19:40:15 +0100549 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551 If your delete key terminal code is wrong, but the
552 code for backspace is alright, you can put this in
553 your .vimrc: >
554 :fixdel
555< This works no matter what the actual code for
556 backspace is.
557
558 If the backspace key terminal code is wrong you can
559 use this: >
560 :if &term == "termname"
561 : set t_kb=^V<BS>
562 : fixdel
563 :endif
564< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000565 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 with your terminal name.
567
568 If your <Delete> key sends a strange key sequence (not
569 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
570 :if &term == "termname"
571 : set t_kD=^V<Delete>
572 :endif
573< Where "^V" is CTRL-V and "<Delete>" is the delete key
574 (don't type eight characters!). Replace "termname"
575 with your terminal name.
576
577 *Linux-backspace*
578 Note about Linux: By default the backspace key
579 produces CTRL-?, which is wrong. You can fix it by
580 putting this line in your rc.local: >
581 echo "keycode 14 = BackSpace" | loadkeys
582<
583 *NetBSD-backspace*
584 Note about NetBSD: If your backspace doesn't produce
585 the right code, try this: >
586 xmodmap -e "keycode 22 = BackSpace"
587< If this works, add this in your .Xmodmap file: >
588 keysym 22 = BackSpace
589< You need to restart for this to take effect.
590
591==============================================================================
5922. Automatically setting options *auto-setting*
593
594Besides changing options with the ":set" command, there are three alternatives
595to set options automatically for one or more files:
596
5971. When starting Vim initializations are read from various places. See
598 |initialization|. Most of them are performed for all editing sessions,
599 and some of them depend on the directory where Vim is started.
600 You can create an initialization file with |:mkvimrc|, |:mkview| and
601 |:mksession|.
6022. If you start editing a new file, the automatic commands are executed.
603 This can be used to set options for files matching a particular pattern and
604 many other things. See |autocommand|.
6053. If you start editing a new file, and the 'modeline' option is on, a
606 number of lines at the beginning and end of the file are checked for
607 modelines. This is explained here.
608
609 *modeline* *vim:* *vi:* *ex:* *E520*
610There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100611 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100613[text{white}] empty or any text followed by at least one blank
614 character (<Space> or <Tab>); "ex:" always requires at
615 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200616{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200617[white] optional white space
618{options} a list of option settings, separated with white space
619 or ':', where each part between ':' is the argument
620 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
Bram Moolenaar14b69452013-06-29 23:05:20 +0200622Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000623 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200624 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626The second form (this is compatible with some versions of Vi):
627
Bram Moolenaarade0d392020-01-21 22:33:58 +0100628 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629
Bram Moolenaarade0d392020-01-21 22:33:58 +0100630[text{white}] empty or any text followed by at least one blank
631 character (<Space> or <Tab>); "ex:" always requires at
632 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200633{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
634[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200635se[t] the string "set " or "se " (note the space); When
636 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200637{options} a list of options, separated with white space, which
638 is the argument for a ":set" command
639: a colon
640[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641
Bram Moolenaar14b69452013-06-29 23:05:20 +0200642Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000643 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200644 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200646The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
647chance that a normal word like "lex:" is caught. There is one exception:
648"vi:" and "vim:" can also be at the start of the line (for compatibility with
649version 3.0). Using "ex:" at the start of the line will be ignored (this
650could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Hu Jialun9dcd3492021-08-28 20:42:50 +0200652If the modeline is disabled within a modeline, subsequent modelines will be
653ignored. This is to allow turning off modeline on a per-file basis. This is
654useful when a line looks like a modeline but isn't. For example, it would be
655good to start a YAML file containing strings like "vim:" with
656 # vim: nomodeline ~
657so as to avoid modeline misdetection. Following options on the same line
658after modeline deactivation, if any, are still evaluated (but you would
659normally not have any).
660
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 *modeline-local*
662The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000663buffer and window that contain the file. Although it's possible to set global
664options from a modeline, this is unusual. If you have two windows open and
665the files in it set the same global option to a different value, the result
666depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000668When editing a file that was already loaded, only the window-local options
669from the modeline are used. Thus if you manually changed a buffer-local
670option after opening the file, it won't be changed if you edit the same buffer
671in another window. But window-local options will be set.
672
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 *modeline-version*
674If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200675number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 vim{vers}: version {vers} or later
677 vim<{vers}: version before {vers}
678 vim={vers}: version {vers}
679 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100680{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
681For example, to use a modeline only for Vim 7.0:
682 /* vim700: set foldmethod=marker */ ~
683To use a modeline for Vim after version 7.2:
684 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685There can be no blanks between "vim" and the ":".
686
687
688The number of lines that are checked can be set with the 'modelines' option.
689If 'modeline' is off or 'modelines' is 0 no lines are checked.
690
691Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000692like:
693 /* vi:ts=4: */ ~
694will give an error message for the trailing "*/". This line is OK:
695 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696
697If an error is detected the rest of the line is skipped.
698
699If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000700backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100701 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
702This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
703before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200704 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000706might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200707can be set. For some options a flag is set, so that when the value is used
708the |sandbox| is effective. Some options can only be set from the modeline
709when 'modelineexpr' is set (the default is off).
710
711Still, there is always a small risk that a modeline causes trouble. E.g.,
712when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
713So disable modelines before editing untrusted text. The mail ftplugin does
714this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715
716Hint: If you would like to do something else than setting an option, you could
717define an autocommand that checks the file for a specific string. For
718example: >
719 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
720And define a function SetVar() that does something with the line containing
721"VAR".
722
723==============================================================================
7243. Options summary *option-summary*
725
726In the list below all the options are mentioned with their full name and with
727an abbreviation if there is one. Both forms may be used.
728
729In this document when a boolean option is "set" that means that ":set option"
730is entered. When an option is "reset", ":set nooption" is used.
731
732For some options there are two default values: The "Vim default", which is
733used when 'compatible' is not set, and the "Vi default", which is used when
734'compatible' is set.
735
736Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000737are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738different value in each window. For example the 'list' option can be set in
739one window and reset in another for the same text, giving both types of view
740at the same time. There are a few options that are specific to a certain
741file. These can have a different value for each file or buffer. For example
742the 'textwidth' option can be 78 for a normal text file and 0 for a C
743program.
744
745 global one option for all buffers and windows
746 local to window each window has its own copy of this option
747 local to buffer each buffer has its own copy of this option
748
749When creating a new window the option values from the currently active window
750are used as a default value for the window-specific options. For the
751buffer-specific options this depends on the 's' and 'S' flags in the
752'cpoptions' option. If 's' is included (which is the default) the values for
753buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000754first entered. If 'S' is present the options are copied each time the buffer
755is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756present, the options are copied from the currently active buffer when the
757buffer is created.
758
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000759Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000761Not all options are supported in all versions. This depends on the supported
762features and sometimes on the system. A remark about this is in curly braces
763below. When an option is not supported it may still be set without getting an
764error, this is called a hidden option. You can't get the value of a hidden
765option though, it is not stored.
766
767To test if option "foo" can be used with ":set" use something like this: >
768 if exists('&foo')
769This also returns true for a hidden option. To test if option "foo" is really
770supported use something like this: >
771 if exists('+foo')
772<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 *E355*
774A jump table for the options with a short description can be found at |Q_op|.
775
776 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100777'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 {only available when compiled with the |+rightleft|
780 feature}
781 The ASCII code for the first letter of the Hebrew alphabet. The
782 routine that maps the keyboard in Hebrew mode, both in Insert mode
783 (when hkmap is set) and on the command-line (when hitting CTRL-_)
784 outputs the Hebrew characters in the range [aleph..aleph+26].
785 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
786 See |rileft.txt|.
787
788 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
789'allowrevins' 'ari' boolean (default off)
790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 {only available when compiled with the |+rightleft|
792 feature}
793 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
794 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
795 into reverse Insert mode, and don't know how to get out. See
796 'revins'.
797 NOTE: This option is reset when 'compatible' is set.
798
799 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
800'altkeymap' 'akm' boolean (default off)
801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 {only available when compiled with the |+farsi|
803 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100804 This option was for using Farsi, which has been removed. See
805 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'ambiwidth'* *'ambw'*
808'ambiwidth' 'ambw' string (default: "single")
809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
811 Tells Vim what to do with characters with East Asian Width Class
812 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
813 letters, Cyrillic letters).
814
815 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000816 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 expected by most users.
818 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200819 *E834* *E835*
820 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100821 contains a character that would be double width. These errors may
822 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200823
824 The values are overruled for characters specified with
825 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 There are a number of CJK fonts for which the width of glyphs for
828 those characters are solely based on how many octets they take in
829 legacy/traditional CJK encodings. In those encodings, Euro,
830 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000831 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000833 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 Vim is running inside a terminal (emulators) that uses a CJK font
835 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
836 this option should be set to "double" to match the width perceived
837 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100838 to be set to "double" under CJK MS-Windows when the system locale is
839 set to one of CJK locales. See Unicode Standard Annex #11
840 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100842 Vim may set this option automatically at startup time when Vim is
843 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200844 escape sequence to request cursor position report. The response can
845 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100846
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
848'antialias' 'anti' boolean (default: off)
849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200851 on macOS}
852 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
854 which can be easier to read at certain sizes on certain displays.
855 Setting this option can sometimes cause problems if 'guifont' is set
856 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100857 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
860'arabic' 'arab' boolean (default off)
861 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 {only available when compiled with the |+arabic|
863 feature}
864 This option can be set to start editing Arabic text.
865 Setting this option will:
866 - Set the 'rightleft' option, unless 'termbidi' is set.
867 - Set the 'arabicshape' option, unless 'termbidi' is set.
868 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
869 between typing English and Arabic key mapping.
870 - Set the 'delcombine' option
871 Note that 'encoding' must be "utf-8" for working with Arabic text.
872
873 Resetting this option will:
874 - Reset the 'rightleft' option.
875 - Disable the use of 'keymap' (without changing its value).
876 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200877 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100878 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Also see |arabic.txt|.
880
881 *'arabicshape'* *'arshape'*
882 *'noarabicshape'* *'noarshape'*
883'arabicshape' 'arshape' boolean (default on)
884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 {only available when compiled with the |+arabic|
886 feature}
887 When on and 'termbidi' is off, the required visual character
888 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200889 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 one which encompasses:
891 a) the changing/morphing of characters based on their location
892 within a word (initial, medial, final and stand-alone).
893 b) the enabling of the ability to compose characters
894 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100895 When disabled the display shows each character's true stand-alone
896 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 Arabic is a complex language which requires other settings, for
898 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100899 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
laburnumT3f7855a2023-12-05 18:37:03 +0100901 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
902'autochdir' 'acd' boolean (default off)
903 global
904 {only available when compiled with it, use
905 exists("+autochdir") to check}
906 When on, Vim will change the current working directory whenever you
907 open a file, switch buffers, delete a buffer or open/close a window.
908 It will change to the directory containing the file which was opened
909 or selected. When a buffer has no name it also has no directory, thus
910 the current directory won't change when navigating to it.
911 Note: When this option is on some plugins may not work.
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
914'autoindent' 'ai' boolean (default off)
915 local to buffer
916 Copy indent from current line when starting a new line (typing <CR>
917 in Insert mode or when using the "o" or "O" command). If you do not
918 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000919 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
920 to another line has the same effect, unless the 'I' flag is included
921 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 When autoindent is on, formatting (with the "gq" command or when you
923 reach 'textwidth' in Insert mode) uses the indentation of the first
924 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 When 'smartindent' or 'cindent' is on the indent is changed in
926 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200927 The 'autoindent' option is reset when the 'paste' option is set and
928 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 *'autoread'* *'ar'* *'noautoread'* *'noar'*
931'autoread' 'ar' boolean (default off)
932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 When a file has been detected to have been changed outside of Vim and
934 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200935 When the file has been deleted this is not done, so you have the text
936 from before it was deleted. When it appears again then it is read.
937 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 If this option has a local value, use this command to switch back to
939 using the global value: >
940 :set autoread<
941<
laburnumT3f7855a2023-12-05 18:37:03 +0100942
943 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
944'autoshelldir' 'asd' boolean (default off)
945 global
946 When on, Vim will change the current working directory whenever you
947 change the directory of the shell running in a terminal window. You
948 need proper setting-up, so whenever the shell's pwd changes an OSC 7
949 escape sequence will be emitted. For example, on Linux, you can
950 source /etc/profile.d/vte.sh in your shell profile if you use bash or
951 zsh. For bash this should work (put it in a bash init file): >
952 if [[ -n "$VIM_TERMINAL" ]]; then
953 PROMPT_COMMAND='_vim_sync_PWD'
954 function _vim_sync_PWD() {
955 printf '\033]7;file://%s\033\\' "$PWD"
956 }
957 fi
958<
959 Or, in a zsh init file: >
960 if [[ -n "$VIM_TERMINAL" ]]; then
961 autoload -Uz add-zsh-hook
962 add-zsh-hook -Uz chpwd _vim_sync_PWD
963 function _vim_sync_PWD() {
964 printf '\033]7;file://%s\033\\' "$PWD"
965 }
966 fi
967<
968 In a fish init file: >
969 if test -n "$VIM_TERMINAL"
970 function _vim_sync_PWD --on-variable=PWD
971 printf '\033]7;file://%s\033\\' "$PWD"
972 end
973 end
974<
975 You can find an alternative method at |terminal-autoshelldir|.
976 When the parsing of the OSC sequence fails you get *E1179* .
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
979'autowrite' 'aw' boolean (default off)
980 global
981 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000982 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000983 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
984 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000985 to another file.
986 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000987 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Note that for some commands the 'autowrite' option is not used, see
989 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200990 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200991 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100992 USE WITH CARE: If you make temporary changes to a buffer that you
993 don't want to be saved this option may cause it to be saved anyway.
994 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
996 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
997'autowriteall' 'awa' boolean (default off)
998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1000 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1001 Setting this option also implies that Vim behaves like 'autowrite' has
1002 been set.
1003
1004 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001005'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 When set to "dark", Vim will try to use colors that look good on a
1008 dark background. When set to "light", Vim will try to use colors that
1009 look good on a light background. Any other value is illegal.
1010 Vim tries to set the default value according to the terminal used.
1011 This will not always be correct.
1012 Setting this option does not change the background color, it tells Vim
1013 what the background color looks like. For changing the background
1014 color, see |:hi-normal|.
1015
Gregory Anders83ad2722024-01-03 19:48:51 +01001016 When 'background' is changed Vim will adjust the default color groups
1017 for the new value. But the colors used for syntax highlighting will
1018 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001019 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001020 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 the color scheme adjusts to the value of 'background' this will work.
1022 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 When setting 'background' to the default value with: >
1026 :set background&
1027< Vim will guess the value. In the GUI this should work correctly,
1028 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001029 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001030 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001032 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001033 color from the terminal. If the returned RGB value is dark/light and
1034 'background' is not dark/light, 'background' will be set and the
1035 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001036 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001037 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001038
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 When starting the GUI, the default value for 'background' will be
1040 "light". When the value is not set in the .gvimrc, and Vim detects
1041 that the background is actually quite dark, 'background' is set to
1042 "dark". But this happens only AFTER the .gvimrc file has been read
1043 (because the window needs to be opened to find the actual background
1044 color). To get around this, force the GUI window to be opened by
1045 putting a ":gui" command in the .gvimrc file, before where the value
1046 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001048 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001049 For other systems "dark" is used when 'term' is "linux",
1050 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1051 background. Otherwise the default is "light".
1052
Bram Moolenaarc572da52017-08-27 16:52:01 +02001053 The |:terminal| command and the |term_start()| function use the
1054 'background' value to decide whether the terminal window will start
1055 with a white or black background.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 Normally this option would be set in the .vimrc file. Possibly
1058 depending on the terminal name. Example: >
1059 :if &term == "pcterm"
1060 : set background=dark
1061 :endif
1062< When this option is set, the default settings for the highlight groups
1063 will change. To use other settings, place ":highlight" commands AFTER
1064 the setting of the 'background' option.
1065 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1066 to select the colors for syntax highlighting. After changing this
1067 option, you must load syntax.vim again to see the result. This can be
1068 done with ":syntax on".
1069
1070 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001071'backspace' 'bs' string (default "", set to "indent,eol,start"
1072 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1075 mode. This is a list of items, separated by commas. Each item allows
1076 a way to backspace over something:
1077 value effect ~
1078 indent allow backspacing over autoindent
1079 eol allow backspacing over line breaks (join lines)
1080 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1081 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001082 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1083 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar46eea442022-03-30 10:51:39 +01001085 When the value is empty, Vi compatible backspacing is used, none of
1086 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
1088 For backwards compatibility with version 5.4 and earlier:
1089 value effect ~
1090 0 same as ":set backspace=" (Vi compatible)
1091 1 same as ":set backspace=indent,eol"
1092 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001093 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
1095 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1096 NOTE: This option is set to "" when 'compatible' is set.
1097
1098 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1099'backup' 'bk' boolean (default off)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 Make a backup before overwriting a file. Leave it around after the
1102 file has been successfully written. If you do not want to keep the
1103 backup file, but you do want a backup while the file is being
1104 written, reset this option and set the 'writebackup' option (this is
1105 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001106 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 |backup-table| for more explanations.
1108 When the 'backupskip' pattern matches, a backup is not made anyway.
1109 When 'patchmode' is set, the backup may be renamed to become the
1110 oldest version of a file.
1111 NOTE: This option is reset when 'compatible' is set.
1112
1113 *'backupcopy'* *'bkc'*
1114'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001115 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001117 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119 The main values are:
1120 "yes" make a copy of the file and overwrite the original one
1121 "no" rename the file and write a new one
1122 "auto" one of the previous, what works best
1123
1124 Extra values that can be combined with the ones above are:
1125 "breaksymlink" always break symlinks when writing
1126 "breakhardlink" always break hardlinks when writing
1127
1128 Making a copy and overwriting the original file:
1129 - Takes extra time to copy the file.
1130 + When the file has special attributes, is a (hard/symbolic) link or
1131 has a resource fork, all this is preserved.
1132 - When the file is a link the backup will have the name of the link,
1133 not of the real file.
1134
1135 Renaming the file and writing a new one:
1136 + It's fast.
1137 - Sometimes not all attributes of the file can be copied to the new
1138 file.
1139 - When the file is a link the new file will not be a link.
1140
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 The "auto" value is the middle way: When Vim sees that renaming the
1142 file is possible without side effects (the attributes can be passed on
1143 and the file is not a link) that is used. When problems are expected,
1144 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145
1146 The "breaksymlink" and "breakhardlink" values can be used in
1147 combination with any of "yes", "no" and "auto". When included, they
1148 force Vim to always break either symbolic or hard links by doing
1149 exactly what the "no" option does, renaming the original file to
1150 become the backup and writing a new file in its place. This can be
1151 useful for example in source trees where all the files are symbolic or
1152 hard links and any changes should stay in the local source tree, not
1153 be propagated back to the original source.
1154 *crontab*
1155 One situation where "no" and "auto" will cause problems: A program
1156 that opens a file, invokes Vim to edit that file, and then tests if
1157 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001158 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 example.
1160
1161 When a copy is made, the original file is truncated and then filled
1162 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001163 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001164 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 group of the backup is set to the group of the original file. If this
1166 fails, the protection bits for the group are made the same as for
1167 others.
1168
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001169 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 the same attributes of the original file, and the newly written file
1171 is owned by the current user. When the file was a (hard/symbolic)
1172 link, the new file will not! That's why the "auto" value doesn't
1173 rename when the file is a link. The owner and group of the newly
1174 written file will be set to the same ones as the original file, but
1175 the system may refuse to do this. In that case the "auto" value will
1176 again not rename the file.
1177
Bram Moolenaar036986f2017-03-16 17:41:02 +01001178 NOTE: This option is set to the Vi default value when 'compatible' is
1179 set and to the Vim default value when 'compatible' is reset.
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 *'backupdir'* *'bdir'*
1182'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001183 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 for Unix: ".,~/tmp,~/")
1185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 List of directories for the backup file, separated with commas.
1187 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001188 where this is possible. The directory must exist, Vim will not
1189 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001190 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 impossible!). Writing may fail because of this.
1192 - A directory "." means to put the backup file in the same directory
1193 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001194 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1195 the backup file relative to where the edited file is. The leading
1196 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 ("." inside a directory name has no special meaning).
1198 - Spaces after the comma are ignored, other spaces are considered part
1199 of the directory name. To have a space at the start of a directory
1200 name, precede it with a backslash.
1201 - To include a comma in a directory name precede it with a backslash.
1202 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001203 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001204 the backup file name will be built from the complete path to the
1205 file with all path separators changed to percent '%' signs. This
1206 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001207 On Win32, it is also possible to end with "\\". However, When a
1208 separating comma is following, you must use "//", since "\\" will
1209 include the comma in the file name. Therefore it is recommended to
1210 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 - Environment variables are expanded |:set_env|.
1212 - Careful with '\' characters, type one before a space, type two to
1213 get one in the option (see |option-backslash|), for example: >
1214 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1215< - For backwards compatibility with Vim version 3.0 a '>' at the start
1216 of the option is removed.
1217 See also 'backup' and 'writebackup' options.
1218 If you want to hide your backup files on Unix, consider this value: >
1219 :set backupdir=./.backup,~/.backup,.,/tmp
1220< You must create a ".backup" directory in each directory and in your
1221 home directory for this to work properly.
1222 The use of |:set+=| and |:set-=| is preferred when adding or removing
1223 directories from the list. This avoids problems when a future version
1224 uses another default.
1225 This option cannot be set from a |modeline| or in the |sandbox|, for
1226 security reasons.
1227
1228 *'backupext'* *'bex'* *E589*
1229'backupext' 'bex' string (default "~", for VMS: "_")
1230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 String which is appended to a file name to make the name of the
1232 backup file. The default is quite unusual, because this avoids
1233 accidentally overwriting existing files with a backup file. You might
1234 prefer using ".bak", but make sure that you don't have files with
1235 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001236 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001238 If you like to keep a lot of backups, you could use a BufWritePre
1239 autocommand to change 'backupext' just before writing the file to
1240 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001241 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001242< Use 'backupdir' to put the backup in a different directory.
1243
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001245'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1246 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1247 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 A list of file patterns. When one of the patterns matches with the
1250 name of the file which is written, no backup file is created. Both
1251 the specified file name and the full path name of the file are used.
1252 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1253 Watch out for special characters, see |option-backslash|.
1254 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001255 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001256
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001257 WARNING: Not having a backup file means that when Vim fails to write
1258 your buffer correctly and then, for whatever reason, Vim exits, you
1259 lose both the original file and what you were writing. Only disable
1260 backups if you don't care about losing the file.
1261
Bram Moolenaar02467872007-05-06 13:22:01 +00001262 Note that environment variables are not expanded. If you want to use
1263 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001264 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001265
1266< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001267 backup would be made by renaming the original file crontab won't see
1268 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269
1270 *'balloondelay'* *'bdlay'*
1271'balloondelay' 'bdlay' number (default: 600)
1272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 {only available when compiled with the |+balloon_eval|
1274 feature}
1275 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1276
1277 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1278'ballooneval' 'beval' boolean (default off)
1279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001281 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001282 Switch on the |balloon-eval| functionality for the GUI.
1283
1284 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1285 *'nobevalterm'*
1286'balloonevalterm' 'bevalterm' boolean (default off)
1287 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001288 {only available when compiled with the
1289 |+balloon_eval_term| feature}
1290 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001292 *'balloonexpr'* *'bexpr'*
1293'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001294 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001295 {only available when compiled with the |+balloon_eval|
1296 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001297 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001298 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1299 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001300
1301 v:beval_bufnr number of the buffer in which balloon is going to show
1302 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001303 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001304 v:beval_lnum line number
1305 v:beval_col column number (byte index)
1306 v:beval_text word under or after the mouse pointer
1307
Bram Moolenaar54775062019-07-31 21:07:14 +02001308 Instead of showing a balloon, which is limited to plain text, consider
1309 using a popup window, see |popup_beval_example|. A popup window can
1310 use highlighting and show a border.
1311
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001312 The evaluation of the expression must not have side effects!
1313 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001314 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001315 return 'Cursor is at line ' .. v:beval_lnum ..
1316 \ ', column ' .. v:beval_col ..
1317 \ ' of file ' .. bufname(v:beval_bufnr) ..
1318 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001319 endfunction
1320 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001321 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001322<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001323 Also see |balloon_show()|, it can be used if the content of the balloon
1324 is to be fetched asynchronously. In that case evaluating
1325 'balloonexpr' should result in an empty string. If you get a balloon
1326 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001327
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001328 NOTE: The balloon is displayed only if the cursor is on a text
1329 character. If the result of evaluating 'balloonexpr' is not empty,
1330 Vim does not try to send a message to an external debugger (Netbeans
1331 or Sun Workshop).
1332
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001333 If the expression starts with s: or |<SID>|, then it is replaced with
1334 the script ID (|local-function|). Example: >
1335 set bexpr=s:MyBalloonExpr()
1336 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001337< Otherwise, the expression is evaluated in the context of the script
1338 where the option was set, thus script-local items are available.
1339
Bram Moolenaar30b65812012-07-12 22:01:11 +02001340 The expression will be evaluated in the |sandbox| when set from a
1341 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001342 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001343
1344 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001345 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001346
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001347 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001348 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001349< When they are supported "\n" characters will start a new line. If the
1350 expression evaluates to a |List| this is equal to using each List item
1351 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001352 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001353
Bram Moolenaar165bc692015-07-21 17:53:25 +02001354 *'belloff'* *'bo'*
1355'belloff' 'bo' string (default "")
1356 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001357 Specifies for which events the bell will not be rung. It is a comma
1358 separated list of items. For each item that is present, the bell
1359 will be silenced. This is most useful to specify specific events in
1360 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001361 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001362
1363 item meaning when present ~
1364 all All events.
1365 backspace When hitting <BS> or <Del> and deleting results in an
1366 error.
1367 cursor Fail to move around using the cursor keys or
1368 <PageUp>/<PageDown> in |Insert-mode|.
1369 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1370 |i_CTRL-X_CTRL-T|.
1371 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1372 |i_CTRL-E|.
1373 ctrlg Unknown Char after <C-G> in Insert mode.
1374 error Other Error occurred (e.g. try to join last line)
1375 (mostly used in |Normal-mode| or |Cmdline-mode|).
1376 esc hitting <Esc> in |Normal-mode|.
1377 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001378 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001379 insertmode Pressing <Esc> in 'insertmode'.
1380 lang Calling the beep module for Lua/Mzscheme/TCL.
1381 mess No output available for |g<|.
1382 showmatch Error occurred for 'showmatch' function.
1383 operator Empty region error |cpo-E|.
1384 register Unknown register after <C-R> in |Insert-mode|.
1385 shell Bell from shell output |:!|.
1386 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001387 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001388 wildmode More matches in |cmdline-completion| available
1389 (depends on the 'wildmode' setting).
1390
Bram Moolenaar036986f2017-03-16 17:41:02 +01001391 This is most useful to fine tune when in Insert mode the bell should
1392 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001393 indicate that an error occurred. It can be silenced by adding the
1394 "error" keyword.
1395
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1397'binary' 'bin' boolean (default off)
1398 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 This option should be set before editing a binary file. You can also
1400 use the |-b| Vim argument. When this option is switched on a few
1401 options will be changed (also when it already was on):
1402 'textwidth' will be set to 0
1403 'wrapmargin' will be set to 0
1404 'modeline' will be off
1405 'expandtab' will be off
1406 Also, 'fileformat' and 'fileformats' options will not be used, the
1407 file is read and written like 'fileformat' was "unix" (a single <NL>
1408 separates lines).
1409 The 'fileencoding' and 'fileencodings' options will not be used, the
1410 file is read without conversion.
1411 NOTE: When you start editing a(nother) file while the 'bin' option is
1412 on, settings from autocommands may change the settings again (e.g.,
1413 'textwidth'), causing trouble when editing. You might want to set
1414 'bin' again when the file has been loaded.
1415 The previous values of these options are remembered and restored when
1416 'bin' is switched from on to off. Each buffer has its own set of
1417 saved option values.
1418 To edit a file with 'binary' set you can use the |++bin| argument.
1419 This avoids you have to do ":set bin", which would have effect for all
1420 files you edit.
1421 When writing a file the <EOL> for the last line is only written if
1422 there was one in the original file (normally Vim appends an <EOL> to
1423 the last line if there is none; this would make the file longer). See
1424 the 'endofline' option.
1425
1426 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1427'bioskey' 'biosk' boolean (default on)
1428 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001429 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001430 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431
1432 *'bomb'* *'nobomb'*
1433'bomb' boolean (default off)
1434 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 When writing a file and the following conditions are met, a BOM (Byte
1436 Order Mark) is prepended to the file:
1437 - this option is on
1438 - the 'binary' option is off
1439 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1440 endian variants.
1441 Some applications use the BOM to recognize the encoding of the file.
1442 Often used for UCS-2 files on MS-Windows. For other applications it
1443 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001444 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1446 check for the presence of the BOM is done and 'bomb' set accordingly.
1447 Unless 'binary' is set, it is removed from the first line, so that you
1448 don't see it when editing. When you don't change the options, the BOM
1449 will be restored when writing the file.
1450
1451 *'breakat'* *'brk'*
1452'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1453 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001454 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 feature}
1456 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001457 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1458 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001460 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001461'breakindent' 'bri' boolean (default off)
1462 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463 {not available when compiled without the |+linebreak|
1464 feature}
1465 Every wrapped line will continue visually indented (same amount of
1466 space as the beginning of that line), thus preserving horizontal blocks
1467 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001468 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001469
1470 *'breakindentopt'* *'briopt'*
1471'breakindentopt' 'briopt' string (default empty)
1472 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001473 {not available when compiled without the |+linebreak|
1474 feature}
1475 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001476 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001477 min:{n} Minimum text width that will be kept after
1478 applying 'breakindent', even if the resulting
1479 text should normally be narrower. This prevents
1480 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001481 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001482 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001483 shift:{n} After applying 'breakindent', the wrapped line's
1484 beginning will be shifted by the given number of
1485 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001486 indentation (negative) or emphasizing the line
1487 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001488 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001489 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001490 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001491 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001492 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001493 numbered or bulleted list (using the
1494 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001495 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001496 list:-1 Uses the width of a match with 'formatlistpat' for
1497 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001498 column:{n} Indent at column {n}. Will overrule the other
1499 sub-options. Note: an additional indent may be
1500 added for the 'showbreak' setting.
1501 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001502
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001504'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001506 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001508 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001509 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 buffer Use the directory of the related buffer.
1511 current Use the current directory.
1512 {path} Use the specified directory
1513
1514 *'bufhidden'* *'bh'*
1515'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001516 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 This option specifies what happens when a buffer is no longer
1518 displayed in a window:
1519 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001520 hide hide the buffer (don't unload it), even if 'hidden' is
1521 not set
1522 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001523 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001524 delete delete the buffer from the buffer list, even if
1525 'hidden' is set; the |:hide| command will also delete
1526 the buffer, making it behave like |:bdelete|
1527 wipe wipe the buffer from the buffer list, even if
1528 'hidden' is set; the |:hide| command will also wipe
1529 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001531 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001532 are lost without a warning. Also, these values may break autocommands
1533 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 This option is used together with 'buftype' and 'swapfile' to specify
1535 special kinds of buffers. See |special-buffers|.
1536
1537 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1538'buflisted' 'bl' boolean (default: on)
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 When this option is set, the buffer shows up in the buffer list. If
1541 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1542 This option is reset by Vim for buffers that are only used to remember
1543 a file name or marks. Vim sets it when starting to edit a buffer.
1544 But not when moving to a buffer with ":buffer".
1545
1546 *'buftype'* *'bt'* *E382*
1547'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001548 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 The value of this option specifies the type of a buffer:
1550 <empty> normal buffer
1551 nofile buffer which is not related to a file and will not be
1552 written
1553 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001554 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001555 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001557 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 help help buffer (you are not supposed to set this
1559 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001560 terminal buffer for a |terminal| (you are not supposed to set
1561 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001562 prompt buffer where only the last line can be edited, meant
1563 to be used by a plugin, see |prompt-buffer|
1564 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001565 popup buffer used in a popup window, see |popup|.
1566 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567
1568 This option is used together with 'bufhidden' and 'swapfile' to
1569 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001570 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571
1572 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001573 One such effect is that Vim will not check the timestamp of the file,
1574 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575
Bram Moolenaar280f1262006-01-30 00:14:18 +00001576 A "quickfix" buffer is only used for the error list and the location
1577 list. This value is set by the |:cwindow| and |:lwindow| commands and
1578 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579
1580 "nofile" and "nowrite" buffers are similar:
1581 both: The buffer is not to be written to disk, ":w" doesn't
1582 work (":w filename" does work though).
1583 both: The buffer is never considered to be |'modified'|.
1584 There is no warning when the changes will be lost, for
1585 example when you quit Vim.
1586 both: A swap file is only created when using too much memory
1587 (when 'swapfile' has been reset there is never a swap
1588 file).
1589 nofile only: The buffer name is fixed, it is not handled like a
1590 file name. It is not modified in response to a |:cd|
1591 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001592 both: When using ":e bufname" and already editing "bufname"
1593 the buffer is made empty and autocommands are
1594 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001595 *E676*
1596 "acwrite" implies that the buffer name is not related to a file, like
1597 "nofile", but it will be written. Thus, in contrast to "nofile" and
1598 "nowrite", ":w" does work and a modified buffer can't be abandoned
1599 without saving. For writing there must be matching |BufWriteCmd|,
1600 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
1602 *'casemap'* *'cmp'*
1603'casemap' 'cmp' string (default: "internal,keepascii")
1604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 Specifies details about changing the case of letters. It may contain
1606 these words, separated by a comma:
1607 internal Use internal case mapping functions, the current
1608 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001609 matters when 'encoding' is a Unicode encoding,
1610 "latin1" or "iso-8859-15". When "internal" is
1611 omitted, the towupper() and towlower() system library
1612 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1614 case mapping, the current locale is not effective.
1615 This probably only matters for Turkish.
1616
Bram Moolenaar938ae282023-02-20 20:44:55 +00001617 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001618'cdhome' 'cdh' boolean (default: off)
1619 global
1620 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1621 current working directory to the |$HOME| directory like in Unix.
1622 When off, those commands just print the current directory name.
1623 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001624 This option cannot be set from a |modeline| or in the |sandbox|, for
1625 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001626 NOTE: This option is reset when 'compatible' is set.
1627
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 *'cdpath'* *'cd'* *E344* *E346*
1629'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001632 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1633 searched for has a relative path, not an absolute part starting with
1634 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 The 'cdpath' option's value has the same form and semantics as
1636 |'path'|. Also see |file-searching|.
1637 The default value is taken from $CDPATH, with a "," prepended to look
1638 in the current directory first.
1639 If the default value taken from $CDPATH is not what you want, include
1640 a modified version of the following command in your vimrc file to
1641 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001642 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643< This option cannot be set from a |modeline| or in the |sandbox|, for
1644 security reasons.
1645 (parts of 'cdpath' can be passed to the shell to expand file names).
1646
1647 *'cedit'*
1648'cedit' string (Vi default: "", Vim default: CTRL-F)
1649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 The key used in Command-line Mode to open the command-line window.
1651 The default is CTRL-F when 'compatible' is off.
1652 Only non-printable keys are allowed.
1653 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001654 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1655 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1656 :set cedit=^Y
1657 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658< |Nvi| also has this option, but it only uses the first character.
1659 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001660 NOTE: This option is set to the Vim default value when 'compatible'
1661 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662
1663 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1664'charconvert' 'ccv' string (default "")
1665 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001666 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 An expression that is used for character encoding conversion. It is
1668 evaluated when a file that is to be read or has been written has a
1669 different encoding from what is desired.
1670 'charconvert' is not used when the internal iconv() function is
1671 supported and is able to do the conversion. Using iconv() is
1672 preferred, because it is much faster.
1673 'charconvert' is not used when reading stdin |--|, because there is no
1674 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001675 The expression must return zero, false or an empty string for success,
1676 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 The possible encoding names encountered are in 'encoding'.
1678 Additionally, names given in 'fileencodings' and 'fileencoding' are
1679 used.
1680 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1681 is done internally by Vim, 'charconvert' is not used for this.
1682 'charconvert' is also used to convert the viminfo file, if the 'c'
1683 flag is present in 'viminfo'. Also used for Unicode conversion.
1684 Example: >
1685 set charconvert=CharConvert()
1686 fun CharConvert()
1687 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001688 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1689 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 return v:shell_error
1691 endfun
1692< The related Vim variables are:
1693 v:charconvert_from name of the current encoding
1694 v:charconvert_to name of the desired encoding
1695 v:fname_in name of the input file
1696 v:fname_out name of the output file
1697 Note that v:fname_in and v:fname_out will never be the same.
1698 Note that v:charconvert_from and v:charconvert_to may be different
1699 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001700
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001701 The advantage of using a function call without arguments is that it is
1702 faster, see |expr-option-function|.
1703
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 Encryption is not done by Vim when using 'charconvert'. If you want
1705 to encrypt the file after conversion, 'charconvert' should take care
1706 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001707
1708 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1709 replaced with the script ID (|local-function|). Example: >
1710 set charconvert=s:MyConvert()
1711 set charconvert=<SID>SomeConvert()
1712< Otherwise the expression is evaluated in the context of the script
1713 where the option was set, thus script-local items are available.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 This option cannot be set from a |modeline| or in the |sandbox|, for
1716 security reasons.
1717
1718 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1719'cindent' 'cin' boolean (default off)
1720 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001721 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 that trigger reindenting in insert mode and 'cinoptions' to set your
1723 preferred indent style.
1724 If 'indentexpr' is not empty, it overrules 'cindent'.
1725 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1726 the "=" operator indents using this algorithm rather than calling an
1727 external program.
1728 See |C-indenting|.
1729 When you don't like the way 'cindent' works, try the 'smartindent'
1730 option or 'indentexpr'.
1731 This option is not used when 'paste' is set.
1732 NOTE: This option is reset when 'compatible' is set.
1733
1734 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001735'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 A list of keys that, when typed in Insert mode, cause reindenting of
1738 the current line. Only used if 'cindent' is on and 'indentexpr' is
1739 empty.
1740 For the format of this option see |cinkeys-format|.
1741 See |C-indenting|.
1742
1743 *'cinoptions'* *'cino'*
1744'cinoptions' 'cino' string (default "")
1745 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1747 program. See |cinoptions-values| for the values of this option, and
1748 |C-indenting| for info on C indenting in general.
1749
laburnumT3f7855a2023-12-05 18:37:03 +01001750 *'cinscopedecls'* *'cinsd'*
1751'cinscopedecls' 'cinsd' string (default "public,protected,private")
1752 local to buffer
1753 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1754 Useful e.g. for working with the Qt framework that defines additional
1755 scope declarations "signals", "public slots" and "private slots": >
1756 set cinscopedecls+=signals,public\ slots,private\ slots
1757<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 *'cinwords'* *'cinw'*
1759'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 These keywords start an extra indent in the next line when
1762 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1763 an appropriate place (inside {}).
1764 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1765 matter, include the keyword both the uppercase and lowercase:
1766 "if,If,IF".
1767
laburnumT3f7855a2023-12-05 18:37:03 +01001768 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1770 for X-windows, "" otherwise)
1771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 {only in GUI versions or when the |+xterm_clipboard|
1773 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001774 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001775 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001776 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 prepend, e.g.: >
1778 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001779< When using the GUI see |'go-A'|.
1780 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001782 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 unnamed When included, Vim will use the clipboard register '*'
1784 for all yank, delete, change and put operations which
1785 would normally go to the unnamed register. When a
1786 register is explicitly specified, it will always be
1787 used regardless of whether "unnamed" is in 'clipboard'
1788 or not. The clipboard register can always be
1789 explicitly accessed using the "* notation. Also see
1790 |gui-clipboard|.
1791
Bram Moolenaar30b65812012-07-12 22:01:11 +02001792 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001793 unnamedplus A variant of the "unnamed" flag which uses the
1794 clipboard register '+' (|quoteplus|) instead of
1795 register '*' for all yank, delete, change and put
1796 operations which would normally go to the unnamed
1797 register. When "unnamed" is also included to the
1798 option, yank operations (but not delete, change or
1799 put) will additionally copy the text into register
1800 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001801 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001802 Availability can be checked with: >
1803 if has('unnamedplus')
1804<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001805 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 autoselect Works like the 'a' flag in 'guioptions': If present,
1807 then whenever Visual mode is started, or the Visual
1808 area extended, Vim tries to become the owner of the
1809 windowing system's global selection or put the
1810 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001811 register "*. See |'go-a'| and |quotestar| for details.
1812 When the GUI is active, the 'a' flag in 'guioptions'
1813 is used, when the GUI is not active, this "autoselect"
1814 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 Also applies to the modeless selection.
1816
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001817 *clipboard-autoselectplus*
1818 autoselectplus Like "autoselect" but using the + register instead of
1819 the * register. Compare to the 'P' flag in
1820 'guioptions'.
1821
1822 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 autoselectml Like "autoselect", but for the modeless selection
1824 only. Compare to the 'A' flag in 'guioptions'.
1825
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001826 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001827 html When the clipboard contains HTML, use this when
1828 pasting. When putting text on the clipboard, mark it
1829 as HTML. This works to copy rendered HTML from
1830 Firefox, paste it as raw HTML in Vim, select the HTML
1831 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001832 You probably want to add this only temporarily,
1833 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001834 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001835
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001836 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 exclude:{pattern}
1838 Defines a pattern that is matched against the name of
1839 the terminal 'term'. If there is a match, no
1840 connection will be made to the X server. This is
1841 useful in this situation:
1842 - Running Vim in a console.
1843 - $DISPLAY is set to start applications on another
1844 display.
1845 - You do not want to connect to the X server in the
1846 console, but do want this in a terminal emulator.
1847 To never connect to the X server use: >
1848 exclude:.*
1849< This has the same effect as using the |-X| argument.
1850 Note that when there is no connection to the X server
1851 the window title won't be restored and the clipboard
1852 cannot be accessed.
1853 The value of 'magic' is ignored, {pattern} is
1854 interpreted as if 'magic' was on.
1855 The rest of the option value will be used for
1856 {pattern}, this must be the last entry.
1857
1858 *'cmdheight'* *'ch'*
1859'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001860 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001861 Number of screen lines to use for the command-line. A larger value
1862 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001863 The value of this option is stored with the tab page, so that each tab
1864 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
1866 *'cmdwinheight'* *'cwh'*
1867'cmdwinheight' 'cwh' number (default 7)
1868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 Number of screen lines to use for the command-line window. |cmdwin|
1870
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001871 *'colorcolumn'* *'cc'*
1872'colorcolumn' 'cc' string (default "")
1873 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001874 {not available when compiled without the |+syntax|
1875 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001876 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001877 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1878 text. Will make screen redrawing slower.
1879 The screen column can be an absolute number, or a number preceded with
1880 '+' or '-', which is added to or subtracted from 'textwidth'. >
1881
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001882 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001883 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1884 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1885<
1886 When 'textwidth' is zero then the items with '-' and '+' are not used.
1887 A maximum of 256 columns are highlighted.
1888
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 *'columns'* *'co'* *E594*
1890'columns' 'co' number (default 80 or terminal width)
1891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001893 initialization and does not have to be set by hand. Also see
1894 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 When Vim is running in the GUI or in a resizable window, setting this
1896 option will cause the window size to be changed. When you only want
1897 to use the size for the GUI, put the command in your |gvimrc| file.
1898 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001899 number of columns of the display, the display may be messed up. For
1900 the GUI it is always possible and Vim limits the number of columns to
1901 what fits on the screen. You can use this command to get the widest
1902 window possible: >
1903 :set columns=9999
1904< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905
1906 *'comments'* *'com'* *E524* *E525*
1907'comments' 'com' string (default
1908 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1909 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001910 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 |format-comments|. See |option-backslash| about using backslashes to
1912 insert a space.
1913
1914 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001915'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 {not available when compiled without the |+folding|
1918 feature}
1919 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001920 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001921 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001922 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923
1924 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001925'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001926 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 This option has the effect of making Vim either more Vi-compatible, or
1929 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001930
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932 other options are also changed as a side effect.
1933 NOTE: Setting or resetting this option can have a lot of unexpected
1934 effects: Mappings are interpreted in another way, undo behaves
1935 differently, etc. If you set this option in your vimrc file, you
1936 should probably put it at the very start.
1937
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 By default this option is on and the Vi defaults are used for the
1939 options. This default was chosen for those people who want to use Vim
1940 just like Vi, and don't even (want to) know about the 'compatible'
1941 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001942 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001943 this option is switched off, and all options that have not been
1944 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001945 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001946 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001947 happen for the system-wide vimrc or gvimrc file, nor for a file given
1948 with the |-u| argument). Also see |compatible-default| and
1949 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 You can also set this option with the "-C" argument, and reset it with
1951 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001952 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 When this option is set, numerous other options are set to make Vim as
1955 Vi-compatible as possible. When this option is unset, various options
1956 are set to make Vim more useful. The table below lists all the
1957 options affected.
1958 The {?} column indicates when the options are affected:
1959 + Means that the option is set to the value given in {set value} when
1960 'compatible' is set.
1961 & Means that the option is set to the value given in {set value} when
1962 'compatible' is set AND is set to its Vim default value when
1963 'compatible' is unset.
1964 - Means the option is NOT changed when setting 'compatible' but IS
1965 set to its Vim default when 'compatible' is unset.
1966 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967
Bram Moolenaar036986f2017-03-16 17:41:02 +01001968 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969
1970 'allowrevins' + off no CTRL-_ command
1971 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001972 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001973 'arabicshape' + on correct character shapes
1974 'backspace' + "" normal backspace
1975 'backup' + off no backup file
1976 'backupcopy' & Unix: "yes" backup file is a copy
1977 else: "auto" copy or rename backup file
1978 'balloonexpr' + "" text to show in evaluation balloon
1979 'breakindent' + off don't indent when wrapping lines
1980 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001981 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001982 'cindent' + off no C code indentation
1983 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1984 'copyindent' + off don't copy indent structure
1985 'cpoptions' & (all flags) Vi-compatible flags
1986 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001987 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001988 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001989 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopeverbose' + off see |cscopeverbose|
1991 'delcombine' + off unicode: delete whole char combination
1992 'digraph' + off no digraphs
1993 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001994 this also disables |modifyOtherKeys|
1995 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001996 'expandtab' + off tabs not expanded to spaces
1997 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001998 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001999 'formatexpr' + "" use 'formatprg' for auto-formatting
2000 'formatoptions' & "vt" Vi compatible formatting
2001 'gdefault' + off no default 'g' flag for ":s"
2002 'history' & 0 no commandline history
2003 'hkmap' + off no Hebrew keyboard mapping
2004 'hkmapp' + off no phonetic Hebrew keyboard mapping
2005 'hlsearch' + off no highlighting of search matches
2006 'incsearch' + off no incremental searching
2007 'indentexpr' + "" no indenting by expression
2008 'insertmode' + off do not start in Insert mode
2009 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002011 'joinspaces' + on insert 2 spaces after period
2012 'modeline' & off no modelines
2013 'more' & off no pauses in listings
2014 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2015 'numberwidth' & 8 min number of columns for line number
2016 'preserveindent'+ off don't preserve current indent structure
2017 when changing it
2018 'revins' + off no reverse insert
2019 'ruler' + off no ruler
2020 'scrolljump' + 1 no jump scroll
2021 'scrolloff' + 0 no scroll offset
2022 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2023 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002024 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002025 'showcmd' & off command characters not shown
2026 'showmode' & off current mode not shown
2027 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2028 'smartcase' + off no automatic ignore case switch
2029 'smartindent' + off no smart indentation
2030 'smarttab' + off no smart tab size
2031 'softtabstop' + 0 tabs are always 'tabstop' positions
2032 'startofline' + on goto startofline with some commands
2033 'tagcase' & "followic" 'ignorecase' when searching tags file
2034 'tagrelative' & off tag file names are not relative
2035 'termguicolors' + off don't use highlight-(guifg|guibg)
2036 'textauto' & off no automatic textmode detection
2037 'textwidth' + 0 no automatic line wrap
2038 'tildeop' + off tilde is not an operator
2039 'ttimeout' + off no terminal timeout
2040 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002041 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002042 'virtualedit' + "" cursor can only be placed on characters
2043 'whichwrap' & "" left-right movements don't wrap
2044 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002046 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047
2048 *'complete'* *'cpt'* *E535*
2049'complete' 'cpt' string (default: ".,w,b,u,t,i")
2050 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 This option specifies how keyword completion |ins-completion| works
2052 when CTRL-P or CTRL-N are used. It is also used for whole-line
2053 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002054 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002055 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 w scan buffers from other windows
2057 b scan other loaded buffers that are in the buffer list
2058 u scan the unloaded buffers that are in the buffer list
2059 U scan the buffers that are not in the buffer list
2060 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002061 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 k{dict} scan the file {dict}. Several "k" flags can be given,
2063 patterns are valid too. For example: >
2064 :set cpt=k/usr/dict/*,k~/spanish
2065< s scan the files given with the 'thesaurus' option
2066 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2067 are valid too.
2068 i scan current and included files
2069 d scan current and included files for defined name or macro
2070 |i_CTRL-X_CTRL-D|
2071 ] tag completion
2072 t same as "]"
2073
2074 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2075 not executed, this may lead to unexpected completions from some files
2076 (gzipped files for example). Unloaded buffers are not scanned for
2077 whole-line completion.
2078
2079 The default is ".,w,b,u,t,i", which means to scan:
2080 1. the current buffer
2081 2. buffers in other windows
2082 3. other loaded buffers
2083 4. unloaded buffers
2084 5. tags
2085 6. included files
2086
2087 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002088 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2089 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002091 *'completefunc'* *'cfu'*
2092'completefunc' 'cfu' string (default: empty)
2093 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002094 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002095 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002096 This option specifies a function to be used for Insert mode completion
2097 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002098 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002099 invoked and what it should return. The value can be the name of a
2100 function, a |lambda| or a |Funcref|. See |option-value-function| for
2101 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002102 This option cannot be set from a |modeline| or in the |sandbox|, for
2103 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002104
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002105 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002106'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002107 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002108 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002109 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002110
2111 menu Use a popup menu to show the possible completions. The
2112 menu is only shown when there is more than one match and
2113 sufficient colors are available. |ins-completion-menu|
2114
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002115 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002116 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002117 match, e.g., what file it comes from.
2118
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002119 longest Only insert the longest common text of the matches. If
2120 the menu is displayed you can use CTRL-L to add more
2121 characters. Whether case is ignored depends on the kind
2122 of completion. For buffer text the 'ignorecase' option is
2123 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002124
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002125 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002126 completion in the preview window. Only works in
2127 combination with "menu" or "menuone".
2128
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002129 popup Show extra information about the currently selected
2130 completion in a popup window. Only works in combination
2131 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002132 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002133 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002134
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002135 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002136 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002137 |CompleteChanged| autocommand to fetch the info and call
2138 |popup_show()| once the popup has been filled.
2139 See the example at |complete-popuphidden|.
2140 {only works when compiled with the |+textprop| feature}
2141
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002142 noinsert Do not insert any text for a match until the user selects
2143 a match from the menu. Only works in combination with
2144 "menu" or "menuone". No effect if "longest" is present.
2145
2146 noselect Do not select a match in the menu, force the user to
2147 select one from the menu. Only works in combination with
2148 "menu" or "menuone".
2149
glepnira218cc62024-06-03 19:32:39 +02002150 fuzzy Enable |fuzzy-matching| for completion candidates. This
2151 allows for more flexible and intuitive matching, where
2152 characters can be skipped and matches can be found even
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002153 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002154
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002155 *'completepopup'* *'cpp'*
2156'completepopup' 'cpp' string (default empty)
2157 global
2158 {not available when compiled without the |+textprop|
2159 or |+quickfix| feature}
2160 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002161 properties of the info popup when it is created. If an info popup
2162 window already exists it is closed, so that the option value is
2163 applied when it is created again.
2164 You can also use |popup_findinfo()| and then set properties for an
2165 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002166
laburnumT3f7855a2023-12-05 18:37:03 +01002167 *'completeslash'* *'csl'*
2168'completeslash' 'csl' string (default: "")
2169 local to buffer
2170 {only for MS-Windows}
2171 When this option is set it overrules 'shellslash' for completion:
2172 - When this option is set to "slash", a forward slash is used for path
2173 completion in insert mode. This is useful when editing HTML tag, or
2174 Makefile with 'noshellslash' on MS-Windows.
2175 - When this option is set to "backslash", backslash is used. This is
2176 useful when editing a batch file with 'shellslash' set on MS-Windows.
2177 - When this option is empty, same character is used as for
2178 'shellslash'.
2179 For Insert mode completion the buffer-local value is used. For
2180 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002181
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002182 *'concealcursor'* *'cocu'*
2183'concealcursor' 'cocu' string (default: "")
2184 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002185 {not available when compiled without the |+conceal|
2186 feature}
2187 Sets the modes in which text in the cursor line can also be concealed.
2188 When the current mode is listed then concealing happens just like in
2189 other lines.
2190 n Normal mode
2191 v Visual mode
2192 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002193 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002194
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002195 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002196 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002197 are moving around text is concealed, but when starting to insert text
2198 or selecting a Visual area the concealed text is displayed, so that
2199 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002200 Keep in mind that the cursor position is not always where it's
2201 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002202
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002203 *'conceallevel'* *'cole'*
2204'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002205 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002206 {not available when compiled without the |+conceal|
2207 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002208 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2209 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002210
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002211 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002212 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002213 1 Each block of concealed text is replaced with one
2214 character. If the syntax item does not have a custom
2215 replacement character defined (see |:syn-cchar|) the
2216 character defined in 'listchars' is used (default is a
2217 space).
2218 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002219 2 Concealed text is completely hidden unless it has a
2220 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002221 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002222 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223
Bram Moolenaara7781e02010-07-19 20:13:22 +02002224 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002225 edit and copy the text. This can be changed with the 'concealcursor'
2226 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002227
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2229'confirm' 'cf' boolean (default off)
2230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 When 'confirm' is on, certain operations that would normally
2232 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2233 instead raise a |dialog| asking if you wish to save the current
2234 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2235 If 'confirm' is off you can still activate confirmation for one
2236 command only (this is most useful in mappings) with the |:confirm|
2237 command.
2238 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2239
2240 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2241'conskey' 'consk' boolean (default off)
2242 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002243 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244
2245 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2246'copyindent' 'ci' boolean (default off)
2247 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 Copy the structure of the existing lines indent when autoindenting a
2249 new line. Normally the new indent is reconstructed by a series of
2250 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2251 in which case only spaces are used). Enabling this option makes the
2252 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002253 existing line. 'expandtab' has no effect on these characters, a Tab
2254 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002256 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 Also see 'preserveindent'.
2258
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002259 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002260'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2261 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002262 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002265 this indicates Vi-compatible behavior. This is used for things where
2266 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 'cpoptions' stands for "compatible-options".
2268 Commas can be added for readability.
2269 To avoid problems with flags that are added in the future, use the
2270 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002271
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 NOTE: This option is set to the Vi default value when 'compatible' is
2273 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002274
2275 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2276 is saved, 'cpoptions' is set to the Vim default, and the saved value
2277 is restored at the end of the script. Changes to the value of
2278 'cpoptions' will be applied to the saved value, but keep in mind that
2279 removing a flag that is not present when 'cpoptions' is changed has no
2280 effect. In the |.vimrc| file the value is not restored, thus using
2281 `vim9script` in the |.vimrc| file results in using the Vim default.
2282
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002283 NOTE: This option is set to the POSIX default value at startup when
2284 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002285 variable exists |posix|. This means Vim tries to behave like the
2286 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287
2288 contains behavior ~
2289 *cpo-a*
2290 a When included, a ":read" command with a file name
2291 argument will set the alternate file name for the
2292 current window.
2293 *cpo-A*
2294 A When included, a ":write" command with a file name
2295 argument will set the alternate file name for the
2296 current window.
2297 *cpo-b*
2298 b "\|" in a ":map" command is recognized as the end of
2299 the map command. The '\' is included in the mapping,
2300 the text after the '|' is interpreted as the next
2301 command. Use a CTRL-V instead of a backslash to
2302 include the '|' in the mapping. Applies to all
2303 mapping, abbreviation, menu and autocmd commands.
2304 See also |map_bar|.
2305 *cpo-B*
2306 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002307 abbreviations, user commands and the "to" part of the
2308 menu commands. Remove this flag to be able to use a
2309 backslash like a CTRL-V. For example, the command
2310 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 'B' included: "\^[" (^[ is a real <Esc>)
2312 'B' excluded: "<Esc>" (5 characters)
2313 ('<' excluded in both cases)
2314 *cpo-c*
2315 c Searching continues at the end of any match at the
2316 cursor position, but not further than the start of the
2317 next line. When not present searching continues
2318 one character from the cursor position. With 'c'
2319 "abababababab" only gets three matches when repeating
2320 "/abab", without 'c' there are five matches.
2321 *cpo-C*
2322 C Do not concatenate sourced lines that start with a
2323 backslash. See |line-continuation|.
2324 *cpo-d*
2325 d Using "./" in the 'tags' option doesn't mean to use
2326 the tags file relative to the current file, but the
2327 tags file in the current directory.
2328 *cpo-D*
2329 D Can't use CTRL-K to enter a digraph after Normal mode
2330 commands with a character argument, like |r|, |f| and
2331 |t|.
2332 *cpo-e*
2333 e When executing a register with ":@r", always add a
2334 <CR> to the last line, also when the register is not
2335 linewise. If this flag is not present, the register
2336 is not linewise and the last line does not end in a
2337 <CR>, then the last line is put on the command-line
2338 and can be edited before hitting <CR>.
2339 *cpo-E*
2340 E It is an error when using "y", "d", "c", "g~", "gu" or
2341 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002342 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 This makes "y0" fail in the first column.
2344 *cpo-f*
2345 f When included, a ":read" command with a file name
2346 argument will set the file name for the current buffer,
2347 if the current buffer doesn't have a file name yet.
2348 *cpo-F*
2349 F When included, a ":write" command with a file name
2350 argument will set the file name for the current
2351 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002352 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 *cpo-g*
2354 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355 *cpo-H*
2356 H When using "I" on a line with only blanks, insert
2357 before the last blank. Without this flag insert after
2358 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 *cpo-i*
2360 i When included, interrupting the reading of a file will
2361 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 *cpo-I*
2363 I When moving the cursor up or down just after inserting
2364 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 *cpo-j*
2366 j When joining lines, only add two spaces after a '.',
2367 not after '!' or '?'. Also see 'joinspaces'.
2368 *cpo-J*
2369 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002370 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 white space.
2372 *cpo-k*
2373 k Disable the recognition of raw key codes in
2374 mappings, abbreviations, and the "to" part of menu
2375 commands. For example, if <Key> sends ^[OA (where ^[
2376 is <Esc>), the command ":map X ^[OA" results in X
2377 being mapped to:
2378 'k' included: "^[OA" (3 characters)
2379 'k' excluded: "<Key>" (one key code)
2380 Also see the '<' flag below.
2381 *cpo-K*
2382 K Don't wait for a key code to complete when it is
2383 halfway a mapping. This breaks mapping <F1><F1> when
2384 only part of the second <F1> has been read. It
2385 enables cancelling the mapping by typing <F1><Esc>.
2386 *cpo-l*
2387 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002388 literally, only "\]", "\^", "\-" and "\\" are special.
2389 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2391 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002392 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 *cpo-L*
2394 L When the 'list' option is set, 'wrapmargin',
2395 'textwidth', 'softtabstop' and Virtual Replace mode
2396 (see |gR|) count a <Tab> as two characters, instead of
2397 the normal behavior of a <Tab>.
2398 *cpo-m*
2399 m When included, a showmatch will always wait half a
2400 second. When not included, a showmatch will wait half
2401 a second or until a character is typed. |'showmatch'|
2402 *cpo-M*
2403 M When excluded, "%" matching will take backslashes into
2404 account. Thus in "( \( )" and "\( ( \)" the outer
2405 parenthesis match. When included "%" ignores
2406 backslashes, which is Vi compatible.
2407 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002408 n When included, the column used for 'number' and
2409 'relativenumber' will also be used for text of wrapped
2410 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 *cpo-o*
2412 o Line offset to search command is not remembered for
2413 next search.
2414 *cpo-O*
2415 O Don't complain if a file is being overwritten, even
2416 when it didn't exist when editing it. This is a
2417 protection against a file unexpectedly created by
2418 someone else. Vi didn't complain about this.
2419 *cpo-p*
2420 p Vi compatible Lisp indenting. When not present, a
2421 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002422 *cpo-P*
2423 P When included, a ":write" command that appends to a
2424 file will set the file name for the current buffer, if
2425 the current buffer doesn't have a file name yet and
2426 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002427 *cpo-q*
2428 q When joining multiple lines leave the cursor at the
2429 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 *cpo-r*
2431 r Redo ("." command) uses "/" to repeat a search
2432 command, instead of the actually used search string.
2433 *cpo-R*
2434 R Remove marks from filtered lines. Without this flag
2435 marks are kept like |:keepmarks| was used.
2436 *cpo-s*
2437 s Set buffer options when entering the buffer for the
2438 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002439 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 set when the buffer is created.
2441 *cpo-S*
2442 S Set buffer options always when entering a buffer
2443 (except 'readonly', 'fileformat', 'filetype' and
2444 'syntax'). This is the (most) Vi compatible setting.
2445 The options are set to the values in the current
2446 buffer. When you change an option and go to another
2447 buffer, the value is copied. Effectively makes the
2448 buffer options global to all buffers.
2449
2450 's' 'S' copy buffer options
2451 no no when buffer created
2452 yes no when buffer first entered (default)
2453 X yes each time when buffer entered (vi comp.)
2454 *cpo-t*
2455 t Search pattern for the tag command is remembered for
2456 "n" command. Otherwise Vim only puts the pattern in
2457 the history for search pattern, but doesn't change the
2458 last used search pattern.
2459 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002460 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 *cpo-v*
2462 v Backspaced characters remain visible on the screen in
2463 Insert mode. Without this flag the characters are
2464 erased from the screen right away. With this flag the
2465 screen newly typed text overwrites backspaced
2466 characters.
2467 *cpo-w*
2468 w When using "cw" on a blank character, only change one
2469 character and not all blanks until the start of the
2470 next word.
2471 *cpo-W*
2472 W Don't overwrite a readonly file. When omitted, ":w!"
2473 overwrites a readonly file, if possible.
2474 *cpo-x*
2475 x <Esc> on the command-line executes the command-line.
2476 The default in Vim is to abandon the command-line,
2477 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002478 *cpo-X*
2479 X When using a count with "R" the replaced text is
2480 deleted only once. Also when repeating "R" with "."
2481 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002483 y A yank command can be redone with ".". Think twice if
2484 you really want to use this, it may break some
2485 plugins, since most people expect "." to only repeat a
2486 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002487 *cpo-Z*
2488 Z When using "w!" while the 'readonly' option is set,
2489 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002490 *cpo-z*
2491 z Special casing the "cw" and "d" command (see |cw| and
2492 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 *cpo-!*
2494 ! When redoing a filter command, use the last used
2495 external command, whatever it was. Otherwise the last
2496 used -filter- command is used.
2497 *cpo-$*
2498 $ When making a change to one line, don't redisplay the
2499 line, but put a '$' at the end of the changed text.
2500 The changed text will be overwritten when you type the
2501 new text. The line is redisplayed if you type any
2502 command that moves the cursor from the insertion
2503 point.
2504 *cpo-%*
2505 % Vi-compatible matching is done for the "%" command.
2506 Does not recognize "#if", "#endif", etc.
2507 Does not recognize "/*" and "*/".
2508 Parens inside single and double quotes are also
2509 counted, causing a string that contains a paren to
2510 disturb the matching. For example, in a line like
2511 "if (strcmp("foo(", s))" the first paren does not
2512 match the last one. When this flag is not included,
2513 parens inside single and double quotes are treated
2514 specially. When matching a paren outside of quotes,
2515 everything inside quotes is ignored. When matching a
2516 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002517 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002518 This flag is also used for other features, such as
2519 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002520 *cpo--*
2521 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002522 it would go above the first line or below the last
2523 line. Without it the cursor moves to the first or
2524 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002525 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002526 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002527 *cpo-+*
2528 + When included, a ":write file" command will reset the
2529 'modified' flag of the buffer, even though the buffer
2530 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002531 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 * Use ":*" in the same way as ":@". When not included,
2533 ":*" is an alias for ":'<,'>", select the Visual area.
2534 *cpo-<*
2535 < Disable the recognition of special key codes in |<>|
2536 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002537 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 ":map X <Tab>" results in X being mapped to:
2539 '<' included: "<Tab>" (5 characters)
2540 '<' excluded: "^I" (^I is a real <Tab>)
2541 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002542 *cpo->*
2543 > When appending to a register, put a line break before
2544 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002545 *cpo-;*
2546 ; When using |,| or |;| to repeat the last |t| search
2547 and the cursor is right in front of the searched
2548 character, the cursor won't move. When not included,
2549 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002550 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002551
2552 POSIX flags. These are not included in the Vi default value, except
2553 when $VIM_POSIX was set on startup. |posix|
2554
2555 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002556 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002557 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002558 *cpo-&*
2559 & When ":preserve" was used keep the swap file when
2560 exiting normally while this buffer is still loaded.
2561 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002562 *cpo-\*
2563 \ Backslash in a [] range in a search pattern is taken
2564 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002565 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2566 '\' excluded: "/[ \-]" finds <Space> and '-'
2567 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002568 *cpo-/*
2569 / When "%" is used as the replacement string in a |:s|
2570 command, use the previous replacement string. |:s%|
2571 *cpo-{*
2572 { The |{| and |}| commands also stop at a "{" character
2573 at the start of a line.
2574 *cpo-.*
2575 . The ":chdir" and ":cd" commands fail if the current
2576 buffer is modified, unless ! is used. Vim doesn't
2577 need this, since it remembers the full path of an
2578 opened file.
2579 *cpo-bar*
2580 | The value of the $LINES and $COLUMNS environment
2581 variables overrule the terminal size values obtained
2582 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002583
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002584 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002585'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002586 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002587 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002588 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002589 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002590 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002591 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002592 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002593 blowfish Blowfish method. Medium strong encryption but it has
2594 an implementation flaw. Requires Vim 7.3 or later,
2595 files can NOT be read by Vim 7.2 and older. This adds
2596 a "seed" to the file, every time you write the file
2597 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002598 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002599 *blowfish2*
2600 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002601 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002602 and older. This adds a "seed" to the file, every time
2603 you write the file the encrypted bytes will be
2604 different. The whole undo file is encrypted, not just
2605 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002606 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002607 *E1197* *E1198* *E1199* *E1200* *E1201*
2608 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2609 Code. Medium strong till strong encryption.
2610 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002611 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002612 It adds a seed and a message authentication code (MAC)
2613 to the file. This needs at least a Vim 8.2.3022 to
2614 read the encrypted file.
2615 Encryption of swap files is not supported, therefore
2616 no swap file will be used when xchacha20 encryption is
2617 enabled.
2618 Encryption of undo files is not yet supported,
2619 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002620 CAREFUL: Files written with this method might have to
2621 be read back with the same version of Vim if the
2622 binary format changes later.
2623 Obsolete, please do no longer use.
2624 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2625 stores the key derivation parameters together with the
2626 encrypted file. Should work better in case the
2627 parameters in the libsodium library ever change.
2628 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002629 might have to be read back with the same version of
2630 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002631
Christian Brabandtaae58342023-04-23 17:50:22 +01002632 You should use "blowfish2", also to re-encrypt older files. The
2633 "xchacha20" method provides better encryption, but it does not work
2634 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002635
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002636 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002637 to the detected method of the file being read. Thus if you write it
2638 without changing 'cryptmethod' the same method will be used.
2639 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002640 explicitly write it, you don't get a warning unless there are other
2641 modifications. Also see |:X|.
2642
2643 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002644 the value "blowfish2". When setting the local value to an empty
2645 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002646
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002647 When a new encryption method is added in a later version of Vim, and
2648 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002649 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002650
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 *'cscopepathcomp'* *'cspc'*
2652'cscopepathcomp' 'cspc' number (default 0)
2653 global
2654 {not available when compiled without the |+cscope|
2655 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 Determines how many components of the path to show in a list of tags.
2657 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002658 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659
2660 *'cscopeprg'* *'csprg'*
2661'cscopeprg' 'csprg' string (default "cscope")
2662 global
2663 {not available when compiled without the |+cscope|
2664 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 Specifies the command to execute cscope. See |cscopeprg|.
2666 This option cannot be set from a |modeline| or in the |sandbox|, for
2667 security reasons.
2668
2669 *'cscopequickfix'* *'csqf'*
2670'cscopequickfix' 'csqf' string (default "")
2671 global
2672 {not available when compiled without the |+cscope|
2673 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 Specifies whether to use quickfix window to show cscope results.
2675 See |cscopequickfix|.
2676
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002677 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002678'cscoperelative' 'csre' boolean (default off)
2679 global
2680 {not available when compiled without the |+cscope|
2681 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002682 In the absence of a prefix (-P) for cscope. setting this option enables
2683 to use the basename of cscope.out path as the prefix.
2684 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002685 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002686
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2688'cscopetag' 'cst' boolean (default off)
2689 global
2690 {not available when compiled without the |+cscope|
2691 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 Use cscope for tag commands. See |cscope-options|.
2693 NOTE: This option is reset when 'compatible' is set.
2694
2695 *'cscopetagorder'* *'csto'*
2696'cscopetagorder' 'csto' number (default 0)
2697 global
2698 {not available when compiled without the |+cscope|
2699 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 Determines the order in which ":cstag" performs a search. See
2701 |cscopetagorder|.
2702 NOTE: This option is set to 0 when 'compatible' is set.
2703
2704 *'cscopeverbose'* *'csverb'*
2705 *'nocscopeverbose'* *'nocsverb'*
2706'cscopeverbose' 'csverb' boolean (default off)
2707 global
2708 {not available when compiled without the |+cscope|
2709 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 Give messages when adding a cscope database. See |cscopeverbose|.
2711 NOTE: This option is reset when 'compatible' is set.
2712
Bram Moolenaar860cae12010-06-05 23:22:07 +02002713 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2714'cursorbind' 'crb' boolean (default off)
2715 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002716 When this option is set, as the cursor in the current
2717 window moves other cursorbound windows (windows that also have
2718 this option set) move their cursors to the corresponding line and
2719 column. This option is useful for viewing the
2720 differences between two versions of a file (see 'diff'); in diff mode,
2721 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002722 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002723
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002724 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2725'cursorcolumn' 'cuc' boolean (default off)
2726 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002727 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002728 feature}
2729 Highlight the screen column of the cursor with CursorColumn
2730 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2731 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002732 If you only want the highlighting in the current window you can use
2733 these autocommands: >
2734 au WinLeave * set nocursorline nocursorcolumn
2735 au WinEnter * set cursorline cursorcolumn
2736<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002737
2738 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2739'cursorline' 'cul' boolean (default off)
2740 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002741 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002742 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002743 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2744 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002745 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002746 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002747
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002748 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002749'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002750 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002751 {not available when compiled without the |+syntax|
2752 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002753 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002754 Valid values:
2755 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002756 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002757 "screenline" Highlight only the screen line of the cursor with
2758 CursorLine |hl-CursorLine|.
2759 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002760 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002761
2762 Special value:
2763 "both" Alias for the values "line,number".
2764
2765 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002766
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 *'debug'*
2768'debug' string (default "")
2769 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002770 These values can be used:
2771 msg Error messages that would otherwise be omitted will be given
2772 anyway.
2773 throw Error messages that would otherwise be omitted will be given
2774 anyway and also throw an exception and set |v:errmsg|.
2775 beep A message will be given when otherwise only a beep would be
2776 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002777 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002778 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2779 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780
2781 *'define'* *'def'*
2782'define' 'def' string (default "^\s*#\s*define")
2783 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002784 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 pattern, just like for the "/" command. This option is used for the
2786 commands like "[i" and "[d" |include-search|. The 'isident' option is
2787 used to recognize the defined name after the match:
2788 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2789 See |option-backslash| about inserting backslashes to include a space
2790 or backslash.
2791 The default value is for C programs. For C++ this value would be
2792 useful, to include const type declarations: >
2793 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002794< You can also use "\ze" just before the name and continue the pattern
2795 to check what is following. E.g. for Javascript, if a function is
2796 defined with "func_name = function(args)": >
2797 ^\s*\ze\i\+\s*=\s*function(
2798< If the function is defined with "func_name : function() {...": >
2799 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002801 To avoid that use `:let` with a single quote string: >
2802 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002803<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804
2805 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2806'delcombine' 'deco' boolean (default off)
2807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 If editing Unicode and this option is set, backspace and Normal mode
2809 "x" delete each combining character on its own. When it is off (the
2810 default) the character along with its combining characters are
2811 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002812 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813
2814 This is useful for Arabic, Hebrew and many other languages where one
2815 may have combining characters overtop of base characters, and want
2816 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002817 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818
2819 *'dictionary'* *'dict'*
2820'dictionary' 'dict' string (default "")
2821 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 List of file names, separated by commas, that are used to lookup words
2823 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2824 contain a list of words. This can be one word per line, or several
2825 words per line, separated by non-keyword characters (white space is
2826 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002827
2828 When this option is empty or an entry "spell" is present, and spell
2829 checking is enabled, words in the word lists for the currently active
2830 'spelllang' are used. See |spell|.
2831
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002832 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 after a comma are ignored, otherwise spaces are included in the file
2834 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002835 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 Where to find a list of words?
2837 - On FreeBSD, there is the file "/usr/share/dict/words".
2838 - In the Simtel archive, look in the "msdos/linguist" directory.
2839 - In "miscfiles" of the GNU collection.
2840 The use of |:set+=| and |:set-=| is preferred when adding or removing
2841 directories from the list. This avoids problems when a future version
2842 uses another default.
2843 Backticks cannot be used in this option for security reasons.
2844
2845 *'diff'* *'nodiff'*
2846'diff' boolean (default off)
2847 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 {not available when compiled without the |+diff|
2849 feature}
2850 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002851 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
2853 *'dex'* *'diffexpr'*
2854'diffexpr' 'dex' string (default "")
2855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 {not available when compiled without the |+diff|
2857 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002858 Expression which is evaluated to obtain a diff file (either ed-style
2859 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 This option cannot be set from a |modeline| or in the |sandbox|, for
2861 security reasons.
2862
2863 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002864'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 {not available when compiled without the |+diff|
2867 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002868 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 All are optional. Items must be separated by a comma.
2870
2871 filler Show filler lines, to keep the text
2872 synchronized with a window that has inserted
2873 lines at the same position. Mostly useful
2874 when windows are side-by-side and 'scrollbind'
2875 is set.
2876
2877 context:{n} Use a context of {n} lines between a change
2878 and a fold that contains unchanged lines.
2879 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002880 When using zero the context is actually one,
2881 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002882 for a deleted line. Set it to a very large
2883 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 See |fold-diff|.
2885
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002886 iblank Ignore changes where lines are all blank. Adds
2887 the "-B" flag to the "diff" command if
2888 'diffexpr' is empty. Check the documentation
2889 of the "diff" command for what this does
2890 exactly.
2891 NOTE: the diff windows will get out of sync,
2892 because no differences between blank lines are
2893 taken into account.
2894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 icase Ignore changes in case of text. "a" and "A"
2896 are considered the same. Adds the "-i" flag
2897 to the "diff" command if 'diffexpr' is empty.
2898
2899 iwhite Ignore changes in amount of white space. Adds
2900 the "-b" flag to the "diff" command if
2901 'diffexpr' is empty. Check the documentation
2902 of the "diff" command for what this does
2903 exactly. It should ignore adding trailing
2904 white space, but not leading white space.
2905
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002906 iwhiteall Ignore all white space changes. Adds
2907 the "-w" flag to the "diff" command if
2908 'diffexpr' is empty. Check the documentation
2909 of the "diff" command for what this does
2910 exactly.
2911
2912 iwhiteeol Ignore white space changes at end of line.
2913 Adds the "-Z" flag to the "diff" command if
2914 'diffexpr' is empty. Check the documentation
2915 of the "diff" command for what this does
2916 exactly.
2917
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002918 horizontal Start diff mode with horizontal splits (unless
2919 explicitly specified otherwise).
2920
2921 vertical Start diff mode with vertical splits (unless
2922 explicitly specified otherwise).
2923
Bram Moolenaarc8234772019-11-10 21:00:27 +01002924 closeoff When a window is closed where 'diff' is set
2925 and there is only one window remaining in the
2926 same tab page with 'diff' set, execute
2927 `:diffoff` in that window. This undoes a
2928 `:diffsplit` command.
2929
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002930 hiddenoff Do not use diff mode for a buffer when it
2931 becomes hidden.
2932
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002933 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2934 starting diff mode. Without this 2 is used.
2935
Bram Moolenaar4223d432021-02-10 13:18:17 +01002936 followwrap Follow the 'wrap' option and leave as it is.
2937
Bram Moolenaare828b762018-09-10 17:51:58 +02002938 internal Use the internal diff library. This is
2939 ignored when 'diffexpr' is set. *E960*
2940 When running out of memory when writing a
2941 buffer this item will be ignored for diffs
2942 involving that buffer. Set the 'verbose'
2943 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944
Bram Moolenaare828b762018-09-10 17:51:58 +02002945 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002946 Use the indent heuristic for the internal
2947 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002948
zeertzjqd086b8f2024-02-25 15:42:52 +08002949 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002950 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002951 algorithms are:
2952 myers the default algorithm
2953 minimal spend extra time to generate the
2954 smallest possible diff
2955 patience patience diff algorithm
2956 histogram histogram diff algorithm
2957
2958 Examples: >
2959 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002961 :set diffopt=internal,filler,foldcolumn:3
2962 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963<
2964 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2965'digraph' 'dg' boolean (default off)
2966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 {not available when compiled without the |+digraphs|
2968 feature}
2969 Enable the entering of digraphs in Insert mode with {char1} <BS>
2970 {char2}. See |digraphs|.
2971 NOTE: This option is reset when 'compatible' is set.
2972
2973 *'directory'* *'dir'*
2974'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002975 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 for Unix: ".,~/tmp,/var/tmp,/tmp")
2977 global
2978 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002979 Recommended value: ".,~/vimswap//" - this will put the swap file next
2980 to the edited file if possible, and in your personal swap directory
2981 otherwise. Make sure "~/vimswap//" is only readable for you.
2982
2983 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 - The swap file will be created in the first directory where this is
2985 possible.
2986 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002987 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 - A directory "." means to put the swap file in the same directory as
2989 the edited file. On Unix, a dot is prepended to the file name, so
2990 it doesn't show in a directory listing. On MS-Windows the "hidden"
2991 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002992 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2993 the swap file relative to where the edited file is. The leading "."
2994 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002995 - For Unix and Win32, if a directory ends in two path separators "//",
2996 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002997 with all path separators replaced by percent '%' signs (including
2998 the colon following the drive letter on Win32). This will ensure
2999 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003000 On Win32, it is also possible to end with "\\". However, When a
3001 separating comma is following, you must use "//", since "\\" will
3002 include the comma in the file name. Therefore it is recommended to
3003 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 - Spaces after the comma are ignored, other spaces are considered part
3005 of the directory name. To have a space at the start of a directory
3006 name, precede it with a backslash.
3007 - To include a comma in a directory name precede it with a backslash.
3008 - A directory name may end in an ':' or '/'.
3009 - Environment variables are expanded |:set_env|.
3010 - Careful with '\' characters, type one before a space, type two to
3011 get one in the option (see |option-backslash|), for example: >
3012 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3013< - For backwards compatibility with Vim version 3.0 a '>' at the start
3014 of the option is removed.
3015 Using "." first in the list is recommended. This means that editing
3016 the same file twice will result in a warning. Using "/tmp" on Unix is
3017 discouraged: When the system crashes you lose the swap file.
3018 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003019 choice than "/tmp". But others on the computer may be able to see the
3020 files, and it can contain a lot of files, your swap files get lost in
3021 the crowd. That is why a "tmp" directory in your home directory is
3022 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 The use of |:set+=| and |:set-=| is preferred when adding or removing
3024 directories from the list. This avoids problems when a future version
3025 uses another default.
3026 This option cannot be set from a |modeline| or in the |sandbox|, for
3027 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
3029 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003030'display' 'dy' string (default "", set to "truncate" in
3031 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003033 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 flags:
3035 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003036 in a window will be displayed. "@@@" is put in the
3037 last columns of the last screen line to indicate the
3038 rest of the line is not displayed.
3039 truncate Like "lastline", but "@@@" is displayed in the first
3040 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 uhex Show unprintable characters hexadecimal as <xx>
3042 instead of using ^C and ~C.
3043
Bram Moolenaard0796902016-09-16 20:02:31 +02003044 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003045 doesn't fit is replaced with "@" lines.
3046
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003047 The "@" character can be changed by setting the "lastline" item in
3048 'fillchars'. The character is highlighted with |hl-NonText|.
3049
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 *'eadirection'* *'ead'*
3051'eadirection' 'ead' string (default "both")
3052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 Tells when the 'equalalways' option applies:
3054 ver vertically, width of windows is not affected
3055 hor horizontally, height of windows is not affected
3056 both width and height of windows is affected
3057
3058 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3059'edcompatible' 'ed' boolean (default off)
3060 global
3061 Makes the 'g' and 'c' flags of the ":substitute" command to be
3062 toggled each time the flag is given. See |complex-change|. See
3063 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003064 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003065 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066
Bram Moolenaar03413f42016-04-12 21:07:15 +02003067 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003068'emoji' 'emo' boolean (default: on)
3069 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003070 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003071 This excludes "text emoji" characters, which are normally displayed as
3072 single width. Unfortunately there is no good specification for this
3073 and it has been determined on trial-and-error basis. Use the
3074 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003075
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003077'encoding' 'enc' string (default for MS-Windows: "utf-8",
3078 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 Sets the character encoding used inside Vim. It applies to text in
3081 the buffers, registers, Strings in expressions, text stored in the
3082 viminfo file, etc. It sets the kind of characters which Vim can work
3083 with. See |encoding-names| for the possible values.
3084
3085 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003086 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003088 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089
Bram Moolenaar865242e2010-07-14 21:12:05 +02003090 This option cannot be set from a |modeline|. It would most likely
3091 corrupt the text.
3092
Bram Moolenaar3df01732017-02-17 22:47:16 +01003093 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3094 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 'encoding', "utf-8" is the natural choice for the environment and
3096 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003097 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 versions, and to avoid changing the encoding of newly created files
3099 without your knowledge (in case 'fileencodings' is empty).
3100
3101 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003102 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 iconv() or as specified with 'charconvert'.
3104
Bram Moolenaar207f0092020-08-30 17:20:20 +02003105 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003106 can use: >
3107 if has("multi_byte_encoding")
3108<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 Normally 'encoding' will be equal to your current locale. This will
3110 be the default if Vim recognizes your environment settings. If
3111 'encoding' is not set to the current locale, 'termencoding' must be
3112 set to convert typed and displayed text. See |encoding-table|.
3113
3114 When you set this option, it fires the |EncodingChanged| autocommand
3115 event so that you can set up fonts if necessary.
3116
3117 When the option is set, the value is converted to lowercase. Thus
3118 you can set it with uppercase values too. Underscores are translated
3119 to '-' signs.
3120 When the encoding is recognized, it is changed to the standard name.
3121 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3122 "iso-8859-2" and "utf8" becomes "utf-8".
3123
3124 Note: "latin1" is also used when the encoding could not be detected.
3125 This only works when editing files in the same encoding! When the
3126 actual character set is not latin1, make sure 'fileencoding' and
3127 'fileencodings' are empty. When conversion is needed, switch to using
3128 utf-8.
3129
3130 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3131 You don't notice this while editing, but it does matter for the
3132 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3133 setting 'encoding' to one of these values instead of utf-8 only has
3134 effect for encoding used for files when 'fileencoding' is empty.
3135
Bram Moolenaar661b1822005-07-28 22:36:45 +00003136 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3137 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003139 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003140'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003142 Indicates that a CTRL-Z character was found at the end of the file
3143 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003145 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003146 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003147 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003148
3149 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3150'endofline' 'eol' boolean (default on)
3151 local to buffer
3152 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003153 is on, or 'fixeol' option is off, no <EOL> will be written for the
3154 last line in the file. This option is automatically set or reset when
3155 starting to edit a new file, depending on whether file has an <EOL>
3156 for the last line in the file. Normally you don't have to set or
3157 reset this option.
3158 When 'binary' is off and 'fixeol' is on the value is not used when
3159 writing the file. When 'binary' is on or 'fixeol' is off it is used
3160 to remember the presence of a <EOL> for the last line in the file, so
3161 that when you write the file the situation from the original file can
3162 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003163 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
3165 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3166'equalalways' 'ea' boolean (default on)
3167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003169 splitting or closing a window. This also happens the moment the
3170 option is switched on. When off, splitting a window will reduce the
3171 size of the current window and leave the other windows the same. When
3172 closing a window the extra lines are given to the window next to it
3173 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 When mixing vertically and horizontally split windows, a minimal size
3175 is computed and some windows may be larger if there is room. The
3176 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003177 Changing the height and width of a window can be avoided by setting
3178 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003179 If a window size is specified when creating a new window sizes are
3180 currently not equalized (it's complicated, but may be implemented in
3181 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
3183 *'equalprg'* *'ep'*
3184'equalprg' 'ep' string (default "")
3185 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003187 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003188 or 'indentexpr'. When Vim was compiled without internal formatting,
3189 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003190 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 about including spaces and backslashes.
3192 This option cannot be set from a |modeline| or in the |sandbox|, for
3193 security reasons.
3194
3195 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3196'errorbells' 'eb' boolean (default off)
3197 global
3198 Ring the bell (beep or screen flash) for error messages. This only
3199 makes a difference for error messages, the bell will be used always
3200 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003201 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003202 screen flash or do nothing. See 'belloff' to finetune when to ring the
3203 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204
3205 *'errorfile'* *'ef'*
3206'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3207 others: "errors.err")
3208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 {not available when compiled without the |+quickfix|
3210 feature}
3211 Name of the errorfile for the QuickFix mode (see |:cf|).
3212 When the "-q" command-line argument is used, 'errorfile' is set to the
3213 following argument. See |-q|.
3214 NOT used for the ":make" command. See 'makeef' for that.
3215 Environment variables are expanded |:set_env|.
3216 See |option-backslash| about including spaces and backslashes.
3217 This option cannot be set from a |modeline| or in the |sandbox|, for
3218 security reasons.
3219
3220 *'errorformat'* *'efm'*
3221'errorformat' 'efm' string (default is very long)
3222 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 {not available when compiled without the |+quickfix|
3224 feature}
3225 Scanf-like description of the format for the lines in the error file
3226 (see |errorformat|).
3227
3228 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3229'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 Function keys that start with an <Esc> are recognized in Insert
3232 mode. When this option is off, the cursor and function keys cannot be
3233 used in Insert mode if they start with an <Esc>. The advantage of
3234 this is that the single <Esc> is recognized immediately, instead of
3235 after one second. Instead of resetting this option, you might want to
3236 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3237 when 'esckeys' is off, you can still map anything, but the cursor keys
3238 won't work by default.
3239 NOTE: This option is set to the Vi default value when 'compatible' is
3240 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003241 NOTE: when this option is off then the |modifyOtherKeys| and
3242 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3243 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244
3245 *'eventignore'* *'ei'*
3246'eventignore' 'ei' string (default "")
3247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003249 When set to "all" or when "all" is one of the items, all autocommand
3250 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003251 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 :set ei=WinEnter,WinLeave
3253<
3254 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3255'expandtab' 'et' boolean (default off)
3256 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003258 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3260 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003261 This option is reset when the 'paste' option is set and restored when
3262 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 NOTE: This option is reset when 'compatible' is set.
3264
3265 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3266'exrc' 'ex' boolean (default off)
3267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003269 directory.
3270
3271 Setting this option is a potential security leak. E.g., consider
3272 unpacking a package or fetching files from github, a .vimrc in there
3273 might be a trojan horse. BETTER NOT SET THIS OPTION!
3274 Instead, define an autocommand in your .vimrc to set options for a
3275 matching directory.
3276
3277 If you do switch this option on you should also consider setting the
3278 'secure' option (see |initialization|).
3279 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 This option cannot be set from a |modeline| or in the |sandbox|, for
3281 security reasons.
3282
3283 *'fileencoding'* *'fenc'* *E213*
3284'fileencoding' 'fenc' string (default: "")
3285 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003287
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003289 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 When 'fileencoding' is empty, the same value as 'encoding' will be
3291 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003292 No error will be given when the value is set, only when it is used,
3293 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003294 Conversion will also be done when 'encoding' and 'fileencoding' are
3295 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3296 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003298 'encoding' is "utf-8" or another Unicode encoding, conversion
3299 is most likely done in a way that the reverse conversion
3300 results in the same text. When 'encoding' is not "utf-8" some
3301 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003302
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 See 'encoding' for the possible values. Additionally, values may be
3304 specified that can be handled by the converter, see
3305 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003306
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 When reading a file 'fileencoding' will be set from 'fileencodings'.
3308 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003309 'fileencoding', use the |++enc| argument. One exception: when
3310 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003311 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003312
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3314 When the option is set, the value is converted to lowercase. Thus
3315 you can set it with uppercase values too. '_' characters are
3316 replaced with '-'. If a name is recognized from the list for
3317 'encoding', it is replaced by the standard name. For example
3318 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 When this option is set, after starting to edit a file, the 'modified'
3321 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003322
3323 Keep in mind that changing 'fenc' from a modeline happens
3324 AFTER the text has been read, thus it applies to when the file will be
3325 written. If you do set 'fenc' in a modeline, you might want to set
3326 'nomodified' to avoid not being able to ":q".
3327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 This option can not be changed when 'modifiable' is off.
3329
3330 *'fe'*
3331 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003332 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 old short name was 'fe', which is no longer used.
3334
3335 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003336'fileencodings' 'fencs' string (default: "ucs-bom",
3337 "ucs-bom,utf-8,default,latin1" when
3338 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 This is a list of character encodings considered when starting to edit
3341 an existing file. When a file is read, Vim tries to use the first
3342 mentioned character encoding. If an error is detected, the next one
3343 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 an empty string, which means the value of 'encoding' is used.
3346 WARNING: Conversion can cause loss of information! When
3347 'encoding' is "utf-8" (or one of the other Unicode variants)
3348 conversion is most likely done in a way that the reverse
3349 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003350 "utf-8" some non-ASCII characters may be lost! You can use
3351 the |++bad| argument to specify what is done with characters
3352 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 For an empty file or a file with only ASCII characters most encodings
3354 will work and the first entry of 'fileencodings' will be used (except
3355 "ucs-bom", which requires the BOM to be present). If you prefer
3356 another encoding use an BufReadPost autocommand event to test if your
3357 preferred encoding is to be used. Example: >
3358 au BufReadPost * if search('\S', 'w') == 0 |
3359 \ set fenc=iso-2022-jp | endif
3360< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3361 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003362 When the |++enc| argument is used then the value of 'fileencodings' is
3363 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003364 Note that 'fileencodings' is not used for a new file, the global value
3365 of 'fileencoding' is used instead. You can set it with: >
3366 :setglobal fenc=iso-8859-2
3367< This means that a non-existing file may get a different encoding than
3368 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 The special value "ucs-bom" can be used to check for a Unicode BOM
3370 (Byte Order Mark) at the start of the file. It must not be preceded
3371 by "utf-8" or another Unicode encoding for this to work properly.
3372 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3373 because Vim cannot detect an error, thus the encoding is always
3374 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003375 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003376 environment. On MS-Windows this is the system encoding. Otherwise
3377 this is the default value for 'encoding'. It is useful when
3378 'encoding' is set to "utf-8" and your environment uses a non-latin1
3379 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003380 When 'encoding' is "utf-8" and a file contains an illegal byte
3381 sequence it won't be recognized as UTF-8. You can use the |8g8|
3382 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 WRONG VALUES: WHAT'S WRONG:
3384 latin1,utf-8 "latin1" will always be used
3385 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3386 file
3387 cp1250,latin1 "cp1250" will always be used
3388 If 'fileencodings' is empty, 'fileencoding' is not modified.
3389 See 'fileencoding' for the possible values.
3390 Setting this option does not have an effect until the next time a file
3391 is read.
3392
3393 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003394'fileformat' 'ff' string (MS-Windows default: "dos",
3395 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 This gives the <EOL> of the current buffer, which is used for
3398 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003399 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 unix <NL>
3401 mac <CR>
3402 When "dos" is used, CTRL-Z at the end of a file is ignored.
3403 See |file-formats| and |file-read|.
3404 For the character encoding of the file see 'fileencoding'.
3405 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003406 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 This option is set automatically when starting to edit a file and
3408 'fileformats' is not empty and 'binary' is off.
3409 When this option is set, after starting to edit a file, the 'modified'
3410 option is set, because the file would be different when written.
3411 This option can not be changed when 'modifiable' is off.
3412 For backwards compatibility: When this option is set to "dos",
3413 'textmode' is set, otherwise 'textmode' is reset.
3414
3415 *'fileformats'* *'ffs'*
3416'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003417 Vim+Vi MS-Windows: "dos,unix",
3418 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 Vi Cygwin: "unix,dos",
3420 Vi others: "")
3421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 This gives the end-of-line (<EOL>) formats that will be tried when
3423 starting to edit a new buffer and when reading a file into an existing
3424 buffer:
3425 - When empty, the format defined with 'fileformat' will be used
3426 always. It is not set automatically.
3427 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003428 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 'fileformats' name will be used when a file is read into an existing
3430 buffer, no matter what 'fileformat' for that buffer is set to.
3431 - When more than one name is present, separated by commas, automatic
3432 <EOL> detection will be done when reading a file. When starting to
3433 edit a file, a check is done for the <EOL>:
3434 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3435 'fileformat' is set to "dos".
3436 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003437 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003439 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3440 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003441 This means that "mac" is only chosen when:
3442 "unix" is not present or no <NL> is found in the file, and
3443 "dos" is not present or no <CR><NL> is found in the file.
3444 Except: if "unix" was chosen, but there is a <CR> before
3445 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003446 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 4. If 'fileformat' is still not set, the first name from
3448 'fileformats' is used.
3449 When reading a file into an existing buffer, the same is done, but
3450 this happens like 'fileformat' has been set appropriately for that
3451 file only, the option is not changed.
3452 When 'binary' is set, the value of 'fileformats' is not used.
3453
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003454 When Vim starts up with an empty buffer the first item is used. You
3455 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003456
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3458 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3459 done:
3460 - When 'fileformats' is empty, there is no automatic detection. Dos
3461 format will be used.
3462 - When 'fileformats' is set to one or more names, automatic detection
3463 is done. This is based on the first <NL> in the file: If there is a
3464 <CR> in front of it, Dos format is used, otherwise Unix format is
3465 used.
3466 Also see |file-formats|.
3467 For backwards compatibility: When this option is set to an empty
3468 string or one format (no comma is included), 'textauto' is reset,
3469 otherwise 'textauto' is set.
3470 NOTE: This option is set to the Vi default value when 'compatible' is
3471 set and to the Vim default value when 'compatible' is reset.
3472
Bram Moolenaarbf884932013-04-05 22:26:15 +02003473 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3474'fileignorecase' 'fic' boolean (default on for systems where case in file
3475 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003476 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003477 When set case is ignored when using file names and directories.
3478 See 'wildignorecase' for only ignoring case when doing completion.
3479
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 *'filetype'* *'ft'*
3481'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003482 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 When this option is set, the FileType autocommand event is triggered.
3484 All autocommands that match with the value of this option will be
3485 executed. Thus the value of 'filetype' is used in place of the file
3486 name.
3487 Otherwise this option does not always reflect the current file type.
3488 This option is normally set when the file type is detected. To enable
3489 this use the ":filetype on" command. |:filetype|
3490 Setting this option to a different value is most useful in a modeline,
3491 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003492 Example, for in an IDL file:
3493 /* vim: set filetype=idl : */ ~
3494 |FileType| |filetypes|
3495 When a dot appears in the value then this separates two filetype
3496 names. Example:
3497 /* vim: set filetype=c.doxygen : */ ~
3498 This will use the "c" filetype first, then the "doxygen" filetype.
3499 This works both for filetype plugins and for syntax files. More than
3500 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 This option is not copied to another buffer, independent of the 's' or
3502 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003503 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504
3505 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003506'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003507 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003508 Characters to fill the statuslines, vertical separators and special
3509 lines in the window.
3510 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003511 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003513 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003514 stl ' ' statusline of the current window
3515 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003516 vert '|' vertical separators |:vsplit|
3517 fold '-' filling 'foldtext'
3518 foldopen '-' mark the beginning of a fold
3519 foldclose '+' show a closed fold
3520 foldsep '|' open fold middle character
3521 diff '-' deleted lines of the 'diff' option
3522 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003523 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003525 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
3527 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003528 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3529<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003530 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3531 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003532 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003533
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003535 item name highlight group ~
3536 stl StatusLine |hl-StatusLine|
3537 stlnc StatusLineNC |hl-StatusLineNC|
3538 vert VertSplit |hl-VertSplit|
3539 fold Folded |hl-Folded|
3540 diff DiffDelete |hl-DiffDelete|
3541 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003542 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003544 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3545'fixendofline' 'fixeol' boolean (default on)
3546 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003547 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003548 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003549 preserve the situation from the original file.
3550 When the 'binary' option is set the value of this option doesn't
3551 matter.
3552 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003553 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003554
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003556'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {only available when compiled with the |+rightleft|
3559 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003560 This option was for using Farsi, which has been removed. See
3561 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562
3563 *'foldclose'* *'fcl'*
3564'foldclose' 'fcl' string (default "")
3565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 {not available when compiled without the |+folding|
3567 feature}
3568 When set to "all", a fold is closed when the cursor isn't in it and
3569 its level is higher than 'foldlevel'. Useful if you want folds to
3570 automatically close when moving out of them.
3571
3572 *'foldcolumn'* *'fdc'*
3573'foldcolumn' 'fdc' number (default 0)
3574 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 {not available when compiled without the |+folding|
3576 feature}
3577 When non-zero, a column with the specified width is shown at the side
3578 of the window which indicates open and closed folds. The maximum
3579 value is 12.
3580 See |folding|.
3581
3582 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3583'foldenable' 'fen' boolean (default on)
3584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 {not available when compiled without the |+folding|
3586 feature}
3587 When off, all folds are open. This option can be used to quickly
3588 switch between showing all text unfolded and viewing the text with
3589 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003590 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 'foldenable' is off.
3592 This option is set by commands that create a new fold or close a fold.
3593 See |folding|.
3594
3595 *'foldexpr'* *'fde'*
3596'foldexpr' 'fde' string (default: "0")
3597 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003599 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003601 for each line to obtain its fold level. The context is set to the
3602 script where 'foldexpr' was set, script-local items can be accessed.
3603 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003604
Bram Moolenaar30b65812012-07-12 22:01:11 +02003605 The expression will be evaluated in the |sandbox| if set from a
3606 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003607 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003608 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003609
3610 It is not allowed to change text or jump to another window while
3611 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612
3613 *'foldignore'* *'fdi'*
3614'foldignore' 'fdi' string (default: "#")
3615 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 {not available when compiled without the |+folding|
3617 feature}
3618 Used only when 'foldmethod' is "indent". Lines starting with
3619 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003620 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 The default "#" works well for C programs. See |fold-indent|.
3622
3623 *'foldlevel'* *'fdl'*
3624'foldlevel' 'fdl' number (default: 0)
3625 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 {not available when compiled without the |+folding|
3627 feature}
3628 Sets the fold level: Folds with a higher level will be closed.
3629 Setting this option to zero will close all folds. Higher numbers will
3630 close fewer folds.
3631 This option is set by commands like |zm|, |zM| and |zR|.
3632 See |fold-foldlevel|.
3633
3634 *'foldlevelstart'* *'fdls'*
3635'foldlevelstart' 'fdls' number (default: -1)
3636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 {not available when compiled without the |+folding|
3638 feature}
3639 Sets 'foldlevel' when starting to edit another buffer in a window.
3640 Useful to always start editing with all folds closed (value zero),
3641 some folds closed (one) or no folds closed (99).
3642 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003643 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 ignores this option and closes all folds.
3645 It is also done before BufReadPre autocommands, to allow an autocmd to
3646 overrule the 'foldlevel' value for specific files.
3647 When the value is negative, it is not used.
3648
3649 *'foldmarker'* *'fmr'* *E536*
3650'foldmarker' 'fmr' string (default: "{{{,}}}")
3651 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 {not available when compiled without the |+folding|
3653 feature}
3654 The start and end marker used when 'foldmethod' is "marker". There
3655 must be one comma, which separates the start and end marker. The
3656 marker is a literal string (a regular expression would be too slow).
3657 See |fold-marker|.
3658
3659 *'foldmethod'* *'fdm'*
3660'foldmethod' 'fdm' string (default: "manual")
3661 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {not available when compiled without the |+folding|
3663 feature}
3664 The kind of folding used for the current window. Possible values:
3665 |fold-manual| manual Folds are created manually.
3666 |fold-indent| indent Lines with equal indent form a fold.
3667 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3668 |fold-marker| marker Markers are used to specify folds.
3669 |fold-syntax| syntax Syntax highlighting items specify folds.
3670 |fold-diff| diff Fold text that is not changed.
3671
3672 *'foldminlines'* *'fml'*
3673'foldminlines' 'fml' number (default: 1)
3674 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {not available when compiled without the |+folding|
3676 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003677 Sets the number of screen lines above which a fold can be displayed
3678 closed. Also for manually closed folds. With the default value of
3679 one a fold can only be closed if it takes up two or more screen lines.
3680 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003681 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 "zc" to close a fold, which is displayed open because it's smaller
3683 than 'foldminlines', a following "zc" may close a containing fold.
3684
3685 *'foldnestmax'* *'fdn'*
3686'foldnestmax' 'fdn' number (default: 20)
3687 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 {not available when compiled without the |+folding|
3689 feature}
3690 Sets the maximum nesting of folds for the "indent" and "syntax"
3691 methods. This avoids that too many folds will be created. Using more
3692 than 20 doesn't work, because the internal limit is 20.
3693
3694 *'foldopen'* *'fdo'*
3695'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3696 search,tag,undo")
3697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {not available when compiled without the |+folding|
3699 feature}
3700 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003701 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003703 NOTE: When the command is part of a mapping this option is not used.
3704 Add the |zv| command to the mapping to get the same effect.
3705 (rationale: the mapping may want to control opening folds itself)
3706
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 item commands ~
3708 all any
3709 block "(", "{", "[[", "[{", etc.
3710 hor horizontal movements: "l", "w", "fx", etc.
3711 insert any command in Insert mode
3712 jump far jumps: "G", "gg", etc.
3713 mark jumping to a mark: "'m", CTRL-O, etc.
3714 percent "%"
3715 quickfix ":cn", ":crew", ":make", etc.
3716 search search for a pattern: "/", "n", "*", "gd", etc.
3717 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003718 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 tag jumping to a tag: ":ta", CTRL-T, etc.
3720 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 When a movement command is used for an operator (e.g., "dl" or "y%")
3722 this option is not used. This means the operator will include the
3723 whole closed fold.
3724 Note that vertical movements are not here, because it would make it
3725 very difficult to move onto a closed fold.
3726 In insert mode the folds containing the cursor will always be open
3727 when text is inserted.
3728 To close folds you can re-apply 'foldlevel' with the |zx| command or
3729 set the 'foldclose' option to "all".
3730
3731 *'foldtext'* *'fdt'*
3732'foldtext' 'fdt' string (default: "foldtext()")
3733 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 {not available when compiled without the |+folding|
3735 feature}
3736 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003737 fold. The context is set to the script where 'foldexpr' was set,
3738 script-local items can be accessed. See |fold-foldtext| for the
3739 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740
Bram Moolenaar30b65812012-07-12 22:01:11 +02003741 The expression will be evaluated in the |sandbox| if set from a
3742 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003743 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003744
3745 It is not allowed to change text or jump to another window while
3746 evaluating 'foldtext' |textlock|.
3747
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003748 *'formatexpr'* *'fex'*
3749'formatexpr' 'fex' string (default "")
3750 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003751 {not available when compiled without the |+eval|
3752 feature}
3753 Expression which is evaluated to format a range of lines for the |gq|
3754 operator or automatic formatting (see 'formatoptions'). When this
3755 option is empty 'formatprg' is used.
3756
3757 The |v:lnum| variable holds the first line to be formatted.
3758 The |v:count| variable holds the number of lines to be formatted.
3759 The |v:char| variable holds the character that is going to be
3760 inserted if the expression is being evaluated due to
3761 automatic formatting. This can be empty. Don't insert
3762 it yet!
3763
3764 Example: >
3765 :set formatexpr=mylang#Format()
3766< This will invoke the mylang#Format() function in the
3767 autoload/mylang.vim file in 'runtimepath'. |autoload|
3768
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003769 The advantage of using a function call without arguments is that it is
3770 faster, see |expr-option-function|.
3771
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003772 The expression is also evaluated when 'textwidth' is set and adding
3773 text beyond that limit. This happens under the same conditions as
3774 when internal formatting is used. Make sure the cursor is kept in the
3775 same spot relative to the text then! The |mode()| function will
3776 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003777
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003778 When the expression evaluates to non-zero Vim will fall back to using
3779 the internal format mechanism.
3780
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003781 If the expression starts with s: or |<SID>|, then it is replaced with
3782 the script ID (|local-function|). Example: >
3783 set formatexpr=s:MyFormatExpr()
3784 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003785< Otherwise, the expression is evaluated in the context of the script
3786 where the option was set, thus script-local items are available.
3787
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003788 The expression will be evaluated in the |sandbox| when set from a
3789 modeline, see |sandbox-option|. That stops the option from working,
3790 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003791 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003792 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003793
Bram Moolenaar86b68352004-12-27 21:59:20 +00003794 *'formatlistpat'* *'flp'*
3795'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3796 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003797 A pattern that is used to recognize a list header. This is used for
3798 the "n" flag in 'formatoptions'.
3799 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003800 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003801 while still checking more characters. There must be a character
3802 following the pattern, when it matches the whole line it is handled
3803 like there is no match.
3804 The default recognizes a number, followed by an optional punctuation
3805 character and white space.
3806
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003807 *'formatoptions'* *'fo'*
3808'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3809 local to buffer
3810 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003811 formatting is to be done.
3812 See |fo-table| for possible values and |gq| for how to format text.
3813 When the 'paste' option is on, no formatting is done (like
3814 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003815 To avoid problems with flags that are added in the future, use the
3816 "+=" and "-=" feature of ":set" |add-option-flags|.
3817 NOTE: This option is set to the Vi default value when 'compatible' is
3818 set and to the Vim default value when 'compatible' is reset.
3819
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 *'formatprg'* *'fp'*
3821'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003822 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003824 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003826 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003827 If the 'formatexpr' option is not empty it will be used instead.
3828 Otherwise, if 'formatprg' option is an empty string, the internal
3829 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003830 Environment variables are expanded |:set_env|. See |option-backslash|
3831 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003832 This option cannot be set from a |modeline| or in the |sandbox|, for
3833 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834
Bram Moolenaard94464e2015-11-02 15:28:18 +01003835 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003836'fsync' 'fs' boolean (default on)
3837 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003838 When on, the library function fsync() will be called after writing a
3839 file. This will flush a file to disk, ensuring that it is safely
3840 written even on filesystems which do metadata-only journaling. This
3841 will force the harddrive to spin up on Linux systems running in laptop
3842 mode, so it may be undesirable in some situations. Be warned that
3843 turning this off increases the chances of data loss after a crash. On
3844 systems without an fsync() implementation, this variable is always
3845 off.
3846 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003847 'fsync' also applies to |writefile()| (unless a flag is used to
3848 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003849 This option cannot be set from a |modeline| or in the |sandbox|, for
3850 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003851
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3853'gdefault' 'gd' boolean (default off)
3854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 When on, the ":substitute" flag 'g' is default on. This means that
3856 all matches in a line are substituted instead of one. When a 'g' flag
3857 is given to a ":substitute" command, this will toggle the substitution
3858 of all or one match. See |complex-change|.
3859
3860 command 'gdefault' on 'gdefault' off ~
3861 :s/// subst. all subst. one
3862 :s///g subst. one subst. all
3863 :s///gg subst. all subst. one
3864
3865 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003866 Setting this option may break plugins that rely on the default
3867 behavior of the 'g' flag. This will also make the 'g' flag have the
3868 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003869 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870
3871 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003872'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 Format to recognize for the ":grep" command output.
3875 This is a scanf-like string that uses the same format as the
3876 'errorformat' option: see |errorformat|.
3877
3878 *'grepprg'* *'gp'*
3879'grepprg' 'gp' string (default "grep -n ",
3880 Unix: "grep -n $* /dev/null",
3881 Win32: "findstr /n" or "grep -n",
3882 VMS: "SEARCH/NUMBERS ")
3883 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003884 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 and '#' characters, which are expanded like when used in a command-
3886 line. The placeholder "$*" is allowed to specify where the arguments
3887 will be included. Environment variables are expanded |:set_env|. See
3888 |option-backslash| about including spaces and backslashes.
3889 When your "grep" accepts the "-H" argument, use this to make ":grep"
3890 also work well with a single file: >
3891 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003892< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003893 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3894 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003895 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 apply equally to 'grepprg'.
3897 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3898 otherwise it's "grep -n".
3899 This option cannot be set from a |modeline| or in the |sandbox|, for
3900 security reasons.
3901
3902 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3903'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3904 ve:ver35-Cursor,
3905 o:hor50-Cursor,
3906 i-ci:ver25-Cursor/lCursor,
3907 r-cr:hor20-Cursor/lCursor,
3908 sm:block-Cursor
3909 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003910 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 "n-v-c:block,o:hor50,i-ci:hor15,
3912 r-cr:hor30,sm:block")
3913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003915 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003917 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003918 height of the cursor can be changed. This can be done by specifying a
3919 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003920 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3921 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003923 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 mode-list and an argument-list:
3925 mode-list:argument-list,mode-list:argument-list,..
3926 The mode-list is a dash separated list of these modes:
3927 n Normal mode
3928 v Visual mode
3929 ve Visual mode with 'selection' "exclusive" (same as 'v',
3930 if not specified)
3931 o Operator-pending mode
3932 i Insert mode
3933 r Replace mode
3934 c Command-line Normal (append) mode
3935 ci Command-line Insert mode
3936 cr Command-line Replace mode
3937 sm showmatch in Insert mode
3938 a all modes
3939 The argument-list is a dash separated list of these arguments:
3940 hor{N} horizontal bar, {N} percent of the character height
3941 ver{N} vertical bar, {N} percent of the character width
3942 block block cursor, fills the whole character
3943 [only one of the above three should be present]
3944 blinkwait{N} *cursor-blinking*
3945 blinkon{N}
3946 blinkoff{N}
3947 blink times for cursor: blinkwait is the delay before
3948 the cursor starts blinking, blinkon is the time that
3949 the cursor is shown and blinkoff is the time that the
3950 cursor is not shown. The times are in msec. When one
3951 of the numbers is zero, there is no blinking. The
3952 default is: "blinkwait700-blinkon400-blinkoff250".
3953 These numbers are used for a missing entry. This
3954 means that blinking is enabled by default. To switch
3955 blinking off you can use "blinkon0". The cursor only
3956 blinks when Vim is waiting for input, not while
3957 executing a command.
3958 To make the cursor blink in an xterm, see
3959 |xterm-blink|.
3960 {group-name}
3961 a highlight group name, that sets the color and font
3962 for the cursor
3963 {group-name}/{group-name}
3964 Two highlight group names, the first is used when
3965 no language mappings are used, the other when they
3966 are. |language-mapping|
3967
3968 Examples of parts:
3969 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3970 block cursor with colors from the "nCursor"
3971 highlight group
3972 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3973 In Insert and Command-line Insert mode, use a
3974 30% vertical bar cursor with colors from the
3975 "iCursor" highlight group. Blink a bit
3976 faster.
3977
3978 The 'a' mode is different. It will set the given argument-list for
3979 all modes. It does not reset anything to defaults. This can be used
3980 to do a common setting for all modes. For example, to switch off
3981 blinking: "a:blinkon0"
3982
3983 Examples of cursor highlighting: >
3984 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3985 :highlight Cursor gui=NONE guifg=bg guibg=fg
3986<
3987 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003988 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989'guifont' 'gfn' string (default "")
3990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 {only available when compiled with GUI enabled}
3992 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003993 In its simplest form the value is just one font name.
3994 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995
3996 *'guifontset'* *'gfs'*
3997 *E250* *E252* *E234* *E597* *E598*
3998'guifontset' 'gfs' string (default "")
3999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 {only available when compiled with GUI enabled and
4001 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004002 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 When not empty, specifies two (or more) fonts to be used. The first
4004 one for normal English, the second one for your special language. See
4005 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004006
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4008'guifontwide' 'gfw' string (default "")
4009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 {only available when compiled with GUI enabled}
4011 When not empty, specifies a comma-separated list of fonts to be used
4012 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004013 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004014
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 *'guiheadroom'* *'ghr'*
4016'guiheadroom' 'ghr' number (default 50)
4017 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004018 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 The number of pixels subtracted from the screen height when fitting
4020 the GUI window on the screen. Set this before the GUI is started,
4021 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004022 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 lines will be left for window decorations and other items on the
4024 screen. Set it to a negative value to allow windows taller than the
4025 screen.
4026
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004027 *'guiligatures'* *'gli'* *E1243*
4028'guiligatures' 'gli' string (default "")
4029 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004030 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004031 List of ASCII characters that, when combined together, can create more
4032 complex shapes. Each character must be a printable ASCII character
4033 with a value in the 32-127 range.
4034 Example: >
4035 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4036< Changing this option updates screen output immediately. Set it to an
4037 empty string to disable ligatures.
4038
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004040'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4041 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004042 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004043 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004046 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 sequence of letters which describes what components and options of the
4048 GUI should be used.
4049 To avoid problems with flags that are added in the future, use the
4050 "+=" and "-=" feature of ":set" |add-option-flags|.
4051
Bram Moolenaar13568252018-03-16 20:46:58 +01004052 Valid characters are as follows:
4053 *'go-!'*
4054 '!' External commands are executed in a terminal window. Without
4055 this flag the MS-Windows GUI will open a console window to
4056 execute the command. The Unix GUI will simulate a dumb
4057 terminal to list the command output.
4058 The terminal window will be positioned at the bottom, and grow
4059 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004060 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 'a' Autoselect: If present, then whenever VISUAL mode is started,
4062 or the Visual area extended, Vim tries to become the owner of
4063 the windowing system's global selection. This means that the
4064 Visually highlighted text is available for pasting into other
4065 applications as well as into Vim itself. When the Visual mode
4066 ends, possibly due to an operation on the text, or when an
4067 application wants to paste the selection, the highlighted text
4068 is automatically yanked into the "* selection register.
4069 Thus the selection is still available for pasting into other
4070 applications after the VISUAL mode has ended.
4071 If not present, then Vim won't become the owner of the
4072 windowing system's global selection unless explicitly told to
4073 by a yank or delete operation for the "* register.
4074 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004075 *'go-P'*
4076 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004077 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004078 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004079 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 applies to the modeless selection.
4081
4082 'guioptions' autoselect Visual autoselect modeless ~
4083 "" - -
4084 "a" yes yes
4085 "A" - yes
4086 "aA" yes yes
4087
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004088 When using a terminal see the 'clipboard' option.
4089
Bram Moolenaar02467872007-05-06 13:22:01 +00004090 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 'c' Use console dialogs instead of popup dialogs for simple
4092 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004093 *'go-d'*
4094 'd' Use dark theme variant if available. Currently only works for
4095 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004096 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004097 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004098 'guitablabel' can be used to change the text in the labels.
4099 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004100 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004101 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004102 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 'f' Foreground: Don't use fork() to detach the GUI from the shell
4104 where it was started. Use this for programs that wait for the
4105 editor to finish (e.g., an e-mail program). Alternatively you
4106 can use "gvim -f" or ":gui -f" to start the GUI in the
4107 foreground. |gui-fork|
4108 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004109 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004110 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4112 corner of the window. It's black&white on non-GTK, because of
4113 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004114 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004116 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004119 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004121 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004122 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 'g' Grey menu items: Make menu items that are not active grey. If
4124 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004125 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 't' Include tearoff menu items. Currently only works for Win32,
4127 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004128 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004129 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4130 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004131 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004133 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 'R' Right-hand scrollbar is present when there is a vertically
4135 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004136 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004138 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 'L' Left-hand scrollbar is present when there is a vertically
4140 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004141 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4143 the longest visible line, or on the cursor line if the 'h'
4144 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004145 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 'h' Limit horizontal scrollbar size to the length of the cursor
4147 line. Reduces computations. |gui-horiz-scroll|
4148
4149 And yes, you may even have scrollbars on the left AND the right if
4150 you really want to :-). See |gui-scrollbars| for more information.
4151
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004152 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 'v' Use a vertical button layout for dialogs. When not included,
4154 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004155 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004156 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 'p' Use Pointer callbacks for X11 GUI. This is required for some
4158 window managers. If the cursor is not blinking or hollow at
4159 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004160 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004162 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004163 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004164 *'go-k'*
4165 'k' Keep the GUI window size when adding/removing a scrollbar, or
4166 toolbar, tabline, etc. Instead, the behavior is similar to
4167 when the window is maximized and will adjust 'lines' and
4168 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004169 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004170 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004171
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 *'guipty'* *'noguipty'*
4173'guipty' boolean (default on)
4174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 {only available when compiled with GUI enabled}
4176 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4177 I/O to/from shell commands. See |gui-pty|.
4178
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004179 *'guitablabel'* *'gtl'*
4180'guitablabel' 'gtl' string (default empty)
4181 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004182 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004183 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004184 pages line. When empty and when the result is empty Vim will use a
4185 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004186
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004187 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004188 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004189 The expression will be evaluated in the |sandbox| when set from a
4190 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004191 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004192
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004193 Only used when the GUI tab pages line is displayed. 'e' must be
4194 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4195 used.
4196
Bram Moolenaar57657d82006-04-21 22:12:41 +00004197 *'guitabtooltip'* *'gtt'*
4198'guitabtooltip' 'gtt' string (default empty)
4199 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004200 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004201 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004202 pages line. When empty Vim will use a default tooltip.
4203 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004204 You can include a line break. Simplest method is to use |:let|: >
4205 :let &guitabtooltip = "line one\nline two"
4206<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004207
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004209'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 (others) "$VIMRUNTIME/doc/help.txt")
4211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 Name of the main help file. All distributed help files should be
4213 placed together in one directory. Additionally, all "doc" directories
4214 in 'runtimepath' will be used.
4215 Environment variables are expanded |:set_env|. For example:
4216 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 spaces and backslashes.
4219 This option cannot be set from a |modeline| or in the |sandbox|, for
4220 security reasons.
4221
4222 *'helpheight'* *'hh'*
4223'helpheight' 'hh' number (default 20)
4224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 Minimal initial height of the help window when it is opened with the
4226 ":help" command. The initial height of the help window is half of the
4227 current window, or (when the 'ea' option is on) the same as other
4228 windows. When the height is less than 'helpheight', the height is
4229 set to 'helpheight'. Set to zero to disable.
4230
4231 *'helplang'* *'hlg'*
4232'helplang' 'hlg' string (default: messages language or empty)
4233 global
4234 {only available when compiled with the |+multi_lang|
4235 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004236 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 for which the desired help can be found. The English help will always
4238 be used as a last resort. You can add "en" to prefer English over
4239 another language, but that will only find tags that exist in that
4240 language and not in the English help.
4241 Example: >
4242 :set helplang=de,it
4243< This will first search German, then Italian and finally English help
4244 files.
4245 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4246 try to find the tag in the current language before using this option.
4247 See |help-translated|.
4248
4249 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4250'hidden' 'hid' boolean (default off)
4251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 When off a buffer is unloaded when it is |abandon|ed. When on a
4253 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4254 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004255
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004257 hidden even if the 'hidden' option is off when these three are true:
4258 - the buffer is modified
4259 - 'autowrite' is off or writing is not possible
4260 - the '!' flag was used
4261 Also see |windows.txt|.
4262
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004263 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 This option is set for one command with ":hide {command}" |:hide|.
4265 WARNING: It's easy to forget that you have changes in hidden buffers.
4266 Think twice when using ":q!" or ":qa!".
4267
4268 *'highlight'* *'hl'*
4269'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004270 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4271 d:Directory,e:ErrorMsg,i:IncSearch,
4272 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004273 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004274 N:CursorLineNr,r:Question,s:StatusLine,
4275 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004276 v:Visual,V:VisualNOS,w:WarningMsg,
4277 W:WildMenu,f:Folded,F:FoldColumn,
4278 A:DiffAdd,C:DiffChange,D:DiffDelete,
4279 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004280 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004281 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004282 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004283 [:PmenuKind,]:PmenuKindSel,
4284 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004285 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4286 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004287 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004288 z:StatusLineTerm,Z:StatusLineTermNC,
4289 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004292 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004294 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004296 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4297 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 characters from 'showbreak'
4299 |hl-Directory| d directories in CTRL-D listing and other special
4300 things in listings
4301 |hl-ErrorMsg| e error messages
4302 h (obsolete, ignored)
4303 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004304 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4306 |hl-MoreMsg| m |more-prompt|
4307 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004308 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004309 |hl-LineNr| n line number for ":number" and ":#" commands, and
4310 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004311 |hl-LineNrAbove| a line number above the cursor for when the
4312 'relativenumber' option is set.
4313 |hl-LineNrBelow| b line number below the cursor for when the
4314 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004315 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4316 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 |hl-Question| r |hit-enter| prompt and yes/no questions
4318 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004319 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4321 |hl-VertSplit| c column used to separate vertically split windows
4322 |hl-Visual| v Visual mode
4323 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4324 Selection" Only X11 Gui's |gui-x11| and
4325 |xterm-clipboard|.
4326 |hl-WarningMsg| w warning messages
4327 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4328 |hl-Folded| f line used for closed folds
4329 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004330 |hl-DiffAdd| A added line in diff mode
4331 |hl-DiffChange| C changed line in diff mode
4332 |hl-DiffDelete| D deleted line in diff mode
4333 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004335 |hl-Conceal| - the placeholders used for concealed characters
4336 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004337 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004338 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004339 |hl-SpellRare| R rare word |spell|
4340 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004341 |hl-Pmenu| + popup menu normal line
4342 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004343 |hl-PmenuKind| [ popup menu "kind" normal line
4344 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004345 |hl-PmenuExtra| { popup menu "extra" normal line
4346 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004347 |hl-PmenuSbar| x popup menu scrollbar
4348 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004349 |hl-PmenuMatch| k popup menu matched text
4350 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351
4352 The display modes are:
4353 r reverse (termcap entry "mr" and "me")
4354 i italic (termcap entry "ZH" and "ZR")
4355 b bold (termcap entry "md" and "me")
4356 s standout (termcap entry "so" and "se")
4357 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004358 c undercurl (termcap entry "Us" and "Ce")
4359 2 double underline (termcap entry "Ds" and "Ce")
4360 d dotted underline (termcap entry "ds" and "Ce")
4361 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004362 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 n no highlighting
4364 - no highlighting
4365 : use a highlight group
4366 The default is used for occasions that are not included.
4367 If you want to change what the display modes do, see |dos-colors|
4368 for an example.
4369 When using the ':' display mode, this must be followed by the name of
4370 a highlight group. A highlight group can be used to define any type
4371 of highlighting, including using color. See |:highlight| on how to
4372 define one. The default uses a different group for each occasion.
4373 See |highlight-default| for the default highlight groups.
4374
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004376'history' 'hi' number (Vim default: 50, Vi default: 0,
4377 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004380 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004382 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 NOTE: This option is set to the Vi default value when 'compatible' is
4384 set and to the Vim default value when 'compatible' is reset.
4385
4386 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4387'hkmap' 'hk' boolean (default off)
4388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 {only available when compiled with the |+rightleft|
4390 feature}
4391 When on, the keyboard is mapped for the Hebrew character set.
4392 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4393 toggle this option. See |rileft.txt|.
4394 NOTE: This option is reset when 'compatible' is set.
4395
4396 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4397'hkmapp' 'hkp' boolean (default off)
4398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 {only available when compiled with the |+rightleft|
4400 feature}
4401 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4402 This is useful if you have a non-Hebrew keyboard.
4403 See |rileft.txt|.
4404 NOTE: This option is reset when 'compatible' is set.
4405
Bram Moolenaar036986f2017-03-16 17:41:02 +01004406 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4407'hlsearch' 'hls' boolean (default off)
4408 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004409 {not available when compiled without the
4410 |+extra_search| feature}
4411 When there is a previous search pattern, highlight all its matches.
4412 The type of highlighting used can be set with the 'l' occasion in the
4413 'highlight' option. This uses the "Search" highlight group by
4414 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004415 are not applied. If the "CurSearch" highlight group is set then the
4416 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004417 See also: 'incsearch' and |:match|.
4418 When you get bored looking at the highlighted matches, you can turn it
4419 off with |:nohlsearch|. This does not change the option value, as
4420 soon as you use a search command, the highlighting comes back.
4421 'redrawtime' specifies the maximum time spent on finding matches.
4422 When the search pattern can match an end-of-line, Vim will try to
4423 highlight all of the matched text. However, this depends on where the
4424 search starts. This will be the first line in the window or the first
4425 line below a closed fold. A match in a previous line which is not
4426 drawn may not continue in a newly drawn line.
4427 You can specify whether the highlight status is restored on startup
4428 with the 'h' flag in 'viminfo' |viminfo-h|.
4429 NOTE: This option is reset when 'compatible' is set.
4430
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 *'icon'* *'noicon'*
4432'icon' boolean (default off, on when title can be restored)
4433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 When on, the icon text of the window will be set to the value of
4435 'iconstring' (if it is not empty), or to the name of the file
4436 currently being edited. Only the last part of the name is used.
4437 Overridden by the 'iconstring' option.
4438 Only works if the terminal supports setting window icons (currently
4439 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4440 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4441 builtin termcap).
4442 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004443 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004445 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446
4447 *'iconstring'*
4448'iconstring' string (default "")
4449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 When this option is not empty, it will be used for the icon text of
4451 the window. This happens only when the 'icon' option is on.
4452 Only works if the terminal supports setting window icon text
4453 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004454 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 When Vim was compiled with HAVE_X11 defined, the original icon will be
4456 restored if possible |X11|.
4457 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004458 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004460 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 {not available when compiled without the |+statusline| feature}
4462
4463 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4464'ignorecase' 'ic' boolean (default off)
4465 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004466 Ignore case in search patterns, |cmdline-completion|, when
4467 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004468 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 Can be overruled by using "\c" or "\C" in the pattern, see
4470 |/ignorecase|.
4471
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004472 *'imactivatefunc'* *'imaf'*
4473'imactivatefunc' 'imaf' string (default "")
4474 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004475 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004476 activate or deactivate the Input Method. The value can be the name of
4477 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4478 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004479 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004480 The expression will be evaluated in the |sandbox| when set from a
4481 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004482
4483 Example: >
4484 function ImActivateFunc(active)
4485 if a:active
4486 ... do something
4487 else
4488 ... do something
4489 endif
4490 " return value is not used
4491 endfunction
4492 set imactivatefunc=ImActivateFunc
4493<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 *'imactivatekey'* *'imak'*
4495'imactivatekey' 'imak' string (default "")
4496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004498 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 Specifies the key that your Input Method in X-Windows uses for
4500 activation. When this is specified correctly, vim can fully control
4501 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4502 You can't use this option to change the activation key, the option
4503 tells Vim what the key is.
4504 Format:
4505 [MODIFIER_FLAG-]KEY_STRING
4506
4507 These characters can be used for MODIFIER_FLAG (case is ignored):
4508 S Shift key
4509 L Lock key
4510 C Control key
4511 1 Mod1 key
4512 2 Mod2 key
4513 3 Mod3 key
4514 4 Mod4 key
4515 5 Mod5 key
4516 Combinations are allowed, for example "S-C-space" or "SC-space" are
4517 both shift+ctrl+space.
4518 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4519
4520 Example: >
4521 :set imactivatekey=S-space
4522< "S-space" means shift+space. This is the activation key for kinput2 +
4523 canna (Japanese), and ami (Korean).
4524
4525 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4526'imcmdline' 'imc' boolean (default off)
4527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 When set the Input Method is always on when starting to edit a command
4529 line, unless entering a search pattern (see 'imsearch' for that).
4530 Setting this option is useful when your input method allows entering
4531 English characters directly, e.g., when it's used to type accented
4532 characters with dead keys.
4533
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004534 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 When set the Input Method is never used. This is useful to disable
4538 the IM when it doesn't work properly.
4539 Currently this option is on by default for SGI/IRIX machines. This
4540 may change in later releases.
4541
4542 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004543'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 Specifies whether :lmap or an Input Method (IM) is to be used in
4546 Insert mode. Valid values:
4547 0 :lmap is off and IM is off
4548 1 :lmap is ON and IM is off
4549 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 To always reset the option to zero when leaving Insert mode with <Esc>
4551 this can be used: >
4552 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4553< This makes :lmap and IM turn off automatically when leaving Insert
4554 mode.
4555 Note that this option changes when using CTRL-^ in Insert mode
4556 |i_CTRL-^|.
4557 The value is set to 1 when setting 'keymap' to a valid keymap name.
4558 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004559 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 methods. Use 'imdisable' to disable XIM then.
4561
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004562 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004563 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004564 |+multi_byte_ime| or |global-ime|.
4565
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004567'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 Specifies whether :lmap or an Input Method (IM) is to be used when
4570 entering a search pattern. Valid values:
4571 -1 the value of 'iminsert' is used, makes it look like
4572 'iminsert' is also used when typing a search pattern
4573 0 :lmap is off and IM is off
4574 1 :lmap is ON and IM is off
4575 2 :lmap is off and IM is ON
4576 Note that this option changes when using CTRL-^ in Command-line mode
4577 |c_CTRL-^|.
4578 The value is set to 1 when it is not -1 and setting the 'keymap'
4579 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004580 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 methods. Use 'imdisable' to disable XIM then.
4582
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004583 *'imstatusfunc'* *'imsf'*
4584'imstatusfunc' 'imsf' string (default "")
4585 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004586 This option specifies a function that is called to obtain the status
4587 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004588 The value can be the name of a function, a |lambda| or a |Funcref|.
4589 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004590 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004591
4592 Example: >
4593 function ImStatusFunc()
4594 let is_active = ...do something
4595 return is_active ? 1 : 0
4596 endfunction
4597 set imstatusfunc=ImStatusFunc
4598<
4599 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004600 The expression will be evaluated in the |sandbox| when set from a
4601 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004602
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004603 *'imstyle'* *'imst'*
4604'imstyle' 'imst' number (default 1)
4605 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004606 {only available when compiled with |+xim| and
4607 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004608 This option specifies the input style of Input Method:
4609 0 use on-the-spot style
4610 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004611 See: |xim-input-style|
4612
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004613 For a long time on-the-spot style had been used in the GTK version of
4614 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004615 |single-repeat|, etc. Therefore over-the-spot style becomes the
4616 default now. This should work fine for most people, however if you
4617 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004618 The expression will be evaluated in the |sandbox| when set from a
4619 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004620
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 *'include'* *'inc'*
4622'include' 'inc' string (default "^\s*#\s*include")
4623 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 {not available when compiled without the
4625 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004626 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 pattern, just like for the "/" command (See |pattern|). The default
4628 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004629 "]I", "[d", etc.
4630 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004631 comes after the matched pattern. But if "\zs" appears in the pattern
4632 then the text matched from "\zs" to the end, or until "\ze" if it
4633 appears, is used as the file name. Use this to include characters
4634 that are not in 'isfname', such as a space. You can then use
4635 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004636 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
4638 *'includeexpr'* *'inex'*
4639'includeexpr' 'inex' string (default "")
4640 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004642 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004644 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004645 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004647 Note the double backslash: the `:set` command first halves them, then
4648 one remains it the value, where "\." matches a dot literally. For
4649 simple character replacements `tr()` avoids the need for escaping: >
4650 :setlocal includeexpr=tr(v:fname,'.','/')
4651<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004653 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 Also used for |<cfile>|.
4655
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004656 If the expression starts with s: or |<SID>|, then it is replaced with
4657 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004658 setlocal includeexpr=s:MyIncludeExpr()
4659 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004660< Otherwise, the expression is evaluated in the context of the script
4661 where the option was set, thus script-local items are available.
4662
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004663 It is more efficient if the value is just a function call without
4664 arguments, see |expr-option-function|.
4665
Bram Moolenaar30b65812012-07-12 22:01:11 +02004666 The expression will be evaluated in the |sandbox| when set from a
4667 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004668 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004669
4670 It is not allowed to change text or jump to another window while
4671 evaluating 'includeexpr' |textlock|.
4672
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004674'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004675 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004678 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004679 While typing a search command, show where the pattern, as it was typed
4680 so far, matches. The matched string is highlighted. If the pattern
4681 is invalid or not found, nothing is shown. The screen will be updated
4682 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004683 Also applies to the pattern in commands: >
4684 :global
4685 :lvimgrep
4686 :lvimgrepadd
4687 :smagic
4688 :snomagic
4689 :sort
4690 :substitute
4691 :vglobal
4692 :vimgrep
4693 :vimgrepadd
4694< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004695 original position when no match is found and when pressing <Esc>. You
4696 still need to finish the search command with <Enter> to move the
4697 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004698 You can use the CTRL-G and CTRL-T keys to move to the next and
4699 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004700 When compiled with the |+reltime| feature Vim only searches for about
4701 half a second. With a complicated pattern and/or a lot of text the
4702 match may not be found. This is to avoid that Vim hangs while you
4703 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004704 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004705 When 'hlsearch' is on, all matched strings are highlighted too while
4706 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004707 If you don't want to turn 'hlsearch' on, but want to highlight all
4708 matches while searching, you can turn on and off 'hlsearch' with
4709 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004710 augroup vimrc-incsearch-highlight
4711 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004712 autocmd CmdlineEnter /,\? :set hlsearch
4713 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004714 augroup END
4715<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004716 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004717 to the command line. If 'ignorecase' and 'smartcase' are set and the
4718 command line has no uppercase characters, the added character is
4719 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004720 CTRL-R CTRL-W can be used to add the word at the end of the current
4721 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 NOTE: This option is reset when 'compatible' is set.
4723
4724 *'indentexpr'* *'inde'*
4725'indentexpr' 'inde' string (default "")
4726 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004727 {not available when compiled without the |+eval|
4728 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 Expression which is evaluated to obtain the proper indent for a line.
4730 It is used when a new line is created, for the |=| operator and
4731 in Insert mode as specified with the 'indentkeys' option.
4732 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004733 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004734 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 When 'paste' is set this option is not used for indenting.
4736 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004737 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004739
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004740 If the expression starts with s: or |<SID>|, then it is replaced with
4741 the script ID (|local-function|). Example: >
4742 set indentexpr=s:MyIndentExpr()
4743 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004744< Otherwise, the expression is evaluated in the context of the script
4745 where the option was set, thus script-local items are available.
4746
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004747 The advantage of using a function call without arguments is that it is
4748 faster, see |expr-option-function|.
4749
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 The expression must return the number of spaces worth of indent. It
4751 can return "-1" to keep the current indent (this means 'autoindent' is
4752 used for the indent).
4753 Functions useful for computing the indent are |indent()|, |cindent()|
4754 and |lispindent()|.
4755 The evaluation of the expression must not have side effects! It must
4756 not change the text, jump to another window, etc. Afterwards the
4757 cursor position is always restored, thus the cursor may be moved.
4758 Normally this option would be set to call a function: >
4759 :set indentexpr=GetMyIndent()
4760< Error messages will be suppressed, unless the 'debug' option contains
4761 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004762 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004763 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
Bram Moolenaar30b65812012-07-12 22:01:11 +02004765 The expression will be evaluated in the |sandbox| when set from a
4766 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004767 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004768
4769 It is not allowed to change text or jump to another window while
4770 evaluating 'indentexpr' |textlock|.
4771
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004773'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 A list of keys that, when typed in Insert mode, cause reindenting of
4776 the current line. Only happens if 'indentexpr' isn't empty.
4777 The format is identical to 'cinkeys', see |indentkeys-format|.
4778 See |C-indenting| and |indent-expression|.
4779
4780 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4781'infercase' 'inf' boolean (default off)
4782 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004784 'ignorecase' is also on, the case of the match is adjusted depending
4785 on the typed text. If the typed text contains a lowercase letter
4786 where the match has an upper case letter, the completed part is made
4787 lowercase. If the typed text has no lowercase letters and the match
4788 has a lowercase letter where the typed text has an uppercase letter,
4789 and there is a letter before it, the completed part is made uppercase.
4790 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
4792 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4793'insertmode' 'im' boolean (default off)
4794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 Makes Vim work in a way that Insert mode is the default mode. Useful
4796 if you want to use Vim as a modeless editor. Used for |evim|.
4797 These Insert mode commands will be useful:
4798 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004799 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 this is a mapping, it is executed as if 'insertmode' was off.
4801 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004803 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4804 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
4806 These items change when 'insertmode' is set:
4807 - when starting to edit of a file, Vim goes to Insert mode.
4808 - <Esc> in Insert mode is a no-op and beeps.
4809 - <Esc> in Normal mode makes Vim go to Insert mode.
4810 - CTRL-L in Insert mode is a command, it is not inserted.
4811 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4812 However, when <Esc> is used inside a mapping, it behaves like
4813 'insertmode' was not set. This was done to be able to use the same
4814 mappings with 'insertmode' set or not set.
4815 When executing commands with |:normal| 'insertmode' is not used.
4816
4817 NOTE: This option is reset when 'compatible' is set.
4818
4819 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004820'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4822 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4823 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4824 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4825 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 The characters specified by this option are included in file names and
4828 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004829 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 Multi-byte characters 256 and above are always included, only the
4831 characters up to 255 are specified with this option.
4832 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004833 Think twice before adding white space to this option. Although a
4834 space may appear inside a file name, the effect will be that Vim
4835 doesn't know where a file name starts or ends when doing completion.
4836 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
4838 Note that on systems using a backslash as path separator, Vim tries to
4839 do its best to make it work as you would expect. That is a bit
4840 tricky, since Vi originally used the backslash to escape special
4841 characters. Vim will not remove a backslash in front of a normal file
4842 name character on these systems, but it will on Unix and alikes. The
4843 '&' and '^' are not included by default, because these are special for
4844 cmd.exe.
4845
4846 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004847 Each part can be a single character number or a range. A range is two
4848 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 decimal number between 0 and 255 or the ASCII character itself (does
4850 not work for digits). Example:
4851 "_,-,128-140,#-43" (include '_' and '-' and the range
4852 128 to 140 and '#' to 43)
4853 If a part starts with '^', the following character number or range
4854 will be excluded from the option. The option is interpreted from left
4855 to right. Put the excluded character after the range where it is
4856 included. To include '^' itself use it as the last character of the
4857 option or the end of a range. Example:
4858 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4859 If the character is '@', all characters where isalpha() returns TRUE
4860 are included. Normally these are the characters a to z and A to Z,
4861 plus accented characters. To include '@' itself use "@-@". Examples:
4862 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004863 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 "a-z,A-Z,@-@" All letters plus the '@' character.
4865 A comma can be included by using it where a character number is
4866 expected. Example:
4867 "48-57,,,_" Digits, comma and underscore.
4868 A comma can be excluded by prepending a '^'. Example:
4869 " -~,^,,9" All characters from space to '~', excluding
4870 comma, plus <Tab>.
4871 See |option-backslash| about including spaces and backslashes.
4872
4873 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004874'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 "@,48-57,_,128-167,224-235"
4876 otherwise: "@,48-57,_,192-255")
4877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 The characters given by this option are included in identifiers.
4879 Identifiers are used in recognizing environment variables and after a
4880 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004881 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004882 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004884 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4886
4887 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004888'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 "@,48-57,_,128-167,224-235"
4890 otherwise: "@,48-57,_,192-255"
4891 Vi default: "@,48-57,_")
4892 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004894 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004895 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004896 characters above 255 check the "word" character class (any character
4897 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004898 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 For a help file it is set to all non-blank printable characters except
4900 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4901 command).
4902 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004903 This option also influences syntax highlighting, unless the syntax
4904 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 NOTE: This option is set to the Vi default value when 'compatible' is
4906 set and to the Vim default value when 'compatible' is reset.
4907
4908 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004909'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 "@,~-255"; otherwise: "@,161-255")
4911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 The characters given by this option are displayed directly on the
4913 screen. It is also used for "\p" in a |pattern|. The characters from
4914 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4915 even when they are not included in 'isprint' or excluded. See
4916 'isfname' for a description of the format of this option.
4917
4918 Non-printable characters are displayed with two characters:
4919 0 - 31 "^@" - "^_"
4920 32 - 126 always single characters
4921 127 "^?"
4922 128 - 159 "~@" - "~_"
4923 160 - 254 "| " - "|~"
4924 255 "~?"
4925 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4926 displayed as <xx>, with the hexadecimal value of the byte.
4927 When 'display' contains "uhex" all unprintable characters are
4928 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004929 The SpecialKey highlighting will be used for unprintable characters.
4930 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931
4932 Multi-byte characters 256 and above are always included, only the
4933 characters up to 255 are specified with this option. When a character
4934 is printable but it is not available in the current font, a
4935 replacement character will be shown.
4936 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4937 There is no option to specify these characters.
4938
4939 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4940'joinspaces' 'js' boolean (default on)
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 Insert two spaces after a '.', '?' and '!' with a join command.
4943 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4944 Otherwise only one space is inserted.
4945 NOTE: This option is set when 'compatible' is set.
4946
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004947 *'jumpoptions'* *'jop'*
4948'jumpoptions' 'jop' string (default "")
4949 global
4950 List of words that change the behavior of the |jumplist|.
4951 stack Make the jumplist behave like the tagstack.
4952 Relative location of entries in the jumplist is
4953 preserved at the cost of discarding subsequent entries
4954 when navigating backwards in the jumplist and then
4955 jumping to a location. |jumplist-stack|
4956
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 *'key'*
4958'key' string (default "")
4959 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004960 {only available when compiled with the |+cryptv|
4961 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004963 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 Careful: Do not set the key value by hand, someone might see the typed
4965 key. Use the |:X| command. But you can make 'key' empty: >
4966 :set key=
4967< It is not possible to get the value of this option with ":set key" or
4968 "echo &key". This is to avoid showing it to someone who shouldn't
4969 know. It also means you cannot see it yourself once you have set it,
4970 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004971 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4972 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004973 You can use "&key" in an expression to detect whether encryption is
4974 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975
4976 *'keymap'* *'kmp'* *E544*
4977'keymap' 'kmp' string (default "")
4978 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 {only available when compiled with the |+keymap|
4980 feature}
4981 Name of a keyboard mapping. See |mbyte-keymap|.
4982 Setting this option to a valid keymap name has the side effect of
4983 setting 'iminsert' to one, so that the keymap becomes effective.
4984 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004985 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986
4987 *'keymodel'* *'km'*
4988'keymodel' 'km' string (default "")
4989 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004990 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 can do. These values can be used:
4992 startsel Using a shifted special key starts selection (either
4993 Select mode or Visual mode, depending on "key" being
4994 present in 'selectmode').
4995 stopsel Using a not-shifted special key stops selection.
4996 Special keys in this context are the cursor keys, <End>, <Home>,
4997 <PageUp> and <PageDown>.
4998 The 'keymodel' option is set by the |:behave| command.
4999
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005000 *'keyprotocol'* *'kpc'*
5001'keyprotocol' 'kpc' string (default: see below)
5002 global
5003 Specifies what keyboard protocol to use depending on the value of
5004 'term'. The supported keyboard protocols names are:
5005 none whatever the terminal uses
5006 mok2 modifyOtherKeys level 2, as supported by xterm
5007 kitty Kitty keyboard protocol, as supported by Kitty
5008
Bram Moolenaara87749e2022-11-30 10:23:17 +00005009 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005010 a pattern that is matched against the 'term' option, a colon and the
5011 protocol name to be used. To illustrate this, the default value would
5012 be set with: >
5013 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5014
5015< This means that when 'term' contains "kitty, "foot" or "wezterm"
5016 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005017 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005018
5019 The first match is used, thus if you want to have "kitty" use the
5020 kitty protocol, but "badkitty" not, then you should match "badkitty"
5021 first and use the "none" value: >
5022 set keyprotocol=badkitty:none,kitty:kitty
5023<
5024 The option is used after 'term' has been changed. First the termcap
5025 entries are set, possibly using the builtin list, see |builtin-terms|.
5026 Then this option is inspected and if there is a match and a protocol
5027 is specified the following happens:
5028 none Nothing, the regular t_TE and t_TI values remain
5029
5030 mok2 The t_TE value is changed to:
5031 CSI >4;m disables modifyOtherKeys
5032 The t_TI value is changed to:
5033 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005034 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005035
5036 kitty The t_TE value is changed to:
5037 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005038 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005039 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005040 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005041 CSI ?u request kitty keyboard protocol state
5042 CSI >c request the termresponse
5043
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005044 If you notice problems, such as characters being displayed that
5045 disappear after `CTRL-L`, you might want to try making this option
5046 empty. Then set the 'term' option to have it take effect: >
5047 set keyprotocol=
5048 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005049<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005050
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 *'keywordprg'* *'kp'*
5052'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005053 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 Program to use for the |K| command. Environment variables are
5056 expanded |:set_env|. ":help" may be used to access the Vim internal
5057 help. (Note that previously setting the global option to the empty
5058 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005059 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005060 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005061 When "man", "man -s" or an Ex command is used, Vim will automatically
5062 translate a count for the "K" command and pass it as the first
5063 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 See |option-backslash| about including spaces and backslashes.
5065 Example: >
5066 :set keywordprg=man\ -s
5067< This option cannot be set from a |modeline| or in the |sandbox|, for
5068 security reasons.
5069
5070 *'langmap'* *'lmap'* *E357* *E358*
5071'langmap' 'lmap' string (default "")
5072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 {only available when compiled with the |+langmap|
5074 feature}
5075 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005076 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005077 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 care of translating these special characters to the original meaning
5079 of the key. This means you don't have to change the keyboard mode to
5080 be able to execute Normal mode commands.
5081 This is the opposite of the 'keymap' option, where characters are
5082 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005083 Also consider setting 'langremap' to off, to prevent 'langmap' from
5084 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005085 This option cannot be set from a |modeline| or in the |sandbox|, for
5086 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005088 Example (for Greek, in UTF-8): *greek* >
5089 :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 +00005090< Example (exchanges meaning of z and y for commands): >
5091 :set langmap=zy,yz,ZY,YZ
5092<
5093 The 'langmap' option is a list of parts, separated with commas. Each
5094 part can be in one of two forms:
5095 1. A list of pairs. Each pair is a "from" character immediately
5096 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005097 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 characters. Example: "abc;ABC"
5099 Example: "aA,fgh;FGH,cCdDeE"
5100 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005101 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102
5103 This will allow you to activate vim actions without having to switch
5104 back and forth between the languages. Your language characters will
5105 be understood as normal vim English characters (according to the
5106 langmap mappings) in the following cases:
5107 o Normal/Visual mode (commands, buffer/register names, user mappings)
5108 o Insert/Replace Mode: Register names after CTRL-R
5109 o Insert/Replace Mode: Mappings
5110 Characters entered in Command-line mode will NOT be affected by
5111 this option. Note that this option can be changed at any time
5112 allowing to switch between mappings for different languages/encodings.
5113 Use a mapping to avoid having to type it each time!
5114
5115 *'langmenu'* *'lm'*
5116'langmenu' 'lm' string (default "")
5117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 {only available when compiled with the |+menu| and
5119 |+multi_lang| features}
5120 Language to use for menu translation. Tells which file is loaded
5121 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005122 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123< (without the spaces). For example, to always use the Dutch menus, no
5124 matter what $LANG is set to: >
5125 :set langmenu=nl_NL.ISO_8859-1
5126< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005127 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 If your $LANG is set to a non-English language but you do want to use
5129 the English menus: >
5130 :set langmenu=none
5131< This option must be set before loading menus, switching on filetype
5132 detection or syntax highlighting. Once the menus are defined setting
5133 this option has no effect. But you could do this: >
5134 :source $VIMRUNTIME/delmenu.vim
5135 :set langmenu=de_DE.ISO_8859-1
5136 :source $VIMRUNTIME/menu.vim
5137< Warning: This deletes all menus that you defined yourself!
5138
Bram Moolenaard94464e2015-11-02 15:28:18 +01005139 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005140'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005141 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005142 {only available when compiled with the |+langmap|
5143 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005144 This is just like 'langremap' but with the value inverted. It only
5145 exists for backwards compatibility. When setting 'langremap' then
5146 'langnoremap' is set to the inverted value, and the other way around.
5147
5148 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005149'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005150 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005151 {only available when compiled with the |+langmap|
5152 feature}
5153 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005154 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005155 'langmap' disables some of your mappings, try resetting this option.
5156 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005157 that works for you to avoid mappings to break.
5158
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 *'laststatus'* *'ls'*
5160'laststatus' 'ls' number (default 1)
5161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 The value of this option influences when the last window will have a
5163 status line:
5164 0: never
5165 1: only if there are at least two windows
5166 2: always
5167 The screen looks nicer with a status line if you have several
5168 windows, but it takes another screen line. |status-line|
5169
5170 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5171'lazyredraw' 'lz' boolean (default off)
5172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 When this option is set, the screen will not be redrawn while
5174 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005175 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005177 This may occasionally cause display errors. It is only meant to be set
5178 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005179 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
5181 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5182'linebreak' 'lbr' boolean (default off)
5183 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005184 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005186 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 than at the last character that fits on the screen. Unlike
5188 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005189 it only affects the way the file is displayed, not its contents.
5190 If 'breakindent' is set, line is visually indented. Then, the value
5191 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005192 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 Note that <Tab> characters after an <EOL> are mostly not displayed
5194 with the right amount of white space.
5195
5196 *'lines'* *E593*
5197'lines' number (default 24 or terminal height)
5198 global
5199 Number of lines of the Vim window.
5200 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005201 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 When Vim is running in the GUI or in a resizable window, setting this
5203 option will cause the window size to be changed. When you only want
5204 to use the size for the GUI, put the command in your |gvimrc| file.
5205 Vim limits the number of lines to what fits on the screen. You can
5206 use this command to get the tallest window possible: >
5207 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005208< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005209 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 When you set this option and Vim is unable to change the physical
5211 number of lines of the display, the display may be messed up.
5212
5213 *'linespace'* *'lsp'*
5214'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 {only in the GUI}
5217 Number of pixel lines inserted between characters. Useful if the font
5218 uses the full character cell height, making lines touch each other.
5219 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005220 With some fonts there can be too much room between lines (to have
5221 space for ascents and descents). Then it makes sense to set
5222 'linespace' to a negative value. This may cause display problems
5223 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224
5225 *'lisp'* *'nolisp'*
5226'lisp' boolean (default off)
5227 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 Lisp mode: When <Enter> is typed in insert mode set the indent for
5229 the next line to Lisp standards (well, sort of). Also happens with
5230 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5231 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5232 better. Also see 'lispwords'.
5233 The '-' character is included in keyword characters. Redefines the
5234 "=" operator to use this same indentation algorithm rather than
5235 calling an external program if 'equalprg' is empty.
5236 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005238 *'lispoptions'* *'lop'*
5239'lispoptions' 'lop' string (default "")
5240 local to buffer
5241 Comma-separated list of items that influence the Lisp indenting when
5242 enabled with the |'lisp'| option. Currently only one item is
5243 supported:
5244 expr:1 use 'indentexpr' for Lisp indenting when it is set
5245 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5246 Note that when using 'indentexpr' the `=` operator indents all the
5247 lines, otherwise the first line is not indented (Vi-compatible).
5248
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 *'lispwords'* *'lw'*
5250'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005251 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005252 Comma-separated list of words that influence the Lisp indenting when
5253 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254
5255 *'list'* *'nolist'*
5256'list' boolean (default off)
5257 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005258 List mode: By default show tabs as CTRL-I is displayed, display $
5259 after end of line. Useful to see the difference between tabs and
5260 spaces and for trailing blanks. Further changed by the 'listchars'
5261 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005262
5263 The cursor is displayed at the start of the space a Tab character
5264 occupies, not at the end as usual in Normal mode. To get this cursor
5265 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005266 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005267<
5268 Note that list mode will also affect formatting (set with 'textwidth'
5269 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 changing the way tabs are displayed.
5271
5272 *'listchars'* *'lcs'*
5273'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005274 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005275 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005276 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005277 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 eol:c Character to show at the end of each line. When
5279 omitted, there is no extra character at the end of the
5280 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005281 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005282 tab:xy[z] Two or three characters to be used to show a tab.
5283 The third character is optional.
5284
5285 tab:xy The 'x' is always used, then 'y' as many times as will
5286 fit. Thus "tab:>-" displays:
5287 >
5288 >-
5289 >--
5290 etc.
5291
5292 tab:xyz The 'z' is always used, then 'x' is prepended, and
5293 then 'y' is used as many times as will fit. Thus
5294 "tab:<->" displays:
5295 >
5296 <>
5297 <->
5298 <-->
5299 etc.
5300
5301 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005302 *lcs-space*
5303 space:c Character to show for a space. When omitted, spaces
5304 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005305 *lcs-multispace*
5306 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005307 One or more characters to use cyclically to show for
5308 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005309 setting, except for single spaces. When omitted, the
5310 "space" setting is used. For example,
5311 `:set listchars=multispace:---+` shows ten consecutive
5312 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005313 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005314 *lcs-lead*
5315 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005316 leading spaces are blank. Overrides the "space" and
5317 "multispace" settings for leading spaces. You can
5318 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005319 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005320< *lcs-leadmultispace*
5321 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005322 Like the |lcs-multispace| value, but for leading
5323 spaces only. Also overrides |lcs-lead| for leading
5324 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005325 `:set listchars=leadmultispace:---+` shows ten
5326 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005327 ---+---+--XXX ~
5328 Where "XXX" denotes the first non-blank characters in
5329 the line.
5330 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005331 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005332 trailing spaces are blank. Overrides the "space" and
5333 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005334 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 extends:c Character to show in the last column, when 'wrap' is
5336 off and the line continues beyond the right of the
5337 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005338 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005339 precedes:c Character to show in the first visible column of the
5340 physical line, when there is text preceding the
5341 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005342 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005343 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005344 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005345 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005346 nbsp:c Character to show for a non-breakable space character
5347 (0xA0 (160 decimal) and U+202F). Left blank when
5348 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005350 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005352 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005354 Each character can be specified as hex: >
5355 set listchars=eol:\\x24
5356 set listchars=eol:\\u21b5
5357 set listchars=eol:\\U000021b5
5358< Note that a double backslash is used. The number of hex characters
5359 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5360
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 Examples: >
5362 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005363 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 :set lcs=extends:>,precedes:<
5365< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005366 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5367 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005368 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
5370 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5371'loadplugins' 'lpl' boolean (default on)
5372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 When on the plugin scripts are loaded when starting up |load-plugins|.
5374 This option can be reset in your |vimrc| file to disable the loading
5375 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005376 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5377 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
Bram Moolenaard94464e2015-11-02 15:28:18 +01005379 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005380'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005381 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005382 {only available when compiled with the |+lua/dyn|
5383 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005384 Specifies the name of the Lua shared library. The default is
5385 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005386 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005387 This option cannot be set from a |modeline| or in the |sandbox|, for
5388 security reasons.
5389
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005390 *'macatsui'* *'nomacatsui'*
5391'macatsui' boolean (default on)
5392 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005393 {not supported}
5394 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005395
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 *'magic'* *'nomagic'*
5397'magic' boolean (default on)
5398 global
5399 Changes the special characters that can be used in search patterns.
5400 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005401 WARNING: Switching this option off most likely breaks plugins! That
5402 is because many patterns assume it's on and will fail when it's off.
5403 Only switch it off when working with old Vi scripts. In any other
5404 situation write patterns that work when 'magic' is on. Include "\M"
5405 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005406 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5407 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408
5409 *'makeef'* *'mef'*
5410'makeef' 'mef' string (default: "")
5411 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 {not available when compiled without the |+quickfix|
5413 feature}
5414 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5415 and the |:grep| command.
5416 When it is empty, an internally generated temp file will be used.
5417 When "##" is included, it is replaced by a number to make the name
5418 unique. This makes sure that the ":make" command doesn't overwrite an
5419 existing file.
5420 NOT used for the ":cf" command. See 'errorfile' for that.
5421 Environment variables are expanded |:set_env|.
5422 See |option-backslash| about including spaces and backslashes.
5423 This option cannot be set from a |modeline| or in the |sandbox|, for
5424 security reasons.
5425
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005426 *'makeencoding'* *'menc'*
5427'makeencoding' 'menc' string (default "")
5428 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005429 Encoding used for reading the output of external commands. When empty,
5430 encoding is not converted.
5431 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5432 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5433 and `:laddfile`.
5434
5435 This would be mostly useful when you use MS-Windows and set 'encoding'
5436 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5437 'makeencoding' to "char" has the same effect as setting to the system
5438 locale encoding. Example: >
5439 :set encoding=utf-8
5440 :set makeencoding=char " system locale is used
5441<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 *'makeprg'* *'mp'*
5443'makeprg' 'mp' string (default "make", VMS: "MMS")
5444 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005445 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005446 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5447 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005448 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005449 Environment variables are expanded |:set_env|. See |option-backslash|
5450 about including spaces and backslashes.
5451 Note that a '|' must be escaped twice: once for ":set" and once for
5452 the interpretation of a command. When you use a filter called
5453 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 :set makeprg=gmake\ \\\|\ myfilter
5455< The placeholder "$*" can be given (even multiple times) to specify
5456 where the arguments will be included, for example: >
5457 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5458< This option cannot be set from a |modeline| or in the |sandbox|, for
5459 security reasons.
5460
5461 *'matchpairs'* *'mps'*
5462'matchpairs' 'mps' string (default "(:),{:},[:]")
5463 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005465 other.
5466 Only character pairs are allowed that are different, thus you cannot
5467 jump between two double quotes.
5468 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005469 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005470 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 :set mps+=<:>
5472
5473< A more exotic example, to jump between the '=' and ';' in an
5474 assignment, useful for languages like C and Java: >
5475 :au FileType c,cpp,java set mps+==:;
5476
5477< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005478 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479
5480 *'matchtime'* *'mat'*
5481'matchtime' 'mat' number (default 5)
5482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 Tenths of a second to show the matching paren, when 'showmatch' is
5484 set. Note that this is not in milliseconds, like other options that
5485 set a time. This is to be compatible with Nvi.
5486
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005487 *'maxcombine'* *'mco'*
5488'maxcombine' 'mco' number (default 2)
5489 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005490 The maximum number of combining characters supported for displaying.
5491 Only used when 'encoding' is "utf-8".
5492 The default is OK for most languages. Hebrew may require 4.
5493 Maximum value is 6.
5494 Even when this option is set to 2 you can still edit text with more
5495 combining characters, you just can't see them. Use |g8| or |ga|.
5496 See |mbyte-combining|.
5497
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 *'maxfuncdepth'* *'mfd'*
5499'maxfuncdepth' 'mfd' number (default 100)
5500 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005501 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005502 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 Maximum depth of function calls for user functions. This normally
5504 catches endless recursion. When using a recursive function with
5505 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5506 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005507 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005508 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005510 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511
5512 *'maxmapdepth'* *'mmd'* *E223*
5513'maxmapdepth' 'mmd' number (default 1000)
5514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 Maximum number of times a mapping is done without resulting in a
5516 character to be used. This normally catches endless mappings, like
5517 ":map x y" with ":map y x". It still does not catch ":map g wg",
5518 because the 'w' is used before the next mapping is done. See also
5519 |key-mapping|.
5520
5521 *'maxmem'* *'mm'*
5522'maxmem' 'mm' number (default between 256 to 5120 (system
5523 dependent) or half the amount of memory
5524 available)
5525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5527 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005528 other memory to be freed.
5529 The maximum usable value is about 2000000. Use this to work without a
5530 limit.
5531 The value is ignored when 'swapfile' is off.
5532 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005534 *'maxmempattern'* *'mmp'*
5535'maxmempattern' 'mmp' number (default 1000)
5536 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005537 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005538 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005539 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005540 When Vim runs into the limit it gives an error message and mostly
5541 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005542 Running into the limit often means that the pattern is very
5543 inefficient or too complex. This may already happen with the pattern
5544 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005545 Might also happen on redraw, when syntax rules try to match a complex
5546 text structure.
5547 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5548 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005549
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 *'maxmemtot'* *'mmt'*
5551'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5552 dependent) or half the amount of memory
5553 available)
5554 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005555 Maximum amount of memory in Kbyte to use for all buffers together.
5556 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005557 without a limit.
5558 On 64 bit machines higher values might work. But hey, do you really
5559 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005560 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005561 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005562 Buffers with 'swapfile' off still count to the total amount of memory
5563 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005564 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565
5566 *'menuitems'* *'mis'*
5567'menuitems' 'mis' number (default 25)
5568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 {not available when compiled without the |+menu|
5570 feature}
5571 Maximum number of items to use in a menu. Used for menus that are
5572 generated from a list of items, e.g., the Buffers menu. Changing this
5573 option has no direct effect, the menu must be refreshed first.
5574
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005575 *'mkspellmem'* *'msm'*
5576'mkspellmem' 'msm' string (default "460000,2000,500")
5577 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005578 {not available when compiled without the |+syntax|
5579 feature}
5580 Parameters for |:mkspell|. This tunes when to start compressing the
5581 word tree. Compression can be slow when there are many words, but
5582 it's needed to avoid running out of memory. The amount of memory used
5583 per word depends very much on how similar the words are, that's why
5584 this tuning is complicated.
5585
5586 There are three numbers, separated by commas:
5587 {start},{inc},{added}
5588
5589 For most languages the uncompressed word tree fits in memory. {start}
5590 gives the amount of memory in Kbyte that can be used before any
5591 compression is done. It should be a bit smaller than the amount of
5592 memory that is available to Vim.
5593
5594 When going over the {start} limit the {inc} number specifies the
5595 amount of memory in Kbyte that can be allocated before another
5596 compression is done. A low number means compression is done after
5597 less words are added, which is slow. A high number means more memory
5598 will be allocated.
5599
5600 After doing compression, {added} times 1024 words can be added before
5601 the {inc} limit is ignored and compression is done when any extra
5602 amount of memory is needed. A low number means there is a smaller
5603 chance of hitting the {inc} limit, less memory is used but it's
5604 slower.
5605
5606 The languages for which these numbers are important are Italian and
5607 Hungarian. The default works for when you have about 512 Mbyte. If
5608 you have 1 Gbyte you could use: >
5609 :set mkspellmem=900000,3000,800
5610< If you have less than 512 Mbyte |:mkspell| may fail for some
5611 languages, no matter what you set 'mkspellmem' to.
5612
dkearns8ebdbc92023-10-29 06:26:19 +11005613 This option cannot be set from a |modeline| or in the |sandbox|, for
5614 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005615
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005617'modeline' 'ml' boolean (Vim default: on (off for root),
5618 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005620 If 'modeline' is on 'modelines' gives the number of lines that is
5621 checked for set commands. If 'modeline' is off or 'modelines' is zero
5622 no lines are checked. See |modeline|.
5623
5624 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5625'modelineexpr' 'mle' boolean (default: off)
5626 global
5627 When on allow some options that are an expression to be set in the
5628 modeline. Check the option for whether it is affected by
5629 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005630 This option cannot be set from a |modeline| or in the |sandbox|, for
5631 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005632
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 *'modelines'* *'mls'*
5634'modelines' 'mls' number (default 5)
5635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 If 'modeline' is on 'modelines' gives the number of lines that is
5637 checked for set commands. If 'modeline' is off or 'modelines' is zero
5638 no lines are checked. See |modeline|.
5639 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5640 set and to the Vim default value when 'compatible' is reset.
5641
5642 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005643 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644'modifiable' 'ma' boolean (default on)
5645 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When off the buffer contents cannot be changed. The 'fileformat' and
5647 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005648 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
5650 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5651'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005652 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 When on, the buffer is considered to be modified. This option is set
5654 when:
5655 1. A change was made to the text since it was last written. Using the
5656 |undo| command to go back to the original text will reset the
5657 option. But undoing changes that were made before writing the
5658 buffer will set the option again, since the text is different from
5659 when it was written.
5660 2. 'fileformat' or 'fileencoding' is different from its original
5661 value. The original value is set when the buffer is read or
5662 written. A ":set nomodified" command also resets the original
5663 values to the current values and the 'modified' option will be
5664 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005665 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005666 This option is not set when a change is made to the buffer as the
5667 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5668 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5669 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5671 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005672 Note that the text may actually be the same, e.g. 'modified' is set
5673 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674
5675 *'more'* *'nomore'*
5676'more' boolean (Vim default: on, Vi default: off)
5677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 When on, listings pause when the whole screen is filled. You will get
5679 the |more-prompt|. When this option is off there are no pauses, the
5680 listing continues until finished.
5681 NOTE: This option is set to the Vi default value when 'compatible' is
5682 set and to the Vim default value when 'compatible' is reset.
5683
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005684 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005685'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005686 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005688 Enable the use of the mouse. Works for most terminals (xterm, Win32
5689 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5690 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5691 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005692 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 v Visual mode
5694 i Insert mode
5695 c Command-line mode
5696 h all previous modes when editing a help file
5697 a all previous modes
5698 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005699 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005701< If your terminal can't overrule the mouse events going to the
5702 application, use: >
5703 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005704< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005705 back to Vim using the mouse events.
5706 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5707 "xterm".
5708
5709 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 modeless selection. This doesn't move the text cursor.
5711
5712 See |mouse-using|. Also see |'clipboard'|.
5713
5714 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005715 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 the mouse buttons can still be used by keeping the shift key pressed.
5717 Also see the 'clipboard' option.
5718
5719 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5720'mousefocus' 'mousef' boolean (default off)
5721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 {only works in the GUI}
5723 The window that the mouse pointer is on is automatically activated.
5724 When changing the window layout or window focus in another way, the
5725 mouse pointer is moved to the window with keyboard focus. Off is the
5726 default because it makes using the pull down menus a little goofy, as
5727 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005728 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005729 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
5731 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5732'mousehide' 'mh' boolean (default on)
5733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 {only works in the GUI}
5735 When on, the mouse pointer is hidden when characters are typed.
5736 The mouse pointer is restored when the mouse is moved.
5737
5738 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005739'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 Sets the model to use for the mouse. The name mostly specifies what
5742 the right mouse button is used for:
5743 extend Right mouse button extends a selection. This works
5744 like in an xterm.
5745 popup Right mouse button pops up a menu. The shifted left
5746 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005747 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 popup_setpos Like "popup", but the cursor will be moved to the
5749 position where the mouse was clicked, and thus the
5750 selected operation will act upon the clicked object.
5751 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005752 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 course, that right clicking outside a selection will
5754 end Visual mode.
5755 Overview of what button does what for each model:
5756 mouse extend popup(_setpos) ~
5757 left click place cursor place cursor
5758 left drag start selection start selection
5759 shift-left search word extend selection
5760 right click extend selection popup menu (place cursor)
5761 right drag extend selection -
5762 middle click paste paste
5763
5764 In the "popup" model the right mouse button produces a pop-up menu.
5765 You need to define this first, see |popup-menu|.
5766
5767 Note that you can further refine the meaning of buttons with mappings.
5768 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5769 selection (because that's handled in the GUI code directly).
5770
5771 The 'mousemodel' option is set by the |:behave| command.
5772
h_east59858792023-10-25 22:47:05 +09005773 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005774'mousemoveevent' 'mousemev' boolean (default off)
5775 global
5776 {only works in the GUI}
5777 When on, mouse move events are delivered to the input queue and are
5778 available for mapping. The default, off, avoids the mouse movement
5779 overhead except when needed. See |gui-mouse-mapping|.
5780 Warning: Setting this option can make pending mappings to be aborted
5781 when the mouse is moved.
5782 Currently only works in the GUI, may be made to work in a terminal
5783 later.
5784
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005786'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5787 vs:leftright,vd:lrsizing,m:no,
5788 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 {only available when compiled with the |+mouseshape|
5791 feature}
5792 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005793 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 like used for 'guicursor'. Each part consist of a mode/location-list
5795 and an argument-list:
5796 mode-list:shape,mode-list:shape,..
5797 The mode-list is a dash separated list of these modes/locations:
5798 In a normal window: ~
5799 n Normal mode
5800 v Visual mode
5801 ve Visual mode with 'selection' "exclusive" (same as 'v',
5802 if not specified)
5803 o Operator-pending mode
5804 i Insert mode
5805 r Replace mode
5806
5807 Others: ~
5808 c appending to the command-line
5809 ci inserting in the command-line
5810 cr replacing in the command-line
5811 m at the 'Hit ENTER' or 'More' prompts
5812 ml idem, but cursor in the last line
5813 e any mode, pointer below last window
5814 s any mode, pointer on a status line
5815 sd any mode, while dragging a status line
5816 vs any mode, pointer on a vertical separator line
5817 vd any mode, while dragging a vertical separator line
5818 a everywhere
5819
5820 The shape is one of the following:
5821 avail name looks like ~
5822 w x arrow Normal mouse pointer
5823 w x blank no pointer at all (use with care!)
5824 w x beam I-beam
5825 w x updown up-down sizing arrows
5826 w x leftright left-right sizing arrows
5827 w x busy The system's usual busy pointer
5828 w x no The system's usual 'no input' pointer
5829 x udsizing indicates up-down resizing
5830 x lrsizing indicates left-right resizing
5831 x crosshair like a big thin +
5832 x hand1 black hand
5833 x hand2 white hand
5834 x pencil what you write with
5835 x question big ?
5836 x rightup-arrow arrow pointing right-up
5837 w x up-arrow arrow pointing up
5838 x <number> any X11 pointer number (see X11/cursorfont.h)
5839
5840 The "avail" column contains a 'w' if the shape is available for Win32,
5841 x for X11.
5842 Any modes not specified or shapes not available use the normal mouse
5843 pointer.
5844
5845 Example: >
5846 :set mouseshape=s:udsizing,m:no
5847< will make the mouse turn to a sizing arrow over the status lines and
5848 indicate no input when the hit-enter prompt is displayed (since
5849 clicking the mouse has no effect in this state.)
5850
5851 *'mousetime'* *'mouset'*
5852'mousetime' 'mouset' number (default 500)
5853 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005854 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 time in msec between two mouse clicks for the second click to be
5856 recognized as a multi click.
5857
laburnumT3f7855a2023-12-05 18:37:03 +01005858 *'mzquantum'* *'mzq'*
5859'mzquantum' 'mzq' number (default 100)
5860 global
5861 {not available when compiled without the |+mzscheme|
5862 feature}
5863 The number of milliseconds between polls for MzScheme threads.
5864 Negative or zero value means no thread scheduling.
5865 NOTE: This option is set to the Vim default value when 'compatible'
5866 is reset.
5867
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005868 *'mzschemedll'*
5869'mzschemedll' string (default depends on the build)
5870 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005871 {only available when compiled with the |+mzscheme/dyn|
5872 feature}
5873 Specifies the name of the MzScheme shared library. The default is
5874 DYNAMIC_MZSCH_DLL which was specified at compile time.
5875 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005876 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005877 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005878 This option cannot be set from a |modeline| or in the |sandbox|, for
5879 security reasons.
5880
5881 *'mzschemegcdll'*
5882'mzschemegcdll' string (default depends on the build)
5883 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005884 {only available when compiled with the |+mzscheme/dyn|
5885 feature}
5886 Specifies the name of the MzScheme GC shared library. The default is
5887 DYNAMIC_MZGC_DLL which was specified at compile time.
5888 The value can be equal to 'mzschemedll' if it includes the GC code.
5889 Environment variables are expanded |:set_env|.
5890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
5892
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005894'nrformats' 'nf' string (default "bin,octal,hex",
5895 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 This defines what bases Vim will consider for numbers when using the
5898 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5899 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005900 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005902 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005903 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005905 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 considered to be hexadecimal. Example: Using CTRL-X on
5907 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005908 bin If included, numbers starting with "0b" or "0B" will be
5909 considered to be binary. Example: Using CTRL-X on
5910 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005911 unsigned If included, numbers are recognized as unsigned. Thus a
5912 leading dash or negative sign won't be considered as part of
5913 the number. Examples:
5914 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5915 (without "unsigned" it would become "9-2021").
5916 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5917 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005918 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5919 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005920 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02005921 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02005922 dash immediately preceded by a non-whitespace character (i.e.,
5923 not a tab or a " "), the negative sign won't be considered as
5924 part of the number. For example:
5925 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5926 (without "blank" it would become "Carbon-13").
5927 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02005928 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02005929 set, it would result in "Carbon -7").
5930 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02005931 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02005932 included, "unsigned" will take precedence.
5933
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 Numbers which simply begin with a digit in the range 1-9 are always
5935 considered decimal. This also happens for numbers that are not
5936 recognized as octal or hex.
5937
5938 *'number'* *'nu'* *'nonumber'* *'nonu'*
5939'number' 'nu' boolean (default off)
5940 local to window
5941 Print the line number in front of each line. When the 'n' option is
5942 excluded from 'cpoptions' a wrapped line will not use the column of
5943 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005944 The 'numberwidth' option can be used to set the room used for the line
5945 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 When a long, wrapped line doesn't start with the first character, '-'
5947 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005948 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5949 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005950 *number_relativenumber*
5951 The 'relativenumber' option changes the displayed number to be
5952 relative to the cursor. Together with 'number' there are these
5953 four combinations (cursor in line 3):
5954
Bram Moolenaar3848e002016-03-19 18:42:29 +01005955 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005956 'nornu' 'nornu' 'rnu' 'rnu'
5957
5958 |apple | 1 apple | 2 apple | 2 apple
5959 |pear | 2 pear | 1 pear | 1 pear
5960 |nobody | 3 nobody | 0 nobody |3 nobody
5961 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005963 *'numberwidth'* *'nuw'*
5964'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5965 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005966 {only available when compiled with the |+linebreak|
5967 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005968 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005969 when the 'number' or 'relativenumber' option is set or printing lines
5970 with a line number. Since one space is always between the number and
5971 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005972 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005973 fit the highest line number in the buffer respectively the number of
5974 rows in the window, depending on whether 'number' or 'relativenumber'
5975 is set. Thus with the Vim default of 4 there is room for a line number
5976 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005977 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005978 NOTE: This option is set to the Vi default value when 'compatible' is
5979 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005980
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005981 *'omnifunc'* *'ofu'*
5982'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005983 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005984 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005985 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005986 This option specifies a function to be used for Insert mode omni
5987 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005988 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005989 invoked and what it should return. The value can be the name of a
5990 function, a |lambda| or a |Funcref|. See |option-value-function| for
5991 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005992 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005993 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005996
Bram Moolenaar02467872007-05-06 13:22:01 +00005997 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005998'opendevice' 'odev' boolean (default off)
5999 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006000 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006001 Enable reading and writing from devices. This may get Vim stuck on a
6002 device that can be opened but doesn't actually do the I/O. Therefore
6003 it is off by default.
6004 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6005 result in editing a device.
6006
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006007 *'operatorfunc'* *'opfunc'*
6008'operatorfunc' 'opfunc' string (default: empty)
6009 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006010 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006011 See |:map-operator| for more info and an example. The value can be
6012 the name of a function, a |lambda| or a |Funcref|. See
6013 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006014
6015 This option cannot be set from a |modeline| or in the |sandbox|, for
6016 security reasons.
6017
Bram Moolenaar251e1912011-06-19 05:09:16 +02006018 *'osfiletype'* *'oft'*
6019'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006021 This option was supported on RISC OS, which has been removed.
6022
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006023 *'packpath'* *'pp'*
6024'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006025 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006026 This option cannot be set from a |modeline| or in the |sandbox|, for
6027 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006028
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006030'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 global
6032 Specifies the nroff macros that separate paragraphs. These are pairs
6033 of two letters (see |object-motions|).
6034
6035 *'paste'* *'nopaste'*
6036'paste' boolean (default off)
6037 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006038 Put Vim in Paste mode. This is useful if you want to cut or copy
6039 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 unexpected effects.
6041 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006042 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 knows about pasting and will mostly do the right thing without 'paste'
6044 being set. The same is true for a terminal where Vim handles the
6045 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006046 This option is reset when starting the GUI. Thus if you set it in
6047 your .vimrc it will work in a terminal, but not in the GUI. Setting
6048 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6049 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 When the 'paste' option is switched on (also when it was already on):
6051 - mapping in Insert mode and Command-line mode is disabled
6052 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006054 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006055 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 - 'revins' is reset
6057 - 'ruler' is reset
6058 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006059 - 'smarttab' is reset
6060 - 'softtabstop' is set to 0
6061 - 'textwidth' is set to 0
6062 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006063 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006066 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006067 - 'indentexpr'
6068 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006069 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 NOTE: When you start editing another file while the 'paste' option is
6071 on, settings from the modelines or autocommands may change the
6072 settings again, causing trouble when pasting text. You might want to
6073 set the 'paste' option again.
6074 When the 'paste' option is reset the mentioned options are restored to
6075 the value before the moment 'paste' was switched from off to on.
6076 Resetting 'paste' before ever setting it does not have any effect.
6077 Since mapping doesn't work while 'paste' is active, you need to use
6078 the 'pastetoggle' option to toggle the 'paste' option with some key.
6079
6080 *'pastetoggle'* *'pt'*
6081'pastetoggle' 'pt' string (default "")
6082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 When non-empty, specifies the key sequence that toggles the 'paste'
6084 option. This is like specifying a mapping: >
6085 :map {keys} :set invpaste<CR>
6086< Where {keys} is the value of 'pastetoggle'.
6087 The difference is that it will work even when 'paste' is set.
6088 'pastetoggle' works in Insert mode and Normal mode, but not in
6089 Command-line mode.
6090 Mappings are checked first, thus overrule 'pastetoggle'. However,
6091 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6092 this: >
6093 :map <F10> :set paste<CR>
6094 :map <F11> :set nopaste<CR>
6095 :imap <F10> <C-O>:set paste<CR>
6096 :imap <F11> <nop>
6097 :set pastetoggle=<F11>
6098< This will make <F10> start paste mode and <F11> stop paste mode.
6099 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6100 mode everything is inserted literally, except the 'pastetoggle' key
6101 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006102 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103
6104 *'pex'* *'patchexpr'*
6105'patchexpr' 'pex' string (default "")
6106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 {not available when compiled without the |+diff|
6108 feature}
6109 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006110 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006111 This option cannot be set from a |modeline| or in the |sandbox|, for
6112 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113
Bram Moolenaardbc28022014-07-26 13:40:44 +02006114 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115'patchmode' 'pm' string (default "")
6116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 When non-empty the oldest version of a file is kept. This can be used
6118 to keep the original version of a file if you are changing files in a
6119 source distribution. Only the first time that a file is written a
6120 copy of the original file will be kept. The name of the copy is the
6121 name of the original file with the string in the 'patchmode' option
6122 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006123 ".orig" or ".org". 'backupdir' must not be empty for this to work
6124 (Detail: The backup file is renamed to the patchmode file after the
6125 new file has been successfully written, that's why it must be possible
6126 to write a backup file). If there was no file to be backed up, an
6127 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 When the 'backupskip' pattern matches, a patchmode file is not made.
6129 Using 'patchmode' for compressed files appends the extension at the
6130 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6131 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006132 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006134 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 other systems: ".,,")
6137 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006139 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6140 provided that the file being searched for has a relative path (not
6141 starting with "/", "./" or "../"). The directories in the 'path'
6142 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 - Use commas to separate directory names: >
6144 :set path=.,/usr/local/include,/usr/include
6145< - Spaces can also be used to separate directory names (for backwards
6146 compatibility with version 3.0). To have a space in a directory
6147 name, precede it with an extra backslash, and escape the space: >
6148 :set path=.,/dir/with\\\ space
6149< - To include a comma in a directory name precede it with an extra
6150 backslash: >
6151 :set path=.,/dir/with\\,comma
6152< - To search relative to the directory of the current file, use: >
6153 :set path=.
6154< - To search in the current directory use an empty string between two
6155 commas: >
6156 :set path=,,
6157< - A directory name may end in a ':' or '/'.
6158 - Environment variables are expanded |:set_env|.
6159 - When using |netrw.vim| URLs can be used. For example, adding
6160 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006161 - Search upwards and downwards in a directory tree using "*", "**" and
6162 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 - Careful with '\' characters, type two to get one in the option: >
6164 :set path=.,c:\\include
6165< Or just use '/' instead: >
6166 :set path=.,c:/include
6167< Don't forget "." or files won't even be found in the same directory as
6168 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006169 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 it is something like 256 or 1024 characters.
6171 You can check if all the include files are found, using the value of
6172 'path', see |:checkpath|.
6173 The use of |:set+=| and |:set-=| is preferred when adding or removing
6174 directories from the list. This avoids problems when a future version
6175 uses another default. To remove the current directory use: >
6176 :set path-=
6177< To add the current directory use: >
6178 :set path+=
6179< To use an environment variable, you probably need to replace the
6180 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006181 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006182 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183< Replace the ';' with a ':' or whatever separator is used. Note that
6184 this doesn't work when $INCL contains a comma or white space.
6185
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006186 *'perldll'*
6187'perldll' string (default depends on the build)
6188 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006189 {only available when compiled with the |+perl/dyn|
6190 feature}
6191 Specifies the name of the Perl shared library. The default is
6192 DYNAMIC_PERL_DLL, which was specified at compile time.
6193 Environment variables are expanded |:set_env|.
6194 This option cannot be set from a |modeline| or in the |sandbox|, for
6195 security reasons.
6196
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6198'preserveindent' 'pi' boolean (default off)
6199 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 When changing the indent of the current line, preserve as much of the
6201 indent structure as possible. Normally the indent is replaced by a
6202 series of tabs followed by spaces as required (unless |'expandtab'| is
6203 enabled, in which case only spaces are used). Enabling this option
6204 means the indent will preserve as many existing characters as possible
6205 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006206 'expandtab' does not apply to the preserved white space, a Tab remains
6207 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 NOTE: When using ">>" multiple times the resulting indent is a mix of
6209 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006210 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 Also see 'copyindent'.
6212 Use |:retab| to clean up white space.
6213
6214 *'previewheight'* *'pvh'*
6215'previewheight' 'pvh' number (default 12)
6216 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006217 {not available when compiled without the |+quickfix|
6218 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006220 commands. Used for |CTRL-W_}| when no count is given. Not used when
6221 'previewpopup' is set.
6222
6223 *'previewpopup'* *'pvp'*
6224'previewpopup' 'pvp' string (default empty)
6225 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006226 {not available when compiled without the |+textprop|
6227 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006228 When not empty a popup window is used for commands that would open a
6229 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006230 Not used for the insert completion info, add "popup" to
6231 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232
6233 *'previewwindow'* *'nopreviewwindow'*
6234 *'pvw'* *'nopvw'* *E590*
6235'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006236 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006237 {not available when compiled without the |+quickfix|
6238 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006239 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 set. It's normally not set directly, but by using one of the commands
6241 |:ptag|, |:pedit|, etc.
6242
6243 *'printdevice'* *'pdev'*
6244'printdevice' 'pdev' string (default empty)
6245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 {only available when compiled with the |+printer|
6247 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006248 The name of the printer to be used for |:hardcopy|.
6249 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006250 This option cannot be set from a |modeline| or in the |sandbox|, for
6251 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252
Bram Moolenaar8299df92004-07-10 09:47:34 +00006253 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006254'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 {only available when compiled with the |+printer|
6257 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006258 Sets the character encoding used when printing.
6259 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260
6261 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006262'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 {only available when compiled with the |+printer|
6265 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006266 Expression used to print the PostScript produced with |:hardcopy|.
6267 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006268 This option cannot be set from a |modeline| or in the |sandbox|, for
6269 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270
Bram Moolenaar8299df92004-07-10 09:47:34 +00006271 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272'printfont' 'pfn' string (default "courier")
6273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 {only available when compiled with the |+printer|
6275 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006276 The name of the font that will be used for |:hardcopy|.
6277 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278
6279 *'printheader'* *'pheader'*
6280'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 {only available when compiled with the |+printer|
6283 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006284 The format of the header produced in |:hardcopy| output.
6285 See |pheader-option|.
6286
6287 *'printmbcharset'* *'pmbcs'*
6288'printmbcharset' 'pmbcs' string (default "")
6289 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006290 {only available when compiled with the |+printer|
6291 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006292 The CJK character set to be used for CJK output from |:hardcopy|.
6293 See |pmbcs-option|.
6294
6295 *'printmbfont'* *'pmbfn'*
6296'printmbfont' 'pmbfn' string (default "")
6297 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006298 {only available when compiled with the |+printer|
6299 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006300 List of font names to be used for CJK output from |:hardcopy|.
6301 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302
6303 *'printoptions'* *'popt'*
6304'printoptions' 'popt' string (default "")
6305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006307 List of items that control the format of the output of |:hardcopy|.
6308 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006310 *'prompt'* *'noprompt'*
6311'prompt' boolean (default on)
6312 global
6313 When on a ":" prompt is used in Ex mode.
6314
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006315 *'pumheight'* *'ph'*
6316'pumheight' 'ph' number (default 0)
6317 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006318 Determines the maximum number of items to show in the popup menu for
6319 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006320 |ins-completion-menu|.
6321
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006322 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006323'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006324 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006325 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006326 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006327
Bram Moolenaard94464e2015-11-02 15:28:18 +01006328 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006329'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006330 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006331 {only available when compiled with the |+python/dyn|
6332 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006333 Specifies the name of the Python 2.x shared library. The default is
6334 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006335 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006336 This option cannot be set from a |modeline| or in the |sandbox|, for
6337 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006338
Bram Moolenaar94073162018-01-31 21:49:05 +01006339 *'pythonhome'*
6340'pythonhome' string (default "")
6341 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006342 {only available when compiled with the |+python/dyn|
6343 feature}
6344 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6345 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6346 which was specified at compile time, will be used for the Python 2.x
6347 home directory.
6348 Environment variables are expanded |:set_env|.
6349 This option cannot be set from a |modeline| or in the |sandbox|, for
6350 security reasons.
6351
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006352 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006353'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006354 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006355 {only available when compiled with the |+python3/dyn|
6356 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006357 Specifies the name of the Python 3 shared library. The default is
6358 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006359 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006360 This option cannot be set from a |modeline| or in the |sandbox|, for
6361 security reasons.
6362
Bram Moolenaar94073162018-01-31 21:49:05 +01006363 *'pythonthreehome'*
6364'pythonthreehome' string (default "")
6365 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006366 {only available when compiled with the |+python3/dyn|
6367 feature}
6368 Specifies the name of the Python 3 home directory. When
6369 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6370 PYTHON3_HOME, which was specified at compile time, will be used for
6371 the Python 3 home directory.
6372 Environment variables are expanded |:set_env|.
6373 This option cannot be set from a |modeline| or in the |sandbox|, for
6374 security reasons.
6375
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006376 *'pyxversion'* *'pyx'*
6377'pyxversion' 'pyx' number (default depends on the build)
6378 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006379 {only available when compiled with the |+python| or
6380 the |+python3| feature}
6381 Specifies the python version used for pyx* functions and commands
6382 |python_x|. The default value is as follows:
6383
6384 Compiled with Default ~
6385 |+python| and |+python3| 0
6386 only |+python| 2
6387 only |+python3| 3
6388
6389 Available values are 0, 2 and 3.
6390 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6391 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6392 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6393 to 2 if Python 2 is available.
6394 See also: |has-pythonx|
6395
6396 If Vim is compiled with only |+python| or |+python3| setting
6397 'pyxversion' has no effect. The pyx* functions and commands are
6398 always the same as the compiled version.
6399
6400 This option cannot be set from a |modeline| or in the |sandbox|, for
6401 security reasons.
6402
Bram Moolenaar858ba062020-05-31 23:11:59 +02006403 *'quickfixtextfunc'* *'qftf'*
6404'quickfixtextfunc' 'qftf' string (default "")
6405 global
6406 {only available when compiled with the |+quickfix|
6407 feature}
6408 This option specifies a function to be used to get the text to display
6409 in the quickfix and location list windows. This can be used to
6410 customize the information displayed in the quickfix or location window
6411 for each entry in the corresponding quickfix or location list. See
6412 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006413 function and an example. The value can be the name of a function, a
6414 |lambda| or a |Funcref|. See |option-value-function| for more
6415 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006416
6417 This option cannot be set from a |modeline| or in the |sandbox|, for
6418 security reasons.
6419
Bram Moolenaar677ee682005-01-27 14:41:15 +00006420 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006421'quoteescape' 'qe' string (default "\")
6422 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006423 The characters that are used to escape quotes in a string. Used for
6424 objects like a', a" and a` |a'|.
6425 When one of the characters in this option is found inside a string,
6426 the following character will be skipped. The default value makes the
6427 text "foo\"bar\\" considered to be one string.
6428
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6430'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006431 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 If on, writes fail unless you use a '!'. Protects you from
6433 accidentally overwriting a file. Default on when Vim is started
6434 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006435 When using ":w!" the 'readonly' option is reset for the current
6436 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006437 When using the ":view" command the 'readonly' option is set for the
6438 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006439 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006441 *'redrawtime'* *'rdt'*
6442'redrawtime' 'rdt' number (default 2000)
6443 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006444 {only available when compiled with the |+reltime|
6445 feature}
6446 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006447 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006448 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006449 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006450 matches will be highlighted.
6451 For syntax highlighting the time applies per window. When over the
6452 limit syntax highlighting is disabled until |CTRL-L| is used.
6453 This is used to avoid that Vim hangs when using a very complicated
6454 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006455
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006456 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006457'regexpengine' 're' number (default 0)
6458 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006459 This selects the default regexp engine. |two-engines|
6460 The possible values are:
6461 0 automatic selection
6462 1 old engine
6463 2 NFA engine
6464 Note that when using the NFA engine and the pattern contains something
6465 that is not supported the pattern will not match. This is only useful
6466 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006467 Using automatic selection enables Vim to switch the engine, if the
6468 default engine becomes too costly. E.g., when the NFA engine uses too
6469 many states. This should prevent Vim from hanging on a combination of
6470 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006471
Bram Moolenaar64486672010-05-16 15:46:46 +02006472 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6473'relativenumber' 'rnu' boolean (default off)
6474 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006475 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006476 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006477 precede some vertical motion commands (e.g. j k + -) with, without
6478 having to calculate it yourself. Especially useful in combination with
6479 other commands (e.g. y d c < > gq gw =).
6480 When the 'n' option is excluded from 'cpoptions' a wrapped
6481 line will not use the column of line numbers (this is the default when
6482 'compatible' isn't set).
6483 The 'numberwidth' option can be used to set the room used for the line
6484 number.
6485 When a long, wrapped line doesn't start with the first character, '-'
6486 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006487 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6488 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006489
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006490 The number in front of the cursor line also depends on the value of
6491 'number', see |number_relativenumber| for all combinations of the two
6492 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006493
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 *'remap'* *'noremap'*
6495'remap' boolean (default on)
6496 global
6497 Allows for mappings to work recursively. If you do not want this for
6498 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006499 NOTE: To avoid portability problems with Vim scripts, always keep
6500 this option at the default "on". Only switch it off when working with
6501 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502
zeertzjqd086b8f2024-02-25 15:42:52 +08006503 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006504'renderoptions' 'rop' string (default: empty)
6505 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006506 {only available when compiled with GUI and DIRECTX on
6507 MS-Windows}
6508 Select a text renderer and set its options. The options depend on the
6509 renderer.
6510
6511 Syntax: >
6512 set rop=type:{renderer}(,{name}:{value})*
6513<
6514 Currently, only one optional renderer is available.
6515
6516 render behavior ~
6517 directx Vim will draw text using DirectX (DirectWrite). It makes
6518 drawn glyphs more beautiful than default GDI.
6519 It requires 'encoding' is "utf-8", and only works on
6520 MS-Windows Vista or newer version.
6521
6522 Options:
6523 name meaning type value ~
6524 gamma gamma float 1.0 - 2.2 (maybe)
6525 contrast enhancedContrast float (unknown)
6526 level clearTypeLevel float (unknown)
6527 geom pixelGeometry int 0 - 2 (see below)
6528 renmode renderingMode int 0 - 6 (see below)
6529 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006530 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006531
Bram Moolenaar92467d32017-12-05 13:22:16 +01006532 See this URL for detail (except for scrlines):
6533 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006534
6535 For geom: structure of a device pixel.
6536 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6537 1 - DWRITE_PIXEL_GEOMETRY_RGB
6538 2 - DWRITE_PIXEL_GEOMETRY_BGR
6539
6540 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006541 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006542
6543 For renmode: method of rendering glyphs.
6544 0 - DWRITE_RENDERING_MODE_DEFAULT
6545 1 - DWRITE_RENDERING_MODE_ALIASED
6546 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6547 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6548 4 - DWRITE_RENDERING_MODE_NATURAL
6549 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6550 6 - DWRITE_RENDERING_MODE_OUTLINE
6551
6552 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006553 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006554
6555 For taamode: antialiasing mode used for drawing text.
6556 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6557 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6558 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6559 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6560
6561 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006562 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6563
Bram Moolenaara338adc2018-01-31 20:51:47 +01006564 For scrlines:
6565 This was used for optimizing scrolling behavior, however this
6566 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006567
6568 Example: >
6569 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006570 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006571 set rop=type:directx
6572<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006573 If select a raster font (Courier, Terminal or FixedSys which
6574 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006575 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006576
6577 NOTE: It is known that some fonts and options combination
6578 causes trouble on drawing glyphs.
6579
Bram Moolenaar92467d32017-12-05 13:22:16 +01006580 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006581 special made fonts (True-Type fonts which includes only
6582 bitmap glyphs).
6583 - 'taamode:3' will not work with some vector fonts.
6584
6585 NOTE: With this option, you can display colored emoji
6586 (emoticon) in Windows 8.1 or later. To display colored emoji,
6587 there are some conditions which you should notice.
6588
6589 - If your font includes non-colored emoji already, it will
6590 be used.
6591 - If your font doesn't have emoji, the system chooses an
6592 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6593 will be used.
6594 - When this alternative font didn't have fixed width glyph,
6595 emoji might be rendered beyond the bounding box of drawing
6596 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006597
6598 Other render types are currently not supported.
6599
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 *'report'*
6601'report' number (default 2)
6602 global
6603 Threshold for reporting number of lines changed. When the number of
6604 changed lines is more than 'report' a message will be given for most
6605 ":" commands. If you want it always, set 'report' to 0.
6606 For the ":substitute" command the number of substitutions is used
6607 instead of the number of lines.
6608
6609 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6610'restorescreen' 'rs' boolean (default on)
6611 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006612 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 When set, the screen contents is restored when exiting Vim. This also
6614 happens when executing external commands.
6615
6616 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6617 options in your .vimrc. To disable restoring:
6618 set t_ti= t_te=
6619 To enable restoring (for an xterm):
6620 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6621 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6622
6623 *'revins'* *'ri'* *'norevins'* *'nori'*
6624'revins' 'ri' boolean (default off)
6625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 {only available when compiled with the |+rightleft|
6627 feature}
6628 Inserting characters in Insert mode will work backwards. See "typing
6629 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6630 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006631 NOTE: This option is reset when 'compatible' is set.
6632 This option is reset when 'paste' is set and restored when 'paste' is
6633 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634
6635 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6636'rightleft' 'rl' boolean (default off)
6637 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 {only available when compiled with the |+rightleft|
6639 feature}
6640 When on, display orientation becomes right-to-left, i.e., characters
6641 that are stored in the file appear from the right to the left.
6642 Using this option, it is possible to edit files for languages that
6643 are written from the right to the left such as Hebrew and Arabic.
6644 This option is per window, so it is possible to edit mixed files
6645 simultaneously, or to view the same file in both ways (this is
6646 useful whenever you have a mixed text file with both right-to-left
6647 and left-to-right strings so that both sets are displayed properly
6648 in different windows). Also see |rileft.txt|.
6649
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006650 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651'rightleftcmd' 'rlc' string (default "search")
6652 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 {only available when compiled with the |+rightleft|
6654 feature}
6655 Each word in this option enables the command line editing to work in
6656 right-to-left mode for a group of commands:
6657
6658 search "/" and "?" commands
6659
6660 This is useful for languages such as Hebrew, Arabic and Farsi.
6661 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6662
Bram Moolenaard94464e2015-11-02 15:28:18 +01006663 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006664'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006665 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006666 {only available when compiled with the |+ruby/dyn|
6667 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006668 Specifies the name of the Ruby shared library. The default is
6669 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006670 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006671 This option cannot be set from a |modeline| or in the |sandbox|, for
6672 security reasons.
6673
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006675'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006678 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 text in the file is shown on the far right:
6680 Top first line is visible
6681 Bot last line is visible
6682 All first and last line are visible
6683 45% relative position in the file
6684 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006685 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006686 ruler is shown there. Otherwise it is shown in the last line of the
6687 screen. If the statusline is given by 'statusline' (i.e. not empty),
6688 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006690 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 the text column (byte number) and the screen column are shown,
6692 separated with a dash.
6693 For an empty line "0-1" is shown.
6694 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006695 This option is reset when 'paste' is set and restored when 'paste' is
6696 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 If you don't want to see the ruler all the time but want to know where
6698 you are, use "g CTRL-G" |g_CTRL-G|.
6699 NOTE: This option is reset when 'compatible' is set.
6700
6701 *'rulerformat'* *'ruf'*
6702'rulerformat' 'ruf' string (default empty)
6703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 {not available when compiled without the |+statusline|
6705 feature}
6706 When this option is not empty, it determines the content of the ruler
6707 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006708 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006709 This option cannot be set in a modeline when 'modelineexpr' is off.
6710
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 The default ruler width is 17 characters. To make the ruler 15
6712 characters wide, put "%15(" at the start and "%)" at the end.
6713 Example: >
6714 :set rulerformat=%15(%c%V\ %p%%%)
6715<
6716 *'runtimepath'* *'rtp'* *vimfiles*
6717'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006718 Unix: "$HOME/.vim or
6719 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 $VIM/vimfiles,
6721 $VIMRUNTIME,
6722 $VIM/vimfiles/after,
6723 $HOME/.vim/after"
6724 Amiga: "home:vimfiles,
6725 $VIM/vimfiles,
6726 $VIMRUNTIME,
6727 $VIM/vimfiles/after,
6728 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006729 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 $VIM/vimfiles,
6731 $VIMRUNTIME,
6732 $VIM/vimfiles/after,
6733 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006734 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 $VIMRUNTIME,
6736 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006737 Haiku: "$BE_USER_SETTINGS/vim,
6738 $VIM/vimfiles,
6739 $VIMRUNTIME,
6740 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006741 $BE_USER_SETTINGS/vim/after"
6742 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 $VIM/vimfiles,
6744 $VIMRUNTIME,
6745 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006746 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 This is a list of directories which will be searched for runtime
6749 files:
6750 filetype.vim filetypes by file name |new-filetype|
6751 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006752 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 colors/ color scheme files |:colorscheme|
6754 compiler/ compiler files |:compiler|
6755 doc/ documentation |write-local-help|
6756 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006757 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 indent/ indent scripts |indent-expression|
6759 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006760 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006762 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 plugin/ plugin scripts |write-plugin|
6764 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006765 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 syntax/ syntax files |mysyntaxfile|
6767 tutor/ files for vimtutor |tutor|
6768
6769 And any other file searched for with the |:runtime| command.
6770
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006771 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6772
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 The defaults for most systems are setup to search five locations:
6774 1. In your home directory, for your personal preferences.
6775 2. In a system-wide Vim directory, for preferences from the system
6776 administrator.
6777 3. In $VIMRUNTIME, for files distributed with Vim.
6778 *after-directory*
6779 4. In the "after" directory in the system-wide Vim directory. This is
6780 for the system administrator to overrule or add to the distributed
6781 defaults (rarely needed)
6782 5. In the "after" directory in your home directory. This is for
6783 personal preferences to overrule or add to the distributed defaults
6784 or system-wide settings (rarely needed).
6785
Bram Moolenaard0796902016-09-16 20:02:31 +02006786 More entries are added when using |packages|. If it gets very long
6787 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6788 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006789
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6791 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006792 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 wildcards.
6794 See |:runtime|.
6795 Example: >
6796 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6797< This will use the directory "~/vimruntime" first (containing your
6798 personal Vim runtime files), then "/mygroup/vim" (shared between a
6799 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6800 files).
6801 You probably should always include $VIMRUNTIME somewhere, to use the
6802 distributed runtime files. You can put a directory before $VIMRUNTIME
6803 to find files which replace a distributed runtime files. You can put
6804 a directory after $VIMRUNTIME to find files which add to distributed
6805 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006806 When Vim is started with |--clean| the home directory entries are not
6807 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 This option cannot be set from a |modeline| or in the |sandbox|, for
6809 security reasons.
6810
6811 *'scroll'* *'scr'*
6812'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006813 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6815 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006816 changes. This may happen when enabling the |status-line| or
6817 'tabline' option after setting the 'scroll' option.
6818 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006819 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006820 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821
6822 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6823'scrollbind' 'scb' boolean (default off)
6824 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006825 See also |scroll-binding|. When this option is set, scrolling the
6826 current window also scrolls other scrollbind windows (windows that
6827 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 differences between two versions of a file, see 'diff'.
6829 See |'scrollopt'| for options that determine how this option should be
6830 interpreted.
6831 This option is mostly reset when splitting a window to edit another
6832 file. This means that ":split | edit file" results in two windows
6833 with scroll-binding, but ":split file" does not.
6834
Bram Moolenaarae20f342019-11-05 21:09:23 +01006835 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6836'scrollfocus' 'scf' boolean (default off)
6837 global
6838 {only for MS-Windows GUI}
6839 When using the scroll wheel and this option is set, the window under
6840 the mouse pointer is scrolled. With this option off the current
6841 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006842 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006843
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 *'scrolljump'* *'sj'*
6845'scrolljump' 'sj' number (default 1)
6846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 Minimal number of lines to scroll when the cursor gets off the
6848 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6849 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006850 When set to a negative number from -1 to -100 this is used as the
6851 percentage of the window height. Thus -50 scrolls half the window
6852 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 NOTE: This option is set to 1 when 'compatible' is set.
6854
6855 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006856'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006857 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 Minimal number of screen lines to keep above and below the cursor.
6859 This will make some context visible around where you are working. If
6860 you set it to a very large value (999) the cursor line will always be
6861 in the middle of the window (except at the start or end of the file or
6862 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006863 After using the local value, go back the global value with one of
6864 these two: >
6865 setlocal scrolloff<
6866 setlocal scrolloff=-1
6867< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 NOTE: This option is set to 0 when 'compatible' is set.
6869
6870 *'scrollopt'* *'sbo'*
6871'scrollopt' 'sbo' string (default "ver,jump")
6872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006874 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6875 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 The following words are available:
6877 ver Bind vertical scrolling for 'scrollbind' windows
6878 hor Bind horizontal scrolling for 'scrollbind' windows
6879 jump Applies to the offset between two windows for vertical
6880 scrolling. This offset is the difference in the first
6881 displayed line of the bound windows. When moving
6882 around in a window, another 'scrollbind' window may
6883 reach a position before the start or after the end of
6884 the buffer. The offset is not changed though, when
6885 moving back the 'scrollbind' window will try to scroll
6886 to the desired position when possible.
6887 When now making that window the current one, two
6888 things can be done with the relative offset:
6889 1. When "jump" is not included, the relative offset is
6890 adjusted for the scroll position in the new current
6891 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006892 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 2. When "jump" is included, the other windows are
6894 scrolled to keep the same relative offset. When
6895 going back to the other window, it still uses the
6896 same relative offset.
6897 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006898 When 'diff' mode is active there always is vertical scroll binding,
6899 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900
6901 *'sections'* *'sect'*
6902'sections' 'sect' string (default "SHNHH HUnhsh")
6903 global
6904 Specifies the nroff macros that separate sections. These are pairs of
6905 two letters (See |object-motions|). The default makes a section start
6906 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6907
6908 *'secure'* *'nosecure'* *E523*
6909'secure' boolean (default off)
6910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 When on, ":autocmd", shell and write commands are not allowed in
6912 ".vimrc" and ".exrc" in the current directory and map commands are
6913 displayed. Switch it off only if you know that you will not run into
6914 problems, or when the 'exrc' option is off. On Unix this option is
6915 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006916 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 'secure' at the end of your ~/.vimrc then.
6918 This option cannot be set from a |modeline| or in the |sandbox|, for
6919 security reasons.
6920
6921 *'selection'* *'sel'*
6922'selection' 'sel' string (default "inclusive")
6923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 This option defines the behavior of the selection. It is only used
6925 in Visual and Select mode.
6926 Possible values:
6927 value past line inclusive ~
6928 old no yes
6929 inclusive yes yes
6930 exclusive yes no
6931 "past line" means that the cursor is allowed to be positioned one
6932 character past the line.
6933 "inclusive" means that the last character of the selection is included
6934 in an operation. For example, when "x" is used to delete the
6935 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006936 When "old" is used and 'virtualedit' allows the cursor to move past
6937 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 Note that when "exclusive" is used and selecting from the end
6939 backwards, you cannot include the last character of a line, when
6940 starting in Normal mode and 'virtualedit' empty.
6941
6942 The 'selection' option is set by the |:behave| command.
6943
6944 *'selectmode'* *'slm'*
6945'selectmode' 'slm' string (default "")
6946 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006947 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 Select mode instead of Visual mode, when a selection is started.
6949 Possible values:
6950 mouse when using the mouse
6951 key when using shifted special keys
6952 cmd when using "v", "V" or CTRL-V
6953 See |Select-mode|.
6954 The 'selectmode' option is set by the |:behave| command.
6955
6956 *'sessionoptions'* *'ssop'*
6957'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006958 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006960 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 feature}
6962 Changes the effect of the |:mksession| command. It is a comma
6963 separated list of words. Each word enables saving and restoring
6964 something:
6965 word save and restore ~
6966 blank empty windows
6967 buffers hidden and unloaded buffers, not just those in windows
6968 curdir the current directory
6969 folds manually created folds, opened/closed folds and local
6970 fold options
6971 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006972 and contain at least one lowercase letter. Only
6973 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 help the help window
6975 localoptions options and mappings local to a window or buffer (not
6976 global values for local options)
6977 options all options and mappings (also global values for local
6978 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006979 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 resize size of the Vim window: 'lines' and 'columns'
6981 sesdir the directory in which the session file is located
6982 will become the current directory (useful with
6983 projects accessed over a network from different
6984 systems)
6985 slash backslashes in file names replaced with forward
6986 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006987 tabpages all tab pages; without this only the current tab page
6988 is restored, so that you can make a session for each
6989 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006990 terminal include terminal windows where the command can be
6991 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 unix with Unix end-of-line format (single <NL>), even when
6993 on Windows or DOS
6994 winpos position of the whole Vim window
6995 winsize window sizes
6996
6997 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006998 When neither "curdir" nor "sesdir" is included, file names are stored
6999 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007000 If you leave out "options" many things won't work well after restoring
7001 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 "slash" and "unix" are useful on Windows when sharing session files
7003 with Unix. The Unix version of Vim cannot source dos format scripts,
7004 but the Windows version of Vim can source unix format scripts.
7005
7006 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007007'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 global
7009 Name of the shell to use for ! and :! commands. When changing the
7010 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7011 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007012 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 See |option-backslash| about including spaces and backslashes.
7014 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007015
Bram Moolenaara2baa732022-02-04 16:09:54 +00007016 In |restricted-mode| shell commands will not be possible. This mode
7017 is used if the value of $SHELL ends in "false" or "nologin".
7018
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007019 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007020 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7022< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007023 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007025 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007027 Example with escaped space (Vim will do this when initializing the
7028 option from $SHELL): >
7029 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007030< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007031 backslashes are consumed by `:set`.
7032
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 Under MS-Windows, when the executable ends in ".com" it must be
7034 included. Thus setting the shell to "command.com" or "4dos.com"
7035 works, but "command" and "4dos" do not work for all commands (e.g.,
7036 filtering).
7037 For unknown reasons, when using "4dos.com" the current directory is
7038 changed to "C:\". To avoid this set 'shell' like this: >
7039 :set shell=command.com\ /c\ 4dos
7040< This option cannot be set from a |modeline| or in the |sandbox|, for
7041 security reasons.
7042
7043 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007044'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007045 Win32, when 'shell' contains "powershell":
7046 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007047 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007050 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7051 For MS-Windows, the default is set according to the value of 'shell',
7052 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007053 On Unix it can have more than one flag. Each white space separated
7054 part is passed as an argument to the shell command.
7055 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007056 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 This option cannot be set from a |modeline| or in the |sandbox|, for
7058 security reasons.
7059
7060 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007061'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7062 "2>&1| tee", or
7063 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 {not available when compiled without the |+quickfix|
7066 feature}
7067 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007068 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 including spaces and backslashes.
7070 The name of the temporary file can be represented by "%s" if necessary
7071 (the file name is appended automatically if no %s appears in the value
7072 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007073 For the Amiga the default is ">". For MS-Windows using powershell the
7074 default is "2>&1 | Out-File -Encoding default", otherwise the default
7075 is ">%s 2>&1". The output is directly saved in a file and not echoed
7076 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007077 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 in a file and echoed to the screen. If the 'shell' option is "csh" or
7079 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007080 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007081 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7082 means that stderr is also included. Before using the 'shell' option a
7083 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007084 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7085 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 The initialization of this option is done after reading the ".vimrc"
7087 and the other initializations, so that when the 'shell' option is set
7088 there, the 'shellpipe' option changes automatically, unless it was
7089 explicitly set before.
7090 When 'shellpipe' is set to an empty string, no redirection of the
7091 ":make" output will be done. This is useful if you use a 'makeprg'
7092 that writes to 'makeef' by itself. If you want no piping, but do
7093 want to include the 'makeef', set 'shellpipe' to a single space.
7094 Don't forget to precede the space with a backslash: ":set sp=\ ".
7095 In the future pipes may be used for filtering and this option will
7096 become obsolete (at least for Unix).
7097 This option cannot be set from a |modeline| or in the |sandbox|, for
7098 security reasons.
7099
7100 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007101'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 Quoting character(s), put around the command passed to the shell, for
7104 the "!" and ":!" commands. The redirection is kept outside of the
7105 quoting. See 'shellxquote' to include the redirection. It's
7106 probably not useful to set both options.
7107 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007108 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007109 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 This option cannot be set from a |modeline| or in the |sandbox|, for
7111 security reasons.
7112
7113 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007114'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7115 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 String to be used to put the output of a filter command in a temporary
7118 file. See also |:!|. See |option-backslash| about including spaces
7119 and backslashes.
7120 The name of the temporary file can be represented by "%s" if necessary
7121 (the file name is appended automatically if no %s appears in the value
7122 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007123 The default is ">". For Unix, if the 'shell' option is "csh" or
7124 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007125 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007126 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7127 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007128 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7129 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007130 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7131 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 The initialization of this option is done after reading the ".vimrc"
7133 and the other initializations, so that when the 'shell' option is set
7134 there, the 'shellredir' option changes automatically unless it was
7135 explicitly set before.
7136 In the future pipes may be used for filtering and this option will
7137 become obsolete (at least for Unix).
7138 This option cannot be set from a |modeline| or in the |sandbox|, for
7139 security reasons.
7140
7141 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7142'shellslash' 'ssl' boolean (default off)
7143 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007144 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007146 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007147 powershell.exe. Backward slashes can still be typed, but they are
7148 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 Note that setting or resetting this option has no effect for some
7150 existing file names, thus this option needs to be set before opening
7151 any file for best results. This might change in the future.
7152 'shellslash' only works when a backslash can be used as a path
7153 separator. To test if this is so use: >
7154 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007155< Also see 'completeslash'.
7156
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007157 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7158'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7159 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007160 When on, use temp files for shell commands. When off use a pipe.
7161 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007162 Currently a pipe is only supported on Unix and MS-Windows 2K and
7163 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007164 :if has("filterpipe")
7165< The advantage of using a pipe is that nobody can read the temp file
7166 and the 'shell' command does not need to support redirection.
7167 The advantage of using a temp file is that the file type and encoding
7168 can be detected.
7169 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7170 |FilterWritePost| autocommands event are not triggered when
7171 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007172 The `system()` function does not respect this option and always uses
7173 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007174 NOTE: This option is set to the Vim default value when 'compatible'
7175 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007176
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 *'shelltype'* *'st'*
7178'shelltype' 'st' number (default 0)
7179 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007180 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 On the Amiga this option influences the way how the commands work
7182 which use a shell.
7183 0 and 1: always use the shell
7184 2 and 3: use the shell only to filter lines
7185 4 and 5: use shell only for ':sh' command
7186 When not using the shell, the command is executed directly.
7187
7188 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7189 1 and 3: use "shell cmd" to start external commands
7190
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007191 *'shellxescape'* *'sxe'*
7192'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007193 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007194 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007195 When 'shellxquote' is set to "(" then the characters listed in this
7196 option will be escaped with a '^' character. This makes it possible
7197 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007198 This option cannot be set from a |modeline| or in the |sandbox|, for
7199 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007200
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 *'shellxquote'* *'sxq'*
7202'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007203 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007204 for Win32, when 'shell' is
7205 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007206 for Win32, when 'shell' contains "sh"
7207 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 for Unix, when using system(): "\"")
7209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 Quoting character(s), put around the command passed to the shell, for
7211 the "!" and ":!" commands. Includes the redirection. See
7212 'shellquote' to exclude the redirection. It's probably not useful
7213 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007214 When the value is '(' then ')' is appended. When the value is '"('
7215 then ')"' is appended.
7216 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007217 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007218 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7219 pwsh.exe which automatically strips off the first and last quote on a
7220 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7221 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007222 'shell', to reduce the need to set this option by the user. See
7223 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 This option cannot be set from a |modeline| or in the |sandbox|, for
7225 security reasons.
7226
7227 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7228'shiftround' 'sr' boolean (default off)
7229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 Round indent to multiple of 'shiftwidth'. Applies to > and <
7231 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7232 a multiple of 'shiftwidth' (this is Vi compatible).
7233 NOTE: This option is reset when 'compatible' is set.
7234
7235 *'shiftwidth'* *'sw'*
7236'shiftwidth' 'sw' number (default 8)
7237 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007238 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007240 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007241 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242
7243 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007244'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7245 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007246 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007248 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 It is a list of flags:
7250 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007251 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7252 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7253 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7254 m use "[+]" instead of "[Modified]" *shm-m*
7255 n use "[New]" instead of "[New File]" *shm-n*
7256 r use "[RO]" instead of "[readonly]" *shm-r*
7257 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007259 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7260 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007261 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007262 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007264 o overwrite message for writing a file with subsequent *shm-o*
7265 message for reading a file (useful for ":wn" or when
7266 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007267 O message for reading a file overwrites any previous *shm-O*
7268 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007269 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7270 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007271 the search count do not show "W" before the count message
7272 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007273 t truncate file message at the start if it is too long *shm-t*
7274 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007275 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007276 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007277 long to fit on the command line; "..." will appear in the
7278 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007279 W don't give "written" or "[w]" when writing a file *shm-W*
7280 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007281 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007282 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007283 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007284 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007285 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7286 match", "Pattern not found", "Back at original", etc.
7287 C don't give messages while scanning for ins-completion *shm-C*
7288 items, for instance "scanning tags"
7289 q use "recording" instead of "recording @a" *shm-q*
7290 F don't give the file info when editing a file, like *shm-F*
7291 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007292 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007293 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007294 "[1/5]". When the "S" flag is not present (e.g. search count
7295 is shown), the "search hit BOTTOM, continuing at TOP" and
7296 "search hit TOP, continuing at BOTTOM" messages are only
7297 indicated by a "W" (Mnemonic: Wrapped) letter before the
7298 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299
7300 This gives you the opportunity to avoid that a change between buffers
7301 requires you to hit <Enter>, but still gives as useful a message as
7302 possible for the space available. To get the whole message that you
7303 would have got with 'shm' empty, use ":file!"
7304 Useful values:
7305 shm= No abbreviation of message.
7306 shm=a Abbreviation, but no loss of information.
7307 shm=at Abbreviation, and truncate message when necessary.
7308
7309 NOTE: This option is set to the Vi default value when 'compatible' is
7310 set and to the Vim default value when 'compatible' is reset.
7311
7312 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7313'shortname' 'sn' boolean (default off)
7314 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 Filenames are assumed to be 8 characters plus one extension of 3
7316 characters. Multiple dots in file names are not allowed. When this
7317 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007318 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007320 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321
7322 *'showbreak'* *'sbr'* *E595*
7323'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007324 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007325 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 feature}
7327 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007328 values are "> " or "+++ ": >
7329 :set showbreak=>\
7330< Note the backslash to escape the trailing space. It's easier like
7331 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007332 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007333< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 comma (in a future version the comma might be used to separate the
7335 part that is shown at the end and at the start of a line).
7336 The characters are highlighted according to the '@' flag in
7337 'highlight'.
7338 Note that tabs after the showbreak will be displayed differently.
7339 If you want the 'showbreak' to appear in between line numbers, add the
7340 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007341 A window-local value overrules a global value. If the global value is
7342 set and you want no value in the current window use NONE: >
7343 :setlocal showbreak=NONE
7344<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007346'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7347 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007349 Show (partial) command in the last line of the screen. Set this
7350 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 In Visual mode the size of the selected area is shown:
7352 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007353 If the number of bytes is different it is also displayed: "2-6"
7354 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007356 - When selecting a block, the size in screen characters:
7357 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007358 This information can be displayed in an alternative location using the
7359 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 NOTE: This option is set to the Vi default value when 'compatible' is
7361 set and to the Vim default value when 'compatible' is reset.
7362
Luuk van Baalba936f62022-12-15 13:15:39 +00007363 *'showcmdloc'* *'sloc'*
7364'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007365 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007366 This option can be used to display the (partially) entered command in
7367 another location. Possible values are:
7368 last Last line of the screen (default).
7369 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007370 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007371 Setting this option to "statusline" or "tabline" means that these will
7372 be redrawn whenever the command changes, which can be on every key
7373 pressed.
7374 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7375 place the text. Without a custom 'statusline' or 'tabline' it will be
7376 displayed in a convenient location.
7377
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7379'showfulltag' 'sft' boolean (default off)
7380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 When completing a word in insert mode (see |ins-completion|) from the
7382 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007383 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 matched a C function, you can see a template for what arguments are
7385 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007386 Note that this doesn't work well together with having "longest" in
7387 'completeopt', because the completion from the search pattern may not
7388 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389
7390 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7391'showmatch' 'sm' boolean (default off)
7392 global
7393 When a bracket is inserted, briefly jump to the matching one. The
7394 jump is only done if the match can be seen on the screen. The time to
7395 show the match can be set with 'matchtime'.
7396 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007397 seen or not).
7398 This option is reset when 'paste' is set and restored when 'paste' is
7399 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 When the 'm' flag is not included in 'cpoptions', typing a character
7401 will immediately move the cursor back to where it belongs.
7402 See the "sm" field in 'guicursor' for setting the cursor shape and
7403 blinking when showing the match.
7404 The 'matchpairs' option can be used to specify the characters to show
7405 matches for. 'rightleft' and 'revins' are used to look for opposite
7406 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007407 Also see the matchparen plugin for highlighting the match when moving
7408 around |pi_paren.txt|.
7409 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410
7411 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7412'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7413 global
7414 If in Insert, Replace or Visual mode put a message on the last line.
7415 Use the 'M' flag in 'highlight' to set the type of highlighting for
7416 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007417 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 doesn't mean XIM is really active, especially when 'imactivatekey' is
7419 not set.
7420 NOTE: This option is set to the Vi default value when 'compatible' is
7421 set and to the Vim default value when 'compatible' is reset.
7422
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007423 *'showtabline'* *'stal'*
7424'showtabline' 'stal' number (default 1)
7425 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007426 The value of this option specifies when the line with tab page labels
7427 will be displayed:
7428 0: never
7429 1: only if there are at least two tab pages
7430 2: always
7431 This is both for the GUI and non-GUI implementation of the tab pages
7432 line.
7433 See |tab-page| for more information about tab pages.
7434
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *'sidescroll'* *'ss'*
7436'sidescroll' 'ss' number (default 0)
7437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 The minimal number of columns to scroll horizontally. Used only when
7439 the 'wrap' option is off and the cursor is moved off of the screen.
7440 When it is zero the cursor will be put in the middle of the screen.
7441 When using a slow terminal set it to a large number or 0. When using
7442 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7443 commands.
7444
7445 *'sidescrolloff'* *'siso'*
7446'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007447 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007449 right of the cursor if 'nowrap' is set. Setting this option to a
7450 value greater than 0 while having |'sidescroll'| also at a non-zero
7451 value makes some context visible in the line you are scrolling in
7452 horizontally (except at beginning of the line). Setting this option
7453 to a large value (like 999) has the effect of keeping the cursor
7454 horizontally centered in the window, as long as one does not come too
7455 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007456 After using the local value, go back the global value with one of
7457 these two: >
7458 setlocal sidescrolloff<
7459 setlocal sidescrolloff=-1
7460< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461
7462 Example: Try this together with 'sidescroll' and 'listchars' as
7463 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007464 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465
7466 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7467 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007468<
7469 *'signcolumn'* *'scl'*
7470'signcolumn' 'scl' string (default "auto")
7471 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007472 {not available when compiled without the |+signs|
7473 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007474 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007475 "auto" only when there is a sign to display
7476 "no" never
7477 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007478 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007479 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7482'smartcase' 'scs' boolean (default off)
7483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 Override the 'ignorecase' option if the search pattern contains upper
7485 case characters. Only used when the search pattern is typed and
7486 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007487 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7489 recalling the search pattern from history and hitting <Enter>.
7490 NOTE: This option is reset when 'compatible' is set.
7491
7492 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7493'smartindent' 'si' boolean (default off)
7494 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 Do smart autoindenting when starting a new line. Works for C-like
7496 programs, but can also be used for other languages. 'cindent' does
7497 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007498 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007499 setting 'si' has no effect. 'indentexpr' is a more advanced
7500 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 Normally 'autoindent' should also be on when using 'smartindent'.
7502 An indent is automatically inserted:
7503 - After a line ending in '{'.
7504 - After a line starting with a keyword from 'cinwords'.
7505 - Before a line starting with '}' (only with the "O" command).
7506 When typing '}' as the first character in a new line, that line is
7507 given the same indent as the matching '{'.
7508 When typing '#' as the first character in a new line, the indent for
7509 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007510 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7512 When using the ">>" command, lines starting with '#' are not shifted
7513 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007514 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007515 This option is reset when 'paste' is set and restored when 'paste' is
7516 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7519'smarttab' 'sta' boolean (default off)
7520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007522 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7523 <BS> will delete a 'shiftwidth' worth of space at the start of the
7524 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007525 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007526 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7527 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007528 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007530 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007531 This option is reset when 'paste' is set and restored when 'paste' is
7532 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 NOTE: This option is reset when 'compatible' is set.
7534
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007535 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7536'smoothscroll' 'sms' boolean (default off)
7537 local to window
7538 Scrolling works with screen lines. When 'wrap' is set and the first
7539 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007540 above the window. "<<<" is displayed at the start of the first line,
7541 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007542 You may also want to add "lastline" to the 'display' option to show as
7543 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007544 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007545
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 *'softtabstop'* *'sts'*
7547'softtabstop' 'sts' number (default 0)
7548 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 Number of spaces that a <Tab> counts for while performing editing
7550 operations, like inserting a <Tab> or using <BS>. It "feels" like
7551 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7552 used. This is useful to keep the 'ts' setting at its standard value
7553 of 8, while being able to edit like it is set to 'sts'. However,
7554 commands like "x" still work on the actual characters.
7555 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007556 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007557 'softtabstop' is set to 0 when the 'paste' option is set and restored
7558 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7560 spaces is minimized by using <Tab>s.
7561 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7562 set.
7563 NOTE: This option is set to 0 when 'compatible' is set.
7564
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007565 If Vim is compiled with the |+vartabs| feature then the value of
7566 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7567 anything other than an empty string.
7568
Bram Moolenaar217ad922005-03-20 22:37:15 +00007569 *'spell'* *'nospell'*
7570'spell' boolean (default off)
7571 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007572 {not available when compiled without the |+syntax|
7573 feature}
7574 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007575 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007576
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007577 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007578'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007579 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007580 {not available when compiled without the |+syntax|
7581 feature}
7582 Pattern to locate the end of a sentence. The following word will be
7583 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007584 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007585 When this check is not wanted make this option empty.
7586 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007587 Be careful with special characters, see |option-backslash| about
7588 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007589 To set this option automatically depending on the language, see
7590 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007591
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007592 *'spellfile'* *'spf'*
7593'spellfile' 'spf' string (default empty)
7594 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007595 {not available when compiled without the |+syntax|
7596 feature}
7597 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007598 commands. It must end in ".{encoding}.add". You need to include the
7599 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007600 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007601 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007602 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007603 |zg| and |zw| commands can be used to access each. This allows using
7604 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007605 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007606 you: Using the first directory in 'runtimepath' that is writable. If
7607 there is no "spell" directory yet it will be created. For the file
7608 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007609 ignoring the region.
7610 The resulting ".spl" file will be used for spell checking, it does not
7611 have to appear in 'spelllang'.
7612 Normally one file is used for all regions, but you can add the region
7613 name if you want to. However, it will then only be used when
7614 'spellfile' is set to it, for entries in 'spelllang' only files
7615 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007616 This option cannot be set from a |modeline| or in the |sandbox|, for
7617 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007618
Bram Moolenaar217ad922005-03-20 22:37:15 +00007619 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007620'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007621 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007622 {not available when compiled without the |+syntax|
7623 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007624 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007625 on spellchecking will be done for these languages. Example: >
7626 set spelllang=en_us,nl,medical
7627< This means US English, Dutch and medical words are recognized. Words
7628 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007629 The word list name must consist of alphanumeric characters, a dash or
7630 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007631 recommended to separate the two letter language name from a
7632 specification. Thus "en-rare" is used for rare English words.
7633 A region name must come last and have the form "_xx", where "xx" is
7634 the two-letter, lower case region name. You can use more than one
7635 region by listing them: "en_us,en_ca" supports both US and Canadian
7636 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007637 Britain. (Note: currently en_au and en_nz dictionaries are older than
7638 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007639 If the name "cjk" is included East Asian characters are excluded from
7640 spell checking. This is useful when editing text that also has Asian
7641 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007642 Note that the "medical" dictionary does not exist, it is just an
7643 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007644 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007645 As a special case the name of a .spl file can be given as-is. The
7646 first "_xx" in the name is removed and used as the region name
7647 (_xx is an underscore, two letters and followed by a non-letter).
7648 This is mainly for testing purposes. You must make sure the correct
7649 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007650 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007651 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7652 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007653 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007654
Bram Moolenaar98692072006-02-04 00:57:42 +00007655 If the |spellfile.vim| plugin is active and you use a language name
7656 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7657 will ask you if you want to download the file.
7658
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007659 After this option has been set successfully, Vim will source the files
7660 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007661 up to the first character that is not an ASCII letter or number and
7662 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007663
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007664 *'spelloptions'* *'spo'*
7665'spelloptions' 'spo' string (default "")
7666 local to buffer
7667 {not available when compiled without the |+syntax|
7668 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007669 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007670 camel When a word is CamelCased, assume "Cased" is a
7671 separate word: every upper-case character in a word
7672 that comes after a lower case character indicates the
7673 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007674
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007675 *'spellsuggest'* *'sps'*
7676'spellsuggest' 'sps' string (default "best")
7677 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007678 {not available when compiled without the |+syntax|
7679 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007680 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007681 the |spellsuggest()| function. This is a comma-separated list of
7682 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007683
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007684 best Internal method that works best for English. Finds
7685 changes like "fast" and uses a bit of sound-a-like
7686 scoring to improve the ordering.
7687
7688 double Internal method that uses two methods and mixes the
7689 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007690 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007691 word. That only works when the language specifies
7692 sound folding. Can be slow and doesn't always give
7693 better results.
7694
7695 fast Internal method that only checks for simple changes:
7696 character inserts/deletes/swaps. Works well for
7697 simple typing mistakes.
7698
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007699 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007700 Not used for |spellsuggest()|. The number of
7701 suggestions is never more than the value of 'lines'
7702 minus two.
7703
Bram Moolenaar585ee072022-01-29 11:22:17 +00007704 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007705 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007706 methods. When omitted the limit is 5000. When
7707 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007708 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007709
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007710 file:{filename} Read file {filename}, which must have two columns,
7711 separated by a slash. The first column contains the
7712 bad word, the second column the suggested good word.
7713 Example:
7714 theribal/terrible ~
7715 Use this for common mistakes that do not appear at the
7716 top of the suggestion list with the internal methods.
7717 Lines without a slash are ignored, use this for
7718 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007719 The word in the second column must be correct,
7720 otherwise it will not be used. Add the word to an
7721 ".add" file if it is currently flagged as a spelling
7722 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007723 The file is used for all languages.
7724
7725 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007726 trouble with spaces. Best is to call a function
7727 without arguments, see |expr-option-function|.
7728 |v:val| holds the badly spelled word. The expression
7729 must evaluate to a List of Lists, each with a
7730 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007731 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007732 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007733 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007734 internal methods use. A lower score is better.
7735 This may invoke |spellsuggest()| if you temporarily
7736 set 'spellsuggest' to exclude the "expr:" part.
7737 Errors are silently ignored, unless you set the
7738 'verbose' option to a non-zero value.
7739
7740 Only one of "best", "double" or "fast" may be used. The others may
7741 appear several times in any order. Example: >
7742 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7743<
7744 This option cannot be set from a |modeline| or in the |sandbox|, for
7745 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007746
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7748'splitbelow' 'sb' boolean (default off)
7749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 When on, splitting a window will put the new window below the current
7751 one. |:split|
7752
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007753 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007754'splitkeep' 'spk' string (default "cursor")
7755 global
7756 The value of this option determines the scroll behavior when opening,
7757 closing or resizing horizontal splits.
7758
7759 Possible values are:
7760 cursor Keep the same relative cursor position.
7761 screen Keep the text on the same screen line.
7762 topline Keep the topline the same.
7763
7764 For the "screen" and "topline" values, the cursor position will be
7765 changed when necessary. In this case, the jumplist will be populated
7766 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007767 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007768
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7770'splitright' 'spr' boolean (default off)
7771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 When on, splitting a window will put the new window right of the
7773 current one. |:vsplit|
7774
7775 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7776'startofline' 'sol' boolean (default on)
7777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007779 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007780 (if possible). This applies to the commands:
7781 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7782 - "d", "<<" and ">>" with a linewise operator
7783 - "%" with a count
7784 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7785 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 In case of buffer changing commands the cursor is placed at the column
7787 where it was the last time the buffer was edited.
7788 NOTE: This option is set when 'compatible' is set.
7789
Bram Moolenaar00654022011-02-25 14:42:19 +01007790 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007792 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 {not available when compiled without the |+statusline|
7794 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007795 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 Also see |status-line|.
7797
7798 The option consists of printf style '%' items interspersed with
7799 normal text. Each status line item is of the form:
7800 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007801 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007802 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803
Bram Moolenaar238a5642006-02-21 22:12:05 +00007804 When the option starts with "%!" then it is used as an expression,
7805 evaluated and the result is used as the option value. Example: >
7806 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007807< The *g:statusline_winid* variable will be set to the |window-ID| of the
7808 window that the status line belongs to.
7809 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007810 Note that the "%!" expression is evaluated in the context of the
7811 current window and buffer, while %{} items are evaluated in the
7812 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007813
7814 When there is error while evaluating the option then it will be made
7815 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007816 When the result contains unprintable characters the result is
7817 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007818
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 Note that the only effect of 'ruler' when this option is set (and
7820 'laststatus' is 2) is controlling the output of |CTRL-G|.
7821
7822 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007823 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007825 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 minwid Minimum width of the item, padding as set by '-' & '0'.
7827 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007828 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 on the left for text items. Numeric items will be
7830 shifted down to maxwid-2 digits followed by '>'number
7831 where number is the amount of missing digits, much like
7832 an exponential notation.
7833 item A one letter code as described below.
7834
7835 Following is a description of the possible statusline items. The
7836 second character in "item" is the type:
7837 N for number
7838 S for string
7839 F for flags as described below
7840 - not applicable
7841
7842 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007843 f S Path to the file in the buffer, as typed or relative to current
7844 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 F S Full path to the file in the buffer.
7846 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007847 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007849 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007851 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007853 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007855 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007857 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7859 being used: "<keymap>"
7860 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007861 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 B N As above, in hexadecimal.
7863 o N Byte number in file of byte under cursor, first byte is 1.
7864 Mnemonic: Offset from start of file (with one added)
7865 {not available when compiled without |+byte_offset| feature}
7866 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007867 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 l N Line number.
7869 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007870 c N Column number (byte index).
7871 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007872 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 p N Percentage through file in lines as in |CTRL-G|.
7874 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007875 percentage described for 'ruler'. Always 3 in length, unless
7876 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007877 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007878 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007880 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007881 Note that there is no '%' before the closing '}'. The
7882 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007883 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007884 {% - This is almost same as { except the result of the expression is
7885 re-evaluated as a statusline format string. Thus if the
7886 return value of expr contains % items they will get expanded.
7887 The expression can contain the } character, the end of
7888 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007889 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007890 func! Stl_filename() abort
7891 return "%t"
7892 endfunc
7893< `stl=%{Stl_filename()}` results in `"%t"`
7894 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007895 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 ( - Start of item group. Can be used for setting the width and
7897 alignment of a section. Must be followed by %) somewhere.
7898 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007899 T N For 'tabline': start of tab page N label. Use %T after the last
7900 label. This information is used for mouse clicks.
7901 X N For 'tabline': start of close tab N label. Use %X after the
7902 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7903 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 < - Where to truncate line if too long. Default is at the start.
7905 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007906 = - Separation point between alignment sections. Each section will
7907 be separated by an equal number of spaces. With one %= what
7908 comes after it will be right-aligned. With two %= there is a
7909 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007911 # - Set highlight group. The name must follow and then a # again.
7912 Thus use %#HLname# for highlight group HLname. The same
7913 highlighting is used, also for the statusline of non-current
7914 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007916 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007917 The difference between User{N} and StatusLine will be applied to
7918 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 The number N must be between 1 and 9. See |hl-User1..9|
7920
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007921 When displaying a flag, Vim removes the leading comma, if any, when
7922 that flag comes right after plaintext. This will make a nice display
7923 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924
Bram Moolenaar582fd852005-03-28 20:58:01 +00007925 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 not set) and a minwid is not set for the group, the whole group will
7927 become empty. This will make a group like the following disappear
7928 completely from the statusline when none of the flags are set. >
7929 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007930< Beware that an expression is evaluated each and every time the status
7931 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007932 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007933 While evaluating %{} the current buffer and current window will be set
7934 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007935 currently being drawn. The expression will evaluate in this context.
7936 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7937 real current buffer and "g:actual_curwin" to the |window-ID| of the
7938 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007939
Bram Moolenaar30b65812012-07-12 22:01:11 +02007940 The 'statusline' option will be evaluated in the |sandbox| if set from
7941 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007942 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007943
7944 It is not allowed to change text or jump to another window while
7945 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946
7947 If the statusline is not updated when you want it (e.g., after setting
7948 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007949 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007951 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 Otherwise the result is taken as flag text and applied to the rules
7953 described above.
7954
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007955 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007957 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958
7959 Examples:
7960 Emulate standard status line with 'ruler' set >
7961 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7962< Similar, but add ASCII value of char under the cursor (like "ga") >
7963 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7964< Display byte count and byte value, modified flag in red. >
7965 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7966 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7967< Display a ,GZ flag if a compressed file is loaded >
7968 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7969< In the |:autocmd|'s: >
7970 :let b:gzflag = 1
7971< And: >
7972 :unlet b:gzflag
7973< And define this function: >
7974 :function VarExists(var, val)
7975 : if exists(a:var) | return a:val | else | return '' | endif
7976 :endfunction
7977<
7978 *'suffixes'* *'su'*
7979'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 Files with these suffixes get a lower priority when multiple files
7982 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007983 suffixes. Spaces after the comma are ignored. A dot is also seen as
7984 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 separator, precede it with a backslash (see |option-backslash| about
7986 including spaces and backslashes).
7987 See 'wildignore' for completely ignoring files.
7988 The use of |:set+=| and |:set-=| is preferred when adding or removing
7989 suffixes from the list. This avoids problems when a future version
7990 uses another default.
7991
7992 *'suffixesadd'* *'sua'*
7993'suffixesadd' 'sua' string (default "")
7994 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007995 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 file for the "gf", "[I", etc. commands. Example: >
7997 :set suffixesadd=.java
7998<
7999 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8000'swapfile' 'swf' boolean (default on)
8001 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008002 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 swapfile is not wanted for a specific buffer. For example, with
8004 confidential information that even root must not be able to access.
8005 Careful: All text will be in memory:
8006 - Don't use this for big files.
8007 - Recovery will be impossible!
8008 A swapfile will only be present when |'updatecount'| is non-zero and
8009 'swapfile' is set.
8010 When 'swapfile' is reset, the swap file for the current buffer is
8011 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8012 non-zero, a swap file is immediately created.
8013 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008014 If you want to open a new buffer without creating a swap file for it,
8015 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008016 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017
8018 This option is used together with 'bufhidden' and 'buftype' to
8019 specify special kinds of buffers. See |special-buffers|.
8020
8021 *'swapsync'* *'sws'*
8022'swapsync' 'sws' string (default "fsync")
8023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008025 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 When this option is empty parts of the swap file may be in memory and
8027 not written to disk. When the system crashes you may lose more work.
8028 On Unix the system does a sync now and then without Vim asking for it,
8029 so the disadvantage of setting this option off is small. On some
8030 systems the swap file will not be written at all. For a unix system
8031 setting it to "sync" will use the sync() call instead of the default
8032 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008033 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034
8035 *'switchbuf'* *'swb'*
8036'switchbuf' 'swb' string (default "")
8037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008039 This option is checked, when
8040 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008041 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008042 - jumping to a tag using the |:stag| command.
8043 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8044 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8045 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008046 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008047 useopen If included, jump to the first open window in the
8048 current tab page that contains the specified buffer
8049 (if there is one). Otherwise: Do not examine other
8050 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008051 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008052 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008054 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008055 Otherwise: do not split, use current window (when used
8056 in the quickfix window: the previously used window or
8057 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008058 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008059 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008060 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008061 uselast If included, jump to the previously used window when
8062 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008063 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8064 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008066 *'synmaxcol'* *'smc'*
8067'synmaxcol' 'smc' number (default 3000)
8068 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008069 {not available when compiled without the |+syntax|
8070 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008071 Maximum column in which to search for syntax items. In long lines the
8072 text after this column is not highlighted and following lines may not
8073 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008074 This helps to avoid very slow redrawing for an XML file that is one
8075 long line.
8076 Set to zero to remove the limit.
8077
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 *'syntax'* *'syn'*
8079'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008080 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 {not available when compiled without the |+syntax|
8082 feature}
8083 When this option is set, the syntax with this name is loaded, unless
8084 syntax highlighting has been switched off with ":syntax off".
8085 Otherwise this option does not always reflect the current syntax (the
8086 b:current_syntax variable does).
8087 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008088 not automatically recognized. Example, in an IDL file:
8089 /* vim: set syntax=idl : */ ~
8090 When a dot appears in the value then this separates two filetype
8091 names. Example:
8092 /* vim: set syntax=c.doxygen : */ ~
8093 This will use the "c" syntax first, then the "doxygen" syntax.
8094 Note that the second one must be prepared to be loaded as an addition,
8095 otherwise it will be skipped. More than one dot may appear.
8096 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 :set syntax=OFF
8098< To switch syntax highlighting on according to the current value of the
8099 'filetype' option: >
8100 :set syntax=ON
8101< What actually happens when setting the 'syntax' option is that the
8102 Syntax autocommand event is triggered with the value as argument.
8103 This option is not copied to another buffer, independent of the 's' or
8104 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008105 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106
LemonBoy5247b0b2024-07-12 19:30:58 +02008107 *'tabclose'* *'tcl'*
8108'tabclose' 'tcl' string (default "")
8109 global
8110 This option controls the behavior when closing tab pages (e.g., using
8111 |:tabclose|). When empty Vim goes to the next (right) tab page.
8112
8113 Possible values (comma-separated list):
8114 left If included, go to the previous tab page instead of
8115 the next one.
8116 uselast If included, go to the previously used tab page if
8117 possible. This option takes precedence over the
8118 others.
8119
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008120 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008121'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008122 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008123 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008124 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008125 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008126
8127 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008128 option and only when there is no GUI tab line. When 'e' is in
8129 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008130 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008131
8132 The value is evaluated like with 'statusline'. You can use
8133 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008134 the text to be displayed. Use "%1T" for the first label, "%2T" for
8135 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008136
Bram Moolenaare12bab32019-01-08 22:02:56 +01008137 When changing something that is used in 'tabline' that does not
8138 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008139 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008140
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008141 Keep in mind that only one of the tab pages is the current one, others
8142 are invisible and you can't jump to their windows.
8143
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008144 *'tabpagemax'* *'tpm'*
8145'tabpagemax' 'tpm' number (default 10)
8146 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008147 Maximum number of tab pages to be opened by the |-p| command line
8148 argument or the ":tab all" command. |tabpage|
8149
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008150 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151'tabstop' 'ts' number (default 8)
8152 local to buffer
8153 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008154 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155
8156 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008157 appear wrong in many places, e.g., when printing it.
8158 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008160 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8162 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008163 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008165 This is the recommended way, the file will look the same with other
8166 tools and when listing it in a terminal.
8167 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8168 'expandtab'. This way you will always insert spaces. The
8169 formatting will never be messed up when 'tabstop' is changed (leave
8170 it at 8 just in case). The file will be a bit larger.
8171 You do need to check if no Tabs exist in the file. You can get rid
8172 of them by first setting 'expandtab' and using `%retab!`, making
8173 sure the value of 'tabstop' is set correctly.
8174 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 'expandtab'. This way you will always insert spaces. The
8176 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008177 You do need to check if no Tabs exist in the file, just like in the
8178 item just above.
8179 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008180 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008181 works when using Vim to edit the file, other tools assume a tabstop
8182 is worth 8 spaces.
8183 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 'noexpandtab'. This should then work (for initial indents only)
8185 for any tabstop setting that people use. It might be nice to have
8186 tabs after the first non-blank inserted as spaces if you do this
8187 though. Otherwise aligned comments will be wrong when 'tabstop' is
8188 changed.
8189
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008190 If Vim is compiled with the |+vartabs| feature then the value of
8191 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8192 than an empty string.
8193
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8195'tagbsearch' 'tbs' boolean (default on)
8196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008198 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 searching makes searching for a tag a LOT faster, but a linear search
8200 will find more tags if the tags file wasn't properly sorted.
8201 Vim normally assumes that your tags files are sorted, or indicate that
8202 they are not sorted. Only when this is not the case does the
8203 'tagbsearch' option need to be switched off.
8204
8205 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008206 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 certain files, or retry all files with a linear search. When
8208 'tagbsearch' is off, only a linear search is done.
8209
8210 Linear searching is done anyway, for one file, when Vim finds a line
8211 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008212 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213< [The whitespace before and after the '0' must be a single <Tab>]
8214
8215 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008216 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 instead of a normal tag name, a retry is done with a linear search.
8218 Tags in unsorted tags files, and matches with different case will only
8219 be found in the retry.
8220
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008221 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008222 linear search can be avoided when case is ignored. Use a value of '2'
8223 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8224 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008225 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8226 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8227 used for this as well. Note that case must be folded to uppercase for
8228 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008229
8230 By default, tag searches are case-sensitive. Case is ignored when
8231 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8232 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008233 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8234 'tagcase' is "smart", and the pattern contains only lowercase
8235 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236
8237 When 'tagbsearch' is off, tags searching is slower when a full match
8238 exists, but faster when no full match exists. Tags in unsorted tags
8239 files may only be found with 'tagbsearch' off.
8240 When the tags file is not sorted, or sorted in a wrong way (not on
8241 ASCII byte value), 'tagbsearch' should be off, or the line given above
8242 must be included in the tags file.
8243 This option doesn't affect commands that find all matching tags (e.g.,
8244 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008246 *'tagcase'* *'tc'*
8247'tagcase' 'tc' string (default "followic")
8248 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008249 This option specifies how case is handled when searching the tags
8250 file:
8251 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008252 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008253 ignore Ignore case
8254 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008255 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008256 NOTE: This option is set to the Vi default value when 'compatible' is
8257 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008258
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008259 *'tagfunc'* *'tfu'*
8260'tagfunc' 'tfu' string (default: empty)
8261 local to buffer
8262 {not available when compiled without the |+eval|
8263 feature}
8264 This option specifies a function to be used to perform tag searches.
8265 The function gets the tag pattern and should return a List of matching
8266 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008267 function and an example. The value can be the name of a function, a
8268 |lambda| or a |Funcref|. See |option-value-function| for more
8269 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008270 This option cannot be set from a |modeline| or in the |sandbox|, for
8271 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008272
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 *'taglength'* *'tl'*
8274'taglength' 'tl' number (default 0)
8275 global
8276 If non-zero, tags are significant up to this number of characters.
8277
8278 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8279'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8280 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008281 If on and using a tags file in another directory, file names in that
8282 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 NOTE: This option is set to the Vi default value when 'compatible' is
8284 set and to the Vim default value when 'compatible' is reset.
8285
8286 *'tags'* *'tag'* *E433*
8287'tags' 'tag' string (default "./tags,tags", when compiled with
8288 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8289 global or local to buffer |global-local|
8290 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008291 include a space or comma in a file name, precede it with backslashes
8292 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 When a file name starts with "./", the '.' is replaced with the path
8294 of the current file. But only when the 'd' flag is not included in
8295 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8296 |tags-option|.
8297 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008298 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8299 find all files named "tags" below "/lib". The filename itself cannot
8300 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008301 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008302 The |tagfiles()| function can be used to get a list of the file names
8303 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8305 files are also supported. They are automatically recognized. The
8306 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8307 differences are ignored (MS-Windows). |emacs-tags|
8308 The use of |:set+=| and |:set-=| is preferred when adding or removing
8309 file names from the list. This avoids problems when a future version
8310 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311
8312 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8313'tagstack' 'tgst' boolean (default on)
8314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 When on, the |tagstack| is used normally. When off, a ":tag" or
8316 ":tselect" command with an argument will not push the tag onto the
8317 tagstack. A following ":tag" without an argument, a ":pop" command or
8318 any other command that uses the tagstack will use the unmodified
8319 tagstack, but does change the pointer to the active entry.
8320 Resetting this option is useful when using a ":tag" command in a
8321 mapping which should not change the tagstack.
8322
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008323 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008324'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008325 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008326 {only available when compiled with the |+tcl/dyn|
8327 feature}
8328 Specifies the name of the Tcl shared library. The default is
8329 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008330 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008331 This option cannot be set from a |modeline| or in the |sandbox|, for
8332 security reasons.
8333
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 *'term'* *E529* *E530* *E531*
8335'term' string (default is $TERM, if that fails:
8336 in the GUI: "builtin_gui"
8337 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008338 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 on Unix: "ansi"
8341 on VMS: "ansi"
8342 on Win 32: "win32")
8343 global
8344 Name of the terminal. Used for choosing the terminal control
8345 characters. Environment variables are expanded |:set_env|.
8346 For example: >
8347 :set term=$TERM
8348< See |termcap|.
8349
8350 *'termbidi'* *'tbidi'*
8351 *'notermbidi'* *'notbidi'*
8352'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 {only available when compiled with the |+arabic|
8355 feature}
8356 The terminal is in charge of Bi-directionality of text (as specified
8357 by Unicode). The terminal is also expected to do the required shaping
8358 that some languages (such as Arabic) require.
8359 Setting this option implies that 'rightleft' will not be set when
8360 'arabic' is set and the value of 'arabicshape' will be ignored.
8361 Note that setting 'termbidi' has the immediate effect that
8362 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8363 This option is reset when the GUI is started.
8364 For further details see |arabic.txt|.
8365
8366 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008367'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 Encoding used for the terminal. This specifies what character
8370 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008371 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008372 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008373 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008374 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8376 Any attempts to set a different value will be rejected, and an error
8377 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008378 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 because the Win32 system always passes Unicode characters.
8380 When empty, the same encoding is used as for the 'encoding' option.
8381 This is the normal value.
8382 Not all combinations for 'termencoding' and 'encoding' are valid. See
8383 |encoding-table|.
8384 The value for this option must be supported by internal conversions or
8385 iconv(). When this is not possible no conversion will be done and you
8386 will probably experience problems with non-ASCII characters.
8387 Example: You are working with the locale set to euc-jp (Japanese) and
8388 want to edit a UTF-8 file: >
8389 :let &termencoding = &encoding
8390 :set encoding=utf-8
8391< You need to do this when your system has no locale support for UTF-8.
8392
Bram Moolenaar938ae282023-02-20 20:44:55 +00008393 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008394'termguicolors' 'tgc' boolean (default off)
8395 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008396 {not available when compiled without the
8397 |+termguicolors| feature}
8398 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008399 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008400
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008401 Requires a ISO-8613-3 compatible terminal. If setting this option
8402 does not work (produces a colorless UI) reading |xterm-true-color|
8403 might help.
8404
8405 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8406 is required. Use this check to find out: >
8407 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008408< This requires Vim to be built with the |+vtp| feature.
8409
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008410 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008411
8412 When using Vim with Windows Terminal, the background of Windows
8413 Terminal is normally filled with the Vim background color. Setting
8414 'termguicolors' and the guibg of the Normal highlight group to NONE
8415 will make the background transparent: >
8416 :hi Normal guibg=NONE
8417<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008418 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008419
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008420 *'termwinkey'* *'twk'*
8421'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008422 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008423 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008424 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008425 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008426 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008427< The string must be one key stroke but can be multiple bytes.
8428 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008429 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008430 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008431
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008432 *'termwinscroll'* *'twsl'*
8433'termwinscroll' 'twsl' number (default 10000)
8434 local to buffer
8435 {not available when compiled without the
8436 |+terminal| feature}
8437 Number of scrollback lines to keep. When going over this limit the
8438 first 10% of the scrollback lines are deleted. This is just to reduce
8439 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008440 Also used as a limit for text sent to the terminal in one write,
8441 multiplied by the number of columns times 3 (average number of bytes
8442 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008443
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008444 *'termwinsize'* *'tws'*
8445'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008446 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008447 Size used when opening the |terminal| window. Format:
8448 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008449 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008450 - When set with a "x" (e.g., "24x80") the terminal size is not
8451 adjusted to the window size. If the window is smaller only the
8452 top-left part is displayed.
8453 - When set with a "*" (e.g., "10*50") the terminal size follows the
8454 window size, but will not be smaller than the specified rows and/or
8455 columns.
8456 - When rows is zero then use the height of the window.
8457 - When columns is zero then use the width of the window.
8458 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008459 - Can be overruled in the |term_start()| options with "term_rows" and
8460 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008461
8462 Examples:
8463 "30x0" uses 30 rows and the current window width.
8464 "20*0" uses at least 20 rows and the current window width.
8465 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008466 Note that the command running in the terminal window may still change
8467 the size of the terminal. In that case the Vim window will be
8468 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008469
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008470 *'termwintype'* *'twt'*
8471'termwintype' 'twt' string (default "")
8472 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008473 {only available when compiled with the |terminal|
8474 feature on MS-Windows}
8475 Specify the virtual console (pty) used when opening the terminal
8476 window.
8477
8478 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008479 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008480 "winpty" use winpty, fail if not supported
8481 "conpty" use |ConPTY|, fail if not supported
8482
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008483 |ConPTY| support depends on the platform. Windows 10 October 2018
8484 Update is the first version that supports ConPTY, however it is still
8485 considered unstable. ConPTY might become stable in the next release
8486 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008487 supported then you cannot open a terminal window.
8488
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 *'terse'* *'noterse'*
8490'terse' boolean (default off)
8491 global
8492 When set: Add 's' flag to 'shortmess' option (this makes the message
8493 for a search that hits the start or end of the file not being
8494 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8495 shortens a lot of messages}
8496
8497 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8498'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 This option is obsolete. Use 'fileformats'.
8501 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8502 set to the default value for the current system. When 'textauto' is
8503 reset, 'fileformats' is made empty.
8504 NOTE: This option is set to the Vi default value when 'compatible' is
8505 set and to the Vim default value when 'compatible' is reset.
8506
8507 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008508'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 others: default off)
8510 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 This option is obsolete. Use 'fileformat'.
8512 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8513 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8514 "unix".
8515
8516 *'textwidth'* *'tw'*
8517'textwidth' 'tw' number (default 0)
8518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 Maximum width of text that is being inserted. A longer line will be
8520 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008521 this.
8522 'textwidth' is set to 0 when the 'paste' option is set and restored
8523 when 'paste' is reset.
8524 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008526 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 NOTE: This option is set to 0 when 'compatible' is set.
8528
8529 *'thesaurus'* *'tsr'*
8530'thesaurus' 'tsr' string (default "")
8531 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008533 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8534 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008535
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008536 This option is not used if 'thesaurusfunc' is set, either for the
8537 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008538
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008539 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008541 name. See |option-backslash| about using backslashes. The use of
8542 |:set+=| and |:set-=| is preferred when adding or removing directories
8543 from the list. This avoids problems when a future version uses
8544 another default. Backticks cannot be used in this option for security
8545 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008547 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008548'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008549 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008550 {not available when compiled without the |+eval|
8551 feature}
8552 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008553 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008554 The value can be the name of a function, a |lambda| or a |Funcref|.
8555 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008556
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008557 This option cannot be set from a |modeline| or in the |sandbox|, for
8558 security reasons.
8559
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8561'tildeop' 'top' boolean (default off)
8562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 When on: The tilde command "~" behaves like an operator.
8564 NOTE: This option is reset when 'compatible' is set.
8565
8566 *'timeout'* *'to'* *'notimeout'* *'noto'*
8567'timeout' 'to' boolean (default on)
8568 global
laburnumT3f7855a2023-12-05 18:37:03 +01008569
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008571'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 These two options together determine the behavior when part of a
8574 mapped key sequence or keyboard code has been received:
8575
8576 'timeout' 'ttimeout' action ~
8577 off off do not time out
8578 on on or off time out on :mappings and key codes
8579 off on time out on key codes
8580
8581 If both options are off, Vim will wait until either the complete
8582 mapping or key sequence has been received, or it is clear that there
8583 is no mapping or key sequence for the received characters. For
8584 example: if you have mapped "vl" and Vim has received 'v', the next
8585 character is needed to see if the 'v' is followed by an 'l'.
8586 When one of the options is on, Vim will wait for about 1 second for
8587 the next character to arrive. After that the already received
8588 characters are interpreted as single characters. The waiting time can
8589 be changed with the 'timeoutlen' option.
8590 On slow terminals or very busy systems timing out may cause
8591 malfunctioning cursor keys. If both options are off, Vim waits
8592 forever after an entered <Esc> if there are key codes that start
8593 with <Esc>. You will have to type <Esc> twice. If you do not have
8594 problems with key codes, but would like to have :mapped key
8595 sequences not timing out in 1 second, set the 'ttimeout' option and
8596 reset the 'timeout' option.
8597
8598 NOTE: 'ttimeout' is reset when 'compatible' is set.
8599
8600 *'timeoutlen'* *'tm'*
8601'timeoutlen' 'tm' number (default 1000)
8602 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008603
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008605'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 The time in milliseconds that is waited for a key code or mapped key
8608 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8609 when part of a command has been typed.
8610 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8611 different timeout value for key codes is desired set 'ttimeoutlen' to
8612 a non-negative number.
8613
8614 ttimeoutlen mapping delay key code delay ~
8615 < 0 'timeoutlen' 'timeoutlen'
8616 >= 0 'timeoutlen' 'ttimeoutlen'
8617
8618 The timeout only happens when the 'timeout' and 'ttimeout' options
8619 tell so. A useful setting would be >
8620 :set timeout timeoutlen=3000 ttimeoutlen=100
8621< (time out on mapping after three seconds, time out on key codes after
8622 a tenth of a second).
8623
8624 *'title'* *'notitle'*
8625'title' boolean (default off, on when title can be restored)
8626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 When on, the title of the window will be set to the value of
8628 'titlestring' (if it is not empty), or to:
8629 filename [+=-] (path) - VIM
8630 Where:
8631 filename the name of the file being edited
8632 - indicates the file cannot be modified, 'ma' off
8633 + indicates the file was modified
8634 = indicates the file is read-only
8635 =+ indicates the file is read-only and modified
8636 (path) is the path of the file being edited
8637 - VIM the server name |v:servername| or "VIM"
8638 Only works if the terminal supports setting window titles
8639 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008640 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8642 *X11*
8643 When Vim was compiled with HAVE_X11 defined, the original title will
8644 be restored if possible. The output of ":version" will include "+X11"
8645 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8646 works for the icon name |'icon'|.
8647 But: When Vim was started with the |-X| argument, restoring the title
8648 will not work (except in the GUI).
8649 If the title cannot be restored, it is set to the value of 'titleold'.
8650 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008651 When using an xterm from a remote machine you can use this command: >
8652
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008654 ssh -X machine_name xterm &
8655<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 then the WINDOWID environment variable should be inherited and the
8657 title of the window should change back to what it should be after
8658 exiting Vim.
8659
8660 *'titlelen'*
8661'titlelen' number (default 85)
8662 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008664 title. When the title is longer, only the end of the path name is
8665 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 Using a percentage makes this adapt to the width of the window. But
8667 it won't work perfectly, because the actual number of characters
8668 available also depends on the font used and other things in the title
8669 bar. When 'titlelen' is zero the full path is used. Otherwise,
8670 values from 1 to 30000 percent can be used.
8671 'titlelen' is also used for the 'titlestring' option.
8672
8673 *'titleold'*
8674'titleold' string (default "Thanks for flying Vim")
8675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 This option will be used for the window title when exiting Vim if the
8677 original title cannot be restored. Only happens if 'title' is on or
8678 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008679 This option cannot be set from a |modeline| or in the |sandbox|, for
8680 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 *'titlestring'*
8682'titlestring' string (default "")
8683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 When this option is not empty, it will be used for the title of the
8685 window. This happens only when the 'title' option is on.
8686 Only works if the terminal supports setting window titles (currently
8687 Amiga console, Win32 console, all GUI versions and terminals with a
8688 non-empty 't_ts' option).
8689 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008690 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 When this option contains printf-style '%' items, they will be
8693 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008694 This option cannot be set in a modeline when 'modelineexpr' is off.
8695
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008697 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8699< The value of 'titlelen' is used to align items in the middle or right
8700 of the available space.
8701 Some people prefer to have the file name first: >
8702 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8703< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008704 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 separating space only when needed.
8706 NOTE: Use of special characters in 'titlestring' may cause the display
8707 to be garbled (e.g., when it contains a CR or NL character).
8708 {not available when compiled without the |+statusline| feature}
8709
8710 *'toolbar'* *'tb'*
8711'toolbar' 'tb' string (default "icons,tooltips")
8712 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008713 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008714 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 possible values are:
8716 icons Toolbar buttons are shown with icons.
8717 text Toolbar buttons shown with text.
8718 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008719 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 tooltips Tooltips are active for toolbar buttons.
8721 Tooltips refer to the popup help text which appears after the mouse
8722 cursor is placed over a toolbar button for a brief moment.
8723
8724 If you want the toolbar to be shown with icons as well as text, do the
8725 following: >
8726 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008727< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 will show icons if both are requested.
8729
8730 If none of the strings specified in 'toolbar' are valid or if
8731 'toolbar' is empty, this option is ignored. If you want to disable
8732 the toolbar, you need to set the 'guioptions' option. For example: >
8733 :set guioptions-=T
8734< Also see |gui-toolbar|.
8735
8736 *'toolbariconsize'* *'tbis'*
8737'toolbariconsize' 'tbis' string (default "small")
8738 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008739 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008741 tiny Use tiny icons.
8742 small Use small icons (default).
8743 medium Use medium-sized icons.
8744 large Use large icons.
8745 huge Use even larger icons.
8746 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008748 the current theme. Common dimensions are giant=48x48, huge=32x32,
8749 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750
8751 If 'toolbariconsize' is empty, the global default size as determined
8752 by user preferences or the current theme is used.
8753
8754 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8755'ttybuiltin' 'tbi' boolean (default on)
8756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 When on, the builtin termcaps are searched before the external ones.
8758 When off the builtin termcaps are searched after the external ones.
8759 When this option is changed, you should set the 'term' option next for
8760 the change to take effect, for example: >
8761 :set notbi term=$TERM
8762< See also |termcap|.
8763 Rationale: The default for this option is "on", because the builtin
8764 termcap entries are generally better (many systems contain faulty
8765 xterm entries...).
8766
8767 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008768'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 Indicates a fast terminal connection. More characters will be sent to
8771 the screen for redrawing, instead of using insert/delete line
8772 commands. Improves smoothness of redrawing when there are multiple
8773 windows and the terminal does not support a scrolling region.
8774 Also enables the extra writing of characters at the end of each screen
8775 line for lines that wrap. This helps when using copy/paste with the
8776 mouse in an xterm and other terminals.
8777
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008778 The default used to be set only for some terminal names, but these
8779 days nearly all terminals are fast, therefore the default is now "on".
8780 If you have a slow connection you may want to set this option off,
8781 e.g. depending on the host name: >
8782 if hostname() =~ 'faraway'
8783 set nottyfast
8784 endif
8785<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 *'ttymouse'* *'ttym'*
8787'ttymouse' 'ttym' string (default depends on 'term')
8788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 {only in Unix and VMS, doesn't work in the GUI; not
8790 available when compiled without |+mouse|}
8791 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008792 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 *xterm-mouse*
8794 xterm xterm-like mouse handling. The mouse generates
8795 "<Esc>[Mscr", where "scr" is three bytes:
8796 "s" = button state
8797 "c" = column plus 33
8798 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008799 This only works up to 223 columns! See "dec",
8800 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 xterm2 Works like "xterm", but with the xterm reporting the
8802 mouse position while the mouse is dragged. This works
8803 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008804 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 work. See below for how Vim detects this
8806 automatically.
8807 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008808 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008810 for the row and column. No other mouse events are
8811 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 *dec-mouse*
8813 dec DEC terminal mouse handling. The mouse generates a
8814 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008815 This is also available for an Xterm, if it was
8816 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 *jsbterm-mouse*
8818 jsbterm JSB term mouse handling.
8819 *pterm-mouse*
8820 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008821 *urxvt-mouse*
8822 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008823 The mouse works only if the terminal supports this
8824 encoding style, but it does not have 223 columns limit
8825 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008826 *sgr-mouse*
8827 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008828 mouse reporting. The mouse works even in columns
8829 beyond 223. This option is backward compatible with
8830 "xterm2" because it can also decode "xterm2" style
8831 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832
8833 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008834 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8835 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8837 recognized, if enabled at compile time. DEC terminal mouse codes
8838 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008839 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8840 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008842 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8843 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8844 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008845 If the terminfo/termcap entry "XM" exists and the first number is
8846 "1006" then 'ttymouse' will be set to "sgr". This works for many
8847 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008848 Additionally, if vim is compiled with the |+termresponse| feature and
8849 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008850 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008852 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8853 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8854 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008855 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8856 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 :set t_RV=
8858<
8859 *'ttyscroll'* *'tsl'*
8860'ttyscroll' 'tsl' number (default 999)
8861 global
8862 Maximum number of lines to scroll the screen. If there are more lines
8863 to scroll the window is redrawn. For terminals where scrolling is
8864 very slow and redrawing is not slow this can be set to a small number,
8865 e.g., 3, to speed up displaying.
8866
8867 *'ttytype'* *'tty'*
8868'ttytype' 'tty' string (default from $TERM)
8869 global
8870 Alias for 'term', see above.
8871
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008872 *'undodir'* *'udir'*
8873'undodir' 'udir' string (default ".")
8874 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008875 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008876 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008877 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008878 "." means using the directory of the file. The undo file name for
8879 "file.txt" is ".file.txt.un~".
8880 For other directories the file name is the full path of the edited
8881 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008882 When writing: The first directory that exists is used. "." always
8883 works, no directories after "." will be used for writing.
8884 When reading all entries are tried to find an undo file. The first
8885 undo file that exists is used. When it cannot be read an error is
8886 given, no further entry is used.
8887 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008888 This option cannot be set from a |modeline| or in the |sandbox|, for
8889 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008890
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008891 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008892'undofile' 'udf' boolean (default off)
8893 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008894 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008895 When on, Vim automatically saves undo history to an undo file when
8896 writing a buffer to a file, and restores undo history from the same
8897 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008898 The directory where the undo file is stored is specified by 'undodir'.
8899 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008900 The undo file is not read when 'undoreload' causes the buffer from
8901 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008902 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008903 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008904
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008906'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008907 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008909 is kept in memory, higher numbers will cause more memory to be used.
8910 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8912 itself: >
8913 set ul=0
8914< But you can also get Vi compatibility by including the 'u' flag in
8915 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008916 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008917 Set to -1 for no undo at all. You might want to do this only for the
8918 current buffer: >
8919 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008921
8922 The local value is set to -123456 when the global value is to be used.
8923
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008924 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008926 *'undoreload'* *'ur'*
8927'undoreload' 'ur' number (default 10000)
8928 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008929 Save the whole buffer for undo when reloading it. This applies to the
8930 ":e!" command and reloading for when the buffer changed outside of
8931 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008932 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008933 of lines is smaller than the value of this option.
8934 Set this option to zero to disable undo for a reload.
8935
8936 When saving undo for a reload, any undo file is not read.
8937
8938 Note that this causes the whole buffer to be stored in memory. Set
8939 this option to a lower value if you run out of memory.
8940
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 *'updatecount'* *'uc'*
8942'updatecount' 'uc' number (default: 200)
8943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 After typing this many characters the swap file will be written to
8945 disk. When zero, no swap file will be created at all (see chapter on
8946 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8947 Vim with the "-n" option, see |startup|. When editing in readonly
8948 mode this option will be initialized to 10000.
8949 The swapfile can be disabled per buffer with |'swapfile'|.
8950 When 'updatecount' is set from zero to non-zero, swap files are
8951 created for all buffers that have 'swapfile' set. When 'updatecount'
8952 is set to zero, existing swap files are not deleted.
8953 Also see |'swapsync'|.
8954 This option has no meaning in buffers where |'buftype'| is "nofile"
8955 or "nowrite".
8956
8957 *'updatetime'* *'ut'*
8958'updatetime' 'ut' number (default 4000)
8959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 If this many milliseconds nothing is typed the swap file will be
8961 written to disk (see |crash-recovery|). Also used for the
8962 |CursorHold| autocommand event.
8963
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008964 *'varsofttabstop'* *'vsts'*
8965'varsofttabstop' 'vsts' string (default "")
8966 local to buffer
8967 {only available when compiled with the |+vartabs|
8968 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008969 A list of the number of spaces that a <Tab> counts for while editing,
8970 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8971 width <Tab>s are being inserted, while in fact a mixture of spaces
8972 and <Tab>s is used. Tab widths are separated with commas, with the
8973 final value applying to all subsequent tabs.
8974
8975 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008976 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008977 to use the following: >
8978 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008979< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8980 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008981
8982 Note that the value of |'softtabstop'| will be ignored while
8983 'varsofttabstop' is set.
8984
8985 *'vartabstop'* *'vts'*
8986'vartabstop' 'vts' string (default "")
8987 local to buffer
8988 {only available when compiled with the |+vartabs|
8989 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008990 A list of the number of spaces that a <Tab> in the file counts for,
8991 separated by commas. Each value corresponds to one tab, with the
8992 final value applying to all subsequent tabs. For example: >
8993 :set vartabstop=4,20,10,8
8994< This will make the first tab 4 spaces wide, the second 20 spaces,
8995 the third 10 spaces, and all following tabs 8 spaces.
8996
8997 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8998 is set.
8999
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 *'verbose'* *'vbs'*
9001'verbose' 'vbs' number (default 0)
9002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 When bigger than zero, Vim will give messages about what it is doing.
9004 Currently, these messages are given:
9005 >= 1 When the viminfo file is read or written.
9006 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009007 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009008 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009 >= 8 Files for which a group of autocommands is executed.
9010 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009011 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 >= 12 Every executed function.
9013 >= 13 When an exception is thrown, caught, finished, or discarded.
9014 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009015 >= 15 Every executed Ex command from a script (truncated at 200
9016 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009017 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018
9019 This option can also be set with the "-V" argument. See |-V|.
9020 This option is also set by the |:verbose| command.
9021
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009022 When the 'verbosefile' option is set then the verbose messages are not
9023 displayed.
9024
9025 *'verbosefile'* *'vfile'*
9026'verbosefile' 'vfile' string (default empty)
9027 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009028 When not empty all messages are written in a file with this name.
9029 When the file exists messages are appended.
9030 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009031 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009032 Setting 'verbosefile' to a new value is like making it empty first.
9033 The difference with |:redir| is that verbose messages are not
9034 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009035 This option cannot be set from a |modeline| or in the |sandbox|, for
9036 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009037
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009039'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009040 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009041 for Unix: "$HOME/.vim/view" or
9042 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009043 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009044 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009046 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009047 feature}
9048 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009049 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 This option cannot be set from a |modeline| or in the |sandbox|, for
9051 security reasons.
9052
9053 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009054'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009056 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009058 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009059 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 word save and restore ~
9061 cursor cursor position in file and in window
9062 folds manually created folds, opened/closed folds and local
9063 fold options
9064 options options and mappings local to a window or buffer (not
9065 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009066 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 slash backslashes in file names replaced with forward
9068 slashes
9069 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009070 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009071 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009073 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009075 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076
9077 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009078'viminfo' 'vi' string (Vi default: "", Vim default for
9079 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009080 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9081 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009083 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 feature}
9085 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009086 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9087 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009088 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009089 consisting of a single character identifying the particular parameter,
9090 followed by a number or string which specifies the value of that
9091 parameter. If a particular character is left out, then the default
9092 value is used for that parameter. The following is a list of the
9093 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009095 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 ! When included, save and restore global variables that start
9097 with an uppercase letter, and don't contain a lowercase
9098 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009099 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009100 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009101 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 " Maximum number of lines saved for each register. Old name of
9103 the '<' item, with the disadvantage that you need to put a
9104 backslash before the ", otherwise it will be recognized as the
9105 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009106 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 % When included, save and restore the buffer list. If Vim is
9108 started with a file name argument, the buffer list is not
9109 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009110 buffer list is restored from the viminfo file. Quickfix
9111 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9112 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009113 When followed by a number, the number specifies the maximum
9114 number of buffers that are stored. Without a number all
9115 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009116 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 ' Maximum number of previously edited files for which the marks
9118 are remembered. This parameter must always be included when
9119 'viminfo' is non-empty.
9120 Including this item also means that the |jumplist| and the
9121 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009122 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009124 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125 patterns are also saved. When not included, the value of
9126 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009127 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009129 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009130 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 < Maximum number of lines saved for each register. If zero then
9132 registers are not saved. When not included, all lines are
9133 saved. '"' is the old name for this item.
9134 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009135 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009137 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009138 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 c When included, convert the text in the viminfo file from the
9140 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009141 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009142 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 f Whether file marks need to be stored. If zero, file marks ('0
9144 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009145 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009147 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 h Disable the effect of 'hlsearch' when loading the viminfo
9149 file. When not included, it depends on whether ":nohlsearch"
9150 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009151 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009153 the 'n'. Must be at the end of the option! If the
9154 'viminfofile' option is set, that file name overrides the one
9155 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009156 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009157 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 r Removable media. The argument is a string (up to the next
9159 ','). This parameter can be given several times. Each
9160 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009161 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009162 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9163 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9164 ignored. Maximum length of each 'r' argument is 50
9165 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009166 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 s Maximum size of an item in Kbyte. If zero then registers are
9168 not saved. Currently only applies to registers. The default
9169 "s10" will exclude registers with more than 10 Kbyte of text.
9170 Also see the '<' item above: line count limit.
9171
9172 Example: >
9173 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9174<
9175 '50 Marks will be remembered for the last 50 files you
9176 edited.
9177 <1000 Contents of registers (up to 1000 lines each) will be
9178 remembered.
9179 s100 Registers with more than 100 Kbyte text are skipped.
9180 :0 Command-line history will not be saved.
9181 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9182 no / Since '/' is not specified, the default will be used,
9183 that is, save all of the search history, and also the
9184 previous search and substitute patterns.
9185 no % The buffer list will not be saved nor read back.
9186 no h 'hlsearch' highlighting will be restored.
9187
9188 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9189 load the contents of the file, this is not done automatically.
9190
9191 This option cannot be set from a |modeline| or in the |sandbox|, for
9192 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009193 NOTE: This option is set to the Vim default value when 'compatible'
9194 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009196 *'viminfofile'* *'vif'*
9197'viminfofile' 'vif' string (default: "")
9198 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009199 {not available when compiled without the |+viminfo|
9200 feature}
9201 When non-empty, overrides the file name used for viminfo.
9202 When equal to "NONE" no viminfo file will be read or written.
9203 This option can be set with the |-i| command line flag. The |--clean|
9204 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009205 This option cannot be set from a |modeline| or in the |sandbox|, for
9206 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009207
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 *'virtualedit'* *'ve'*
9209'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009210 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009211 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 block Allow virtual editing in Visual block mode.
9213 insert Allow virtual editing in Insert mode.
9214 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009215 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009216 none When used as the local value, do not allow virtual
9217 editing even when the global value is set. When used
9218 as the global value, "none" is the same as "".
9219 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009220
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009222 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009223 of the line. Useful for selecting a rectangle in Visual mode and
9224 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009225 "onemore" is not the same, it will only allow moving the cursor just
9226 after the last character of the line. This makes some commands more
9227 consistent. Previously the cursor was always past the end of the line
9228 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009229 break some plugins or Vim scripts. For example because |l| can move
9230 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009231 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009232 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009233 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009234 It doesn't make sense to combine "all" with "onemore", but you will
9235 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009236 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009237 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238
9239 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9240'visualbell' 'vb' boolean (default off)
9241 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009242 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009244 use: >
9245 :set vb t_vb=
9246< If you want a short flash, you can use this on many terminals: >
9247 :set vb t_vb=[?5h$<100>[?5l
9248< Here $<100> specifies the time, you can use a smaller or bigger value
9249 to get a shorter or longer flash.
9250
9251 Note: Vim will limit the bell to once per half a second. This avoids
9252 having to wait for the flashing to finish when there are lots of
9253 bells, e.g. on key repeat. This also happens without 'visualbell'
9254 set.
9255
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9257 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9258 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009259
9260 Note: When the GUI starts, 't_vb' is reset to its default value. You
9261 might want to set it again in your |gvimrc|.
9262
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263 Does not work on the Amiga, you always get a screen flash.
9264 Also see 'errorbells'.
9265
9266 *'warn'* *'nowarn'*
9267'warn' boolean (default on)
9268 global
9269 Give a warning message when a shell command is used while the buffer
9270 has been changed.
9271
9272 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9273'weirdinvert' 'wiv' boolean (default off)
9274 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009275 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 It is provided for backwards compatibility with version 4.x.
9277 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9278 vice versa. Has no effect when the GUI is running.
9279
9280 *'whichwrap'* *'ww'*
9281'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283 Allow specified keys that move the cursor left/right to move to the
9284 previous/next line when the cursor is on the first/last character in
9285 the line. Concatenate characters to allow this for these keys:
9286 char key mode ~
9287 b <BS> Normal and Visual
9288 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009289 h "h" Normal and Visual (not recommended)
9290 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 < <Left> Normal and Visual
9292 > <Right> Normal and Visual
9293 ~ "~" Normal
9294 [ <Left> Insert and Replace
9295 ] <Right> Insert and Replace
9296 For example: >
9297 :set ww=<,>,[,]
9298< allows wrap only when cursor keys are used.
9299 When the movement keys are used in combination with a delete or change
9300 operator, the <EOL> also counts for a character. This makes "3h"
9301 different from "3dh" when the cursor crosses the end of a line. This
9302 is also true for "x" and "X", because they do the same as "dl" and
9303 "dh". If you use this, you may also want to use the mapping
9304 ":map <BS> X" to make backspace delete the character in front of the
9305 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009306 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009307 line (not an empty line) then it will not move to the next line. This
9308 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 NOTE: This option is set to the Vi default value when 'compatible' is
9310 set and to the Vim default value when 'compatible' is reset.
9311
9312 *'wildchar'* *'wc'*
9313'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315 Character you have to type to start wildcard expansion in the
9316 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009317 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318 The character is not recognized when used inside a macro. See
9319 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009320 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009321 <Esc> can be used, but hitting it twice in a row will still exit
9322 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009323 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009324 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325< NOTE: This option is set to the Vi default value when 'compatible' is
9326 set and to the Vim default value when 'compatible' is reset.
9327
9328 *'wildcharm'* *'wcm'*
9329'wildcharm' 'wcm' number (default: none (0))
9330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009332 recognized when used inside a macro. You can find "spare" command-line
9333 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 you'll never actually type 'wildcharm', just use it in mappings that
9335 automatically invoke completion mode, e.g.: >
9336 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009337 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009338< Then after typing :ss you can use CTRL-P & CTRL-N.
9339
9340 *'wildignore'* *'wig'*
9341'wildignore' 'wig' string (default "")
9342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009344 patterns is ignored when expanding |wildcards|, completing file or
9345 directory names, and influences the result of |expand()|, |glob()| and
9346 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009347 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9348 Also see 'suffixes'.
9349 Example: >
9350 :set wildignore=*.o,*.obj
9351< The use of |:set+=| and |:set-=| is preferred when adding or removing
9352 a pattern from the list. This avoids problems when a future version
9353 uses another default.
9354
h_east596a9f22023-11-21 21:24:23 +09009355 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009356'wildignorecase' 'wic' boolean (default off)
9357 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009358 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009359 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009360 Does not apply when the shell is used to expand wildcards, which
9361 happens when there are special characters.
9362
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009364'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366 When 'wildmenu' is on, command-line completion operates in an enhanced
9367 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009368 the possible matches are shown.
9369 When 'wildoptions' contains "pum", then the completion matches are
9370 shown in a popup menu. Otherwise they are displayed just above the
9371 command line, with the first match highlighted (overwriting the status
9372 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009373 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9375 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9376 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009377 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 If there are more matches than can fit in the line, a ">" is shown on
9379 the right and/or a "<" is shown on the left. The status line scrolls
9380 as needed.
9381 The "wildmenu" mode is abandoned when a key is hit that is not used
9382 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009383 While the "wildmenu" is active, the following keys have special
9384 meanings:
9385 CTRL-P - go to the previous entry
9386 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009387 <CR> - in menu completion, when the cursor is just after a
9388 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009389 CTRL-E - end completion, go back to what was there before
9390 selecting a match.
9391 CTRL-Y - accept the currently selected match and stop
9392 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009393
9394 When not using the popup menu for command line completion, the
9395 following keys have special meanings:
9396 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009397 <Up> - in filename/menu name completion: move up into
9398 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009399 <Down> - in filename/menu name completion: move into a
9400 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009401
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009402 When using the popup menu for command line completion, the following
9403 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009404 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009405 <PageUp> - select a match several entries back
9406 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009407 <Left> - in filename/menu name completion: move up into
9408 parent directory or parent menu.
9409 <Right> - in filename/menu name completion: move into a
9410 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009411
Bram Moolenaar071d4272004-06-13 20:20:40 +00009412 This makes the menus accessible from the console |console-menus|.
9413
9414 If you prefer the <Left> and <Right> keys to move the cursor instead
9415 of selecting a different match, use this: >
9416 :cnoremap <Left> <Space><BS><Left>
9417 :cnoremap <Right> <Space><BS><Right>
9418<
9419 The "WildMenu" highlighting is used for displaying the current match
9420 |hl-WildMenu|.
9421
9422 *'wildmode'* *'wim'*
9423'wildmode' 'wim' string (Vim default: "full")
9424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009425 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009426 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009427 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009428 first part specifies the behavior for the first use of 'wildchar',
9429 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009430
9431 Each part consists of a colon separated list consisting of the
9432 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 "" Complete only the first match.
9434 "full" Complete the next full match. After the last match,
9435 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009436 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009437 "longest" Complete till longest common string. If this doesn't
9438 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009440 "lastused" When completing buffer names and more than one buffer
9441 matches, sort buffers by time last used (other than
9442 the current buffer).
9443 When there is only a single match, it is fully completed in all cases.
9444
9445 Examples of useful colon-separated values:
9446 "longest:full" Like "longest", but also start 'wildmenu' if it is
9447 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009448 "list:full" When more than one match, list all matches and
9449 complete first match.
9450 "list:longest" When more than one match, list all matches and
9451 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009452 "list:lastused" When more than one buffer matches, list all matches
9453 and sort buffers by time last used (other than the
9454 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009455
9456 Examples: >
9457 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009458< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009459 :set wildmode=longest,full
9460< Complete longest common string, then each full match >
9461 :set wildmode=list:full
9462< List all matches and complete each full match >
9463 :set wildmode=list,full
9464< List all matches without completing, then each full match >
9465 :set wildmode=longest,list
9466< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009467 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009468
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009469 *'wildoptions'* *'wop'*
9470'wildoptions' 'wop' string (default "")
9471 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009472 A list of words that change how |cmdline-completion| is done.
9473 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009474 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009475 this value is specified, wildcard expansion will not
9476 be used for completion. The matches will be sorted by
9477 the "best match" rather than alphabetically sorted.
9478 This will find more matches than the wildcard
9479 expansion. Currently fuzzy matching based completion
9480 is not supported for file and directory names and
9481 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009482 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009483 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009484 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009485 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009486 is displayed per line. Often used tag kinds are:
9487 d #define
9488 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009489
Bram Moolenaar071d4272004-06-13 20:20:40 +00009490 *'winaltkeys'* *'wak'*
9491'winaltkeys' 'wak' string (default "menu")
9492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 {only used in Win32, Motif, GTK and Photon GUI}
9494 Some GUI versions allow the access to menu entries by using the ALT
9495 key in combination with a character that appears underlined in the
9496 menu. This conflicts with the use of the ALT key for mappings and
9497 entering special characters. This option tells what to do:
9498 no Don't use ALT keys for menus. ALT key combinations can be
9499 mapped, but there is no automatic handling. This can then be
9500 done with the |:simalt| command.
9501 yes ALT key handling is done by the windowing system. ALT key
9502 combinations cannot be mapped.
9503 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009504 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505 keys can be mapped.
9506 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9507 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009508 This option is not used for <F10>; on Win32 and with GTK <F10> will
9509 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009510
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009511 *'wincolor'* *'wcr'*
9512'wincolor' 'wcr' string (default empty)
9513 local to window
9514 Highlight group name to use for this window instead of the Normal
9515 color |hl-Normal|.
9516
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009517 *'window'* *'wi'*
9518'window' 'wi' number (default screen height - 1)
9519 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009520 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9521 window and the value is smaller than 'lines' minus one. The screen
9522 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009523 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9524 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009525 When resizing the Vim window, and the value is smaller than 1 or more
9526 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009527 Note: Do not confuse this with the height of the Vim window, use
9528 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009529
Colin Kennedy21570352024-03-03 16:16:47 +01009530 *'winfixbuf'*
9531'winfixbuf' 'wfb' boolean (default off)
9532 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009533 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009534 For example, attempting to change the buffer with |:edit| will fail.
9535 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009536 also skip any window with 'winfixbuf' enabled. However if an Ex
9537 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009538
laburnumT3f7855a2023-12-05 18:37:03 +01009539 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9540'winfixheight' 'wfh' boolean (default off)
9541 local to window |local-noglobal|
9542 Keep the window height when windows are opened or closed and
9543 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9544 |preview-window| and |quickfix-window|.
9545 The height may be changed anyway when running out of room.
9546
9547 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9548'winfixwidth' 'wfw' boolean (default off)
9549 local to window |local-noglobal|
9550 Keep the window width when windows are opened or closed and
9551 'equalalways' is set. Also for |CTRL-W_=|.
9552 The width may be changed anyway when running out of room.
9553
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554 *'winheight'* *'wh'* *E591*
9555'winheight' 'wh' number (default 1)
9556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009558 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009559 focus goes to a window that is smaller, its size is increased, at the
9560 cost of the height of other windows.
9561 Set 'winheight' to a small number for normal editing.
9562 Set it to 999 to make the current window fill most of the screen.
9563 Other windows will be only 'winminheight' high. This has the drawback
9564 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9565 to create only two windows, set the option after startup is done,
9566 using the |VimEnter| event: >
9567 au VimEnter * set winheight=999
9568< Minimum value is 1.
9569 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009570 height of the current window.
9571 'winheight' applies to the current window. Use 'winminheight' to set
9572 the minimal height for other windows.
9573
Bram Moolenaar071d4272004-06-13 20:20:40 +00009574 *'winminheight'* *'wmh'*
9575'winminheight' 'wmh' number (default 1)
9576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009577 The minimal height of a window, when it's not the current window.
9578 This is a hard minimum, windows will never become smaller.
9579 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9580 status bar) if necessary. They will return to at least one line when
9581 they become active (since the cursor has to have somewhere to go.)
9582 Use 'winheight' to set the minimal height of the current window.
9583 This option is only checked when making a window smaller. Don't use a
9584 large number, it will cause errors when opening more than a few
9585 windows. A value of 0 to 3 is reasonable.
9586
9587 *'winminwidth'* *'wmw'*
9588'winminwidth' 'wmw' number (default 1)
9589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009590 The minimal width of a window, when it's not the current window.
9591 This is a hard minimum, windows will never become smaller.
9592 When set to zero, windows may be "squashed" to zero columns (i.e. just
9593 a vertical separator) if necessary. They will return to at least one
9594 line when they become active (since the cursor has to have somewhere
9595 to go.)
9596 Use 'winwidth' to set the minimal width of the current window.
9597 This option is only checked when making a window smaller. Don't use a
9598 large number, it will cause errors when opening more than a few
9599 windows. A value of 0 to 12 is reasonable.
9600
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009601 *'winptydll'*
9602'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9603 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009604 {only available when compiled with the |terminal|
9605 feature on MS-Windows}
9606 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009607 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009608 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009609 a fallback.
9610 Environment variables are expanded |:set_env|.
9611 This option cannot be set from a |modeline| or in the |sandbox|, for
9612 security reasons.
9613
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 *'winwidth'* *'wiw'* *E592*
9615'winwidth' 'wiw' number (default 20)
9616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617 Minimal number of columns for the current window. This is not a hard
9618 minimum, Vim will use fewer columns if there is not enough room. If
9619 the current window is smaller, its size is increased, at the cost of
9620 the width of other windows. Set it to 999 to make the current window
9621 always fill the screen. Set it to a small number for normal editing.
9622 The width is not adjusted after one of the commands to change the
9623 width of the current window.
9624 'winwidth' applies to the current window. Use 'winminwidth' to set
9625 the minimal width for other windows.
9626
9627 *'wrap'* *'nowrap'*
9628'wrap' boolean (default on)
9629 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009630 This option changes how text is displayed. It doesn't change the text
9631 in the buffer, see 'textwidth' for that.
9632 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009633 displaying continues on the next line. When off lines will not wrap
9634 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009635 moved to a part that is not shown, the screen will scroll
9636 horizontally.
9637 The line will be broken in the middle of a word if necessary. See
9638 'linebreak' to get the break at a word boundary.
9639 To make scrolling horizontally a bit more useful, try this: >
9640 :set sidescroll=5
9641 :set listchars+=precedes:<,extends:>
9642< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009643 This option can't be set from a |modeline| when the 'diff' option is
9644 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009645
9646 *'wrapmargin'* *'wm'*
9647'wrapmargin' 'wm' number (default 0)
9648 local to buffer
9649 Number of characters from the right window border where wrapping
9650 starts. When typing text beyond this limit, an <EOL> will be inserted
9651 and inserting continues on the next line.
9652 Options that add a margin, such as 'number' and 'foldcolumn', cause
9653 the text width to be further reduced. This is Vi compatible.
9654 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009655 This option is set to 0 when 'paste' is set and restored when 'paste'
9656 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009657 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009658
9659 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9660'wrapscan' 'ws' boolean (default on) *E384* *E385*
9661 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009662 Searches wrap around the end of the file. Also applies to |]s| and
9663 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009664
9665 *'write'* *'nowrite'*
9666'write' boolean (default on)
9667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009668 Allows writing files. When not set, writing a file is not allowed.
9669 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009670 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009671 argument. Filtering text is still possible, even though this requires
9672 writing a temporary file.
9673
9674 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9675'writeany' 'wa' boolean (default off)
9676 global
9677 Allows writing to any file with no need for "!" override.
9678
9679 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9680'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9681 otherwise)
9682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009683 Make a backup before overwriting a file. The backup is removed after
9684 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009685 also on.
9686 WARNING: Switching this option off means that when Vim fails to write
9687 your buffer correctly and then, for whatever reason, Vim exits, you
9688 lose both the original file and what you were writing. Only reset
9689 this option if your file system is almost full and it makes the write
9690 fail (and make sure not to exit Vim until the write was successful).
9691 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009692 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009693 Depending on 'backupcopy' the backup is a new file or the original
9694 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009695 NOTE: This option is set to the default value when 'compatible' is
9696 set.
9697
9698 *'writedelay'* *'wd'*
9699'writedelay' 'wd' number (default 0)
9700 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009701 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009702 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009703 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009704
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009705 *'xtermcodes'* *'noxtermcodes'*
9706'xtermcodes' boolean (default on)
9707 global
9708 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009709 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009710 key codes and number of colors from the terminal. This takes care of
9711 various configuration options of the terminal that cannot be obtained
9712 from the termlib/terminfo entry, see |xterm-codes|.
9713 A side effect may be that t_Co changes and Vim will redraw the
9714 display.
9715
9716
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009717 vim:tw=78:ts=8:noet:ft=help:norl: