blob: bc0e18379b14d64556853e6b134e6ef7c87babf0 [file] [log] [blame]
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02001*options.txt* For Vim version 9.1. Last change: 2024 Oct 22
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.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001154 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 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
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001159 example, as are several |file-watcher| daemons like inotify. In that
1160 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161
1162 When a copy is made, the original file is truncated and then filled
1163 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001164 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001165 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 group of the backup is set to the group of the original file. If this
1167 fails, the protection bits for the group are made the same as for
1168 others.
1169
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001170 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 the same attributes of the original file, and the newly written file
1172 is owned by the current user. When the file was a (hard/symbolic)
1173 link, the new file will not! That's why the "auto" value doesn't
1174 rename when the file is a link. The owner and group of the newly
1175 written file will be set to the same ones as the original file, but
1176 the system may refuse to do this. In that case the "auto" value will
1177 again not rename the file.
1178
Bram Moolenaar036986f2017-03-16 17:41:02 +01001179 NOTE: This option is set to the Vi default value when 'compatible' is
1180 set and to the Vim default value when 'compatible' is reset.
1181
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 *'backupdir'* *'bdir'*
1183'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001184 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 for Unix: ".,~/tmp,~/")
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 List of directories for the backup file, separated with commas.
1188 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001189 where this is possible. The directory must exist, Vim will not
1190 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001191 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 impossible!). Writing may fail because of this.
1193 - A directory "." means to put the backup file in the same directory
1194 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001195 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1196 the backup file relative to where the edited file is. The leading
1197 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 ("." inside a directory name has no special meaning).
1199 - Spaces after the comma are ignored, other spaces are considered part
1200 of the directory name. To have a space at the start of a directory
1201 name, precede it with a backslash.
1202 - To include a comma in a directory name precede it with a backslash.
1203 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001204 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001205 the backup file name will be built from the complete path to the
1206 file with all path separators changed to percent '%' signs. This
1207 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001208 On Win32, it is also possible to end with "\\". However, When a
1209 separating comma is following, you must use "//", since "\\" will
1210 include the comma in the file name. Therefore it is recommended to
1211 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 - Environment variables are expanded |:set_env|.
1213 - Careful with '\' characters, type one before a space, type two to
1214 get one in the option (see |option-backslash|), for example: >
1215 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1216< - For backwards compatibility with Vim version 3.0 a '>' at the start
1217 of the option is removed.
1218 See also 'backup' and 'writebackup' options.
1219 If you want to hide your backup files on Unix, consider this value: >
1220 :set backupdir=./.backup,~/.backup,.,/tmp
1221< You must create a ".backup" directory in each directory and in your
1222 home directory for this to work properly.
1223 The use of |:set+=| and |:set-=| is preferred when adding or removing
1224 directories from the list. This avoids problems when a future version
1225 uses another default.
1226 This option cannot be set from a |modeline| or in the |sandbox|, for
1227 security reasons.
1228
1229 *'backupext'* *'bex'* *E589*
1230'backupext' 'bex' string (default "~", for VMS: "_")
1231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 String which is appended to a file name to make the name of the
1233 backup file. The default is quite unusual, because this avoids
1234 accidentally overwriting existing files with a backup file. You might
1235 prefer using ".bak", but make sure that you don't have files with
1236 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001237 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001239 If you like to keep a lot of backups, you could use a BufWritePre
1240 autocommand to change 'backupext' just before writing the file to
1241 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001242 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001243< Use 'backupdir' to put the backup in a different directory.
1244
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001246'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1247 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 A list of file patterns. When one of the patterns matches with the
1251 name of the file which is written, no backup file is created. Both
1252 the specified file name and the full path name of the file are used.
1253 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1254 Watch out for special characters, see |option-backslash|.
1255 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001256 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001257
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001258 WARNING: Not having a backup file means that when Vim fails to write
1259 your buffer correctly and then, for whatever reason, Vim exits, you
1260 lose both the original file and what you were writing. Only disable
1261 backups if you don't care about losing the file.
1262
Bram Moolenaar02467872007-05-06 13:22:01 +00001263 Note that environment variables are not expanded. If you want to use
1264 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001265 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001266
1267< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001268 backup would be made by renaming the original file crontab won't see
1269 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
1271 *'balloondelay'* *'bdlay'*
1272'balloondelay' 'bdlay' number (default: 600)
1273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 {only available when compiled with the |+balloon_eval|
1275 feature}
1276 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1277
1278 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1279'ballooneval' 'beval' boolean (default off)
1280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001282 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001283 Switch on the |balloon-eval| functionality for the GUI.
1284
1285 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1286 *'nobevalterm'*
1287'balloonevalterm' 'bevalterm' boolean (default off)
1288 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001289 {only available when compiled with the
1290 |+balloon_eval_term| feature}
1291 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001293 *'balloonexpr'* *'bexpr'*
1294'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001295 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001296 {only available when compiled with the |+balloon_eval|
1297 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001298 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001299 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1300 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001301
1302 v:beval_bufnr number of the buffer in which balloon is going to show
1303 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001304 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001305 v:beval_lnum line number
1306 v:beval_col column number (byte index)
1307 v:beval_text word under or after the mouse pointer
1308
Bram Moolenaar54775062019-07-31 21:07:14 +02001309 Instead of showing a balloon, which is limited to plain text, consider
1310 using a popup window, see |popup_beval_example|. A popup window can
1311 use highlighting and show a border.
1312
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001313 The evaluation of the expression must not have side effects!
1314 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001315 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001316 return 'Cursor is at line ' .. v:beval_lnum ..
1317 \ ', column ' .. v:beval_col ..
1318 \ ' of file ' .. bufname(v:beval_bufnr) ..
1319 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001320 endfunction
1321 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001322 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001323<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001324 Also see |balloon_show()|, it can be used if the content of the balloon
1325 is to be fetched asynchronously. In that case evaluating
1326 'balloonexpr' should result in an empty string. If you get a balloon
1327 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001328
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001329 NOTE: The balloon is displayed only if the cursor is on a text
1330 character. If the result of evaluating 'balloonexpr' is not empty,
1331 Vim does not try to send a message to an external debugger (Netbeans
1332 or Sun Workshop).
1333
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001334 If the expression starts with s: or |<SID>|, then it is replaced with
1335 the script ID (|local-function|). Example: >
1336 set bexpr=s:MyBalloonExpr()
1337 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001338< Otherwise, the expression is evaluated in the context of the script
1339 where the option was set, thus script-local items are available.
1340
Bram Moolenaar30b65812012-07-12 22:01:11 +02001341 The expression will be evaluated in the |sandbox| when set from a
1342 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001343 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001344
1345 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001346 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001347
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001348 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001349 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001350< When they are supported "\n" characters will start a new line. If the
1351 expression evaluates to a |List| this is equal to using each List item
1352 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001353 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001354
Bram Moolenaar165bc692015-07-21 17:53:25 +02001355 *'belloff'* *'bo'*
1356'belloff' 'bo' string (default "")
1357 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001358 Specifies for which events the bell will not be rung. It is a comma
1359 separated list of items. For each item that is present, the bell
1360 will be silenced. This is most useful to specify specific events in
1361 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001362 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001363
1364 item meaning when present ~
1365 all All events.
1366 backspace When hitting <BS> or <Del> and deleting results in an
1367 error.
1368 cursor Fail to move around using the cursor keys or
1369 <PageUp>/<PageDown> in |Insert-mode|.
1370 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1371 |i_CTRL-X_CTRL-T|.
1372 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1373 |i_CTRL-E|.
1374 ctrlg Unknown Char after <C-G> in Insert mode.
1375 error Other Error occurred (e.g. try to join last line)
1376 (mostly used in |Normal-mode| or |Cmdline-mode|).
1377 esc hitting <Esc> in |Normal-mode|.
1378 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001379 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001380 insertmode Pressing <Esc> in 'insertmode'.
1381 lang Calling the beep module for Lua/Mzscheme/TCL.
1382 mess No output available for |g<|.
1383 showmatch Error occurred for 'showmatch' function.
1384 operator Empty region error |cpo-E|.
1385 register Unknown register after <C-R> in |Insert-mode|.
1386 shell Bell from shell output |:!|.
1387 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001388 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001389 wildmode More matches in |cmdline-completion| available
1390 (depends on the 'wildmode' setting).
1391
Bram Moolenaar036986f2017-03-16 17:41:02 +01001392 This is most useful to fine tune when in Insert mode the bell should
1393 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001394 indicate that an error occurred. It can be silenced by adding the
1395 "error" keyword.
1396
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1398'binary' 'bin' boolean (default off)
1399 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 This option should be set before editing a binary file. You can also
1401 use the |-b| Vim argument. When this option is switched on a few
1402 options will be changed (also when it already was on):
1403 'textwidth' will be set to 0
1404 'wrapmargin' will be set to 0
1405 'modeline' will be off
1406 'expandtab' will be off
1407 Also, 'fileformat' and 'fileformats' options will not be used, the
1408 file is read and written like 'fileformat' was "unix" (a single <NL>
1409 separates lines).
1410 The 'fileencoding' and 'fileencodings' options will not be used, the
1411 file is read without conversion.
1412 NOTE: When you start editing a(nother) file while the 'bin' option is
1413 on, settings from autocommands may change the settings again (e.g.,
1414 'textwidth'), causing trouble when editing. You might want to set
1415 'bin' again when the file has been loaded.
1416 The previous values of these options are remembered and restored when
1417 'bin' is switched from on to off. Each buffer has its own set of
1418 saved option values.
1419 To edit a file with 'binary' set you can use the |++bin| argument.
1420 This avoids you have to do ":set bin", which would have effect for all
1421 files you edit.
1422 When writing a file the <EOL> for the last line is only written if
1423 there was one in the original file (normally Vim appends an <EOL> to
1424 the last line if there is none; this would make the file longer). See
1425 the 'endofline' option.
1426
1427 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1428'bioskey' 'biosk' boolean (default on)
1429 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001430 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001431 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432
1433 *'bomb'* *'nobomb'*
1434'bomb' boolean (default off)
1435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 When writing a file and the following conditions are met, a BOM (Byte
1437 Order Mark) is prepended to the file:
1438 - this option is on
1439 - the 'binary' option is off
1440 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1441 endian variants.
1442 Some applications use the BOM to recognize the encoding of the file.
1443 Often used for UCS-2 files on MS-Windows. For other applications it
1444 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001445 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1447 check for the presence of the BOM is done and 'bomb' set accordingly.
1448 Unless 'binary' is set, it is removed from the first line, so that you
1449 don't see it when editing. When you don't change the options, the BOM
1450 will be restored when writing the file.
1451
1452 *'breakat'* *'brk'*
1453'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1454 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001455 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 feature}
1457 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001458 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1459 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001461 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001462'breakindent' 'bri' boolean (default off)
1463 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001464 {not available when compiled without the |+linebreak|
1465 feature}
1466 Every wrapped line will continue visually indented (same amount of
1467 space as the beginning of that line), thus preserving horizontal blocks
1468 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001469 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001470
1471 *'breakindentopt'* *'briopt'*
1472'breakindentopt' 'briopt' string (default empty)
1473 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001474 {not available when compiled without the |+linebreak|
1475 feature}
1476 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001477 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001478 min:{n} Minimum text width that will be kept after
1479 applying 'breakindent', even if the resulting
1480 text should normally be narrower. This prevents
1481 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001482 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001483 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001484 shift:{n} After applying 'breakindent', the wrapped line's
1485 beginning will be shifted by the given number of
1486 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001487 indentation (negative) or emphasizing the line
1488 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001489 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001490 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001491 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001492 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001493 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001494 numbered or bulleted list (using the
1495 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001496 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001497 list:-1 Uses the width of a match with 'formatlistpat' for
1498 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001499 column:{n} Indent at column {n}. Will overrule the other
1500 sub-options. Note: an additional indent may be
1501 added for the 'showbreak' setting.
1502 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001503
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001505'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001507 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001509 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001510 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 buffer Use the directory of the related buffer.
1512 current Use the current directory.
1513 {path} Use the specified directory
1514
1515 *'bufhidden'* *'bh'*
1516'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001517 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 This option specifies what happens when a buffer is no longer
1519 displayed in a window:
1520 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001521 hide hide the buffer (don't unload it), even if 'hidden' is
1522 not set
1523 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001524 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001525 delete delete the buffer from the buffer list, even if
1526 'hidden' is set; the |:hide| command will also delete
1527 the buffer, making it behave like |:bdelete|
1528 wipe wipe the buffer from the buffer list, even if
1529 'hidden' is set; the |:hide| command will also wipe
1530 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001532 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001533 are lost without a warning. Also, these values may break autocommands
1534 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 This option is used together with 'buftype' and 'swapfile' to specify
1536 special kinds of buffers. See |special-buffers|.
1537
1538 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1539'buflisted' 'bl' boolean (default: on)
1540 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 When this option is set, the buffer shows up in the buffer list. If
1542 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1543 This option is reset by Vim for buffers that are only used to remember
1544 a file name or marks. Vim sets it when starting to edit a buffer.
1545 But not when moving to a buffer with ":buffer".
1546
1547 *'buftype'* *'bt'* *E382*
1548'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001549 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 The value of this option specifies the type of a buffer:
1551 <empty> normal buffer
1552 nofile buffer which is not related to a file and will not be
1553 written
1554 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001555 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001556 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001558 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 help help buffer (you are not supposed to set this
1560 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001561 terminal buffer for a |terminal| (you are not supposed to set
1562 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001563 prompt buffer where only the last line can be edited, meant
1564 to be used by a plugin, see |prompt-buffer|
1565 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001566 popup buffer used in a popup window, see |popup|.
1567 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 This option is used together with 'bufhidden' and 'swapfile' to
1570 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001571 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572
1573 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001574 One such effect is that Vim will not check the timestamp of the file,
1575 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576
Bram Moolenaar280f1262006-01-30 00:14:18 +00001577 A "quickfix" buffer is only used for the error list and the location
1578 list. This value is set by the |:cwindow| and |:lwindow| commands and
1579 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
1581 "nofile" and "nowrite" buffers are similar:
1582 both: The buffer is not to be written to disk, ":w" doesn't
1583 work (":w filename" does work though).
1584 both: The buffer is never considered to be |'modified'|.
1585 There is no warning when the changes will be lost, for
1586 example when you quit Vim.
1587 both: A swap file is only created when using too much memory
1588 (when 'swapfile' has been reset there is never a swap
1589 file).
1590 nofile only: The buffer name is fixed, it is not handled like a
1591 file name. It is not modified in response to a |:cd|
1592 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001593 both: When using ":e bufname" and already editing "bufname"
1594 the buffer is made empty and autocommands are
1595 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001596 *E676*
1597 "acwrite" implies that the buffer name is not related to a file, like
1598 "nofile", but it will be written. Thus, in contrast to "nofile" and
1599 "nowrite", ":w" does work and a modified buffer can't be abandoned
1600 without saving. For writing there must be matching |BufWriteCmd|,
1601 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602
1603 *'casemap'* *'cmp'*
1604'casemap' 'cmp' string (default: "internal,keepascii")
1605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 Specifies details about changing the case of letters. It may contain
1607 these words, separated by a comma:
1608 internal Use internal case mapping functions, the current
1609 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001610 matters when 'encoding' is a Unicode encoding,
1611 "latin1" or "iso-8859-15". When "internal" is
1612 omitted, the towupper() and towlower() system library
1613 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1615 case mapping, the current locale is not effective.
1616 This probably only matters for Turkish.
1617
Bram Moolenaar938ae282023-02-20 20:44:55 +00001618 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001619'cdhome' 'cdh' boolean (default: off)
1620 global
1621 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1622 current working directory to the |$HOME| directory like in Unix.
1623 When off, those commands just print the current directory name.
1624 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001625 This option cannot be set from a |modeline| or in the |sandbox|, for
1626 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001627 NOTE: This option is reset when 'compatible' is set.
1628
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 *'cdpath'* *'cd'* *E344* *E346*
1630'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001633 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1634 searched for has a relative path, not an absolute part starting with
1635 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 The 'cdpath' option's value has the same form and semantics as
1637 |'path'|. Also see |file-searching|.
1638 The default value is taken from $CDPATH, with a "," prepended to look
1639 in the current directory first.
1640 If the default value taken from $CDPATH is not what you want, include
1641 a modified version of the following command in your vimrc file to
1642 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001643 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644< This option cannot be set from a |modeline| or in the |sandbox|, for
1645 security reasons.
1646 (parts of 'cdpath' can be passed to the shell to expand file names).
1647
1648 *'cedit'*
1649'cedit' string (Vi default: "", Vim default: CTRL-F)
1650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 The key used in Command-line Mode to open the command-line window.
1652 The default is CTRL-F when 'compatible' is off.
1653 Only non-printable keys are allowed.
1654 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001655 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1656 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1657 :set cedit=^Y
1658 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659< |Nvi| also has this option, but it only uses the first character.
1660 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001661 NOTE: This option is set to the Vim default value when 'compatible'
1662 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663
1664 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1665'charconvert' 'ccv' string (default "")
1666 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001667 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 An expression that is used for character encoding conversion. It is
1669 evaluated when a file that is to be read or has been written has a
1670 different encoding from what is desired.
1671 'charconvert' is not used when the internal iconv() function is
1672 supported and is able to do the conversion. Using iconv() is
1673 preferred, because it is much faster.
1674 'charconvert' is not used when reading stdin |--|, because there is no
1675 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001676 The expression must return zero, false or an empty string for success,
1677 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 The possible encoding names encountered are in 'encoding'.
1679 Additionally, names given in 'fileencodings' and 'fileencoding' are
1680 used.
1681 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1682 is done internally by Vim, 'charconvert' is not used for this.
1683 'charconvert' is also used to convert the viminfo file, if the 'c'
1684 flag is present in 'viminfo'. Also used for Unicode conversion.
1685 Example: >
1686 set charconvert=CharConvert()
1687 fun CharConvert()
1688 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001689 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1690 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 return v:shell_error
1692 endfun
1693< The related Vim variables are:
1694 v:charconvert_from name of the current encoding
1695 v:charconvert_to name of the desired encoding
1696 v:fname_in name of the input file
1697 v:fname_out name of the output file
1698 Note that v:fname_in and v:fname_out will never be the same.
1699 Note that v:charconvert_from and v:charconvert_to may be different
1700 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001701
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001702 The advantage of using a function call without arguments is that it is
1703 faster, see |expr-option-function|.
1704
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 Encryption is not done by Vim when using 'charconvert'. If you want
1706 to encrypt the file after conversion, 'charconvert' should take care
1707 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001708
1709 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1710 replaced with the script ID (|local-function|). Example: >
1711 set charconvert=s:MyConvert()
1712 set charconvert=<SID>SomeConvert()
1713< Otherwise the expression is evaluated in the context of the script
1714 where the option was set, thus script-local items are available.
1715
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 This option cannot be set from a |modeline| or in the |sandbox|, for
1717 security reasons.
1718
1719 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1720'cindent' 'cin' boolean (default off)
1721 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001722 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 that trigger reindenting in insert mode and 'cinoptions' to set your
1724 preferred indent style.
1725 If 'indentexpr' is not empty, it overrules 'cindent'.
1726 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1727 the "=" operator indents using this algorithm rather than calling an
1728 external program.
1729 See |C-indenting|.
1730 When you don't like the way 'cindent' works, try the 'smartindent'
1731 option or 'indentexpr'.
1732 This option is not used when 'paste' is set.
1733 NOTE: This option is reset when 'compatible' is set.
1734
1735 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001736'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 A list of keys that, when typed in Insert mode, cause reindenting of
1739 the current line. Only used if 'cindent' is on and 'indentexpr' is
1740 empty.
1741 For the format of this option see |cinkeys-format|.
1742 See |C-indenting|.
1743
1744 *'cinoptions'* *'cino'*
1745'cinoptions' 'cino' string (default "")
1746 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1748 program. See |cinoptions-values| for the values of this option, and
1749 |C-indenting| for info on C indenting in general.
1750
laburnumT3f7855a2023-12-05 18:37:03 +01001751 *'cinscopedecls'* *'cinsd'*
1752'cinscopedecls' 'cinsd' string (default "public,protected,private")
1753 local to buffer
1754 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1755 Useful e.g. for working with the Qt framework that defines additional
1756 scope declarations "signals", "public slots" and "private slots": >
1757 set cinscopedecls+=signals,public\ slots,private\ slots
1758<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 *'cinwords'* *'cinw'*
1760'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1761 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 These keywords start an extra indent in the next line when
1763 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1764 an appropriate place (inside {}).
1765 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1766 matter, include the keyword both the uppercase and lowercase:
1767 "if,If,IF".
1768
laburnumT3f7855a2023-12-05 18:37:03 +01001769 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1771 for X-windows, "" otherwise)
1772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 {only in GUI versions or when the |+xterm_clipboard|
1774 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001775 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001776 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001777 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001778 prepend, e.g.: >
1779 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001780< When using the GUI see |'go-A'|.
1781 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001783 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 unnamed When included, Vim will use the clipboard register '*'
1785 for all yank, delete, change and put operations which
1786 would normally go to the unnamed register. When a
1787 register is explicitly specified, it will always be
1788 used regardless of whether "unnamed" is in 'clipboard'
1789 or not. The clipboard register can always be
1790 explicitly accessed using the "* notation. Also see
1791 |gui-clipboard|.
1792
Bram Moolenaar30b65812012-07-12 22:01:11 +02001793 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001794 unnamedplus A variant of the "unnamed" flag which uses the
1795 clipboard register '+' (|quoteplus|) instead of
1796 register '*' for all yank, delete, change and put
1797 operations which would normally go to the unnamed
1798 register. When "unnamed" is also included to the
1799 option, yank operations (but not delete, change or
1800 put) will additionally copy the text into register
1801 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001802 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001803 Availability can be checked with: >
1804 if has('unnamedplus')
1805<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001806 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 autoselect Works like the 'a' flag in 'guioptions': If present,
1808 then whenever Visual mode is started, or the Visual
1809 area extended, Vim tries to become the owner of the
1810 windowing system's global selection or put the
1811 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001812 register "*. See |'go-a'| and |quotestar| for details.
1813 When the GUI is active, the 'a' flag in 'guioptions'
1814 is used, when the GUI is not active, this "autoselect"
1815 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 Also applies to the modeless selection.
1817
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001818 *clipboard-autoselectplus*
1819 autoselectplus Like "autoselect" but using the + register instead of
1820 the * register. Compare to the 'P' flag in
1821 'guioptions'.
1822
1823 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 autoselectml Like "autoselect", but for the modeless selection
1825 only. Compare to the 'A' flag in 'guioptions'.
1826
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001827 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001828 html When the clipboard contains HTML, use this when
1829 pasting. When putting text on the clipboard, mark it
1830 as HTML. This works to copy rendered HTML from
1831 Firefox, paste it as raw HTML in Vim, select the HTML
1832 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001833 You probably want to add this only temporarily,
1834 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001835 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001837 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 exclude:{pattern}
1839 Defines a pattern that is matched against the name of
1840 the terminal 'term'. If there is a match, no
1841 connection will be made to the X server. This is
1842 useful in this situation:
1843 - Running Vim in a console.
1844 - $DISPLAY is set to start applications on another
1845 display.
1846 - You do not want to connect to the X server in the
1847 console, but do want this in a terminal emulator.
1848 To never connect to the X server use: >
1849 exclude:.*
1850< This has the same effect as using the |-X| argument.
1851 Note that when there is no connection to the X server
1852 the window title won't be restored and the clipboard
1853 cannot be accessed.
1854 The value of 'magic' is ignored, {pattern} is
1855 interpreted as if 'magic' was on.
1856 The rest of the option value will be used for
1857 {pattern}, this must be the last entry.
1858
1859 *'cmdheight'* *'ch'*
1860'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001861 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001862 Number of screen lines to use for the command-line. A larger value
1863 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001864 The value of this option is stored with the tab page, so that each tab
1865 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866
1867 *'cmdwinheight'* *'cwh'*
1868'cmdwinheight' 'cwh' number (default 7)
1869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 Number of screen lines to use for the command-line window. |cmdwin|
1871
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001872 *'colorcolumn'* *'cc'*
1873'colorcolumn' 'cc' string (default "")
1874 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001875 {not available when compiled without the |+syntax|
1876 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001877 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001878 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1879 text. Will make screen redrawing slower.
1880 The screen column can be an absolute number, or a number preceded with
1881 '+' or '-', which is added to or subtracted from 'textwidth'. >
1882
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001883 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001884 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1885 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1886<
1887 When 'textwidth' is zero then the items with '-' and '+' are not used.
1888 A maximum of 256 columns are highlighted.
1889
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *'columns'* *'co'* *E594*
1891'columns' 'co' number (default 80 or terminal width)
1892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001894 initialization and does not have to be set by hand. Also see
1895 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 When Vim is running in the GUI or in a resizable window, setting this
1897 option will cause the window size to be changed. When you only want
1898 to use the size for the GUI, put the command in your |gvimrc| file.
1899 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001900 number of columns of the display, the display may be messed up. For
1901 the GUI it is always possible and Vim limits the number of columns to
1902 what fits on the screen. You can use this command to get the widest
1903 window possible: >
1904 :set columns=9999
1905< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906
1907 *'comments'* *'com'* *E524* *E525*
1908'comments' 'com' string (default
1909 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1910 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001911 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 |format-comments|. See |option-backslash| about using backslashes to
1913 insert a space.
1914
1915 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001916'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 {not available when compiled without the |+folding|
1919 feature}
1920 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001921 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001922 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001923 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
1925 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001926'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001927 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 This option has the effect of making Vim either more Vi-compatible, or
1930 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001931
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001933 other options are also changed as a side effect.
1934 NOTE: Setting or resetting this option can have a lot of unexpected
1935 effects: Mappings are interpreted in another way, undo behaves
1936 differently, etc. If you set this option in your vimrc file, you
1937 should probably put it at the very start.
1938
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939 By default this option is on and the Vi defaults are used for the
1940 options. This default was chosen for those people who want to use Vim
1941 just like Vi, and don't even (want to) know about the 'compatible'
1942 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001943 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001944 this option is switched off, and all options that have not been
1945 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001946 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001947 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001948 happen for the system-wide vimrc or gvimrc file, nor for a file given
1949 with the |-u| argument). Also see |compatible-default| and
1950 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 You can also set this option with the "-C" argument, and reset it with
1952 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001953 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954
Bram Moolenaar214641f2017-03-05 17:04:09 +01001955 When this option is set, numerous other options are set to make Vim as
1956 Vi-compatible as possible. When this option is unset, various options
1957 are set to make Vim more useful. The table below lists all the
1958 options affected.
1959 The {?} column indicates when the options are affected:
1960 + Means that the option is set to the value given in {set value} when
1961 'compatible' is set.
1962 & Means that the option is set to the value given in {set value} when
1963 'compatible' is set AND is set to its Vim default value when
1964 'compatible' is unset.
1965 - Means the option is NOT changed when setting 'compatible' but IS
1966 set to its Vim default when 'compatible' is unset.
1967 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968
Bram Moolenaar036986f2017-03-16 17:41:02 +01001969 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970
1971 'allowrevins' + off no CTRL-_ command
1972 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001973 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001974 'arabicshape' + on correct character shapes
1975 'backspace' + "" normal backspace
1976 'backup' + off no backup file
1977 'backupcopy' & Unix: "yes" backup file is a copy
1978 else: "auto" copy or rename backup file
1979 'balloonexpr' + "" text to show in evaluation balloon
1980 'breakindent' + off don't indent when wrapping lines
1981 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001982 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001983 'cindent' + off no C code indentation
1984 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1985 'copyindent' + off don't copy indent structure
1986 'cpoptions' & (all flags) Vi-compatible flags
1987 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001988 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001989 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001990 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001991 'cscopeverbose' + off see |cscopeverbose|
1992 'delcombine' + off unicode: delete whole char combination
1993 'digraph' + off no digraphs
1994 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001995 this also disables |modifyOtherKeys|
1996 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001997 'expandtab' + off tabs not expanded to spaces
1998 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001999 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002000 'formatexpr' + "" use 'formatprg' for auto-formatting
2001 'formatoptions' & "vt" Vi compatible formatting
2002 'gdefault' + off no default 'g' flag for ":s"
2003 'history' & 0 no commandline history
2004 'hkmap' + off no Hebrew keyboard mapping
2005 'hkmapp' + off no phonetic Hebrew keyboard mapping
2006 'hlsearch' + off no highlighting of search matches
2007 'incsearch' + off no incremental searching
2008 'indentexpr' + "" no indenting by expression
2009 'insertmode' + off do not start in Insert mode
2010 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002012 'joinspaces' + on insert 2 spaces after period
2013 'modeline' & off no modelines
2014 'more' & off no pauses in listings
2015 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2016 'numberwidth' & 8 min number of columns for line number
2017 'preserveindent'+ off don't preserve current indent structure
2018 when changing it
2019 'revins' + off no reverse insert
2020 'ruler' + off no ruler
2021 'scrolljump' + 1 no jump scroll
2022 'scrolloff' + 0 no scroll offset
2023 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2024 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002025 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002026 'showcmd' & off command characters not shown
2027 'showmode' & off current mode not shown
2028 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2029 'smartcase' + off no automatic ignore case switch
2030 'smartindent' + off no smart indentation
2031 'smarttab' + off no smart tab size
2032 'softtabstop' + 0 tabs are always 'tabstop' positions
2033 'startofline' + on goto startofline with some commands
2034 'tagcase' & "followic" 'ignorecase' when searching tags file
2035 'tagrelative' & off tag file names are not relative
2036 'termguicolors' + off don't use highlight-(guifg|guibg)
2037 'textauto' & off no automatic textmode detection
2038 'textwidth' + 0 no automatic line wrap
2039 'tildeop' + off tilde is not an operator
2040 'ttimeout' + off no terminal timeout
2041 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002042 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002043 'virtualedit' + "" cursor can only be placed on characters
2044 'whichwrap' & "" left-right movements don't wrap
2045 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002047 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048
2049 *'complete'* *'cpt'* *E535*
2050'complete' 'cpt' string (default: ".,w,b,u,t,i")
2051 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 This option specifies how keyword completion |ins-completion| works
2053 when CTRL-P or CTRL-N are used. It is also used for whole-line
2054 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002055 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002056 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 w scan buffers from other windows
2058 b scan other loaded buffers that are in the buffer list
2059 u scan the unloaded buffers that are in the buffer list
2060 U scan the buffers that are not in the buffer list
2061 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002062 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 k{dict} scan the file {dict}. Several "k" flags can be given,
2064 patterns are valid too. For example: >
2065 :set cpt=k/usr/dict/*,k~/spanish
2066< s scan the files given with the 'thesaurus' option
2067 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2068 are valid too.
2069 i scan current and included files
2070 d scan current and included files for defined name or macro
2071 |i_CTRL-X_CTRL-D|
2072 ] tag completion
2073 t same as "]"
2074
2075 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2076 not executed, this may lead to unexpected completions from some files
2077 (gzipped files for example). Unloaded buffers are not scanned for
2078 whole-line completion.
2079
2080 The default is ".,w,b,u,t,i", which means to scan:
2081 1. the current buffer
2082 2. buffers in other windows
2083 3. other loaded buffers
2084 4. unloaded buffers
2085 5. tags
2086 6. included files
2087
2088 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002089 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2090 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002092 *'completefunc'* *'cfu'*
2093'completefunc' 'cfu' string (default: empty)
2094 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002095 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002096 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002097 This option specifies a function to be used for Insert mode completion
2098 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002099 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002100 invoked and what it should return. The value can be the name of a
2101 function, a |lambda| or a |Funcref|. See |option-value-function| for
2102 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002103 This option cannot be set from a |modeline| or in the |sandbox|, for
2104 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002105
glepnir6a89c942024-10-01 20:32:12 +02002106 *'completeitemalign'* *'cia'*
2107'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2108 global
2109 A comma-separated list of |complete-items| that controls the alignment
2110 and display order of items in the popup menu during Insert mode
2111 completion. The supported values are abbr, kind, and menu. These
2112 options allow to customize how the completion items are shown in the
2113 popup menu. Note: must always contain those three values in any
2114 order.
2115
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002116 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002117'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002118 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002119 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002120 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002121
2122 menu Use a popup menu to show the possible completions. The
2123 menu is only shown when there is more than one match and
2124 sufficient colors are available. |ins-completion-menu|
2125
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002126 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002127 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002128 match, e.g., what file it comes from.
2129
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002130 longest Only insert the longest common text of the matches. If
2131 the menu is displayed you can use CTRL-L to add more
2132 characters. Whether case is ignored depends on the kind
2133 of completion. For buffer text the 'ignorecase' option is
2134 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002135
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002136 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002137 completion in the preview window. Only works in
2138 combination with "menu" or "menuone".
2139
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002140 popup Show extra information about the currently selected
2141 completion in a popup window. Only works in combination
2142 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002143 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002144 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002145
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002146 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002147 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002148 |CompleteChanged| autocommand to fetch the info and call
2149 |popup_show()| once the popup has been filled.
2150 See the example at |complete-popuphidden|.
2151 {only works when compiled with the |+textprop| feature}
2152
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002153 noinsert Do not insert any text for a match until the user selects
2154 a match from the menu. Only works in combination with
2155 "menu" or "menuone". No effect if "longest" is present.
2156
2157 noselect Do not select a match in the menu, force the user to
2158 select one from the menu. Only works in combination with
2159 "menu" or "menuone".
2160
glepnira218cc62024-06-03 19:32:39 +02002161 fuzzy Enable |fuzzy-matching| for completion candidates. This
2162 allows for more flexible and intuitive matching, where
2163 characters can be skipped and matches can be found even
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002164 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002165
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002166 *'completepopup'* *'cpp'*
2167'completepopup' 'cpp' string (default empty)
2168 global
2169 {not available when compiled without the |+textprop|
2170 or |+quickfix| feature}
2171 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002172 properties of the info popup when it is created. If an info popup
2173 window already exists it is closed, so that the option value is
2174 applied when it is created again.
2175 You can also use |popup_findinfo()| and then set properties for an
2176 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002177
laburnumT3f7855a2023-12-05 18:37:03 +01002178 *'completeslash'* *'csl'*
2179'completeslash' 'csl' string (default: "")
2180 local to buffer
2181 {only for MS-Windows}
2182 When this option is set it overrules 'shellslash' for completion:
2183 - When this option is set to "slash", a forward slash is used for path
2184 completion in insert mode. This is useful when editing HTML tag, or
2185 Makefile with 'noshellslash' on MS-Windows.
2186 - When this option is set to "backslash", backslash is used. This is
2187 useful when editing a batch file with 'shellslash' set on MS-Windows.
2188 - When this option is empty, same character is used as for
2189 'shellslash'.
2190 For Insert mode completion the buffer-local value is used. For
2191 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002192
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002193 *'concealcursor'* *'cocu'*
2194'concealcursor' 'cocu' string (default: "")
2195 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002196 {not available when compiled without the |+conceal|
2197 feature}
2198 Sets the modes in which text in the cursor line can also be concealed.
2199 When the current mode is listed then concealing happens just like in
2200 other lines.
2201 n Normal mode
2202 v Visual mode
2203 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002204 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002205
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002206 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002207 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002208 are moving around text is concealed, but when starting to insert text
2209 or selecting a Visual area the concealed text is displayed, so that
2210 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002211 Keep in mind that the cursor position is not always where it's
2212 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002213
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002214 *'conceallevel'* *'cole'*
2215'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002216 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002217 {not available when compiled without the |+conceal|
2218 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002219 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2220 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002221
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002222 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002224 1 Each block of concealed text is replaced with one
2225 character. If the syntax item does not have a custom
2226 replacement character defined (see |:syn-cchar|) the
2227 character defined in 'listchars' is used (default is a
2228 space).
2229 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002230 2 Concealed text is completely hidden unless it has a
2231 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002232 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002233 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002234
Bram Moolenaara7781e02010-07-19 20:13:22 +02002235 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002236 edit and copy the text. This can be changed with the 'concealcursor'
2237 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002238
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2240'confirm' 'cf' boolean (default off)
2241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 When 'confirm' is on, certain operations that would normally
2243 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2244 instead raise a |dialog| asking if you wish to save the current
2245 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2246 If 'confirm' is off you can still activate confirmation for one
2247 command only (this is most useful in mappings) with the |:confirm|
2248 command.
2249 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2250
2251 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2252'conskey' 'consk' boolean (default off)
2253 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002254 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255
2256 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2257'copyindent' 'ci' boolean (default off)
2258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 Copy the structure of the existing lines indent when autoindenting a
2260 new line. Normally the new indent is reconstructed by a series of
2261 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2262 in which case only spaces are used). Enabling this option makes the
2263 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002264 existing line. 'expandtab' has no effect on these characters, a Tab
2265 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002267 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 Also see 'preserveindent'.
2269
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002270 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002271'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2272 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002273 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002276 this indicates Vi-compatible behavior. This is used for things where
2277 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 'cpoptions' stands for "compatible-options".
2279 Commas can be added for readability.
2280 To avoid problems with flags that are added in the future, use the
2281 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002282
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 NOTE: This option is set to the Vi default value when 'compatible' is
2284 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002285
2286 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2287 is saved, 'cpoptions' is set to the Vim default, and the saved value
2288 is restored at the end of the script. Changes to the value of
2289 'cpoptions' will be applied to the saved value, but keep in mind that
2290 removing a flag that is not present when 'cpoptions' is changed has no
2291 effect. In the |.vimrc| file the value is not restored, thus using
2292 `vim9script` in the |.vimrc| file results in using the Vim default.
2293
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002294 NOTE: This option is set to the POSIX default value at startup when
2295 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002296 variable exists |posix|. This means Vim tries to behave like the
2297 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298
2299 contains behavior ~
2300 *cpo-a*
2301 a When included, a ":read" command with a file name
2302 argument will set the alternate file name for the
2303 current window.
2304 *cpo-A*
2305 A When included, a ":write" command with a file name
2306 argument will set the alternate file name for the
2307 current window.
2308 *cpo-b*
2309 b "\|" in a ":map" command is recognized as the end of
2310 the map command. The '\' is included in the mapping,
2311 the text after the '|' is interpreted as the next
2312 command. Use a CTRL-V instead of a backslash to
2313 include the '|' in the mapping. Applies to all
2314 mapping, abbreviation, menu and autocmd commands.
2315 See also |map_bar|.
2316 *cpo-B*
2317 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002318 abbreviations, user commands and the "to" part of the
2319 menu commands. Remove this flag to be able to use a
2320 backslash like a CTRL-V. For example, the command
2321 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 'B' included: "\^[" (^[ is a real <Esc>)
2323 'B' excluded: "<Esc>" (5 characters)
2324 ('<' excluded in both cases)
2325 *cpo-c*
2326 c Searching continues at the end of any match at the
2327 cursor position, but not further than the start of the
2328 next line. When not present searching continues
2329 one character from the cursor position. With 'c'
2330 "abababababab" only gets three matches when repeating
2331 "/abab", without 'c' there are five matches.
2332 *cpo-C*
2333 C Do not concatenate sourced lines that start with a
2334 backslash. See |line-continuation|.
2335 *cpo-d*
2336 d Using "./" in the 'tags' option doesn't mean to use
2337 the tags file relative to the current file, but the
2338 tags file in the current directory.
2339 *cpo-D*
2340 D Can't use CTRL-K to enter a digraph after Normal mode
2341 commands with a character argument, like |r|, |f| and
2342 |t|.
2343 *cpo-e*
2344 e When executing a register with ":@r", always add a
2345 <CR> to the last line, also when the register is not
2346 linewise. If this flag is not present, the register
2347 is not linewise and the last line does not end in a
2348 <CR>, then the last line is put on the command-line
2349 and can be edited before hitting <CR>.
2350 *cpo-E*
2351 E It is an error when using "y", "d", "c", "g~", "gu" or
2352 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002353 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 This makes "y0" fail in the first column.
2355 *cpo-f*
2356 f When included, a ":read" command with a file name
2357 argument will set the file name for the current buffer,
2358 if the current buffer doesn't have a file name yet.
2359 *cpo-F*
2360 F When included, a ":write" command with a file name
2361 argument will set the file name for the current
2362 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002363 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 *cpo-g*
2365 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002366 *cpo-H*
2367 H When using "I" on a line with only blanks, insert
2368 before the last blank. Without this flag insert after
2369 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 *cpo-i*
2371 i When included, interrupting the reading of a file will
2372 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002373 *cpo-I*
2374 I When moving the cursor up or down just after inserting
2375 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 *cpo-j*
2377 j When joining lines, only add two spaces after a '.',
2378 not after '!' or '?'. Also see 'joinspaces'.
2379 *cpo-J*
2380 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002381 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 white space.
2383 *cpo-k*
2384 k Disable the recognition of raw key codes in
2385 mappings, abbreviations, and the "to" part of menu
2386 commands. For example, if <Key> sends ^[OA (where ^[
2387 is <Esc>), the command ":map X ^[OA" results in X
2388 being mapped to:
2389 'k' included: "^[OA" (3 characters)
2390 'k' excluded: "<Key>" (one key code)
2391 Also see the '<' flag below.
2392 *cpo-K*
2393 K Don't wait for a key code to complete when it is
2394 halfway a mapping. This breaks mapping <F1><F1> when
2395 only part of the second <F1> has been read. It
2396 enables cancelling the mapping by typing <F1><Esc>.
2397 *cpo-l*
2398 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002399 literally, only "\]", "\^", "\-" and "\\" are special.
2400 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2402 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002403 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 *cpo-L*
2405 L When the 'list' option is set, 'wrapmargin',
2406 'textwidth', 'softtabstop' and Virtual Replace mode
2407 (see |gR|) count a <Tab> as two characters, instead of
2408 the normal behavior of a <Tab>.
2409 *cpo-m*
2410 m When included, a showmatch will always wait half a
2411 second. When not included, a showmatch will wait half
2412 a second or until a character is typed. |'showmatch'|
2413 *cpo-M*
2414 M When excluded, "%" matching will take backslashes into
2415 account. Thus in "( \( )" and "\( ( \)" the outer
2416 parenthesis match. When included "%" ignores
2417 backslashes, which is Vi compatible.
2418 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002419 n When included, the column used for 'number' and
2420 'relativenumber' will also be used for text of wrapped
2421 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 *cpo-o*
2423 o Line offset to search command is not remembered for
2424 next search.
2425 *cpo-O*
2426 O Don't complain if a file is being overwritten, even
2427 when it didn't exist when editing it. This is a
2428 protection against a file unexpectedly created by
2429 someone else. Vi didn't complain about this.
2430 *cpo-p*
2431 p Vi compatible Lisp indenting. When not present, a
2432 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002433 *cpo-P*
2434 P When included, a ":write" command that appends to a
2435 file will set the file name for the current buffer, if
2436 the current buffer doesn't have a file name yet and
2437 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002438 *cpo-q*
2439 q When joining multiple lines leave the cursor at the
2440 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 *cpo-r*
2442 r Redo ("." command) uses "/" to repeat a search
2443 command, instead of the actually used search string.
2444 *cpo-R*
2445 R Remove marks from filtered lines. Without this flag
2446 marks are kept like |:keepmarks| was used.
2447 *cpo-s*
2448 s Set buffer options when entering the buffer for the
2449 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002450 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 set when the buffer is created.
2452 *cpo-S*
2453 S Set buffer options always when entering a buffer
2454 (except 'readonly', 'fileformat', 'filetype' and
2455 'syntax'). This is the (most) Vi compatible setting.
2456 The options are set to the values in the current
2457 buffer. When you change an option and go to another
2458 buffer, the value is copied. Effectively makes the
2459 buffer options global to all buffers.
2460
2461 's' 'S' copy buffer options
2462 no no when buffer created
2463 yes no when buffer first entered (default)
2464 X yes each time when buffer entered (vi comp.)
2465 *cpo-t*
2466 t Search pattern for the tag command is remembered for
2467 "n" command. Otherwise Vim only puts the pattern in
2468 the history for search pattern, but doesn't change the
2469 last used search pattern.
2470 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002471 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 *cpo-v*
2473 v Backspaced characters remain visible on the screen in
2474 Insert mode. Without this flag the characters are
2475 erased from the screen right away. With this flag the
2476 screen newly typed text overwrites backspaced
2477 characters.
2478 *cpo-w*
2479 w When using "cw" on a blank character, only change one
2480 character and not all blanks until the start of the
2481 next word.
2482 *cpo-W*
2483 W Don't overwrite a readonly file. When omitted, ":w!"
2484 overwrites a readonly file, if possible.
2485 *cpo-x*
2486 x <Esc> on the command-line executes the command-line.
2487 The default in Vim is to abandon the command-line,
2488 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002489 *cpo-X*
2490 X When using a count with "R" the replaced text is
2491 deleted only once. Also when repeating "R" with "."
2492 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002494 y A yank command can be redone with ".". Think twice if
2495 you really want to use this, it may break some
2496 plugins, since most people expect "." to only repeat a
2497 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002498 *cpo-Z*
2499 Z When using "w!" while the 'readonly' option is set,
2500 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002501 *cpo-z*
2502 z Special casing the "cw" and "d" command (see |cw| and
2503 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *cpo-!*
2505 ! When redoing a filter command, use the last used
2506 external command, whatever it was. Otherwise the last
2507 used -filter- command is used.
2508 *cpo-$*
2509 $ When making a change to one line, don't redisplay the
2510 line, but put a '$' at the end of the changed text.
2511 The changed text will be overwritten when you type the
2512 new text. The line is redisplayed if you type any
2513 command that moves the cursor from the insertion
2514 point.
2515 *cpo-%*
2516 % Vi-compatible matching is done for the "%" command.
2517 Does not recognize "#if", "#endif", etc.
2518 Does not recognize "/*" and "*/".
2519 Parens inside single and double quotes are also
2520 counted, causing a string that contains a paren to
2521 disturb the matching. For example, in a line like
2522 "if (strcmp("foo(", s))" the first paren does not
2523 match the last one. When this flag is not included,
2524 parens inside single and double quotes are treated
2525 specially. When matching a paren outside of quotes,
2526 everything inside quotes is ignored. When matching a
2527 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002528 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002529 This flag is also used for other features, such as
2530 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002531 *cpo--*
2532 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002533 it would go above the first line or below the last
2534 line. Without it the cursor moves to the first or
2535 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002536 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002537 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002538 *cpo-+*
2539 + When included, a ":write file" command will reset the
2540 'modified' flag of the buffer, even though the buffer
2541 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002542 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 * Use ":*" in the same way as ":@". When not included,
2544 ":*" is an alias for ":'<,'>", select the Visual area.
2545 *cpo-<*
2546 < Disable the recognition of special key codes in |<>|
2547 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002548 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 ":map X <Tab>" results in X being mapped to:
2550 '<' included: "<Tab>" (5 characters)
2551 '<' excluded: "^I" (^I is a real <Tab>)
2552 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002553 *cpo->*
2554 > When appending to a register, put a line break before
2555 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002556 *cpo-;*
2557 ; When using |,| or |;| to repeat the last |t| search
2558 and the cursor is right in front of the searched
2559 character, the cursor won't move. When not included,
2560 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002561 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002562
2563 POSIX flags. These are not included in the Vi default value, except
2564 when $VIM_POSIX was set on startup. |posix|
2565
2566 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002567 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002568 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002569 *cpo-&*
2570 & When ":preserve" was used keep the swap file when
2571 exiting normally while this buffer is still loaded.
2572 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002573 *cpo-\*
2574 \ Backslash in a [] range in a search pattern is taken
2575 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002576 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2577 '\' excluded: "/[ \-]" finds <Space> and '-'
2578 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002579 *cpo-/*
2580 / When "%" is used as the replacement string in a |:s|
2581 command, use the previous replacement string. |:s%|
2582 *cpo-{*
2583 { The |{| and |}| commands also stop at a "{" character
2584 at the start of a line.
2585 *cpo-.*
2586 . The ":chdir" and ":cd" commands fail if the current
2587 buffer is modified, unless ! is used. Vim doesn't
2588 need this, since it remembers the full path of an
2589 opened file.
2590 *cpo-bar*
2591 | The value of the $LINES and $COLUMNS environment
2592 variables overrule the terminal size values obtained
2593 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002594
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002595 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002596'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002597 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002598 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002599 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002600 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002601 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002602 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002603 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002604 blowfish Blowfish method. Medium strong encryption but it has
2605 an implementation flaw. Requires Vim 7.3 or later,
2606 files can NOT be read by Vim 7.2 and older. This adds
2607 a "seed" to the file, every time you write the file
2608 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002609 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002610 *blowfish2*
2611 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002612 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002613 and older. This adds a "seed" to the file, every time
2614 you write the file the encrypted bytes will be
2615 different. The whole undo file is encrypted, not just
2616 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002617 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002618 *E1197* *E1198* *E1199* *E1200* *E1201*
2619 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2620 Code. Medium strong till strong encryption.
2621 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002622 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002623 It adds a seed and a message authentication code (MAC)
2624 to the file. This needs at least a Vim 8.2.3022 to
2625 read the encrypted file.
2626 Encryption of swap files is not supported, therefore
2627 no swap file will be used when xchacha20 encryption is
2628 enabled.
2629 Encryption of undo files is not yet supported,
2630 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002631 CAREFUL: Files written with this method might have to
2632 be read back with the same version of Vim if the
2633 binary format changes later.
2634 Obsolete, please do no longer use.
2635 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2636 stores the key derivation parameters together with the
2637 encrypted file. Should work better in case the
2638 parameters in the libsodium library ever change.
2639 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002640 might have to be read back with the same version of
2641 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002642
Christian Brabandtaae58342023-04-23 17:50:22 +01002643 You should use "blowfish2", also to re-encrypt older files. The
2644 "xchacha20" method provides better encryption, but it does not work
2645 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002646
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002647 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002648 to the detected method of the file being read. Thus if you write it
2649 without changing 'cryptmethod' the same method will be used.
2650 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002651 explicitly write it, you don't get a warning unless there are other
2652 modifications. Also see |:X|.
2653
2654 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002655 the value "blowfish2". When setting the local value to an empty
2656 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002657
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002658 When a new encryption method is added in a later version of Vim, and
2659 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002660 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002661
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 *'cscopepathcomp'* *'cspc'*
2663'cscopepathcomp' 'cspc' number (default 0)
2664 global
2665 {not available when compiled without the |+cscope|
2666 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 Determines how many components of the path to show in a list of tags.
2668 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002669 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
2671 *'cscopeprg'* *'csprg'*
2672'cscopeprg' 'csprg' string (default "cscope")
2673 global
2674 {not available when compiled without the |+cscope|
2675 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 Specifies the command to execute cscope. See |cscopeprg|.
2677 This option cannot be set from a |modeline| or in the |sandbox|, for
2678 security reasons.
2679
2680 *'cscopequickfix'* *'csqf'*
2681'cscopequickfix' 'csqf' string (default "")
2682 global
2683 {not available when compiled without the |+cscope|
2684 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 Specifies whether to use quickfix window to show cscope results.
2686 See |cscopequickfix|.
2687
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002688 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002689'cscoperelative' 'csre' boolean (default off)
2690 global
2691 {not available when compiled without the |+cscope|
2692 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002693 In the absence of a prefix (-P) for cscope. setting this option enables
2694 to use the basename of cscope.out path as the prefix.
2695 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002696 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002697
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2699'cscopetag' 'cst' boolean (default off)
2700 global
2701 {not available when compiled without the |+cscope|
2702 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 Use cscope for tag commands. See |cscope-options|.
2704 NOTE: This option is reset when 'compatible' is set.
2705
2706 *'cscopetagorder'* *'csto'*
2707'cscopetagorder' 'csto' number (default 0)
2708 global
2709 {not available when compiled without the |+cscope|
2710 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 Determines the order in which ":cstag" performs a search. See
2712 |cscopetagorder|.
2713 NOTE: This option is set to 0 when 'compatible' is set.
2714
2715 *'cscopeverbose'* *'csverb'*
2716 *'nocscopeverbose'* *'nocsverb'*
2717'cscopeverbose' 'csverb' boolean (default off)
2718 global
2719 {not available when compiled without the |+cscope|
2720 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 Give messages when adding a cscope database. See |cscopeverbose|.
2722 NOTE: This option is reset when 'compatible' is set.
2723
Bram Moolenaar860cae12010-06-05 23:22:07 +02002724 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2725'cursorbind' 'crb' boolean (default off)
2726 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002727 When this option is set, as the cursor in the current
2728 window moves other cursorbound windows (windows that also have
2729 this option set) move their cursors to the corresponding line and
2730 column. This option is useful for viewing the
2731 differences between two versions of a file (see 'diff'); in diff mode,
2732 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002733 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002734
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002735 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2736'cursorcolumn' 'cuc' boolean (default off)
2737 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002738 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002739 feature}
2740 Highlight the screen column of the cursor with CursorColumn
2741 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2742 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002743 If you only want the highlighting in the current window you can use
2744 these autocommands: >
2745 au WinLeave * set nocursorline nocursorcolumn
2746 au WinEnter * set cursorline cursorcolumn
2747<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002748
2749 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2750'cursorline' 'cul' boolean (default off)
2751 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002752 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002753 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002754 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2755 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002756 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002757 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002758
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002759 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002760'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002761 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002762 {not available when compiled without the |+syntax|
2763 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002764 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002765 Valid values:
2766 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002767 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002768 "screenline" Highlight only the screen line of the cursor with
2769 CursorLine |hl-CursorLine|.
2770 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002771 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002772
2773 Special value:
2774 "both" Alias for the values "line,number".
2775
2776 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002777
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 *'debug'*
2779'debug' string (default "")
2780 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002781 These values can be used:
2782 msg Error messages that would otherwise be omitted will be given
2783 anyway.
2784 throw Error messages that would otherwise be omitted will be given
2785 anyway and also throw an exception and set |v:errmsg|.
2786 beep A message will be given when otherwise only a beep would be
2787 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002788 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002789 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2790 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
2792 *'define'* *'def'*
2793'define' 'def' string (default "^\s*#\s*define")
2794 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002795 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 pattern, just like for the "/" command. This option is used for the
2797 commands like "[i" and "[d" |include-search|. The 'isident' option is
2798 used to recognize the defined name after the match:
2799 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2800 See |option-backslash| about inserting backslashes to include a space
2801 or backslash.
2802 The default value is for C programs. For C++ this value would be
2803 useful, to include const type declarations: >
2804 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002805< You can also use "\ze" just before the name and continue the pattern
2806 to check what is following. E.g. for Javascript, if a function is
2807 defined with "func_name = function(args)": >
2808 ^\s*\ze\i\+\s*=\s*function(
2809< If the function is defined with "func_name : function() {...": >
2810 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002812 To avoid that use `:let` with a single quote string: >
2813 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002814<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815
2816 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2817'delcombine' 'deco' boolean (default off)
2818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 If editing Unicode and this option is set, backspace and Normal mode
2820 "x" delete each combining character on its own. When it is off (the
2821 default) the character along with its combining characters are
2822 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002823 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824
2825 This is useful for Arabic, Hebrew and many other languages where one
2826 may have combining characters overtop of base characters, and want
2827 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002828 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'dictionary'* *'dict'*
2831'dictionary' 'dict' string (default "")
2832 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 List of file names, separated by commas, that are used to lookup words
2834 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2835 contain a list of words. This can be one word per line, or several
2836 words per line, separated by non-keyword characters (white space is
2837 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002838
2839 When this option is empty or an entry "spell" is present, and spell
2840 checking is enabled, words in the word lists for the currently active
2841 'spelllang' are used. See |spell|.
2842
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002843 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 after a comma are ignored, otherwise spaces are included in the file
2845 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002846 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 Where to find a list of words?
2848 - On FreeBSD, there is the file "/usr/share/dict/words".
2849 - In the Simtel archive, look in the "msdos/linguist" directory.
2850 - In "miscfiles" of the GNU collection.
2851 The use of |:set+=| and |:set-=| is preferred when adding or removing
2852 directories from the list. This avoids problems when a future version
2853 uses another default.
2854 Backticks cannot be used in this option for security reasons.
2855
2856 *'diff'* *'nodiff'*
2857'diff' boolean (default off)
2858 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 {not available when compiled without the |+diff|
2860 feature}
2861 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002862 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863
2864 *'dex'* *'diffexpr'*
2865'diffexpr' 'dex' string (default "")
2866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 {not available when compiled without the |+diff|
2868 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002869 Expression which is evaluated to obtain a diff file (either ed-style
2870 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 This option cannot be set from a |modeline| or in the |sandbox|, for
2872 security reasons.
2873
2874 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002875'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 {not available when compiled without the |+diff|
2878 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002879 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 All are optional. Items must be separated by a comma.
2881
2882 filler Show filler lines, to keep the text
2883 synchronized with a window that has inserted
2884 lines at the same position. Mostly useful
2885 when windows are side-by-side and 'scrollbind'
2886 is set.
2887
2888 context:{n} Use a context of {n} lines between a change
2889 and a fold that contains unchanged lines.
2890 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002891 When using zero the context is actually one,
2892 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002893 for a deleted line. Set it to a very large
2894 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 See |fold-diff|.
2896
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002897 iblank Ignore changes where lines are all blank. Adds
2898 the "-B" flag to the "diff" command if
2899 'diffexpr' is empty. Check the documentation
2900 of the "diff" command for what this does
2901 exactly.
2902 NOTE: the diff windows will get out of sync,
2903 because no differences between blank lines are
2904 taken into account.
2905
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 icase Ignore changes in case of text. "a" and "A"
2907 are considered the same. Adds the "-i" flag
2908 to the "diff" command if 'diffexpr' is empty.
2909
2910 iwhite Ignore changes in amount of white space. Adds
2911 the "-b" flag to the "diff" command if
2912 'diffexpr' is empty. Check the documentation
2913 of the "diff" command for what this does
2914 exactly. It should ignore adding trailing
2915 white space, but not leading white space.
2916
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002917 iwhiteall Ignore all white space changes. Adds
2918 the "-w" flag to the "diff" command if
2919 'diffexpr' is empty. Check the documentation
2920 of the "diff" command for what this does
2921 exactly.
2922
2923 iwhiteeol Ignore white space changes at end of line.
2924 Adds the "-Z" flag to the "diff" command if
2925 'diffexpr' is empty. Check the documentation
2926 of the "diff" command for what this does
2927 exactly.
2928
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002929 horizontal Start diff mode with horizontal splits (unless
2930 explicitly specified otherwise).
2931
2932 vertical Start diff mode with vertical splits (unless
2933 explicitly specified otherwise).
2934
Bram Moolenaarc8234772019-11-10 21:00:27 +01002935 closeoff When a window is closed where 'diff' is set
2936 and there is only one window remaining in the
2937 same tab page with 'diff' set, execute
2938 `:diffoff` in that window. This undoes a
2939 `:diffsplit` command.
2940
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002941 hiddenoff Do not use diff mode for a buffer when it
2942 becomes hidden.
2943
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002944 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2945 starting diff mode. Without this 2 is used.
2946
Bram Moolenaar4223d432021-02-10 13:18:17 +01002947 followwrap Follow the 'wrap' option and leave as it is.
2948
Bram Moolenaare828b762018-09-10 17:51:58 +02002949 internal Use the internal diff library. This is
2950 ignored when 'diffexpr' is set. *E960*
2951 When running out of memory when writing a
2952 buffer this item will be ignored for diffs
2953 involving that buffer. Set the 'verbose'
2954 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955
Bram Moolenaare828b762018-09-10 17:51:58 +02002956 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002957 Use the indent heuristic for the internal
2958 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002959
zeertzjqd086b8f2024-02-25 15:42:52 +08002960 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002961 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002962 algorithms are:
2963 myers the default algorithm
2964 minimal spend extra time to generate the
2965 smallest possible diff
2966 patience patience diff algorithm
2967 histogram histogram diff algorithm
2968
2969 Examples: >
2970 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002972 :set diffopt=internal,filler,foldcolumn:3
2973 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974<
2975 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2976'digraph' 'dg' boolean (default off)
2977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 {not available when compiled without the |+digraphs|
2979 feature}
2980 Enable the entering of digraphs in Insert mode with {char1} <BS>
2981 {char2}. See |digraphs|.
2982 NOTE: This option is reset when 'compatible' is set.
2983
2984 *'directory'* *'dir'*
2985'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002986 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 for Unix: ".,~/tmp,/var/tmp,/tmp")
2988 global
2989 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002990 Recommended value: ".,~/vimswap//" - this will put the swap file next
2991 to the edited file if possible, and in your personal swap directory
2992 otherwise. Make sure "~/vimswap//" is only readable for you.
2993
2994 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 - The swap file will be created in the first directory where this is
2996 possible.
2997 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002998 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 - A directory "." means to put the swap file in the same directory as
3000 the edited file. On Unix, a dot is prepended to the file name, so
3001 it doesn't show in a directory listing. On MS-Windows the "hidden"
3002 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003003 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3004 the swap file relative to where the edited file is. The leading "."
3005 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003006 - For Unix and Win32, if a directory ends in two path separators "//",
3007 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003008 with all path separators replaced by percent '%' signs (including
3009 the colon following the drive letter on Win32). This will ensure
3010 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003011 On Win32, it is also possible to end with "\\". However, When a
3012 separating comma is following, you must use "//", since "\\" will
3013 include the comma in the file name. Therefore it is recommended to
3014 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 - Spaces after the comma are ignored, other spaces are considered part
3016 of the directory name. To have a space at the start of a directory
3017 name, precede it with a backslash.
3018 - To include a comma in a directory name precede it with a backslash.
3019 - A directory name may end in an ':' or '/'.
3020 - Environment variables are expanded |:set_env|.
3021 - Careful with '\' characters, type one before a space, type two to
3022 get one in the option (see |option-backslash|), for example: >
3023 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3024< - For backwards compatibility with Vim version 3.0 a '>' at the start
3025 of the option is removed.
3026 Using "." first in the list is recommended. This means that editing
3027 the same file twice will result in a warning. Using "/tmp" on Unix is
3028 discouraged: When the system crashes you lose the swap file.
3029 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003030 choice than "/tmp". But others on the computer may be able to see the
3031 files, and it can contain a lot of files, your swap files get lost in
3032 the crowd. That is why a "tmp" directory in your home directory is
3033 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 The use of |:set+=| and |:set-=| is preferred when adding or removing
3035 directories from the list. This avoids problems when a future version
3036 uses another default.
3037 This option cannot be set from a |modeline| or in the |sandbox|, for
3038 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
3040 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003041'display' 'dy' string (default "", set to "truncate" in
3042 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003044 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 flags:
3046 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003047 in a window will be displayed. "@@@" is put in the
3048 last columns of the last screen line to indicate the
3049 rest of the line is not displayed.
3050 truncate Like "lastline", but "@@@" is displayed in the first
3051 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 uhex Show unprintable characters hexadecimal as <xx>
3053 instead of using ^C and ~C.
3054
Bram Moolenaard0796902016-09-16 20:02:31 +02003055 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003056 doesn't fit is replaced with "@" lines.
3057
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003058 The "@" character can be changed by setting the "lastline" item in
3059 'fillchars'. The character is highlighted with |hl-NonText|.
3060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 *'eadirection'* *'ead'*
3062'eadirection' 'ead' string (default "both")
3063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 Tells when the 'equalalways' option applies:
3065 ver vertically, width of windows is not affected
3066 hor horizontally, height of windows is not affected
3067 both width and height of windows is affected
3068
3069 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3070'edcompatible' 'ed' boolean (default off)
3071 global
3072 Makes the 'g' and 'c' flags of the ":substitute" command to be
3073 toggled each time the flag is given. See |complex-change|. See
3074 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003075 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003076 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077
Bram Moolenaar03413f42016-04-12 21:07:15 +02003078 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003079'emoji' 'emo' boolean (default: on)
3080 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003081 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003082 This excludes "text emoji" characters, which are normally displayed as
3083 single width. Unfortunately there is no good specification for this
3084 and it has been determined on trial-and-error basis. Use the
3085 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003086
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003088'encoding' 'enc' string (default for MS-Windows: "utf-8",
3089 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 Sets the character encoding used inside Vim. It applies to text in
3092 the buffers, registers, Strings in expressions, text stored in the
3093 viminfo file, etc. It sets the kind of characters which Vim can work
3094 with. See |encoding-names| for the possible values.
3095
3096 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003097 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003099 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100
Bram Moolenaar865242e2010-07-14 21:12:05 +02003101 This option cannot be set from a |modeline|. It would most likely
3102 corrupt the text.
3103
Bram Moolenaar3df01732017-02-17 22:47:16 +01003104 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3105 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 'encoding', "utf-8" is the natural choice for the environment and
3107 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003108 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 versions, and to avoid changing the encoding of newly created files
3110 without your knowledge (in case 'fileencodings' is empty).
3111
3112 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003113 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 iconv() or as specified with 'charconvert'.
3115
Bram Moolenaar207f0092020-08-30 17:20:20 +02003116 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003117 can use: >
3118 if has("multi_byte_encoding")
3119<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 Normally 'encoding' will be equal to your current locale. This will
3121 be the default if Vim recognizes your environment settings. If
3122 'encoding' is not set to the current locale, 'termencoding' must be
3123 set to convert typed and displayed text. See |encoding-table|.
3124
3125 When you set this option, it fires the |EncodingChanged| autocommand
3126 event so that you can set up fonts if necessary.
3127
3128 When the option is set, the value is converted to lowercase. Thus
3129 you can set it with uppercase values too. Underscores are translated
3130 to '-' signs.
3131 When the encoding is recognized, it is changed to the standard name.
3132 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3133 "iso-8859-2" and "utf8" becomes "utf-8".
3134
3135 Note: "latin1" is also used when the encoding could not be detected.
3136 This only works when editing files in the same encoding! When the
3137 actual character set is not latin1, make sure 'fileencoding' and
3138 'fileencodings' are empty. When conversion is needed, switch to using
3139 utf-8.
3140
3141 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3142 You don't notice this while editing, but it does matter for the
3143 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3144 setting 'encoding' to one of these values instead of utf-8 only has
3145 effect for encoding used for files when 'fileencoding' is empty.
3146
Bram Moolenaar661b1822005-07-28 22:36:45 +00003147 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3148 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003150 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003151'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003153 Indicates that a CTRL-Z character was found at the end of the file
3154 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003156 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003157 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003158 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003159
3160 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3161'endofline' 'eol' boolean (default on)
3162 local to buffer
3163 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003164 is on, or 'fixeol' option is off, no <EOL> will be written for the
3165 last line in the file. This option is automatically set or reset when
3166 starting to edit a new file, depending on whether file has an <EOL>
3167 for the last line in the file. Normally you don't have to set or
3168 reset this option.
3169 When 'binary' is off and 'fixeol' is on the value is not used when
3170 writing the file. When 'binary' is on or 'fixeol' is off it is used
3171 to remember the presence of a <EOL> for the last line in the file, so
3172 that when you write the file the situation from the original file can
3173 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003174 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175
3176 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3177'equalalways' 'ea' boolean (default on)
3178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003180 splitting or closing a window. This also happens the moment the
3181 option is switched on. When off, splitting a window will reduce the
3182 size of the current window and leave the other windows the same. When
3183 closing a window the extra lines are given to the window next to it
3184 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 When mixing vertically and horizontally split windows, a minimal size
3186 is computed and some windows may be larger if there is room. The
3187 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003188 Changing the height and width of a window can be avoided by setting
3189 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003190 If a window size is specified when creating a new window sizes are
3191 currently not equalized (it's complicated, but may be implemented in
3192 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193
3194 *'equalprg'* *'ep'*
3195'equalprg' 'ep' string (default "")
3196 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003198 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003199 or 'indentexpr'. When Vim was compiled without internal formatting,
3200 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003201 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 about including spaces and backslashes.
3203 This option cannot be set from a |modeline| or in the |sandbox|, for
3204 security reasons.
3205
3206 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3207'errorbells' 'eb' boolean (default off)
3208 global
3209 Ring the bell (beep or screen flash) for error messages. This only
3210 makes a difference for error messages, the bell will be used always
3211 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003212 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003213 screen flash or do nothing. See 'belloff' to finetune when to ring the
3214 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215
3216 *'errorfile'* *'ef'*
3217'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3218 others: "errors.err")
3219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 {not available when compiled without the |+quickfix|
3221 feature}
3222 Name of the errorfile for the QuickFix mode (see |:cf|).
3223 When the "-q" command-line argument is used, 'errorfile' is set to the
3224 following argument. See |-q|.
3225 NOT used for the ":make" command. See 'makeef' for that.
3226 Environment variables are expanded |:set_env|.
3227 See |option-backslash| about including spaces and backslashes.
3228 This option cannot be set from a |modeline| or in the |sandbox|, for
3229 security reasons.
3230
3231 *'errorformat'* *'efm'*
3232'errorformat' 'efm' string (default is very long)
3233 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 {not available when compiled without the |+quickfix|
3235 feature}
3236 Scanf-like description of the format for the lines in the error file
3237 (see |errorformat|).
3238
3239 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3240'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Function keys that start with an <Esc> are recognized in Insert
3243 mode. When this option is off, the cursor and function keys cannot be
3244 used in Insert mode if they start with an <Esc>. The advantage of
3245 this is that the single <Esc> is recognized immediately, instead of
3246 after one second. Instead of resetting this option, you might want to
3247 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3248 when 'esckeys' is off, you can still map anything, but the cursor keys
3249 won't work by default.
3250 NOTE: This option is set to the Vi default value when 'compatible' is
3251 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003252 NOTE: when this option is off then the |modifyOtherKeys| and
3253 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3254 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255
3256 *'eventignore'* *'ei'*
3257'eventignore' 'ei' string (default "")
3258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003260 When set to "all" or when "all" is one of the items, all autocommand
3261 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003262 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 :set ei=WinEnter,WinLeave
3264<
3265 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3266'expandtab' 'et' boolean (default off)
3267 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3271 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003272 This option is reset when the 'paste' option is set and restored when
3273 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 NOTE: This option is reset when 'compatible' is set.
3275
3276 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3277'exrc' 'ex' boolean (default off)
3278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003280 directory.
3281
3282 Setting this option is a potential security leak. E.g., consider
3283 unpacking a package or fetching files from github, a .vimrc in there
3284 might be a trojan horse. BETTER NOT SET THIS OPTION!
3285 Instead, define an autocommand in your .vimrc to set options for a
3286 matching directory.
3287
3288 If you do switch this option on you should also consider setting the
3289 'secure' option (see |initialization|).
3290 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 This option cannot be set from a |modeline| or in the |sandbox|, for
3292 security reasons.
3293
3294 *'fileencoding'* *'fenc'* *E213*
3295'fileencoding' 'fenc' string (default: "")
3296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003300 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 When 'fileencoding' is empty, the same value as 'encoding' will be
3302 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003303 No error will be given when the value is set, only when it is used,
3304 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003305 Conversion will also be done when 'encoding' and 'fileencoding' are
3306 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3307 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003309 'encoding' is "utf-8" or another Unicode encoding, conversion
3310 is most likely done in a way that the reverse conversion
3311 results in the same text. When 'encoding' is not "utf-8" some
3312 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 See 'encoding' for the possible values. Additionally, values may be
3315 specified that can be handled by the converter, see
3316 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 When reading a file 'fileencoding' will be set from 'fileencodings'.
3319 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003320 'fileencoding', use the |++enc| argument. One exception: when
3321 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003322 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003323
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3325 When the option is set, the value is converted to lowercase. Thus
3326 you can set it with uppercase values too. '_' characters are
3327 replaced with '-'. If a name is recognized from the list for
3328 'encoding', it is replaced by the standard name. For example
3329 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 When this option is set, after starting to edit a file, the 'modified'
3332 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003333
3334 Keep in mind that changing 'fenc' from a modeline happens
3335 AFTER the text has been read, thus it applies to when the file will be
3336 written. If you do set 'fenc' in a modeline, you might want to set
3337 'nomodified' to avoid not being able to ":q".
3338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 This option can not be changed when 'modifiable' is off.
3340
3341 *'fe'*
3342 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003343 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 old short name was 'fe', which is no longer used.
3345
3346 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003347'fileencodings' 'fencs' string (default: "ucs-bom",
3348 "ucs-bom,utf-8,default,latin1" when
3349 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 This is a list of character encodings considered when starting to edit
3352 an existing file. When a file is read, Vim tries to use the first
3353 mentioned character encoding. If an error is detected, the next one
3354 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 an empty string, which means the value of 'encoding' is used.
3357 WARNING: Conversion can cause loss of information! When
3358 'encoding' is "utf-8" (or one of the other Unicode variants)
3359 conversion is most likely done in a way that the reverse
3360 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003361 "utf-8" some non-ASCII characters may be lost! You can use
3362 the |++bad| argument to specify what is done with characters
3363 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 For an empty file or a file with only ASCII characters most encodings
3365 will work and the first entry of 'fileencodings' will be used (except
3366 "ucs-bom", which requires the BOM to be present). If you prefer
3367 another encoding use an BufReadPost autocommand event to test if your
3368 preferred encoding is to be used. Example: >
3369 au BufReadPost * if search('\S', 'w') == 0 |
3370 \ set fenc=iso-2022-jp | endif
3371< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3372 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003373 When the |++enc| argument is used then the value of 'fileencodings' is
3374 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003375 Note that 'fileencodings' is not used for a new file, the global value
3376 of 'fileencoding' is used instead. You can set it with: >
3377 :setglobal fenc=iso-8859-2
3378< This means that a non-existing file may get a different encoding than
3379 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 The special value "ucs-bom" can be used to check for a Unicode BOM
3381 (Byte Order Mark) at the start of the file. It must not be preceded
3382 by "utf-8" or another Unicode encoding for this to work properly.
3383 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3384 because Vim cannot detect an error, thus the encoding is always
3385 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003386 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003387 environment. On MS-Windows this is the system encoding. Otherwise
3388 this is the default value for 'encoding'. It is useful when
3389 'encoding' is set to "utf-8" and your environment uses a non-latin1
3390 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003391 When 'encoding' is "utf-8" and a file contains an illegal byte
3392 sequence it won't be recognized as UTF-8. You can use the |8g8|
3393 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 WRONG VALUES: WHAT'S WRONG:
3395 latin1,utf-8 "latin1" will always be used
3396 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3397 file
3398 cp1250,latin1 "cp1250" will always be used
3399 If 'fileencodings' is empty, 'fileencoding' is not modified.
3400 See 'fileencoding' for the possible values.
3401 Setting this option does not have an effect until the next time a file
3402 is read.
3403
3404 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003405'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003406 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 This gives the <EOL> of the current buffer, which is used for
3409 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003410 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 unix <NL>
3412 mac <CR>
3413 When "dos" is used, CTRL-Z at the end of a file is ignored.
3414 See |file-formats| and |file-read|.
3415 For the character encoding of the file see 'fileencoding'.
3416 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003417 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 This option is set automatically when starting to edit a file and
3419 'fileformats' is not empty and 'binary' is off.
3420 When this option is set, after starting to edit a file, the 'modified'
3421 option is set, because the file would be different when written.
3422 This option can not be changed when 'modifiable' is off.
3423 For backwards compatibility: When this option is set to "dos",
3424 'textmode' is set, otherwise 'textmode' is reset.
3425
3426 *'fileformats'* *'ffs'*
3427'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003428 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003429 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 Vi Cygwin: "unix,dos",
3431 Vi others: "")
3432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 This gives the end-of-line (<EOL>) formats that will be tried when
3434 starting to edit a new buffer and when reading a file into an existing
3435 buffer:
3436 - When empty, the format defined with 'fileformat' will be used
3437 always. It is not set automatically.
3438 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003439 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 'fileformats' name will be used when a file is read into an existing
3441 buffer, no matter what 'fileformat' for that buffer is set to.
3442 - When more than one name is present, separated by commas, automatic
3443 <EOL> detection will be done when reading a file. When starting to
3444 edit a file, a check is done for the <EOL>:
3445 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3446 'fileformat' is set to "dos".
3447 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003448 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003450 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3451 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003452 This means that "mac" is only chosen when:
3453 "unix" is not present or no <NL> is found in the file, and
3454 "dos" is not present or no <CR><NL> is found in the file.
3455 Except: if "unix" was chosen, but there is a <CR> before
3456 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003457 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 4. If 'fileformat' is still not set, the first name from
3459 'fileformats' is used.
3460 When reading a file into an existing buffer, the same is done, but
3461 this happens like 'fileformat' has been set appropriately for that
3462 file only, the option is not changed.
3463 When 'binary' is set, the value of 'fileformats' is not used.
3464
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003465 When Vim starts up with an empty buffer the first item is used. You
3466 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3469 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3470 done:
3471 - When 'fileformats' is empty, there is no automatic detection. Dos
3472 format will be used.
3473 - When 'fileformats' is set to one or more names, automatic detection
3474 is done. This is based on the first <NL> in the file: If there is a
3475 <CR> in front of it, Dos format is used, otherwise Unix format is
3476 used.
3477 Also see |file-formats|.
3478 For backwards compatibility: When this option is set to an empty
3479 string or one format (no comma is included), 'textauto' is reset,
3480 otherwise 'textauto' is set.
3481 NOTE: This option is set to the Vi default value when 'compatible' is
3482 set and to the Vim default value when 'compatible' is reset.
3483
Bram Moolenaarbf884932013-04-05 22:26:15 +02003484 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3485'fileignorecase' 'fic' boolean (default on for systems where case in file
3486 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003487 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003488 When set case is ignored when using file names and directories.
3489 See 'wildignorecase' for only ignoring case when doing completion.
3490
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 *'filetype'* *'ft'*
3492'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003493 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 When this option is set, the FileType autocommand event is triggered.
3495 All autocommands that match with the value of this option will be
3496 executed. Thus the value of 'filetype' is used in place of the file
3497 name.
3498 Otherwise this option does not always reflect the current file type.
3499 This option is normally set when the file type is detected. To enable
3500 this use the ":filetype on" command. |:filetype|
3501 Setting this option to a different value is most useful in a modeline,
3502 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003503 Example, for in an IDL file:
3504 /* vim: set filetype=idl : */ ~
3505 |FileType| |filetypes|
3506 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003507 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003508 /* vim: set filetype=c.doxygen : */ ~
3509 This will use the "c" filetype first, then the "doxygen" filetype.
3510 This works both for filetype plugins and for syntax files. More than
3511 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 This option is not copied to another buffer, independent of the 's' or
3513 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003514 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515
3516 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003517'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003518 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003519 Characters to fill the statuslines, vertical separators and special
3520 lines in the window.
3521 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003522 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003524 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003525 stl ' ' statusline of the current window
3526 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003527 vert '|' vertical separators |:vsplit|
3528 fold '-' filling 'foldtext'
3529 foldopen '-' mark the beginning of a fold
3530 foldclose '+' show a closed fold
3531 foldsep '|' open fold middle character
3532 diff '-' deleted lines of the 'diff' option
3533 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003534 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003536 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
3538 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003539 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3540<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003541 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3542 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003543 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003544
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003546 item name highlight group ~
3547 stl StatusLine |hl-StatusLine|
3548 stlnc StatusLineNC |hl-StatusLineNC|
3549 vert VertSplit |hl-VertSplit|
3550 fold Folded |hl-Folded|
3551 diff DiffDelete |hl-DiffDelete|
3552 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003553 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003555 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3556'fixendofline' 'fixeol' boolean (default on)
3557 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003558 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003559 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003560 preserve the situation from the original file.
3561 When the 'binary' option is set the value of this option doesn't
3562 matter.
3563 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003564 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003565
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003567'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 {only available when compiled with the |+rightleft|
3570 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003571 This option was for using Farsi, which has been removed. See
3572 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573
3574 *'foldclose'* *'fcl'*
3575'foldclose' 'fcl' string (default "")
3576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 {not available when compiled without the |+folding|
3578 feature}
3579 When set to "all", a fold is closed when the cursor isn't in it and
3580 its level is higher than 'foldlevel'. Useful if you want folds to
3581 automatically close when moving out of them.
3582
3583 *'foldcolumn'* *'fdc'*
3584'foldcolumn' 'fdc' number (default 0)
3585 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 {not available when compiled without the |+folding|
3587 feature}
3588 When non-zero, a column with the specified width is shown at the side
3589 of the window which indicates open and closed folds. The maximum
3590 value is 12.
3591 See |folding|.
3592
3593 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3594'foldenable' 'fen' boolean (default on)
3595 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 {not available when compiled without the |+folding|
3597 feature}
3598 When off, all folds are open. This option can be used to quickly
3599 switch between showing all text unfolded and viewing the text with
3600 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003601 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 'foldenable' is off.
3603 This option is set by commands that create a new fold or close a fold.
3604 See |folding|.
3605
3606 *'foldexpr'* *'fde'*
3607'foldexpr' 'fde' string (default: "0")
3608 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003610 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003612 for each line to obtain its fold level. The context is set to the
3613 script where 'foldexpr' was set, script-local items can be accessed.
3614 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003615
Bram Moolenaar30b65812012-07-12 22:01:11 +02003616 The expression will be evaluated in the |sandbox| if set from a
3617 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003618 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003619 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003620
3621 It is not allowed to change text or jump to another window while
3622 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623
3624 *'foldignore'* *'fdi'*
3625'foldignore' 'fdi' string (default: "#")
3626 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 {not available when compiled without the |+folding|
3628 feature}
3629 Used only when 'foldmethod' is "indent". Lines starting with
3630 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003631 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 The default "#" works well for C programs. See |fold-indent|.
3633
3634 *'foldlevel'* *'fdl'*
3635'foldlevel' 'fdl' number (default: 0)
3636 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 {not available when compiled without the |+folding|
3638 feature}
3639 Sets the fold level: Folds with a higher level will be closed.
3640 Setting this option to zero will close all folds. Higher numbers will
3641 close fewer folds.
3642 This option is set by commands like |zm|, |zM| and |zR|.
3643 See |fold-foldlevel|.
3644
3645 *'foldlevelstart'* *'fdls'*
3646'foldlevelstart' 'fdls' number (default: -1)
3647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {not available when compiled without the |+folding|
3649 feature}
3650 Sets 'foldlevel' when starting to edit another buffer in a window.
3651 Useful to always start editing with all folds closed (value zero),
3652 some folds closed (one) or no folds closed (99).
3653 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003654 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 ignores this option and closes all folds.
3656 It is also done before BufReadPre autocommands, to allow an autocmd to
3657 overrule the 'foldlevel' value for specific files.
3658 When the value is negative, it is not used.
3659
3660 *'foldmarker'* *'fmr'* *E536*
3661'foldmarker' 'fmr' string (default: "{{{,}}}")
3662 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 {not available when compiled without the |+folding|
3664 feature}
3665 The start and end marker used when 'foldmethod' is "marker". There
3666 must be one comma, which separates the start and end marker. The
3667 marker is a literal string (a regular expression would be too slow).
3668 See |fold-marker|.
3669
3670 *'foldmethod'* *'fdm'*
3671'foldmethod' 'fdm' string (default: "manual")
3672 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {not available when compiled without the |+folding|
3674 feature}
3675 The kind of folding used for the current window. Possible values:
3676 |fold-manual| manual Folds are created manually.
3677 |fold-indent| indent Lines with equal indent form a fold.
3678 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3679 |fold-marker| marker Markers are used to specify folds.
3680 |fold-syntax| syntax Syntax highlighting items specify folds.
3681 |fold-diff| diff Fold text that is not changed.
3682
3683 *'foldminlines'* *'fml'*
3684'foldminlines' 'fml' number (default: 1)
3685 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 {not available when compiled without the |+folding|
3687 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003688 Sets the number of screen lines above which a fold can be displayed
3689 closed. Also for manually closed folds. With the default value of
3690 one a fold can only be closed if it takes up two or more screen lines.
3691 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003692 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 "zc" to close a fold, which is displayed open because it's smaller
3694 than 'foldminlines', a following "zc" may close a containing fold.
3695
3696 *'foldnestmax'* *'fdn'*
3697'foldnestmax' 'fdn' number (default: 20)
3698 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 {not available when compiled without the |+folding|
3700 feature}
3701 Sets the maximum nesting of folds for the "indent" and "syntax"
3702 methods. This avoids that too many folds will be created. Using more
3703 than 20 doesn't work, because the internal limit is 20.
3704
3705 *'foldopen'* *'fdo'*
3706'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3707 search,tag,undo")
3708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 {not available when compiled without the |+folding|
3710 feature}
3711 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003712 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003714 NOTE: When the command is part of a mapping this option is not used.
3715 Add the |zv| command to the mapping to get the same effect.
3716 (rationale: the mapping may want to control opening folds itself)
3717
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 item commands ~
3719 all any
3720 block "(", "{", "[[", "[{", etc.
3721 hor horizontal movements: "l", "w", "fx", etc.
3722 insert any command in Insert mode
3723 jump far jumps: "G", "gg", etc.
3724 mark jumping to a mark: "'m", CTRL-O, etc.
3725 percent "%"
3726 quickfix ":cn", ":crew", ":make", etc.
3727 search search for a pattern: "/", "n", "*", "gd", etc.
3728 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003729 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 tag jumping to a tag: ":ta", CTRL-T, etc.
3731 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 When a movement command is used for an operator (e.g., "dl" or "y%")
3733 this option is not used. This means the operator will include the
3734 whole closed fold.
3735 Note that vertical movements are not here, because it would make it
3736 very difficult to move onto a closed fold.
3737 In insert mode the folds containing the cursor will always be open
3738 when text is inserted.
3739 To close folds you can re-apply 'foldlevel' with the |zx| command or
3740 set the 'foldclose' option to "all".
3741
3742 *'foldtext'* *'fdt'*
3743'foldtext' 'fdt' string (default: "foldtext()")
3744 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 {not available when compiled without the |+folding|
3746 feature}
3747 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003748 fold. The context is set to the script where 'foldexpr' was set,
3749 script-local items can be accessed. See |fold-foldtext| for the
3750 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751
Bram Moolenaar30b65812012-07-12 22:01:11 +02003752 The expression will be evaluated in the |sandbox| if set from a
3753 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003754 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003755
3756 It is not allowed to change text or jump to another window while
3757 evaluating 'foldtext' |textlock|.
3758
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003759 *'formatexpr'* *'fex'*
3760'formatexpr' 'fex' string (default "")
3761 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003762 {not available when compiled without the |+eval|
3763 feature}
3764 Expression which is evaluated to format a range of lines for the |gq|
3765 operator or automatic formatting (see 'formatoptions'). When this
3766 option is empty 'formatprg' is used.
3767
3768 The |v:lnum| variable holds the first line to be formatted.
3769 The |v:count| variable holds the number of lines to be formatted.
3770 The |v:char| variable holds the character that is going to be
3771 inserted if the expression is being evaluated due to
3772 automatic formatting. This can be empty. Don't insert
3773 it yet!
3774
3775 Example: >
3776 :set formatexpr=mylang#Format()
3777< This will invoke the mylang#Format() function in the
3778 autoload/mylang.vim file in 'runtimepath'. |autoload|
3779
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003780 The advantage of using a function call without arguments is that it is
3781 faster, see |expr-option-function|.
3782
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003783 The expression is also evaluated when 'textwidth' is set and adding
3784 text beyond that limit. This happens under the same conditions as
3785 when internal formatting is used. Make sure the cursor is kept in the
3786 same spot relative to the text then! The |mode()| function will
3787 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003788
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003789 When the expression evaluates to non-zero Vim will fall back to using
3790 the internal format mechanism.
3791
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003792 If the expression starts with s: or |<SID>|, then it is replaced with
3793 the script ID (|local-function|). Example: >
3794 set formatexpr=s:MyFormatExpr()
3795 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003796< Otherwise, the expression is evaluated in the context of the script
3797 where the option was set, thus script-local items are available.
3798
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003799 The expression will be evaluated in the |sandbox| when set from a
3800 modeline, see |sandbox-option|. That stops the option from working,
3801 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003802 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003803 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003804
Bram Moolenaar86b68352004-12-27 21:59:20 +00003805 *'formatlistpat'* *'flp'*
3806'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3807 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003808 A pattern that is used to recognize a list header. This is used for
3809 the "n" flag in 'formatoptions'.
3810 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003811 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003812 while still checking more characters. There must be a character
3813 following the pattern, when it matches the whole line it is handled
3814 like there is no match.
3815 The default recognizes a number, followed by an optional punctuation
3816 character and white space.
3817
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003818 *'formatoptions'* *'fo'*
3819'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3820 local to buffer
3821 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003822 formatting is to be done.
3823 See |fo-table| for possible values and |gq| for how to format text.
3824 When the 'paste' option is on, no formatting is done (like
3825 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003826 To avoid problems with flags that are added in the future, use the
3827 "+=" and "-=" feature of ":set" |add-option-flags|.
3828 NOTE: This option is set to the Vi default value when 'compatible' is
3829 set and to the Vim default value when 'compatible' is reset.
3830
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 *'formatprg'* *'fp'*
3832'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003833 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003835 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003837 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003838 If the 'formatexpr' option is not empty it will be used instead.
3839 Otherwise, if 'formatprg' option is an empty string, the internal
3840 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003841 Environment variables are expanded |:set_env|. See |option-backslash|
3842 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003843 This option cannot be set from a |modeline| or in the |sandbox|, for
3844 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845
Bram Moolenaard94464e2015-11-02 15:28:18 +01003846 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003847'fsync' 'fs' boolean (default on)
3848 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003849 When on, the library function fsync() will be called after writing a
3850 file. This will flush a file to disk, ensuring that it is safely
3851 written even on filesystems which do metadata-only journaling. This
3852 will force the harddrive to spin up on Linux systems running in laptop
3853 mode, so it may be undesirable in some situations. Be warned that
3854 turning this off increases the chances of data loss after a crash. On
3855 systems without an fsync() implementation, this variable is always
3856 off.
3857 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003858 'fsync' also applies to |writefile()| (unless a flag is used to
3859 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003860 This option cannot be set from a |modeline| or in the |sandbox|, for
3861 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003862
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3864'gdefault' 'gd' boolean (default off)
3865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 When on, the ":substitute" flag 'g' is default on. This means that
3867 all matches in a line are substituted instead of one. When a 'g' flag
3868 is given to a ":substitute" command, this will toggle the substitution
3869 of all or one match. See |complex-change|.
3870
3871 command 'gdefault' on 'gdefault' off ~
3872 :s/// subst. all subst. one
3873 :s///g subst. one subst. all
3874 :s///gg subst. all subst. one
3875
3876 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003877 Setting this option may break plugins that rely on the default
3878 behavior of the 'g' flag. This will also make the 'g' flag have the
3879 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003880 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881
3882 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003883'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 Format to recognize for the ":grep" command output.
3886 This is a scanf-like string that uses the same format as the
3887 'errorformat' option: see |errorformat|.
3888
3889 *'grepprg'* *'gp'*
3890'grepprg' 'gp' string (default "grep -n ",
3891 Unix: "grep -n $* /dev/null",
3892 Win32: "findstr /n" or "grep -n",
3893 VMS: "SEARCH/NUMBERS ")
3894 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003895 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 and '#' characters, which are expanded like when used in a command-
3897 line. The placeholder "$*" is allowed to specify where the arguments
3898 will be included. Environment variables are expanded |:set_env|. See
3899 |option-backslash| about including spaces and backslashes.
3900 When your "grep" accepts the "-H" argument, use this to make ":grep"
3901 also work well with a single file: >
3902 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003903< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003904 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3905 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003906 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 apply equally to 'grepprg'.
3908 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3909 otherwise it's "grep -n".
3910 This option cannot be set from a |modeline| or in the |sandbox|, for
3911 security reasons.
3912
3913 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3914'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3915 ve:ver35-Cursor,
3916 o:hor50-Cursor,
3917 i-ci:ver25-Cursor/lCursor,
3918 r-cr:hor20-Cursor/lCursor,
3919 sm:block-Cursor
3920 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003921 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 "n-v-c:block,o:hor50,i-ci:hor15,
3923 r-cr:hor30,sm:block")
3924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003926 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003928 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003929 height of the cursor can be changed. This can be done by specifying a
3930 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003931 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3932 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003934 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 mode-list and an argument-list:
3936 mode-list:argument-list,mode-list:argument-list,..
3937 The mode-list is a dash separated list of these modes:
3938 n Normal mode
3939 v Visual mode
3940 ve Visual mode with 'selection' "exclusive" (same as 'v',
3941 if not specified)
3942 o Operator-pending mode
3943 i Insert mode
3944 r Replace mode
3945 c Command-line Normal (append) mode
3946 ci Command-line Insert mode
3947 cr Command-line Replace mode
3948 sm showmatch in Insert mode
3949 a all modes
3950 The argument-list is a dash separated list of these arguments:
3951 hor{N} horizontal bar, {N} percent of the character height
3952 ver{N} vertical bar, {N} percent of the character width
3953 block block cursor, fills the whole character
3954 [only one of the above three should be present]
3955 blinkwait{N} *cursor-blinking*
3956 blinkon{N}
3957 blinkoff{N}
3958 blink times for cursor: blinkwait is the delay before
3959 the cursor starts blinking, blinkon is the time that
3960 the cursor is shown and blinkoff is the time that the
3961 cursor is not shown. The times are in msec. When one
3962 of the numbers is zero, there is no blinking. The
3963 default is: "blinkwait700-blinkon400-blinkoff250".
3964 These numbers are used for a missing entry. This
3965 means that blinking is enabled by default. To switch
3966 blinking off you can use "blinkon0". The cursor only
3967 blinks when Vim is waiting for input, not while
3968 executing a command.
3969 To make the cursor blink in an xterm, see
3970 |xterm-blink|.
3971 {group-name}
3972 a highlight group name, that sets the color and font
3973 for the cursor
3974 {group-name}/{group-name}
3975 Two highlight group names, the first is used when
3976 no language mappings are used, the other when they
3977 are. |language-mapping|
3978
3979 Examples of parts:
3980 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3981 block cursor with colors from the "nCursor"
3982 highlight group
3983 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3984 In Insert and Command-line Insert mode, use a
3985 30% vertical bar cursor with colors from the
3986 "iCursor" highlight group. Blink a bit
3987 faster.
3988
3989 The 'a' mode is different. It will set the given argument-list for
3990 all modes. It does not reset anything to defaults. This can be used
3991 to do a common setting for all modes. For example, to switch off
3992 blinking: "a:blinkon0"
3993
3994 Examples of cursor highlighting: >
3995 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3996 :highlight Cursor gui=NONE guifg=bg guibg=fg
3997<
3998 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003999 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000'guifont' 'gfn' string (default "")
4001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 {only available when compiled with GUI enabled}
4003 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004004 In its simplest form the value is just one font name.
4005 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006
4007 *'guifontset'* *'gfs'*
4008 *E250* *E252* *E234* *E597* *E598*
4009'guifontset' 'gfs' string (default "")
4010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 {only available when compiled with GUI enabled and
4012 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004013 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 When not empty, specifies two (or more) fonts to be used. The first
4015 one for normal English, the second one for your special language. See
4016 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004017
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4019'guifontwide' 'gfw' string (default "")
4020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 {only available when compiled with GUI enabled}
4022 When not empty, specifies a comma-separated list of fonts to be used
4023 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004024 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004025
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 *'guiheadroom'* *'ghr'*
4027'guiheadroom' 'ghr' number (default 50)
4028 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004029 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 The number of pixels subtracted from the screen height when fitting
4031 the GUI window on the screen. Set this before the GUI is started,
4032 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004033 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 lines will be left for window decorations and other items on the
4035 screen. Set it to a negative value to allow windows taller than the
4036 screen.
4037
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004038 *'guiligatures'* *'gli'* *E1243*
4039'guiligatures' 'gli' string (default "")
4040 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004041 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004042 List of ASCII characters that, when combined together, can create more
4043 complex shapes. Each character must be a printable ASCII character
4044 with a value in the 32-127 range.
4045 Example: >
4046 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4047< Changing this option updates screen output immediately. Set it to an
4048 empty string to disable ligatures.
4049
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004051'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4052 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004053 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004054 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004057 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 sequence of letters which describes what components and options of the
4059 GUI should be used.
4060 To avoid problems with flags that are added in the future, use the
4061 "+=" and "-=" feature of ":set" |add-option-flags|.
4062
Bram Moolenaar13568252018-03-16 20:46:58 +01004063 Valid characters are as follows:
4064 *'go-!'*
4065 '!' External commands are executed in a terminal window. Without
4066 this flag the MS-Windows GUI will open a console window to
4067 execute the command. The Unix GUI will simulate a dumb
4068 terminal to list the command output.
4069 The terminal window will be positioned at the bottom, and grow
4070 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004071 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 'a' Autoselect: If present, then whenever VISUAL mode is started,
4073 or the Visual area extended, Vim tries to become the owner of
4074 the windowing system's global selection. This means that the
4075 Visually highlighted text is available for pasting into other
4076 applications as well as into Vim itself. When the Visual mode
4077 ends, possibly due to an operation on the text, or when an
4078 application wants to paste the selection, the highlighted text
4079 is automatically yanked into the "* selection register.
4080 Thus the selection is still available for pasting into other
4081 applications after the VISUAL mode has ended.
4082 If not present, then Vim won't become the owner of the
4083 windowing system's global selection unless explicitly told to
4084 by a yank or delete operation for the "* register.
4085 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004086 *'go-P'*
4087 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004088 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004089 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004090 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 applies to the modeless selection.
4092
4093 'guioptions' autoselect Visual autoselect modeless ~
4094 "" - -
4095 "a" yes yes
4096 "A" - yes
4097 "aA" yes yes
4098
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004099 When using a terminal see the 'clipboard' option.
4100
Bram Moolenaar02467872007-05-06 13:22:01 +00004101 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 'c' Use console dialogs instead of popup dialogs for simple
4103 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004104 *'go-d'*
4105 'd' Use dark theme variant if available. Currently only works for
4106 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004107 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004108 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004109 'guitablabel' can be used to change the text in the labels.
4110 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004111 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004112 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004113 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 'f' Foreground: Don't use fork() to detach the GUI from the shell
4115 where it was started. Use this for programs that wait for the
4116 editor to finish (e.g., an e-mail program). Alternatively you
4117 can use "gvim -f" or ":gui -f" to start the GUI in the
4118 foreground. |gui-fork|
4119 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004120 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004121 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4123 corner of the window. It's black&white on non-GTK, because of
4124 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004125 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004127 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004128 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004130 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004132 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004133 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 'g' Grey menu items: Make menu items that are not active grey. If
4135 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004136 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 't' Include tearoff menu items. Currently only works for Win32,
4138 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004139 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004140 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4141 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004142 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004144 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 'R' Right-hand scrollbar is present when there is a vertically
4146 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004147 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004149 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 'L' Left-hand scrollbar is present when there is a vertically
4151 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004152 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4154 the longest visible line, or on the cursor line if the 'h'
4155 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004156 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 'h' Limit horizontal scrollbar size to the length of the cursor
4158 line. Reduces computations. |gui-horiz-scroll|
4159
4160 And yes, you may even have scrollbars on the left AND the right if
4161 you really want to :-). See |gui-scrollbars| for more information.
4162
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004163 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 'v' Use a vertical button layout for dialogs. When not included,
4165 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004166 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004167 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 'p' Use Pointer callbacks for X11 GUI. This is required for some
4169 window managers. If the cursor is not blinking or hollow at
4170 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004171 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004173 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004174 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004175 *'go-k'*
4176 'k' Keep the GUI window size when adding/removing a scrollbar, or
4177 toolbar, tabline, etc. Instead, the behavior is similar to
4178 when the window is maximized and will adjust 'lines' and
4179 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004180 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004181 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004182
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 *'guipty'* *'noguipty'*
4184'guipty' boolean (default on)
4185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 {only available when compiled with GUI enabled}
4187 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4188 I/O to/from shell commands. See |gui-pty|.
4189
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004190 *'guitablabel'* *'gtl'*
4191'guitablabel' 'gtl' string (default empty)
4192 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004193 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004194 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004195 pages line. When empty and when the result is empty Vim will use a
4196 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004197
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004198 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004199 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004200 The expression will be evaluated in the |sandbox| when set from a
4201 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004202 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004203
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004204 Only used when the GUI tab pages line is displayed. 'e' must be
4205 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4206 used.
4207
Bram Moolenaar57657d82006-04-21 22:12:41 +00004208 *'guitabtooltip'* *'gtt'*
4209'guitabtooltip' 'gtt' string (default empty)
4210 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004211 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004212 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004213 pages line. When empty Vim will use a default tooltip.
4214 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004215 You can include a line break. Simplest method is to use |:let|: >
4216 :let &guitabtooltip = "line one\nline two"
4217<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004218
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004220'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 (others) "$VIMRUNTIME/doc/help.txt")
4222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 Name of the main help file. All distributed help files should be
4224 placed together in one directory. Additionally, all "doc" directories
4225 in 'runtimepath' will be used.
4226 Environment variables are expanded |:set_env|. For example:
4227 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004228 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 spaces and backslashes.
4230 This option cannot be set from a |modeline| or in the |sandbox|, for
4231 security reasons.
4232
4233 *'helpheight'* *'hh'*
4234'helpheight' 'hh' number (default 20)
4235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 Minimal initial height of the help window when it is opened with the
4237 ":help" command. The initial height of the help window is half of the
4238 current window, or (when the 'ea' option is on) the same as other
4239 windows. When the height is less than 'helpheight', the height is
4240 set to 'helpheight'. Set to zero to disable.
4241
4242 *'helplang'* *'hlg'*
4243'helplang' 'hlg' string (default: messages language or empty)
4244 global
4245 {only available when compiled with the |+multi_lang|
4246 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004247 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 for which the desired help can be found. The English help will always
4249 be used as a last resort. You can add "en" to prefer English over
4250 another language, but that will only find tags that exist in that
4251 language and not in the English help.
4252 Example: >
4253 :set helplang=de,it
4254< This will first search German, then Italian and finally English help
4255 files.
4256 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4257 try to find the tag in the current language before using this option.
4258 See |help-translated|.
4259
4260 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4261'hidden' 'hid' boolean (default off)
4262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 When off a buffer is unloaded when it is |abandon|ed. When on a
4264 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4265 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004266
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004268 hidden even if the 'hidden' option is off when these three are true:
4269 - the buffer is modified
4270 - 'autowrite' is off or writing is not possible
4271 - the '!' flag was used
4272 Also see |windows.txt|.
4273
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004274 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 This option is set for one command with ":hide {command}" |:hide|.
4276 WARNING: It's easy to forget that you have changes in hidden buffers.
4277 Think twice when using ":q!" or ":qa!".
4278
4279 *'highlight'* *'hl'*
4280'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004281 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4282 d:Directory,e:ErrorMsg,i:IncSearch,
4283 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004284 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004285 N:CursorLineNr,r:Question,s:StatusLine,
4286 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004287 v:Visual,V:VisualNOS,w:WarningMsg,
4288 W:WildMenu,f:Folded,F:FoldColumn,
4289 A:DiffAdd,C:DiffChange,D:DiffDelete,
4290 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004291 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004292 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004293 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004294 [:PmenuKind,]:PmenuKindSel,
4295 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004296 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4297 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004298 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004299 z:StatusLineTerm,Z:StatusLineTermNC,
4300 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004303 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004305 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004307 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4308 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 characters from 'showbreak'
4310 |hl-Directory| d directories in CTRL-D listing and other special
4311 things in listings
4312 |hl-ErrorMsg| e error messages
4313 h (obsolete, ignored)
4314 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004315 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4317 |hl-MoreMsg| m |more-prompt|
4318 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004319 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004320 |hl-LineNr| n line number for ":number" and ":#" commands, and
4321 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004322 |hl-LineNrAbove| a line number above the cursor for when the
4323 'relativenumber' option is set.
4324 |hl-LineNrBelow| b line number below the cursor for when the
4325 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004326 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4327 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 |hl-Question| r |hit-enter| prompt and yes/no questions
4329 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004330 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4332 |hl-VertSplit| c column used to separate vertically split windows
4333 |hl-Visual| v Visual mode
4334 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4335 Selection" Only X11 Gui's |gui-x11| and
4336 |xterm-clipboard|.
4337 |hl-WarningMsg| w warning messages
4338 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4339 |hl-Folded| f line used for closed folds
4340 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004341 |hl-DiffAdd| A added line in diff mode
4342 |hl-DiffChange| C changed line in diff mode
4343 |hl-DiffDelete| D deleted line in diff mode
4344 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004346 |hl-Conceal| - the placeholders used for concealed characters
4347 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004348 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004349 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004350 |hl-SpellRare| R rare word |spell|
4351 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004352 |hl-Pmenu| + popup menu normal line
4353 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004354 |hl-PmenuKind| [ popup menu "kind" normal line
4355 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004356 |hl-PmenuExtra| { popup menu "extra" normal line
4357 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004358 |hl-PmenuSbar| x popup menu scrollbar
4359 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004360 |hl-PmenuMatch| k popup menu matched text
4361 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362
4363 The display modes are:
4364 r reverse (termcap entry "mr" and "me")
4365 i italic (termcap entry "ZH" and "ZR")
4366 b bold (termcap entry "md" and "me")
4367 s standout (termcap entry "so" and "se")
4368 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004369 c undercurl (termcap entry "Us" and "Ce")
4370 2 double underline (termcap entry "Ds" and "Ce")
4371 d dotted underline (termcap entry "ds" and "Ce")
4372 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004373 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 n no highlighting
4375 - no highlighting
4376 : use a highlight group
4377 The default is used for occasions that are not included.
4378 If you want to change what the display modes do, see |dos-colors|
4379 for an example.
4380 When using the ':' display mode, this must be followed by the name of
4381 a highlight group. A highlight group can be used to define any type
4382 of highlighting, including using color. See |:highlight| on how to
4383 define one. The default uses a different group for each occasion.
4384 See |highlight-default| for the default highlight groups.
4385
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004387'history' 'hi' number (Vim default: 50, Vi default: 0,
4388 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004391 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004393 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 NOTE: This option is set to the Vi default value when 'compatible' is
4395 set and to the Vim default value when 'compatible' is reset.
4396
4397 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4398'hkmap' 'hk' boolean (default off)
4399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 {only available when compiled with the |+rightleft|
4401 feature}
4402 When on, the keyboard is mapped for the Hebrew character set.
4403 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4404 toggle this option. See |rileft.txt|.
4405 NOTE: This option is reset when 'compatible' is set.
4406
4407 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4408'hkmapp' 'hkp' boolean (default off)
4409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 {only available when compiled with the |+rightleft|
4411 feature}
4412 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4413 This is useful if you have a non-Hebrew keyboard.
4414 See |rileft.txt|.
4415 NOTE: This option is reset when 'compatible' is set.
4416
Bram Moolenaar036986f2017-03-16 17:41:02 +01004417 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4418'hlsearch' 'hls' boolean (default off)
4419 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004420 {not available when compiled without the
4421 |+extra_search| feature}
4422 When there is a previous search pattern, highlight all its matches.
4423 The type of highlighting used can be set with the 'l' occasion in the
4424 'highlight' option. This uses the "Search" highlight group by
4425 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004426 are not applied. If the "CurSearch" highlight group is set then the
4427 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004428 See also: 'incsearch' and |:match|.
4429 When you get bored looking at the highlighted matches, you can turn it
4430 off with |:nohlsearch|. This does not change the option value, as
4431 soon as you use a search command, the highlighting comes back.
4432 'redrawtime' specifies the maximum time spent on finding matches.
4433 When the search pattern can match an end-of-line, Vim will try to
4434 highlight all of the matched text. However, this depends on where the
4435 search starts. This will be the first line in the window or the first
4436 line below a closed fold. A match in a previous line which is not
4437 drawn may not continue in a newly drawn line.
4438 You can specify whether the highlight status is restored on startup
4439 with the 'h' flag in 'viminfo' |viminfo-h|.
4440 NOTE: This option is reset when 'compatible' is set.
4441
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 *'icon'* *'noicon'*
4443'icon' boolean (default off, on when title can be restored)
4444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 When on, the icon text of the window will be set to the value of
4446 'iconstring' (if it is not empty), or to the name of the file
4447 currently being edited. Only the last part of the name is used.
4448 Overridden by the 'iconstring' option.
4449 Only works if the terminal supports setting window icons (currently
4450 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4451 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4452 builtin termcap).
4453 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004454 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004456 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457
4458 *'iconstring'*
4459'iconstring' string (default "")
4460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 When this option is not empty, it will be used for the icon text of
4462 the window. This happens only when the 'icon' option is on.
4463 Only works if the terminal supports setting window icon text
4464 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004465 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 When Vim was compiled with HAVE_X11 defined, the original icon will be
4467 restored if possible |X11|.
4468 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004469 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004471 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 {not available when compiled without the |+statusline| feature}
4473
4474 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4475'ignorecase' 'ic' boolean (default off)
4476 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004477 Ignore case in search patterns, |cmdline-completion|, when
4478 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004479 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 Can be overruled by using "\c" or "\C" in the pattern, see
4481 |/ignorecase|.
4482
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004483 *'imactivatefunc'* *'imaf'*
4484'imactivatefunc' 'imaf' string (default "")
4485 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004486 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004487 activate or deactivate the Input Method. The value can be the name of
4488 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4489 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004490 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004491 The expression will be evaluated in the |sandbox| when set from a
4492 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004493
4494 Example: >
4495 function ImActivateFunc(active)
4496 if a:active
4497 ... do something
4498 else
4499 ... do something
4500 endif
4501 " return value is not used
4502 endfunction
4503 set imactivatefunc=ImActivateFunc
4504<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 *'imactivatekey'* *'imak'*
4506'imactivatekey' 'imak' string (default "")
4507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004509 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 Specifies the key that your Input Method in X-Windows uses for
4511 activation. When this is specified correctly, vim can fully control
4512 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4513 You can't use this option to change the activation key, the option
4514 tells Vim what the key is.
4515 Format:
4516 [MODIFIER_FLAG-]KEY_STRING
4517
4518 These characters can be used for MODIFIER_FLAG (case is ignored):
4519 S Shift key
4520 L Lock key
4521 C Control key
4522 1 Mod1 key
4523 2 Mod2 key
4524 3 Mod3 key
4525 4 Mod4 key
4526 5 Mod5 key
4527 Combinations are allowed, for example "S-C-space" or "SC-space" are
4528 both shift+ctrl+space.
4529 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4530
4531 Example: >
4532 :set imactivatekey=S-space
4533< "S-space" means shift+space. This is the activation key for kinput2 +
4534 canna (Japanese), and ami (Korean).
4535
4536 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4537'imcmdline' 'imc' boolean (default off)
4538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 When set the Input Method is always on when starting to edit a command
4540 line, unless entering a search pattern (see 'imsearch' for that).
4541 Setting this option is useful when your input method allows entering
4542 English characters directly, e.g., when it's used to type accented
4543 characters with dead keys.
4544
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004545 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 When set the Input Method is never used. This is useful to disable
4549 the IM when it doesn't work properly.
4550 Currently this option is on by default for SGI/IRIX machines. This
4551 may change in later releases.
4552
4553 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004554'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 Specifies whether :lmap or an Input Method (IM) is to be used in
4557 Insert mode. Valid values:
4558 0 :lmap is off and IM is off
4559 1 :lmap is ON and IM is off
4560 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 To always reset the option to zero when leaving Insert mode with <Esc>
4562 this can be used: >
4563 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4564< This makes :lmap and IM turn off automatically when leaving Insert
4565 mode.
4566 Note that this option changes when using CTRL-^ in Insert mode
4567 |i_CTRL-^|.
4568 The value is set to 1 when setting 'keymap' to a valid keymap name.
4569 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004570 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 methods. Use 'imdisable' to disable XIM then.
4572
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004573 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004574 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004575 |+multi_byte_ime| or |global-ime|.
4576
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004578'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 Specifies whether :lmap or an Input Method (IM) is to be used when
4581 entering a search pattern. Valid values:
4582 -1 the value of 'iminsert' is used, makes it look like
4583 'iminsert' is also used when typing a search pattern
4584 0 :lmap is off and IM is off
4585 1 :lmap is ON and IM is off
4586 2 :lmap is off and IM is ON
4587 Note that this option changes when using CTRL-^ in Command-line mode
4588 |c_CTRL-^|.
4589 The value is set to 1 when it is not -1 and setting the 'keymap'
4590 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004591 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 methods. Use 'imdisable' to disable XIM then.
4593
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004594 *'imstatusfunc'* *'imsf'*
4595'imstatusfunc' 'imsf' string (default "")
4596 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004597 This option specifies a function that is called to obtain the status
4598 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004599 The value can be the name of a function, a |lambda| or a |Funcref|.
4600 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004601 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004602
4603 Example: >
4604 function ImStatusFunc()
4605 let is_active = ...do something
4606 return is_active ? 1 : 0
4607 endfunction
4608 set imstatusfunc=ImStatusFunc
4609<
4610 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004611 The expression will be evaluated in the |sandbox| when set from a
4612 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004613
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004614 *'imstyle'* *'imst'*
4615'imstyle' 'imst' number (default 1)
4616 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004617 {only available when compiled with |+xim| and
4618 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004619 This option specifies the input style of Input Method:
4620 0 use on-the-spot style
4621 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004622 See: |xim-input-style|
4623
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004624 For a long time on-the-spot style had been used in the GTK version of
4625 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004626 |single-repeat|, etc. Therefore over-the-spot style becomes the
4627 default now. This should work fine for most people, however if you
4628 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004629 The expression will be evaluated in the |sandbox| when set from a
4630 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004631
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 *'include'* *'inc'*
4633'include' 'inc' string (default "^\s*#\s*include")
4634 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 {not available when compiled without the
4636 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004637 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 pattern, just like for the "/" command (See |pattern|). The default
4639 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004640 "]I", "[d", etc.
4641 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004642 comes after the matched pattern. But if "\zs" appears in the pattern
4643 then the text matched from "\zs" to the end, or until "\ze" if it
4644 appears, is used as the file name. Use this to include characters
4645 that are not in 'isfname', such as a space. You can then use
4646 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004647 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648
4649 *'includeexpr'* *'inex'*
4650'includeexpr' 'inex' string (default "")
4651 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004653 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004655 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004656 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004658 Note the double backslash: the `:set` command first halves them, then
4659 one remains it the value, where "\." matches a dot literally. For
4660 simple character replacements `tr()` avoids the need for escaping: >
4661 :setlocal includeexpr=tr(v:fname,'.','/')
4662<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004664 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 Also used for |<cfile>|.
4666
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004667 If the expression starts with s: or |<SID>|, then it is replaced with
4668 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004669 setlocal includeexpr=s:MyIncludeExpr()
4670 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004671< Otherwise, the expression is evaluated in the context of the script
4672 where the option was set, thus script-local items are available.
4673
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004674 It is more efficient if the value is just a function call without
4675 arguments, see |expr-option-function|.
4676
Bram Moolenaar30b65812012-07-12 22:01:11 +02004677 The expression will be evaluated in the |sandbox| when set from a
4678 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004679 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004680
4681 It is not allowed to change text or jump to another window while
4682 evaluating 'includeexpr' |textlock|.
4683
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004685'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004686 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004689 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004690 While typing a search command, show where the pattern, as it was typed
4691 so far, matches. The matched string is highlighted. If the pattern
4692 is invalid or not found, nothing is shown. The screen will be updated
4693 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004694 Also applies to the pattern in commands: >
4695 :global
4696 :lvimgrep
4697 :lvimgrepadd
4698 :smagic
4699 :snomagic
4700 :sort
4701 :substitute
4702 :vglobal
4703 :vimgrep
4704 :vimgrepadd
4705< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004706 original position when no match is found and when pressing <Esc>. You
4707 still need to finish the search command with <Enter> to move the
4708 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004709 You can use the CTRL-G and CTRL-T keys to move to the next and
4710 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004711 When compiled with the |+reltime| feature Vim only searches for about
4712 half a second. With a complicated pattern and/or a lot of text the
4713 match may not be found. This is to avoid that Vim hangs while you
4714 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004715 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004716 When 'hlsearch' is on, all matched strings are highlighted too while
4717 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004718 If you don't want to turn 'hlsearch' on, but want to highlight all
4719 matches while searching, you can turn on and off 'hlsearch' with
4720 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004721 augroup vimrc-incsearch-highlight
4722 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004723 autocmd CmdlineEnter /,\? :set hlsearch
4724 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004725 augroup END
4726<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004727 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004728 to the command line. If 'ignorecase' and 'smartcase' are set and the
4729 command line has no uppercase characters, the added character is
4730 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004731 CTRL-R CTRL-W can be used to add the word at the end of the current
4732 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 NOTE: This option is reset when 'compatible' is set.
4734
4735 *'indentexpr'* *'inde'*
4736'indentexpr' 'inde' string (default "")
4737 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004738 {not available when compiled without the |+eval|
4739 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 Expression which is evaluated to obtain the proper indent for a line.
4741 It is used when a new line is created, for the |=| operator and
4742 in Insert mode as specified with the 'indentkeys' option.
4743 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004744 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004745 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 When 'paste' is set this option is not used for indenting.
4747 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004748 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004750
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004751 If the expression starts with s: or |<SID>|, then it is replaced with
4752 the script ID (|local-function|). Example: >
4753 set indentexpr=s:MyIndentExpr()
4754 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004755< Otherwise, the expression is evaluated in the context of the script
4756 where the option was set, thus script-local items are available.
4757
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004758 The advantage of using a function call without arguments is that it is
4759 faster, see |expr-option-function|.
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 The expression must return the number of spaces worth of indent. It
4762 can return "-1" to keep the current indent (this means 'autoindent' is
4763 used for the indent).
4764 Functions useful for computing the indent are |indent()|, |cindent()|
4765 and |lispindent()|.
4766 The evaluation of the expression must not have side effects! It must
4767 not change the text, jump to another window, etc. Afterwards the
4768 cursor position is always restored, thus the cursor may be moved.
4769 Normally this option would be set to call a function: >
4770 :set indentexpr=GetMyIndent()
4771< Error messages will be suppressed, unless the 'debug' option contains
4772 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004773 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004774 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775
Bram Moolenaar30b65812012-07-12 22:01:11 +02004776 The expression will be evaluated in the |sandbox| when set from a
4777 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004778 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004779
4780 It is not allowed to change text or jump to another window while
4781 evaluating 'indentexpr' |textlock|.
4782
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004784'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 A list of keys that, when typed in Insert mode, cause reindenting of
4787 the current line. Only happens if 'indentexpr' isn't empty.
4788 The format is identical to 'cinkeys', see |indentkeys-format|.
4789 See |C-indenting| and |indent-expression|.
4790
4791 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4792'infercase' 'inf' boolean (default off)
4793 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004795 'ignorecase' is also on, the case of the match is adjusted depending
4796 on the typed text. If the typed text contains a lowercase letter
4797 where the match has an upper case letter, the completed part is made
4798 lowercase. If the typed text has no lowercase letters and the match
4799 has a lowercase letter where the typed text has an uppercase letter,
4800 and there is a letter before it, the completed part is made uppercase.
4801 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
4803 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4804'insertmode' 'im' boolean (default off)
4805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 Makes Vim work in a way that Insert mode is the default mode. Useful
4807 if you want to use Vim as a modeless editor. Used for |evim|.
4808 These Insert mode commands will be useful:
4809 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004810 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 this is a mapping, it is executed as if 'insertmode' was off.
4812 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004814 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4815 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816
4817 These items change when 'insertmode' is set:
4818 - when starting to edit of a file, Vim goes to Insert mode.
4819 - <Esc> in Insert mode is a no-op and beeps.
4820 - <Esc> in Normal mode makes Vim go to Insert mode.
4821 - CTRL-L in Insert mode is a command, it is not inserted.
4822 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4823 However, when <Esc> is used inside a mapping, it behaves like
4824 'insertmode' was not set. This was done to be able to use the same
4825 mappings with 'insertmode' set or not set.
4826 When executing commands with |:normal| 'insertmode' is not used.
4827
4828 NOTE: This option is reset when 'compatible' is set.
4829
4830 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004831'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4833 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4834 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4835 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4836 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 The characters specified by this option are included in file names and
4839 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004840 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 Multi-byte characters 256 and above are always included, only the
4842 characters up to 255 are specified with this option.
4843 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004844 Think twice before adding white space to this option. Although a
4845 space may appear inside a file name, the effect will be that Vim
4846 doesn't know where a file name starts or ends when doing completion.
4847 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
4849 Note that on systems using a backslash as path separator, Vim tries to
4850 do its best to make it work as you would expect. That is a bit
4851 tricky, since Vi originally used the backslash to escape special
4852 characters. Vim will not remove a backslash in front of a normal file
4853 name character on these systems, but it will on Unix and alikes. The
4854 '&' and '^' are not included by default, because these are special for
4855 cmd.exe.
4856
4857 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004858 Each part can be a single character number or a range. A range is two
4859 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 decimal number between 0 and 255 or the ASCII character itself (does
4861 not work for digits). Example:
4862 "_,-,128-140,#-43" (include '_' and '-' and the range
4863 128 to 140 and '#' to 43)
4864 If a part starts with '^', the following character number or range
4865 will be excluded from the option. The option is interpreted from left
4866 to right. Put the excluded character after the range where it is
4867 included. To include '^' itself use it as the last character of the
4868 option or the end of a range. Example:
4869 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4870 If the character is '@', all characters where isalpha() returns TRUE
4871 are included. Normally these are the characters a to z and A to Z,
4872 plus accented characters. To include '@' itself use "@-@". Examples:
4873 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004874 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 "a-z,A-Z,@-@" All letters plus the '@' character.
4876 A comma can be included by using it where a character number is
4877 expected. Example:
4878 "48-57,,,_" Digits, comma and underscore.
4879 A comma can be excluded by prepending a '^'. Example:
4880 " -~,^,,9" All characters from space to '~', excluding
4881 comma, plus <Tab>.
4882 See |option-backslash| about including spaces and backslashes.
4883
4884 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004885'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 "@,48-57,_,128-167,224-235"
4887 otherwise: "@,48-57,_,192-255")
4888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 The characters given by this option are included in identifiers.
4890 Identifiers are used in recognizing environment variables and after a
4891 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004892 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004893 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004895 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4897
4898 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004899'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 "@,48-57,_,128-167,224-235"
4901 otherwise: "@,48-57,_,192-255"
4902 Vi default: "@,48-57,_")
4903 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004905 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004906 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004907 characters above 255 check the "word" character class (any character
4908 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004909 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 For a help file it is set to all non-blank printable characters except
4911 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4912 command).
4913 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004914 This option also influences syntax highlighting, unless the syntax
4915 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 NOTE: This option is set to the Vi default value when 'compatible' is
4917 set and to the Vim default value when 'compatible' is reset.
4918
4919 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02004920'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 "@,~-255"; otherwise: "@,161-255")
4922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 The characters given by this option are displayed directly on the
4924 screen. It is also used for "\p" in a |pattern|. The characters from
4925 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4926 even when they are not included in 'isprint' or excluded. See
4927 'isfname' for a description of the format of this option.
4928
4929 Non-printable characters are displayed with two characters:
4930 0 - 31 "^@" - "^_"
4931 32 - 126 always single characters
4932 127 "^?"
4933 128 - 159 "~@" - "~_"
4934 160 - 254 "| " - "|~"
4935 255 "~?"
4936 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4937 displayed as <xx>, with the hexadecimal value of the byte.
4938 When 'display' contains "uhex" all unprintable characters are
4939 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004940 The SpecialKey highlighting will be used for unprintable characters.
4941 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942
4943 Multi-byte characters 256 and above are always included, only the
4944 characters up to 255 are specified with this option. When a character
4945 is printable but it is not available in the current font, a
4946 replacement character will be shown.
4947 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4948 There is no option to specify these characters.
4949
4950 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4951'joinspaces' 'js' boolean (default on)
4952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 Insert two spaces after a '.', '?' and '!' with a join command.
4954 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4955 Otherwise only one space is inserted.
4956 NOTE: This option is set when 'compatible' is set.
4957
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004958 *'jumpoptions'* *'jop'*
4959'jumpoptions' 'jop' string (default "")
4960 global
4961 List of words that change the behavior of the |jumplist|.
4962 stack Make the jumplist behave like the tagstack.
4963 Relative location of entries in the jumplist is
4964 preserved at the cost of discarding subsequent entries
4965 when navigating backwards in the jumplist and then
4966 jumping to a location. |jumplist-stack|
4967
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 *'key'*
4969'key' string (default "")
4970 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004971 {only available when compiled with the |+cryptv|
4972 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004974 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 Careful: Do not set the key value by hand, someone might see the typed
4976 key. Use the |:X| command. But you can make 'key' empty: >
4977 :set key=
4978< It is not possible to get the value of this option with ":set key" or
4979 "echo &key". This is to avoid showing it to someone who shouldn't
4980 know. It also means you cannot see it yourself once you have set it,
4981 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004982 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4983 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004984 You can use "&key" in an expression to detect whether encryption is
4985 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986
4987 *'keymap'* *'kmp'* *E544*
4988'keymap' 'kmp' string (default "")
4989 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 {only available when compiled with the |+keymap|
4991 feature}
4992 Name of a keyboard mapping. See |mbyte-keymap|.
4993 Setting this option to a valid keymap name has the side effect of
4994 setting 'iminsert' to one, so that the keymap becomes effective.
4995 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02004996 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997
4998 *'keymodel'* *'km'*
4999'keymodel' 'km' string (default "")
5000 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005001 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 can do. These values can be used:
5003 startsel Using a shifted special key starts selection (either
5004 Select mode or Visual mode, depending on "key" being
5005 present in 'selectmode').
5006 stopsel Using a not-shifted special key stops selection.
5007 Special keys in this context are the cursor keys, <End>, <Home>,
5008 <PageUp> and <PageDown>.
5009 The 'keymodel' option is set by the |:behave| command.
5010
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005011 *'keyprotocol'* *'kpc'*
5012'keyprotocol' 'kpc' string (default: see below)
5013 global
5014 Specifies what keyboard protocol to use depending on the value of
5015 'term'. The supported keyboard protocols names are:
5016 none whatever the terminal uses
5017 mok2 modifyOtherKeys level 2, as supported by xterm
5018 kitty Kitty keyboard protocol, as supported by Kitty
5019
Bram Moolenaara87749e2022-11-30 10:23:17 +00005020 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005021 a pattern that is matched against the 'term' option, a colon and the
5022 protocol name to be used. To illustrate this, the default value would
5023 be set with: >
5024 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5025
5026< This means that when 'term' contains "kitty, "foot" or "wezterm"
5027 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005028 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005029
5030 The first match is used, thus if you want to have "kitty" use the
5031 kitty protocol, but "badkitty" not, then you should match "badkitty"
5032 first and use the "none" value: >
5033 set keyprotocol=badkitty:none,kitty:kitty
5034<
5035 The option is used after 'term' has been changed. First the termcap
5036 entries are set, possibly using the builtin list, see |builtin-terms|.
5037 Then this option is inspected and if there is a match and a protocol
5038 is specified the following happens:
5039 none Nothing, the regular t_TE and t_TI values remain
5040
5041 mok2 The t_TE value is changed to:
5042 CSI >4;m disables modifyOtherKeys
5043 The t_TI value is changed to:
5044 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005045 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005046
5047 kitty The t_TE value is changed to:
5048 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005049 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005050 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005051 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005052 CSI ?u request kitty keyboard protocol state
5053 CSI >c request the termresponse
5054
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005055 If you notice problems, such as characters being displayed that
5056 disappear after `CTRL-L`, you might want to try making this option
5057 empty. Then set the 'term' option to have it take effect: >
5058 set keyprotocol=
5059 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005060<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005061
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 *'keywordprg'* *'kp'*
5063'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005064 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 Program to use for the |K| command. Environment variables are
5067 expanded |:set_env|. ":help" may be used to access the Vim internal
5068 help. (Note that previously setting the global option to the empty
5069 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005070 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005071 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005072 When "man", "man -s" or an Ex command is used, Vim will automatically
5073 translate a count for the "K" command and pass it as the first
5074 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 See |option-backslash| about including spaces and backslashes.
5076 Example: >
5077 :set keywordprg=man\ -s
5078< This option cannot be set from a |modeline| or in the |sandbox|, for
5079 security reasons.
5080
5081 *'langmap'* *'lmap'* *E357* *E358*
5082'langmap' 'lmap' string (default "")
5083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 {only available when compiled with the |+langmap|
5085 feature}
5086 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005087 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005088 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 care of translating these special characters to the original meaning
5090 of the key. This means you don't have to change the keyboard mode to
5091 be able to execute Normal mode commands.
5092 This is the opposite of the 'keymap' option, where characters are
5093 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005094 Also consider setting 'langremap' to off, to prevent 'langmap' from
5095 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005096 This option cannot be set from a |modeline| or in the |sandbox|, for
5097 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005099 Example (for Greek, in UTF-8): *greek* >
5100 :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 +00005101< Example (exchanges meaning of z and y for commands): >
5102 :set langmap=zy,yz,ZY,YZ
5103<
5104 The 'langmap' option is a list of parts, separated with commas. Each
5105 part can be in one of two forms:
5106 1. A list of pairs. Each pair is a "from" character immediately
5107 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005108 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 characters. Example: "abc;ABC"
5110 Example: "aA,fgh;FGH,cCdDeE"
5111 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005112 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113
5114 This will allow you to activate vim actions without having to switch
5115 back and forth between the languages. Your language characters will
5116 be understood as normal vim English characters (according to the
5117 langmap mappings) in the following cases:
5118 o Normal/Visual mode (commands, buffer/register names, user mappings)
5119 o Insert/Replace Mode: Register names after CTRL-R
5120 o Insert/Replace Mode: Mappings
5121 Characters entered in Command-line mode will NOT be affected by
5122 this option. Note that this option can be changed at any time
5123 allowing to switch between mappings for different languages/encodings.
5124 Use a mapping to avoid having to type it each time!
5125
5126 *'langmenu'* *'lm'*
5127'langmenu' 'lm' string (default "")
5128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 {only available when compiled with the |+menu| and
5130 |+multi_lang| features}
5131 Language to use for menu translation. Tells which file is loaded
5132 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005133 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134< (without the spaces). For example, to always use the Dutch menus, no
5135 matter what $LANG is set to: >
5136 :set langmenu=nl_NL.ISO_8859-1
5137< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005138 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 If your $LANG is set to a non-English language but you do want to use
5140 the English menus: >
5141 :set langmenu=none
5142< This option must be set before loading menus, switching on filetype
5143 detection or syntax highlighting. Once the menus are defined setting
5144 this option has no effect. But you could do this: >
5145 :source $VIMRUNTIME/delmenu.vim
5146 :set langmenu=de_DE.ISO_8859-1
5147 :source $VIMRUNTIME/menu.vim
5148< Warning: This deletes all menus that you defined yourself!
5149
Bram Moolenaard94464e2015-11-02 15:28:18 +01005150 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005151'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005152 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005153 {only available when compiled with the |+langmap|
5154 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005155 This is just like 'langremap' but with the value inverted. It only
5156 exists for backwards compatibility. When setting 'langremap' then
5157 'langnoremap' is set to the inverted value, and the other way around.
5158
5159 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005160'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005161 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005162 {only available when compiled with the |+langmap|
5163 feature}
5164 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005165 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005166 'langmap' disables some of your mappings, try resetting this option.
5167 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005168 that works for you to avoid mappings to break.
5169
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 *'laststatus'* *'ls'*
5171'laststatus' 'ls' number (default 1)
5172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 The value of this option influences when the last window will have a
5174 status line:
5175 0: never
5176 1: only if there are at least two windows
5177 2: always
5178 The screen looks nicer with a status line if you have several
5179 windows, but it takes another screen line. |status-line|
5180
5181 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5182'lazyredraw' 'lz' boolean (default off)
5183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 When this option is set, the screen will not be redrawn while
5185 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005186 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005188 This may occasionally cause display errors. It is only meant to be set
5189 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005190 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191
5192 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5193'linebreak' 'lbr' boolean (default off)
5194 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005195 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005197 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 than at the last character that fits on the screen. Unlike
5199 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005200 it only affects the way the file is displayed, not its contents.
5201 If 'breakindent' is set, line is visually indented. Then, the value
5202 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005203 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 Note that <Tab> characters after an <EOL> are mostly not displayed
5205 with the right amount of white space.
5206
5207 *'lines'* *E593*
5208'lines' number (default 24 or terminal height)
5209 global
5210 Number of lines of the Vim window.
5211 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005212 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 When Vim is running in the GUI or in a resizable window, setting this
5214 option will cause the window size to be changed. When you only want
5215 to use the size for the GUI, put the command in your |gvimrc| file.
5216 Vim limits the number of lines to what fits on the screen. You can
5217 use this command to get the tallest window possible: >
5218 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005219< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005220 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 When you set this option and Vim is unable to change the physical
5222 number of lines of the display, the display may be messed up.
5223
5224 *'linespace'* *'lsp'*
5225'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 {only in the GUI}
5228 Number of pixel lines inserted between characters. Useful if the font
5229 uses the full character cell height, making lines touch each other.
5230 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005231 With some fonts there can be too much room between lines (to have
5232 space for ascents and descents). Then it makes sense to set
5233 'linespace' to a negative value. This may cause display problems
5234 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235
5236 *'lisp'* *'nolisp'*
5237'lisp' boolean (default off)
5238 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 Lisp mode: When <Enter> is typed in insert mode set the indent for
5240 the next line to Lisp standards (well, sort of). Also happens with
5241 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5242 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5243 better. Also see 'lispwords'.
5244 The '-' character is included in keyword characters. Redefines the
5245 "=" operator to use this same indentation algorithm rather than
5246 calling an external program if 'equalprg' is empty.
5247 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005249 *'lispoptions'* *'lop'*
5250'lispoptions' 'lop' string (default "")
5251 local to buffer
5252 Comma-separated list of items that influence the Lisp indenting when
5253 enabled with the |'lisp'| option. Currently only one item is
5254 supported:
5255 expr:1 use 'indentexpr' for Lisp indenting when it is set
5256 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5257 Note that when using 'indentexpr' the `=` operator indents all the
5258 lines, otherwise the first line is not indented (Vi-compatible).
5259
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 *'lispwords'* *'lw'*
5261'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005262 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005263 Comma-separated list of words that influence the Lisp indenting when
5264 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265
5266 *'list'* *'nolist'*
5267'list' boolean (default off)
5268 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005269 List mode: By default show tabs as CTRL-I is displayed, display $
5270 after end of line. Useful to see the difference between tabs and
5271 spaces and for trailing blanks. Further changed by the 'listchars'
5272 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005273
5274 The cursor is displayed at the start of the space a Tab character
5275 occupies, not at the end as usual in Normal mode. To get this cursor
5276 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005277 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005278<
5279 Note that list mode will also affect formatting (set with 'textwidth'
5280 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 changing the way tabs are displayed.
5282
5283 *'listchars'* *'lcs'*
5284'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005285 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005286 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005287 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005288 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 eol:c Character to show at the end of each line. When
5290 omitted, there is no extra character at the end of the
5291 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005292 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005293 tab:xy[z] Two or three characters to be used to show a tab.
5294 The third character is optional.
5295
5296 tab:xy The 'x' is always used, then 'y' as many times as will
5297 fit. Thus "tab:>-" displays:
5298 >
5299 >-
5300 >--
5301 etc.
5302
5303 tab:xyz The 'z' is always used, then 'x' is prepended, and
5304 then 'y' is used as many times as will fit. Thus
5305 "tab:<->" displays:
5306 >
5307 <>
5308 <->
5309 <-->
5310 etc.
5311
5312 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005313 *lcs-space*
5314 space:c Character to show for a space. When omitted, spaces
5315 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005316 *lcs-multispace*
5317 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005318 One or more characters to use cyclically to show for
5319 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005320 setting, except for single spaces. When omitted, the
5321 "space" setting is used. For example,
5322 `:set listchars=multispace:---+` shows ten consecutive
5323 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005324 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005325 *lcs-lead*
5326 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005327 leading spaces are blank. Overrides the "space" and
5328 "multispace" settings for leading spaces. You can
5329 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005330 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005331< *lcs-leadmultispace*
5332 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005333 Like the |lcs-multispace| value, but for leading
5334 spaces only. Also overrides |lcs-lead| for leading
5335 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005336 `:set listchars=leadmultispace:---+` shows ten
5337 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005338 ---+---+--XXX ~
5339 Where "XXX" denotes the first non-blank characters in
5340 the line.
5341 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005342 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005343 trailing spaces are blank. Overrides the "space" and
5344 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005345 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 extends:c Character to show in the last column, when 'wrap' is
5347 off and the line continues beyond the right of the
5348 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005349 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005350 precedes:c Character to show in the first visible column of the
5351 physical line, when there is text preceding the
5352 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005353 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005354 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005355 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005356 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005357 nbsp:c Character to show for a non-breakable space character
5358 (0xA0 (160 decimal) and U+202F). Left blank when
5359 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005361 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005363 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005365 Each character can be specified as hex: >
5366 set listchars=eol:\\x24
5367 set listchars=eol:\\u21b5
5368 set listchars=eol:\\U000021b5
5369< Note that a double backslash is used. The number of hex characters
5370 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5371
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 Examples: >
5373 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005374 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 :set lcs=extends:>,precedes:<
5376< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005377 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5378 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005379 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380
5381 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5382'loadplugins' 'lpl' boolean (default on)
5383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 When on the plugin scripts are loaded when starting up |load-plugins|.
5385 This option can be reset in your |vimrc| file to disable the loading
5386 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005387 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5388 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
Bram Moolenaard94464e2015-11-02 15:28:18 +01005390 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005391'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005392 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005393 {only available when compiled with the |+lua/dyn|
5394 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005395 Specifies the name of the Lua shared library. The default is
5396 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005397 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005398 This option cannot be set from a |modeline| or in the |sandbox|, for
5399 security reasons.
5400
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005401 *'macatsui'* *'nomacatsui'*
5402'macatsui' boolean (default on)
5403 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005404 {not supported}
5405 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005406
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 *'magic'* *'nomagic'*
5408'magic' boolean (default on)
5409 global
5410 Changes the special characters that can be used in search patterns.
5411 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005412 WARNING: Switching this option off most likely breaks plugins! That
5413 is because many patterns assume it's on and will fail when it's off.
5414 Only switch it off when working with old Vi scripts. In any other
5415 situation write patterns that work when 'magic' is on. Include "\M"
5416 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005417 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5418 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419
5420 *'makeef'* *'mef'*
5421'makeef' 'mef' string (default: "")
5422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 {not available when compiled without the |+quickfix|
5424 feature}
5425 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5426 and the |:grep| command.
5427 When it is empty, an internally generated temp file will be used.
5428 When "##" is included, it is replaced by a number to make the name
5429 unique. This makes sure that the ":make" command doesn't overwrite an
5430 existing file.
5431 NOT used for the ":cf" command. See 'errorfile' for that.
5432 Environment variables are expanded |:set_env|.
5433 See |option-backslash| about including spaces and backslashes.
5434 This option cannot be set from a |modeline| or in the |sandbox|, for
5435 security reasons.
5436
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005437 *'makeencoding'* *'menc'*
5438'makeencoding' 'menc' string (default "")
5439 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005440 Encoding used for reading the output of external commands. When empty,
5441 encoding is not converted.
5442 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5443 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5444 and `:laddfile`.
5445
5446 This would be mostly useful when you use MS-Windows and set 'encoding'
5447 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5448 'makeencoding' to "char" has the same effect as setting to the system
5449 locale encoding. Example: >
5450 :set encoding=utf-8
5451 :set makeencoding=char " system locale is used
5452<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 *'makeprg'* *'mp'*
5454'makeprg' 'mp' string (default "make", VMS: "MMS")
5455 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005456 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005457 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5458 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005459 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005460 Environment variables are expanded |:set_env|. See |option-backslash|
5461 about including spaces and backslashes.
5462 Note that a '|' must be escaped twice: once for ":set" and once for
5463 the interpretation of a command. When you use a filter called
5464 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 :set makeprg=gmake\ \\\|\ myfilter
5466< The placeholder "$*" can be given (even multiple times) to specify
5467 where the arguments will be included, for example: >
5468 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5469< This option cannot be set from a |modeline| or in the |sandbox|, for
5470 security reasons.
5471
5472 *'matchpairs'* *'mps'*
5473'matchpairs' 'mps' string (default "(:),{:},[:]")
5474 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005476 other.
5477 Only character pairs are allowed that are different, thus you cannot
5478 jump between two double quotes.
5479 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005480 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005481 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 :set mps+=<:>
5483
5484< A more exotic example, to jump between the '=' and ';' in an
5485 assignment, useful for languages like C and Java: >
5486 :au FileType c,cpp,java set mps+==:;
5487
5488< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005489 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490
5491 *'matchtime'* *'mat'*
5492'matchtime' 'mat' number (default 5)
5493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 Tenths of a second to show the matching paren, when 'showmatch' is
5495 set. Note that this is not in milliseconds, like other options that
5496 set a time. This is to be compatible with Nvi.
5497
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005498 *'maxcombine'* *'mco'*
5499'maxcombine' 'mco' number (default 2)
5500 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005501 The maximum number of combining characters supported for displaying.
5502 Only used when 'encoding' is "utf-8".
5503 The default is OK for most languages. Hebrew may require 4.
5504 Maximum value is 6.
5505 Even when this option is set to 2 you can still edit text with more
5506 combining characters, you just can't see them. Use |g8| or |ga|.
5507 See |mbyte-combining|.
5508
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 *'maxfuncdepth'* *'mfd'*
5510'maxfuncdepth' 'mfd' number (default 100)
5511 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005512 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005513 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 Maximum depth of function calls for user functions. This normally
5515 catches endless recursion. When using a recursive function with
5516 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5517 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005518 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005519 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005521 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522
5523 *'maxmapdepth'* *'mmd'* *E223*
5524'maxmapdepth' 'mmd' number (default 1000)
5525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 Maximum number of times a mapping is done without resulting in a
5527 character to be used. This normally catches endless mappings, like
5528 ":map x y" with ":map y x". It still does not catch ":map g wg",
5529 because the 'w' is used before the next mapping is done. See also
5530 |key-mapping|.
5531
5532 *'maxmem'* *'mm'*
5533'maxmem' 'mm' number (default between 256 to 5120 (system
5534 dependent) or half the amount of memory
5535 available)
5536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5538 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005539 other memory to be freed.
5540 The maximum usable value is about 2000000. Use this to work without a
5541 limit.
5542 The value is ignored when 'swapfile' is off.
5543 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005545 *'maxmempattern'* *'mmp'*
5546'maxmempattern' 'mmp' number (default 1000)
5547 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005548 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005549 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005550 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005551 When Vim runs into the limit it gives an error message and mostly
5552 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005553 Running into the limit often means that the pattern is very
5554 inefficient or too complex. This may already happen with the pattern
5555 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005556 Might also happen on redraw, when syntax rules try to match a complex
5557 text structure.
5558 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5559 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005560
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 *'maxmemtot'* *'mmt'*
5562'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5563 dependent) or half the amount of memory
5564 available)
5565 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005566 Maximum amount of memory in Kbyte to use for all buffers together.
5567 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005568 without a limit.
5569 On 64 bit machines higher values might work. But hey, do you really
5570 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005571 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005572 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005573 Buffers with 'swapfile' off still count to the total amount of memory
5574 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005575 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576
5577 *'menuitems'* *'mis'*
5578'menuitems' 'mis' number (default 25)
5579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 {not available when compiled without the |+menu|
5581 feature}
5582 Maximum number of items to use in a menu. Used for menus that are
5583 generated from a list of items, e.g., the Buffers menu. Changing this
5584 option has no direct effect, the menu must be refreshed first.
5585
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005586 *'mkspellmem'* *'msm'*
5587'mkspellmem' 'msm' string (default "460000,2000,500")
5588 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005589 {not available when compiled without the |+syntax|
5590 feature}
5591 Parameters for |:mkspell|. This tunes when to start compressing the
5592 word tree. Compression can be slow when there are many words, but
5593 it's needed to avoid running out of memory. The amount of memory used
5594 per word depends very much on how similar the words are, that's why
5595 this tuning is complicated.
5596
5597 There are three numbers, separated by commas:
5598 {start},{inc},{added}
5599
5600 For most languages the uncompressed word tree fits in memory. {start}
5601 gives the amount of memory in Kbyte that can be used before any
5602 compression is done. It should be a bit smaller than the amount of
5603 memory that is available to Vim.
5604
5605 When going over the {start} limit the {inc} number specifies the
5606 amount of memory in Kbyte that can be allocated before another
5607 compression is done. A low number means compression is done after
5608 less words are added, which is slow. A high number means more memory
5609 will be allocated.
5610
5611 After doing compression, {added} times 1024 words can be added before
5612 the {inc} limit is ignored and compression is done when any extra
5613 amount of memory is needed. A low number means there is a smaller
5614 chance of hitting the {inc} limit, less memory is used but it's
5615 slower.
5616
5617 The languages for which these numbers are important are Italian and
5618 Hungarian. The default works for when you have about 512 Mbyte. If
5619 you have 1 Gbyte you could use: >
5620 :set mkspellmem=900000,3000,800
5621< If you have less than 512 Mbyte |:mkspell| may fail for some
5622 languages, no matter what you set 'mkspellmem' to.
5623
dkearns8ebdbc92023-10-29 06:26:19 +11005624 This option cannot be set from a |modeline| or in the |sandbox|, for
5625 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005626
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005628'modeline' 'ml' boolean (Vim default: on (off for root),
5629 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005631 If 'modeline' is on 'modelines' gives the number of lines that is
5632 checked for set commands. If 'modeline' is off or 'modelines' is zero
5633 no lines are checked. See |modeline|.
5634
5635 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5636'modelineexpr' 'mle' boolean (default: off)
5637 global
5638 When on allow some options that are an expression to be set in the
5639 modeline. Check the option for whether it is affected by
5640 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005641 This option cannot be set from a |modeline| or in the |sandbox|, for
5642 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005643
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 *'modelines'* *'mls'*
5645'modelines' 'mls' number (default 5)
5646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 If 'modeline' is on 'modelines' gives the number of lines that is
5648 checked for set commands. If 'modeline' is off or 'modelines' is zero
5649 no lines are checked. See |modeline|.
5650 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5651 set and to the Vim default value when 'compatible' is reset.
5652
5653 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005654 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655'modifiable' 'ma' boolean (default on)
5656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 When off the buffer contents cannot be changed. The 'fileformat' and
5658 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005659 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660
5661 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5662'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005663 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 When on, the buffer is considered to be modified. This option is set
5665 when:
5666 1. A change was made to the text since it was last written. Using the
5667 |undo| command to go back to the original text will reset the
5668 option. But undoing changes that were made before writing the
5669 buffer will set the option again, since the text is different from
5670 when it was written.
5671 2. 'fileformat' or 'fileencoding' is different from its original
5672 value. The original value is set when the buffer is read or
5673 written. A ":set nomodified" command also resets the original
5674 values to the current values and the 'modified' option will be
5675 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005676 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005677 This option is not set when a change is made to the buffer as the
5678 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5679 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5680 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5682 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005683 Note that the text may actually be the same, e.g. 'modified' is set
5684 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685
5686 *'more'* *'nomore'*
5687'more' boolean (Vim default: on, Vi default: off)
5688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When on, listings pause when the whole screen is filled. You will get
5690 the |more-prompt|. When this option is off there are no pauses, the
5691 listing continues until finished.
5692 NOTE: This option is set to the Vi default value when 'compatible' is
5693 set and to the Vim default value when 'compatible' is reset.
5694
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005695 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005696'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005697 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005699 Enable the use of the mouse. Works for most terminals (xterm, Win32
5700 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5701 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5702 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005703 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 v Visual mode
5705 i Insert mode
5706 c Command-line mode
5707 h all previous modes when editing a help file
5708 a all previous modes
5709 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005710 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005712< If your terminal can't overrule the mouse events going to the
5713 application, use: >
5714 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005715< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005716 back to Vim using the mouse events.
5717 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5718 "xterm".
5719
5720 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 modeless selection. This doesn't move the text cursor.
5722
5723 See |mouse-using|. Also see |'clipboard'|.
5724
5725 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005726 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 the mouse buttons can still be used by keeping the shift key pressed.
5728 Also see the 'clipboard' option.
5729
5730 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5731'mousefocus' 'mousef' boolean (default off)
5732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 {only works in the GUI}
5734 The window that the mouse pointer is on is automatically activated.
5735 When changing the window layout or window focus in another way, the
5736 mouse pointer is moved to the window with keyboard focus. Off is the
5737 default because it makes using the pull down menus a little goofy, as
5738 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005739 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005740 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741
5742 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5743'mousehide' 'mh' boolean (default on)
5744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 {only works in the GUI}
5746 When on, the mouse pointer is hidden when characters are typed.
5747 The mouse pointer is restored when the mouse is moved.
5748
5749 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005750'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 Sets the model to use for the mouse. The name mostly specifies what
5753 the right mouse button is used for:
5754 extend Right mouse button extends a selection. This works
5755 like in an xterm.
5756 popup Right mouse button pops up a menu. The shifted left
5757 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005758 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 popup_setpos Like "popup", but the cursor will be moved to the
5760 position where the mouse was clicked, and thus the
5761 selected operation will act upon the clicked object.
5762 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005763 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 course, that right clicking outside a selection will
5765 end Visual mode.
5766 Overview of what button does what for each model:
5767 mouse extend popup(_setpos) ~
5768 left click place cursor place cursor
5769 left drag start selection start selection
5770 shift-left search word extend selection
5771 right click extend selection popup menu (place cursor)
5772 right drag extend selection -
5773 middle click paste paste
5774
5775 In the "popup" model the right mouse button produces a pop-up menu.
5776 You need to define this first, see |popup-menu|.
5777
5778 Note that you can further refine the meaning of buttons with mappings.
5779 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5780 selection (because that's handled in the GUI code directly).
5781
5782 The 'mousemodel' option is set by the |:behave| command.
5783
h_east59858792023-10-25 22:47:05 +09005784 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005785'mousemoveevent' 'mousemev' boolean (default off)
5786 global
5787 {only works in the GUI}
5788 When on, mouse move events are delivered to the input queue and are
5789 available for mapping. The default, off, avoids the mouse movement
5790 overhead except when needed. See |gui-mouse-mapping|.
5791 Warning: Setting this option can make pending mappings to be aborted
5792 when the mouse is moved.
5793 Currently only works in the GUI, may be made to work in a terminal
5794 later.
5795
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005797'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5798 vs:leftright,vd:lrsizing,m:no,
5799 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 {only available when compiled with the |+mouseshape|
5802 feature}
5803 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005804 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 like used for 'guicursor'. Each part consist of a mode/location-list
5806 and an argument-list:
5807 mode-list:shape,mode-list:shape,..
5808 The mode-list is a dash separated list of these modes/locations:
5809 In a normal window: ~
5810 n Normal mode
5811 v Visual mode
5812 ve Visual mode with 'selection' "exclusive" (same as 'v',
5813 if not specified)
5814 o Operator-pending mode
5815 i Insert mode
5816 r Replace mode
5817
5818 Others: ~
5819 c appending to the command-line
5820 ci inserting in the command-line
5821 cr replacing in the command-line
5822 m at the 'Hit ENTER' or 'More' prompts
5823 ml idem, but cursor in the last line
5824 e any mode, pointer below last window
5825 s any mode, pointer on a status line
5826 sd any mode, while dragging a status line
5827 vs any mode, pointer on a vertical separator line
5828 vd any mode, while dragging a vertical separator line
5829 a everywhere
5830
5831 The shape is one of the following:
5832 avail name looks like ~
5833 w x arrow Normal mouse pointer
5834 w x blank no pointer at all (use with care!)
5835 w x beam I-beam
5836 w x updown up-down sizing arrows
5837 w x leftright left-right sizing arrows
5838 w x busy The system's usual busy pointer
5839 w x no The system's usual 'no input' pointer
5840 x udsizing indicates up-down resizing
5841 x lrsizing indicates left-right resizing
5842 x crosshair like a big thin +
5843 x hand1 black hand
5844 x hand2 white hand
5845 x pencil what you write with
5846 x question big ?
5847 x rightup-arrow arrow pointing right-up
5848 w x up-arrow arrow pointing up
5849 x <number> any X11 pointer number (see X11/cursorfont.h)
5850
5851 The "avail" column contains a 'w' if the shape is available for Win32,
5852 x for X11.
5853 Any modes not specified or shapes not available use the normal mouse
5854 pointer.
5855
5856 Example: >
5857 :set mouseshape=s:udsizing,m:no
5858< will make the mouse turn to a sizing arrow over the status lines and
5859 indicate no input when the hit-enter prompt is displayed (since
5860 clicking the mouse has no effect in this state.)
5861
5862 *'mousetime'* *'mouset'*
5863'mousetime' 'mouset' number (default 500)
5864 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005865 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 time in msec between two mouse clicks for the second click to be
5867 recognized as a multi click.
5868
laburnumT3f7855a2023-12-05 18:37:03 +01005869 *'mzquantum'* *'mzq'*
5870'mzquantum' 'mzq' number (default 100)
5871 global
5872 {not available when compiled without the |+mzscheme|
5873 feature}
5874 The number of milliseconds between polls for MzScheme threads.
5875 Negative or zero value means no thread scheduling.
5876 NOTE: This option is set to the Vim default value when 'compatible'
5877 is reset.
5878
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005879 *'mzschemedll'*
5880'mzschemedll' string (default depends on the build)
5881 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005882 {only available when compiled with the |+mzscheme/dyn|
5883 feature}
5884 Specifies the name of the MzScheme shared library. The default is
5885 DYNAMIC_MZSCH_DLL which was specified at compile time.
5886 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005887 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005888 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005889 This option cannot be set from a |modeline| or in the |sandbox|, for
5890 security reasons.
5891
5892 *'mzschemegcdll'*
5893'mzschemegcdll' string (default depends on the build)
5894 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005895 {only available when compiled with the |+mzscheme/dyn|
5896 feature}
5897 Specifies the name of the MzScheme GC shared library. The default is
5898 DYNAMIC_MZGC_DLL which was specified at compile time.
5899 The value can be equal to 'mzschemedll' if it includes the GC code.
5900 Environment variables are expanded |:set_env|.
5901 This option cannot be set from a |modeline| or in the |sandbox|, for
5902 security reasons.
5903
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005905'nrformats' 'nf' string (default "bin,octal,hex",
5906 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 This defines what bases Vim will consider for numbers when using the
5909 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5910 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005911 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005913 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005914 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005916 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 considered to be hexadecimal. Example: Using CTRL-X on
5918 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005919 bin If included, numbers starting with "0b" or "0B" will be
5920 considered to be binary. Example: Using CTRL-X on
5921 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005922 unsigned If included, numbers are recognized as unsigned. Thus a
5923 leading dash or negative sign won't be considered as part of
5924 the number. Examples:
5925 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5926 (without "unsigned" it would become "9-2021").
5927 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5928 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005929 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5930 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005931 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02005932 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02005933 dash immediately preceded by a non-whitespace character (i.e.,
5934 not a tab or a " "), the negative sign won't be considered as
5935 part of the number. For example:
5936 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5937 (without "blank" it would become "Carbon-13").
5938 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02005939 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02005940 set, it would result in "Carbon -7").
5941 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02005942 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02005943 included, "unsigned" will take precedence.
5944
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 Numbers which simply begin with a digit in the range 1-9 are always
5946 considered decimal. This also happens for numbers that are not
5947 recognized as octal or hex.
5948
5949 *'number'* *'nu'* *'nonumber'* *'nonu'*
5950'number' 'nu' boolean (default off)
5951 local to window
5952 Print the line number in front of each line. When the 'n' option is
5953 excluded from 'cpoptions' a wrapped line will not use the column of
5954 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005955 The 'numberwidth' option can be used to set the room used for the line
5956 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 When a long, wrapped line doesn't start with the first character, '-'
5958 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005959 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5960 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005961 *number_relativenumber*
5962 The 'relativenumber' option changes the displayed number to be
5963 relative to the cursor. Together with 'number' there are these
5964 four combinations (cursor in line 3):
5965
Bram Moolenaar3848e002016-03-19 18:42:29 +01005966 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005967 'nornu' 'nornu' 'rnu' 'rnu'
5968
5969 |apple | 1 apple | 2 apple | 2 apple
5970 |pear | 2 pear | 1 pear | 1 pear
5971 |nobody | 3 nobody | 0 nobody |3 nobody
5972 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005974 *'numberwidth'* *'nuw'*
5975'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5976 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005977 {only available when compiled with the |+linebreak|
5978 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005979 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005980 when the 'number' or 'relativenumber' option is set or printing lines
5981 with a line number. Since one space is always between the number and
5982 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005983 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005984 fit the highest line number in the buffer respectively the number of
5985 rows in the window, depending on whether 'number' or 'relativenumber'
5986 is set. Thus with the Vim default of 4 there is room for a line number
5987 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005988 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005989 NOTE: This option is set to the Vi default value when 'compatible' is
5990 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005991
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005992 *'omnifunc'* *'ofu'*
5993'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005994 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005995 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005996 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005997 This option specifies a function to be used for Insert mode omni
5998 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005999 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006000 invoked and what it should return. The value can be the name of a
6001 function, a |lambda| or a |Funcref|. See |option-value-function| for
6002 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006003 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006004 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006005 This option cannot be set from a |modeline| or in the |sandbox|, for
6006 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006007
Bram Moolenaar02467872007-05-06 13:22:01 +00006008 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006009'opendevice' 'odev' boolean (default off)
6010 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006011 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006012 Enable reading and writing from devices. This may get Vim stuck on a
6013 device that can be opened but doesn't actually do the I/O. Therefore
6014 it is off by default.
6015 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6016 result in editing a device.
6017
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006018 *'operatorfunc'* *'opfunc'*
6019'operatorfunc' 'opfunc' string (default: empty)
6020 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006021 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006022 See |:map-operator| for more info and an example. The value can be
6023 the name of a function, a |lambda| or a |Funcref|. See
6024 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006025
6026 This option cannot be set from a |modeline| or in the |sandbox|, for
6027 security reasons.
6028
Bram Moolenaar251e1912011-06-19 05:09:16 +02006029 *'osfiletype'* *'oft'*
6030'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006032 This option was supported on RISC OS, which has been removed.
6033
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006034 *'packpath'* *'pp'*
6035'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006036 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006037 This option cannot be set from a |modeline| or in the |sandbox|, for
6038 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006039
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006041'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 global
6043 Specifies the nroff macros that separate paragraphs. These are pairs
6044 of two letters (see |object-motions|).
6045
6046 *'paste'* *'nopaste'*
6047'paste' boolean (default off)
6048 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006049 Put Vim in Paste mode. This is useful if you want to cut or copy
6050 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 unexpected effects.
6052 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006053 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 knows about pasting and will mostly do the right thing without 'paste'
6055 being set. The same is true for a terminal where Vim handles the
6056 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006057 This option is reset when starting the GUI. Thus if you set it in
6058 your .vimrc it will work in a terminal, but not in the GUI. Setting
6059 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6060 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 When the 'paste' option is switched on (also when it was already on):
6062 - mapping in Insert mode and Command-line mode is disabled
6063 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006065 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006066 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 - 'revins' is reset
6068 - 'ruler' is reset
6069 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006070 - 'smarttab' is reset
6071 - 'softtabstop' is set to 0
6072 - 'textwidth' is set to 0
6073 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006074 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006077 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006078 - 'indentexpr'
6079 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006080 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 NOTE: When you start editing another file while the 'paste' option is
6082 on, settings from the modelines or autocommands may change the
6083 settings again, causing trouble when pasting text. You might want to
6084 set the 'paste' option again.
6085 When the 'paste' option is reset the mentioned options are restored to
6086 the value before the moment 'paste' was switched from off to on.
6087 Resetting 'paste' before ever setting it does not have any effect.
6088 Since mapping doesn't work while 'paste' is active, you need to use
6089 the 'pastetoggle' option to toggle the 'paste' option with some key.
6090
6091 *'pastetoggle'* *'pt'*
6092'pastetoggle' 'pt' string (default "")
6093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 When non-empty, specifies the key sequence that toggles the 'paste'
6095 option. This is like specifying a mapping: >
6096 :map {keys} :set invpaste<CR>
6097< Where {keys} is the value of 'pastetoggle'.
6098 The difference is that it will work even when 'paste' is set.
6099 'pastetoggle' works in Insert mode and Normal mode, but not in
6100 Command-line mode.
6101 Mappings are checked first, thus overrule 'pastetoggle'. However,
6102 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6103 this: >
6104 :map <F10> :set paste<CR>
6105 :map <F11> :set nopaste<CR>
6106 :imap <F10> <C-O>:set paste<CR>
6107 :imap <F11> <nop>
6108 :set pastetoggle=<F11>
6109< This will make <F10> start paste mode and <F11> stop paste mode.
6110 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6111 mode everything is inserted literally, except the 'pastetoggle' key
6112 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006113 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114
6115 *'pex'* *'patchexpr'*
6116'patchexpr' 'pex' string (default "")
6117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 {not available when compiled without the |+diff|
6119 feature}
6120 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006121 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006122 This option cannot be set from a |modeline| or in the |sandbox|, for
6123 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124
Bram Moolenaardbc28022014-07-26 13:40:44 +02006125 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126'patchmode' 'pm' string (default "")
6127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 When non-empty the oldest version of a file is kept. This can be used
6129 to keep the original version of a file if you are changing files in a
6130 source distribution. Only the first time that a file is written a
6131 copy of the original file will be kept. The name of the copy is the
6132 name of the original file with the string in the 'patchmode' option
6133 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006134 ".orig" or ".org". 'backupdir' must not be empty for this to work
6135 (Detail: The backup file is renamed to the patchmode file after the
6136 new file has been successfully written, that's why it must be possible
6137 to write a backup file). If there was no file to be backed up, an
6138 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 When the 'backupskip' pattern matches, a patchmode file is not made.
6140 Using 'patchmode' for compressed files appends the extension at the
6141 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6142 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006143 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006145 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 other systems: ".,,")
6148 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006150 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6151 provided that the file being searched for has a relative path (not
6152 starting with "/", "./" or "../"). The directories in the 'path'
6153 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 - Use commas to separate directory names: >
6155 :set path=.,/usr/local/include,/usr/include
6156< - Spaces can also be used to separate directory names (for backwards
6157 compatibility with version 3.0). To have a space in a directory
6158 name, precede it with an extra backslash, and escape the space: >
6159 :set path=.,/dir/with\\\ space
6160< - To include a comma in a directory name precede it with an extra
6161 backslash: >
6162 :set path=.,/dir/with\\,comma
6163< - To search relative to the directory of the current file, use: >
6164 :set path=.
6165< - To search in the current directory use an empty string between two
6166 commas: >
6167 :set path=,,
6168< - A directory name may end in a ':' or '/'.
6169 - Environment variables are expanded |:set_env|.
6170 - When using |netrw.vim| URLs can be used. For example, adding
6171 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006172 - Search upwards and downwards in a directory tree using "*", "**" and
6173 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 - Careful with '\' characters, type two to get one in the option: >
6175 :set path=.,c:\\include
6176< Or just use '/' instead: >
6177 :set path=.,c:/include
6178< Don't forget "." or files won't even be found in the same directory as
6179 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 it is something like 256 or 1024 characters.
6182 You can check if all the include files are found, using the value of
6183 'path', see |:checkpath|.
6184 The use of |:set+=| and |:set-=| is preferred when adding or removing
6185 directories from the list. This avoids problems when a future version
6186 uses another default. To remove the current directory use: >
6187 :set path-=
6188< To add the current directory use: >
6189 :set path+=
6190< To use an environment variable, you probably need to replace the
6191 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006192 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006193 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194< Replace the ';' with a ':' or whatever separator is used. Note that
6195 this doesn't work when $INCL contains a comma or white space.
6196
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006197 *'perldll'*
6198'perldll' string (default depends on the build)
6199 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006200 {only available when compiled with the |+perl/dyn|
6201 feature}
6202 Specifies the name of the Perl shared library. The default is
6203 DYNAMIC_PERL_DLL, which was specified at compile time.
6204 Environment variables are expanded |:set_env|.
6205 This option cannot be set from a |modeline| or in the |sandbox|, for
6206 security reasons.
6207
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6209'preserveindent' 'pi' boolean (default off)
6210 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 When changing the indent of the current line, preserve as much of the
6212 indent structure as possible. Normally the indent is replaced by a
6213 series of tabs followed by spaces as required (unless |'expandtab'| is
6214 enabled, in which case only spaces are used). Enabling this option
6215 means the indent will preserve as many existing characters as possible
6216 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006217 'expandtab' does not apply to the preserved white space, a Tab remains
6218 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 NOTE: When using ">>" multiple times the resulting indent is a mix of
6220 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006221 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 Also see 'copyindent'.
6223 Use |:retab| to clean up white space.
6224
6225 *'previewheight'* *'pvh'*
6226'previewheight' 'pvh' number (default 12)
6227 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006228 {not available when compiled without the |+quickfix|
6229 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006231 commands. Used for |CTRL-W_}| when no count is given. Not used when
6232 'previewpopup' is set.
6233
6234 *'previewpopup'* *'pvp'*
6235'previewpopup' 'pvp' string (default empty)
6236 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006237 {not available when compiled without the |+textprop|
6238 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006239 When not empty a popup window is used for commands that would open a
6240 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006241 Not used for the insert completion info, add "popup" to
6242 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
6244 *'previewwindow'* *'nopreviewwindow'*
6245 *'pvw'* *'nopvw'* *E590*
6246'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006247 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006248 {not available when compiled without the |+quickfix|
6249 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006250 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 set. It's normally not set directly, but by using one of the commands
6252 |:ptag|, |:pedit|, etc.
6253
6254 *'printdevice'* *'pdev'*
6255'printdevice' 'pdev' string (default empty)
6256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 {only available when compiled with the |+printer|
6258 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006259 The name of the printer to be used for |:hardcopy|.
6260 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006261 This option cannot be set from a |modeline| or in the |sandbox|, for
6262 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263
Bram Moolenaar8299df92004-07-10 09:47:34 +00006264 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006265'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 {only available when compiled with the |+printer|
6268 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006269 Sets the character encoding used when printing.
6270 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271
6272 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006273'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 {only available when compiled with the |+printer|
6276 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006277 Expression used to print the PostScript produced with |:hardcopy|.
6278 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006279 This option cannot be set from a |modeline| or in the |sandbox|, for
6280 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281
Bram Moolenaar8299df92004-07-10 09:47:34 +00006282 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283'printfont' 'pfn' string (default "courier")
6284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 {only available when compiled with the |+printer|
6286 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006287 The name of the font that will be used for |:hardcopy|.
6288 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289
6290 *'printheader'* *'pheader'*
6291'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 {only available when compiled with the |+printer|
6294 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006295 The format of the header produced in |:hardcopy| output.
6296 See |pheader-option|.
6297
6298 *'printmbcharset'* *'pmbcs'*
6299'printmbcharset' 'pmbcs' string (default "")
6300 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006301 {only available when compiled with the |+printer|
6302 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006303 The CJK character set to be used for CJK output from |:hardcopy|.
6304 See |pmbcs-option|.
6305
6306 *'printmbfont'* *'pmbfn'*
6307'printmbfont' 'pmbfn' string (default "")
6308 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006309 {only available when compiled with the |+printer|
6310 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006311 List of font names to be used for CJK output from |:hardcopy|.
6312 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313
6314 *'printoptions'* *'popt'*
6315'printoptions' 'popt' string (default "")
6316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006318 List of items that control the format of the output of |:hardcopy|.
6319 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006321 *'prompt'* *'noprompt'*
6322'prompt' boolean (default on)
6323 global
6324 When on a ":" prompt is used in Ex mode.
6325
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006326 *'pumheight'* *'ph'*
6327'pumheight' 'ph' number (default 0)
6328 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006329 Determines the maximum number of items to show in the popup menu for
6330 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006331 |ins-completion-menu|.
6332
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006333 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006334'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006335 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006336 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006337 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006338
Bram Moolenaard94464e2015-11-02 15:28:18 +01006339 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006340'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006341 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006342 {only available when compiled with the |+python/dyn|
6343 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006344 Specifies the name of the Python 2.x shared library. The default is
6345 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006346 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006347 This option cannot be set from a |modeline| or in the |sandbox|, for
6348 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006349
Bram Moolenaar94073162018-01-31 21:49:05 +01006350 *'pythonhome'*
6351'pythonhome' string (default "")
6352 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006353 {only available when compiled with the |+python/dyn|
6354 feature}
6355 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6356 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6357 which was specified at compile time, will be used for the Python 2.x
6358 home directory.
6359 Environment variables are expanded |:set_env|.
6360 This option cannot be set from a |modeline| or in the |sandbox|, for
6361 security reasons.
6362
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006363 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006364'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006365 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006366 {only available when compiled with the |+python3/dyn|
6367 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006368 Specifies the name of the Python 3 shared library. The default is
6369 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006370 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006371 This option cannot be set from a |modeline| or in the |sandbox|, for
6372 security reasons.
6373
Bram Moolenaar94073162018-01-31 21:49:05 +01006374 *'pythonthreehome'*
6375'pythonthreehome' string (default "")
6376 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006377 {only available when compiled with the |+python3/dyn|
6378 feature}
6379 Specifies the name of the Python 3 home directory. When
6380 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6381 PYTHON3_HOME, which was specified at compile time, will be used for
6382 the Python 3 home directory.
6383 Environment variables are expanded |:set_env|.
6384 This option cannot be set from a |modeline| or in the |sandbox|, for
6385 security reasons.
6386
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006387 *'pyxversion'* *'pyx'*
6388'pyxversion' 'pyx' number (default depends on the build)
6389 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006390 {only available when compiled with the |+python| or
6391 the |+python3| feature}
6392 Specifies the python version used for pyx* functions and commands
6393 |python_x|. The default value is as follows:
6394
6395 Compiled with Default ~
6396 |+python| and |+python3| 0
6397 only |+python| 2
6398 only |+python3| 3
6399
6400 Available values are 0, 2 and 3.
6401 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6402 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6403 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6404 to 2 if Python 2 is available.
6405 See also: |has-pythonx|
6406
6407 If Vim is compiled with only |+python| or |+python3| setting
6408 'pyxversion' has no effect. The pyx* functions and commands are
6409 always the same as the compiled version.
6410
6411 This option cannot be set from a |modeline| or in the |sandbox|, for
6412 security reasons.
6413
Bram Moolenaar858ba062020-05-31 23:11:59 +02006414 *'quickfixtextfunc'* *'qftf'*
6415'quickfixtextfunc' 'qftf' string (default "")
6416 global
6417 {only available when compiled with the |+quickfix|
6418 feature}
6419 This option specifies a function to be used to get the text to display
6420 in the quickfix and location list windows. This can be used to
6421 customize the information displayed in the quickfix or location window
6422 for each entry in the corresponding quickfix or location list. See
6423 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006424 function and an example. The value can be the name of a function, a
6425 |lambda| or a |Funcref|. See |option-value-function| for more
6426 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006427
6428 This option cannot be set from a |modeline| or in the |sandbox|, for
6429 security reasons.
6430
Bram Moolenaar677ee682005-01-27 14:41:15 +00006431 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006432'quoteescape' 'qe' string (default "\")
6433 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006434 The characters that are used to escape quotes in a string. Used for
6435 objects like a', a" and a` |a'|.
6436 When one of the characters in this option is found inside a string,
6437 the following character will be skipped. The default value makes the
6438 text "foo\"bar\\" considered to be one string.
6439
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6441'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006442 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 If on, writes fail unless you use a '!'. Protects you from
6444 accidentally overwriting a file. Default on when Vim is started
6445 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006446 When using ":w!" the 'readonly' option is reset for the current
6447 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006448 When using the ":view" command the 'readonly' option is set for the
6449 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006450 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006452 *'redrawtime'* *'rdt'*
6453'redrawtime' 'rdt' number (default 2000)
6454 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006455 {only available when compiled with the |+reltime|
6456 feature}
6457 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006458 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006459 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006460 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006461 matches will be highlighted.
6462 For syntax highlighting the time applies per window. When over the
6463 limit syntax highlighting is disabled until |CTRL-L| is used.
6464 This is used to avoid that Vim hangs when using a very complicated
6465 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006466
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006467 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006468'regexpengine' 're' number (default 0)
6469 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006470 This selects the default regexp engine. |two-engines|
6471 The possible values are:
6472 0 automatic selection
6473 1 old engine
6474 2 NFA engine
6475 Note that when using the NFA engine and the pattern contains something
6476 that is not supported the pattern will not match. This is only useful
6477 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006478 Using automatic selection enables Vim to switch the engine, if the
6479 default engine becomes too costly. E.g., when the NFA engine uses too
6480 many states. This should prevent Vim from hanging on a combination of
6481 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006482
Bram Moolenaar64486672010-05-16 15:46:46 +02006483 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6484'relativenumber' 'rnu' boolean (default off)
6485 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006486 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006487 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006488 precede some vertical motion commands (e.g. j k + -) with, without
6489 having to calculate it yourself. Especially useful in combination with
6490 other commands (e.g. y d c < > gq gw =).
6491 When the 'n' option is excluded from 'cpoptions' a wrapped
6492 line will not use the column of line numbers (this is the default when
6493 'compatible' isn't set).
6494 The 'numberwidth' option can be used to set the room used for the line
6495 number.
6496 When a long, wrapped line doesn't start with the first character, '-'
6497 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006498 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6499 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006500
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006501 The number in front of the cursor line also depends on the value of
6502 'number', see |number_relativenumber| for all combinations of the two
6503 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006504
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 *'remap'* *'noremap'*
6506'remap' boolean (default on)
6507 global
6508 Allows for mappings to work recursively. If you do not want this for
6509 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006510 NOTE: To avoid portability problems with Vim scripts, always keep
6511 this option at the default "on". Only switch it off when working with
6512 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513
zeertzjqd086b8f2024-02-25 15:42:52 +08006514 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006515'renderoptions' 'rop' string (default: empty)
6516 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006517 {only available when compiled with GUI and DIRECTX on
6518 MS-Windows}
6519 Select a text renderer and set its options. The options depend on the
6520 renderer.
6521
6522 Syntax: >
6523 set rop=type:{renderer}(,{name}:{value})*
6524<
6525 Currently, only one optional renderer is available.
6526
6527 render behavior ~
6528 directx Vim will draw text using DirectX (DirectWrite). It makes
6529 drawn glyphs more beautiful than default GDI.
6530 It requires 'encoding' is "utf-8", and only works on
6531 MS-Windows Vista or newer version.
6532
6533 Options:
6534 name meaning type value ~
6535 gamma gamma float 1.0 - 2.2 (maybe)
6536 contrast enhancedContrast float (unknown)
6537 level clearTypeLevel float (unknown)
6538 geom pixelGeometry int 0 - 2 (see below)
6539 renmode renderingMode int 0 - 6 (see below)
6540 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006541 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006542
Bram Moolenaar92467d32017-12-05 13:22:16 +01006543 See this URL for detail (except for scrlines):
6544 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006545
6546 For geom: structure of a device pixel.
6547 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6548 1 - DWRITE_PIXEL_GEOMETRY_RGB
6549 2 - DWRITE_PIXEL_GEOMETRY_BGR
6550
6551 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006552 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006553
6554 For renmode: method of rendering glyphs.
6555 0 - DWRITE_RENDERING_MODE_DEFAULT
6556 1 - DWRITE_RENDERING_MODE_ALIASED
6557 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6558 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6559 4 - DWRITE_RENDERING_MODE_NATURAL
6560 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6561 6 - DWRITE_RENDERING_MODE_OUTLINE
6562
6563 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006564 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006565
6566 For taamode: antialiasing mode used for drawing text.
6567 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6568 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6569 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6570 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6571
6572 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006573 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6574
Bram Moolenaara338adc2018-01-31 20:51:47 +01006575 For scrlines:
6576 This was used for optimizing scrolling behavior, however this
6577 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006578
6579 Example: >
6580 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006581 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006582 set rop=type:directx
6583<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006584 If select a raster font (Courier, Terminal or FixedSys which
6585 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006586 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006587
6588 NOTE: It is known that some fonts and options combination
6589 causes trouble on drawing glyphs.
6590
Bram Moolenaar92467d32017-12-05 13:22:16 +01006591 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006592 special made fonts (True-Type fonts which includes only
6593 bitmap glyphs).
6594 - 'taamode:3' will not work with some vector fonts.
6595
6596 NOTE: With this option, you can display colored emoji
6597 (emoticon) in Windows 8.1 or later. To display colored emoji,
6598 there are some conditions which you should notice.
6599
6600 - If your font includes non-colored emoji already, it will
6601 be used.
6602 - If your font doesn't have emoji, the system chooses an
6603 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6604 will be used.
6605 - When this alternative font didn't have fixed width glyph,
6606 emoji might be rendered beyond the bounding box of drawing
6607 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006608
6609 Other render types are currently not supported.
6610
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 *'report'*
6612'report' number (default 2)
6613 global
6614 Threshold for reporting number of lines changed. When the number of
6615 changed lines is more than 'report' a message will be given for most
6616 ":" commands. If you want it always, set 'report' to 0.
6617 For the ":substitute" command the number of substitutions is used
6618 instead of the number of lines.
6619
6620 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6621'restorescreen' 'rs' boolean (default on)
6622 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006623 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 When set, the screen contents is restored when exiting Vim. This also
6625 happens when executing external commands.
6626
6627 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6628 options in your .vimrc. To disable restoring:
6629 set t_ti= t_te=
6630 To enable restoring (for an xterm):
6631 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6632 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6633
6634 *'revins'* *'ri'* *'norevins'* *'nori'*
6635'revins' 'ri' boolean (default off)
6636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 {only available when compiled with the |+rightleft|
6638 feature}
6639 Inserting characters in Insert mode will work backwards. See "typing
6640 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6641 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006642 NOTE: This option is reset when 'compatible' is set.
6643 This option is reset when 'paste' is set and restored when 'paste' is
6644 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645
6646 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6647'rightleft' 'rl' boolean (default off)
6648 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 {only available when compiled with the |+rightleft|
6650 feature}
6651 When on, display orientation becomes right-to-left, i.e., characters
6652 that are stored in the file appear from the right to the left.
6653 Using this option, it is possible to edit files for languages that
6654 are written from the right to the left such as Hebrew and Arabic.
6655 This option is per window, so it is possible to edit mixed files
6656 simultaneously, or to view the same file in both ways (this is
6657 useful whenever you have a mixed text file with both right-to-left
6658 and left-to-right strings so that both sets are displayed properly
6659 in different windows). Also see |rileft.txt|.
6660
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006661 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662'rightleftcmd' 'rlc' string (default "search")
6663 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 {only available when compiled with the |+rightleft|
6665 feature}
6666 Each word in this option enables the command line editing to work in
6667 right-to-left mode for a group of commands:
6668
6669 search "/" and "?" commands
6670
6671 This is useful for languages such as Hebrew, Arabic and Farsi.
6672 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6673
Bram Moolenaard94464e2015-11-02 15:28:18 +01006674 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006675'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006676 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006677 {only available when compiled with the |+ruby/dyn|
6678 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006679 Specifies the name of the Ruby shared library. The default is
6680 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006681 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006682 This option cannot be set from a |modeline| or in the |sandbox|, for
6683 security reasons.
6684
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006686'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006689 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 text in the file is shown on the far right:
6691 Top first line is visible
6692 Bot last line is visible
6693 All first and last line are visible
6694 45% relative position in the file
6695 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006696 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006697 ruler is shown there. Otherwise it is shown in the last line of the
6698 screen. If the statusline is given by 'statusline' (i.e. not empty),
6699 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006701 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 the text column (byte number) and the screen column are shown,
6703 separated with a dash.
6704 For an empty line "0-1" is shown.
6705 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006706 This option is reset when 'paste' is set and restored when 'paste' is
6707 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 If you don't want to see the ruler all the time but want to know where
6709 you are, use "g CTRL-G" |g_CTRL-G|.
6710 NOTE: This option is reset when 'compatible' is set.
6711
6712 *'rulerformat'* *'ruf'*
6713'rulerformat' 'ruf' string (default empty)
6714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 {not available when compiled without the |+statusline|
6716 feature}
6717 When this option is not empty, it determines the content of the ruler
6718 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006719 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006720 This option cannot be set in a modeline when 'modelineexpr' is off.
6721
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 The default ruler width is 17 characters. To make the ruler 15
6723 characters wide, put "%15(" at the start and "%)" at the end.
6724 Example: >
6725 :set rulerformat=%15(%c%V\ %p%%%)
6726<
6727 *'runtimepath'* *'rtp'* *vimfiles*
6728'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006729 Unix: "$HOME/.vim or
6730 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 $VIM/vimfiles,
6732 $VIMRUNTIME,
6733 $VIM/vimfiles/after,
6734 $HOME/.vim/after"
6735 Amiga: "home:vimfiles,
6736 $VIM/vimfiles,
6737 $VIMRUNTIME,
6738 $VIM/vimfiles/after,
6739 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006740 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 $VIM/vimfiles,
6742 $VIMRUNTIME,
6743 $VIM/vimfiles/after,
6744 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006745 Haiku: "$BE_USER_SETTINGS/vim,
6746 $VIM/vimfiles,
6747 $VIMRUNTIME,
6748 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006749 $BE_USER_SETTINGS/vim/after"
6750 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 $VIM/vimfiles,
6752 $VIMRUNTIME,
6753 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006754 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 This is a list of directories which will be searched for runtime
6757 files:
6758 filetype.vim filetypes by file name |new-filetype|
6759 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006760 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 colors/ color scheme files |:colorscheme|
6762 compiler/ compiler files |:compiler|
6763 doc/ documentation |write-local-help|
6764 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006765 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 indent/ indent scripts |indent-expression|
6767 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006768 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006770 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 plugin/ plugin scripts |write-plugin|
6772 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006773 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 syntax/ syntax files |mysyntaxfile|
6775 tutor/ files for vimtutor |tutor|
6776
6777 And any other file searched for with the |:runtime| command.
6778
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006779 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6780
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 The defaults for most systems are setup to search five locations:
6782 1. In your home directory, for your personal preferences.
6783 2. In a system-wide Vim directory, for preferences from the system
6784 administrator.
6785 3. In $VIMRUNTIME, for files distributed with Vim.
6786 *after-directory*
6787 4. In the "after" directory in the system-wide Vim directory. This is
6788 for the system administrator to overrule or add to the distributed
6789 defaults (rarely needed)
6790 5. In the "after" directory in your home directory. This is for
6791 personal preferences to overrule or add to the distributed defaults
6792 or system-wide settings (rarely needed).
6793
Bram Moolenaard0796902016-09-16 20:02:31 +02006794 More entries are added when using |packages|. If it gets very long
6795 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6796 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006797
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6799 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006800 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 wildcards.
6802 See |:runtime|.
6803 Example: >
6804 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6805< This will use the directory "~/vimruntime" first (containing your
6806 personal Vim runtime files), then "/mygroup/vim" (shared between a
6807 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6808 files).
6809 You probably should always include $VIMRUNTIME somewhere, to use the
6810 distributed runtime files. You can put a directory before $VIMRUNTIME
6811 to find files which replace a distributed runtime files. You can put
6812 a directory after $VIMRUNTIME to find files which add to distributed
6813 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006814 When Vim is started with |--clean| the home directory entries are not
6815 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 This option cannot be set from a |modeline| or in the |sandbox|, for
6817 security reasons.
6818
6819 *'scroll'* *'scr'*
6820'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006821 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6823 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006824 changes. This may happen when enabling the |status-line| or
6825 'tabline' option after setting the 'scroll' option.
6826 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006827 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006828 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829
6830 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6831'scrollbind' 'scb' boolean (default off)
6832 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006833 See also |scroll-binding|. When this option is set, scrolling the
6834 current window also scrolls other scrollbind windows (windows that
6835 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 differences between two versions of a file, see 'diff'.
6837 See |'scrollopt'| for options that determine how this option should be
6838 interpreted.
6839 This option is mostly reset when splitting a window to edit another
6840 file. This means that ":split | edit file" results in two windows
6841 with scroll-binding, but ":split file" does not.
6842
Bram Moolenaarae20f342019-11-05 21:09:23 +01006843 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6844'scrollfocus' 'scf' boolean (default off)
6845 global
6846 {only for MS-Windows GUI}
6847 When using the scroll wheel and this option is set, the window under
6848 the mouse pointer is scrolled. With this option off the current
6849 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006850 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006851
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 *'scrolljump'* *'sj'*
6853'scrolljump' 'sj' number (default 1)
6854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 Minimal number of lines to scroll when the cursor gets off the
6856 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6857 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006858 When set to a negative number from -1 to -100 this is used as the
6859 percentage of the window height. Thus -50 scrolls half the window
6860 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 NOTE: This option is set to 1 when 'compatible' is set.
6862
6863 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006864'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006865 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 Minimal number of screen lines to keep above and below the cursor.
6867 This will make some context visible around where you are working. If
6868 you set it to a very large value (999) the cursor line will always be
6869 in the middle of the window (except at the start or end of the file or
6870 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006871 After using the local value, go back the global value with one of
6872 these two: >
6873 setlocal scrolloff<
6874 setlocal scrolloff=-1
6875< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 NOTE: This option is set to 0 when 'compatible' is set.
6877
6878 *'scrollopt'* *'sbo'*
6879'scrollopt' 'sbo' string (default "ver,jump")
6880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006882 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6883 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 The following words are available:
6885 ver Bind vertical scrolling for 'scrollbind' windows
6886 hor Bind horizontal scrolling for 'scrollbind' windows
6887 jump Applies to the offset between two windows for vertical
6888 scrolling. This offset is the difference in the first
6889 displayed line of the bound windows. When moving
6890 around in a window, another 'scrollbind' window may
6891 reach a position before the start or after the end of
6892 the buffer. The offset is not changed though, when
6893 moving back the 'scrollbind' window will try to scroll
6894 to the desired position when possible.
6895 When now making that window the current one, two
6896 things can be done with the relative offset:
6897 1. When "jump" is not included, the relative offset is
6898 adjusted for the scroll position in the new current
6899 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006900 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 2. When "jump" is included, the other windows are
6902 scrolled to keep the same relative offset. When
6903 going back to the other window, it still uses the
6904 same relative offset.
6905 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006906 When 'diff' mode is active there always is vertical scroll binding,
6907 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908
6909 *'sections'* *'sect'*
6910'sections' 'sect' string (default "SHNHH HUnhsh")
6911 global
6912 Specifies the nroff macros that separate sections. These are pairs of
6913 two letters (See |object-motions|). The default makes a section start
6914 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6915
6916 *'secure'* *'nosecure'* *E523*
6917'secure' boolean (default off)
6918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 When on, ":autocmd", shell and write commands are not allowed in
6920 ".vimrc" and ".exrc" in the current directory and map commands are
6921 displayed. Switch it off only if you know that you will not run into
6922 problems, or when the 'exrc' option is off. On Unix this option is
6923 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006924 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 'secure' at the end of your ~/.vimrc then.
6926 This option cannot be set from a |modeline| or in the |sandbox|, for
6927 security reasons.
6928
6929 *'selection'* *'sel'*
6930'selection' 'sel' string (default "inclusive")
6931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 This option defines the behavior of the selection. It is only used
6933 in Visual and Select mode.
6934 Possible values:
6935 value past line inclusive ~
6936 old no yes
6937 inclusive yes yes
6938 exclusive yes no
6939 "past line" means that the cursor is allowed to be positioned one
6940 character past the line.
6941 "inclusive" means that the last character of the selection is included
6942 in an operation. For example, when "x" is used to delete the
6943 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006944 When "old" is used and 'virtualedit' allows the cursor to move past
6945 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 Note that when "exclusive" is used and selecting from the end
6947 backwards, you cannot include the last character of a line, when
6948 starting in Normal mode and 'virtualedit' empty.
6949
6950 The 'selection' option is set by the |:behave| command.
6951
6952 *'selectmode'* *'slm'*
6953'selectmode' 'slm' string (default "")
6954 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006955 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 Select mode instead of Visual mode, when a selection is started.
6957 Possible values:
6958 mouse when using the mouse
6959 key when using shifted special keys
6960 cmd when using "v", "V" or CTRL-V
6961 See |Select-mode|.
6962 The 'selectmode' option is set by the |:behave| command.
6963
6964 *'sessionoptions'* *'ssop'*
6965'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006966 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006968 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 feature}
6970 Changes the effect of the |:mksession| command. It is a comma
6971 separated list of words. Each word enables saving and restoring
6972 something:
6973 word save and restore ~
6974 blank empty windows
6975 buffers hidden and unloaded buffers, not just those in windows
6976 curdir the current directory
6977 folds manually created folds, opened/closed folds and local
6978 fold options
6979 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006980 and contain at least one lowercase letter. Only
6981 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 help the help window
6983 localoptions options and mappings local to a window or buffer (not
6984 global values for local options)
6985 options all options and mappings (also global values for local
6986 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006987 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 resize size of the Vim window: 'lines' and 'columns'
6989 sesdir the directory in which the session file is located
6990 will become the current directory (useful with
6991 projects accessed over a network from different
6992 systems)
6993 slash backslashes in file names replaced with forward
6994 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006995 tabpages all tab pages; without this only the current tab page
6996 is restored, so that you can make a session for each
6997 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006998 terminal include terminal windows where the command can be
6999 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 unix with Unix end-of-line format (single <NL>), even when
7001 on Windows or DOS
7002 winpos position of the whole Vim window
7003 winsize window sizes
7004
7005 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007006 When neither "curdir" nor "sesdir" is included, file names are stored
7007 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007008 If you leave out "options" many things won't work well after restoring
7009 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 "slash" and "unix" are useful on Windows when sharing session files
7011 with Unix. The Unix version of Vim cannot source dos format scripts,
7012 but the Windows version of Vim can source unix format scripts.
7013
7014 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007015'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 global
7017 Name of the shell to use for ! and :! commands. When changing the
7018 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7019 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007020 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 See |option-backslash| about including spaces and backslashes.
7022 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007023
Bram Moolenaara2baa732022-02-04 16:09:54 +00007024 In |restricted-mode| shell commands will not be possible. This mode
7025 is used if the value of $SHELL ends in "false" or "nologin".
7026
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007027 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007028 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7030< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007031 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007033 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007035 Example with escaped space (Vim will do this when initializing the
7036 option from $SHELL): >
7037 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007038< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007039 backslashes are consumed by `:set`.
7040
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 Under MS-Windows, when the executable ends in ".com" it must be
7042 included. Thus setting the shell to "command.com" or "4dos.com"
7043 works, but "command" and "4dos" do not work for all commands (e.g.,
7044 filtering).
7045 For unknown reasons, when using "4dos.com" the current directory is
7046 changed to "C:\". To avoid this set 'shell' like this: >
7047 :set shell=command.com\ /c\ 4dos
7048< This option cannot be set from a |modeline| or in the |sandbox|, for
7049 security reasons.
7050
7051 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007052'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007053 Win32, when 'shell' contains "powershell":
7054 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007055 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007058 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7059 For MS-Windows, the default is set according to the value of 'shell',
7060 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007061 On Unix it can have more than one flag. Each white space separated
7062 part is passed as an argument to the shell command.
7063 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007064 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 This option cannot be set from a |modeline| or in the |sandbox|, for
7066 security reasons.
7067
7068 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007069'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7070 "2>&1| tee", or
7071 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 {not available when compiled without the |+quickfix|
7074 feature}
7075 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007076 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 including spaces and backslashes.
7078 The name of the temporary file can be represented by "%s" if necessary
7079 (the file name is appended automatically if no %s appears in the value
7080 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007081 For the Amiga the default is ">". For MS-Windows using powershell the
7082 default is "2>&1 | Out-File -Encoding default", otherwise the default
7083 is ">%s 2>&1". The output is directly saved in a file and not echoed
7084 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007085 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 in a file and echoed to the screen. If the 'shell' option is "csh" or
7087 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007088 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007089 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7090 means that stderr is also included. Before using the 'shell' option a
7091 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007092 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7093 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 The initialization of this option is done after reading the ".vimrc"
7095 and the other initializations, so that when the 'shell' option is set
7096 there, the 'shellpipe' option changes automatically, unless it was
7097 explicitly set before.
7098 When 'shellpipe' is set to an empty string, no redirection of the
7099 ":make" output will be done. This is useful if you use a 'makeprg'
7100 that writes to 'makeef' by itself. If you want no piping, but do
7101 want to include the 'makeef', set 'shellpipe' to a single space.
7102 Don't forget to precede the space with a backslash: ":set sp=\ ".
7103 In the future pipes may be used for filtering and this option will
7104 become obsolete (at least for Unix).
7105 This option cannot be set from a |modeline| or in the |sandbox|, for
7106 security reasons.
7107
7108 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007109'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 Quoting character(s), put around the command passed to the shell, for
7112 the "!" and ":!" commands. The redirection is kept outside of the
7113 quoting. See 'shellxquote' to include the redirection. It's
7114 probably not useful to set both options.
7115 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007116 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007117 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 This option cannot be set from a |modeline| or in the |sandbox|, for
7119 security reasons.
7120
7121 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007122'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7123 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 String to be used to put the output of a filter command in a temporary
7126 file. See also |:!|. See |option-backslash| about including spaces
7127 and backslashes.
7128 The name of the temporary file can be represented by "%s" if necessary
7129 (the file name is appended automatically if no %s appears in the value
7130 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007131 The default is ">". For Unix, if the 'shell' option is "csh" or
7132 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007133 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007134 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7135 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007136 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7137 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007138 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7139 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 The initialization of this option is done after reading the ".vimrc"
7141 and the other initializations, so that when the 'shell' option is set
7142 there, the 'shellredir' option changes automatically unless it was
7143 explicitly set before.
7144 In the future pipes may be used for filtering and this option will
7145 become obsolete (at least for Unix).
7146 This option cannot be set from a |modeline| or in the |sandbox|, for
7147 security reasons.
7148
7149 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7150'shellslash' 'ssl' boolean (default off)
7151 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007152 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007154 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007155 powershell.exe. Backward slashes can still be typed, but they are
7156 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 Note that setting or resetting this option has no effect for some
7158 existing file names, thus this option needs to be set before opening
7159 any file for best results. This might change in the future.
7160 'shellslash' only works when a backslash can be used as a path
7161 separator. To test if this is so use: >
7162 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007163< Also see 'completeslash'.
7164
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007165 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7166'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7167 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007168 When on, use temp files for shell commands. When off use a pipe.
7169 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007170 Currently a pipe is only supported on Unix and MS-Windows 2K and
7171 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007172 :if has("filterpipe")
7173< The advantage of using a pipe is that nobody can read the temp file
7174 and the 'shell' command does not need to support redirection.
7175 The advantage of using a temp file is that the file type and encoding
7176 can be detected.
7177 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7178 |FilterWritePost| autocommands event are not triggered when
7179 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007180 The `system()` function does not respect this option and always uses
7181 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007182 NOTE: This option is set to the Vim default value when 'compatible'
7183 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007184
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 *'shelltype'* *'st'*
7186'shelltype' 'st' number (default 0)
7187 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007188 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 On the Amiga this option influences the way how the commands work
7190 which use a shell.
7191 0 and 1: always use the shell
7192 2 and 3: use the shell only to filter lines
7193 4 and 5: use shell only for ':sh' command
7194 When not using the shell, the command is executed directly.
7195
7196 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7197 1 and 3: use "shell cmd" to start external commands
7198
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007199 *'shellxescape'* *'sxe'*
7200'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007201 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007202 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007203 When 'shellxquote' is set to "(" then the characters listed in this
7204 option will be escaped with a '^' character. This makes it possible
7205 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007206 This option cannot be set from a |modeline| or in the |sandbox|, for
7207 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007208
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 *'shellxquote'* *'sxq'*
7210'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007211 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007212 for Win32, when 'shell' is
7213 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007214 for Win32, when 'shell' contains "sh"
7215 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 for Unix, when using system(): "\"")
7217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 Quoting character(s), put around the command passed to the shell, for
7219 the "!" and ":!" commands. Includes the redirection. See
7220 'shellquote' to exclude the redirection. It's probably not useful
7221 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007222 When the value is '(' then ')' is appended. When the value is '"('
7223 then ')"' is appended.
7224 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007225 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007226 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7227 pwsh.exe which automatically strips off the first and last quote on a
7228 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7229 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007230 'shell', to reduce the need to set this option by the user. See
7231 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 This option cannot be set from a |modeline| or in the |sandbox|, for
7233 security reasons.
7234
7235 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7236'shiftround' 'sr' boolean (default off)
7237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 Round indent to multiple of 'shiftwidth'. Applies to > and <
7239 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7240 a multiple of 'shiftwidth' (this is Vi compatible).
7241 NOTE: This option is reset when 'compatible' is set.
7242
7243 *'shiftwidth'* *'sw'*
7244'shiftwidth' 'sw' number (default 8)
7245 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007248 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007249 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250
7251 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007252'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7253 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007254 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007256 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 It is a list of flags:
7258 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007259 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7260 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7261 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7262 m use "[+]" instead of "[Modified]" *shm-m*
7263 n use "[New]" instead of "[New File]" *shm-n*
7264 r use "[RO]" instead of "[readonly]" *shm-r*
7265 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007267 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7268 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007269 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007270 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007272 o overwrite message for writing a file with subsequent *shm-o*
7273 message for reading a file (useful for ":wn" or when
7274 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007275 O message for reading a file overwrites any previous *shm-O*
7276 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007277 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7278 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007279 the search count do not show "W" before the count message
7280 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007281 t truncate file message at the start if it is too long *shm-t*
7282 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007283 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007284 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007285 long to fit on the command line; "..." will appear in the
7286 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007287 W don't give "written" or "[w]" when writing a file *shm-W*
7288 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007289 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007290 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007291 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007292 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007293 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7294 match", "Pattern not found", "Back at original", etc.
7295 C don't give messages while scanning for ins-completion *shm-C*
7296 items, for instance "scanning tags"
7297 q use "recording" instead of "recording @a" *shm-q*
7298 F don't give the file info when editing a file, like *shm-F*
7299 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007300 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007301 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007302 "[1/5]". When the "S" flag is not present (e.g. search count
7303 is shown), the "search hit BOTTOM, continuing at TOP" and
7304 "search hit TOP, continuing at BOTTOM" messages are only
7305 indicated by a "W" (Mnemonic: Wrapped) letter before the
7306 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307
7308 This gives you the opportunity to avoid that a change between buffers
7309 requires you to hit <Enter>, but still gives as useful a message as
7310 possible for the space available. To get the whole message that you
7311 would have got with 'shm' empty, use ":file!"
7312 Useful values:
7313 shm= No abbreviation of message.
7314 shm=a Abbreviation, but no loss of information.
7315 shm=at Abbreviation, and truncate message when necessary.
7316
7317 NOTE: This option is set to the Vi default value when 'compatible' is
7318 set and to the Vim default value when 'compatible' is reset.
7319
7320 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7321'shortname' 'sn' boolean (default off)
7322 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 Filenames are assumed to be 8 characters plus one extension of 3
7324 characters. Multiple dots in file names are not allowed. When this
7325 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007326 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007328 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
7330 *'showbreak'* *'sbr'* *E595*
7331'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007332 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007333 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 feature}
7335 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007336 values are "> " or "+++ ": >
7337 :set showbreak=>\
7338< Note the backslash to escape the trailing space. It's easier like
7339 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007340 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007341< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 comma (in a future version the comma might be used to separate the
7343 part that is shown at the end and at the start of a line).
7344 The characters are highlighted according to the '@' flag in
7345 'highlight'.
7346 Note that tabs after the showbreak will be displayed differently.
7347 If you want the 'showbreak' to appear in between line numbers, add the
7348 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007349 A window-local value overrules a global value. If the global value is
7350 set and you want no value in the current window use NONE: >
7351 :setlocal showbreak=NONE
7352<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007354'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7355 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007357 Show (partial) command in the last line of the screen. Set this
7358 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 In Visual mode the size of the selected area is shown:
7360 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007361 If the number of bytes is different it is also displayed: "2-6"
7362 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007364 - When selecting a block, the size in screen characters:
7365 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007366 This information can be displayed in an alternative location using the
7367 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 NOTE: This option is set to the Vi default value when 'compatible' is
7369 set and to the Vim default value when 'compatible' is reset.
7370
Luuk van Baalba936f62022-12-15 13:15:39 +00007371 *'showcmdloc'* *'sloc'*
7372'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007373 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007374 This option can be used to display the (partially) entered command in
7375 another location. Possible values are:
7376 last Last line of the screen (default).
7377 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007378 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007379 Setting this option to "statusline" or "tabline" means that these will
7380 be redrawn whenever the command changes, which can be on every key
7381 pressed.
7382 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7383 place the text. Without a custom 'statusline' or 'tabline' it will be
7384 displayed in a convenient location.
7385
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7387'showfulltag' 'sft' boolean (default off)
7388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 When completing a word in insert mode (see |ins-completion|) from the
7390 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007391 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 matched a C function, you can see a template for what arguments are
7393 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007394 Note that this doesn't work well together with having "longest" in
7395 'completeopt', because the completion from the search pattern may not
7396 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397
7398 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7399'showmatch' 'sm' boolean (default off)
7400 global
7401 When a bracket is inserted, briefly jump to the matching one. The
7402 jump is only done if the match can be seen on the screen. The time to
7403 show the match can be set with 'matchtime'.
7404 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007405 seen or not).
7406 This option is reset when 'paste' is set and restored when 'paste' is
7407 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 When the 'm' flag is not included in 'cpoptions', typing a character
7409 will immediately move the cursor back to where it belongs.
7410 See the "sm" field in 'guicursor' for setting the cursor shape and
7411 blinking when showing the match.
7412 The 'matchpairs' option can be used to specify the characters to show
7413 matches for. 'rightleft' and 'revins' are used to look for opposite
7414 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007415 Also see the matchparen plugin for highlighting the match when moving
7416 around |pi_paren.txt|.
7417 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418
7419 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7420'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7421 global
7422 If in Insert, Replace or Visual mode put a message on the last line.
7423 Use the 'M' flag in 'highlight' to set the type of highlighting for
7424 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007425 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 doesn't mean XIM is really active, especially when 'imactivatekey' is
7427 not set.
7428 NOTE: This option is set to the Vi default value when 'compatible' is
7429 set and to the Vim default value when 'compatible' is reset.
7430
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007431 *'showtabline'* *'stal'*
7432'showtabline' 'stal' number (default 1)
7433 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007434 The value of this option specifies when the line with tab page labels
7435 will be displayed:
7436 0: never
7437 1: only if there are at least two tab pages
7438 2: always
7439 This is both for the GUI and non-GUI implementation of the tab pages
7440 line.
7441 See |tab-page| for more information about tab pages.
7442
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 *'sidescroll'* *'ss'*
7444'sidescroll' 'ss' number (default 0)
7445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 The minimal number of columns to scroll horizontally. Used only when
7447 the 'wrap' option is off and the cursor is moved off of the screen.
7448 When it is zero the cursor will be put in the middle of the screen.
7449 When using a slow terminal set it to a large number or 0. When using
7450 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7451 commands.
7452
7453 *'sidescrolloff'* *'siso'*
7454'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007455 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007457 right of the cursor if 'nowrap' is set. Setting this option to a
7458 value greater than 0 while having |'sidescroll'| also at a non-zero
7459 value makes some context visible in the line you are scrolling in
7460 horizontally (except at beginning of the line). Setting this option
7461 to a large value (like 999) has the effect of keeping the cursor
7462 horizontally centered in the window, as long as one does not come too
7463 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007464 After using the local value, go back the global value with one of
7465 these two: >
7466 setlocal sidescrolloff<
7467 setlocal sidescrolloff=-1
7468< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469
7470 Example: Try this together with 'sidescroll' and 'listchars' as
7471 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007472 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473
7474 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7475 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007476<
7477 *'signcolumn'* *'scl'*
7478'signcolumn' 'scl' string (default "auto")
7479 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007480 {not available when compiled without the |+signs|
7481 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007482 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007483 "auto" only when there is a sign to display
7484 "no" never
7485 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007486 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007487 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7490'smartcase' 'scs' boolean (default off)
7491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 Override the 'ignorecase' option if the search pattern contains upper
7493 case characters. Only used when the search pattern is typed and
7494 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007495 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7497 recalling the search pattern from history and hitting <Enter>.
7498 NOTE: This option is reset when 'compatible' is set.
7499
7500 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7501'smartindent' 'si' boolean (default off)
7502 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 Do smart autoindenting when starting a new line. Works for C-like
7504 programs, but can also be used for other languages. 'cindent' does
7505 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007506 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007507 setting 'si' has no effect. 'indentexpr' is a more advanced
7508 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 Normally 'autoindent' should also be on when using 'smartindent'.
7510 An indent is automatically inserted:
7511 - After a line ending in '{'.
7512 - After a line starting with a keyword from 'cinwords'.
7513 - Before a line starting with '}' (only with the "O" command).
7514 When typing '}' as the first character in a new line, that line is
7515 given the same indent as the matching '{'.
7516 When typing '#' as the first character in a new line, the indent for
7517 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007518 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7520 When using the ">>" command, lines starting with '#' are not shifted
7521 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007522 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007523 This option is reset when 'paste' is set and restored when 'paste' is
7524 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7527'smarttab' 'sta' boolean (default off)
7528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007530 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7531 <BS> will delete a 'shiftwidth' worth of space at the start of the
7532 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007533 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007534 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7535 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007536 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007538 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007539 This option is reset when 'paste' is set and restored when 'paste' is
7540 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 NOTE: This option is reset when 'compatible' is set.
7542
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007543 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7544'smoothscroll' 'sms' boolean (default off)
7545 local to window
7546 Scrolling works with screen lines. When 'wrap' is set and the first
7547 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007548 above the window. "<<<" is displayed at the start of the first line,
7549 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007550 You may also want to add "lastline" to the 'display' option to show as
7551 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007552 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007553
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 *'softtabstop'* *'sts'*
7555'softtabstop' 'sts' number (default 0)
7556 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 Number of spaces that a <Tab> counts for while performing editing
7558 operations, like inserting a <Tab> or using <BS>. It "feels" like
7559 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7560 used. This is useful to keep the 'ts' setting at its standard value
7561 of 8, while being able to edit like it is set to 'sts'. However,
7562 commands like "x" still work on the actual characters.
7563 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007564 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007565 'softtabstop' is set to 0 when the 'paste' option is set and restored
7566 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7568 spaces is minimized by using <Tab>s.
7569 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7570 set.
7571 NOTE: This option is set to 0 when 'compatible' is set.
7572
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007573 If Vim is compiled with the |+vartabs| feature then the value of
7574 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7575 anything other than an empty string.
7576
Bram Moolenaar217ad922005-03-20 22:37:15 +00007577 *'spell'* *'nospell'*
7578'spell' boolean (default off)
7579 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007580 {not available when compiled without the |+syntax|
7581 feature}
7582 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007583 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007584
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007585 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007586'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007587 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007588 {not available when compiled without the |+syntax|
7589 feature}
7590 Pattern to locate the end of a sentence. The following word will be
7591 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007592 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007593 When this check is not wanted make this option empty.
7594 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007595 Be careful with special characters, see |option-backslash| about
7596 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007597 To set this option automatically depending on the language, see
7598 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007599
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007600 *'spellfile'* *'spf'*
7601'spellfile' 'spf' string (default empty)
7602 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007603 {not available when compiled without the |+syntax|
7604 feature}
7605 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007606 commands. It must end in ".{encoding}.add". You need to include the
7607 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007608 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007609 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007610 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007611 |zg| and |zw| commands can be used to access each. This allows using
7612 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007613 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007614 you: Using the first directory in 'runtimepath' that is writable. If
7615 there is no "spell" directory yet it will be created. For the file
7616 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007617 ignoring the region.
7618 The resulting ".spl" file will be used for spell checking, it does not
7619 have to appear in 'spelllang'.
7620 Normally one file is used for all regions, but you can add the region
7621 name if you want to. However, it will then only be used when
7622 'spellfile' is set to it, for entries in 'spelllang' only files
7623 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007624 This option cannot be set from a |modeline| or in the |sandbox|, for
7625 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007626
Bram Moolenaar217ad922005-03-20 22:37:15 +00007627 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007628'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007629 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007630 {not available when compiled without the |+syntax|
7631 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007632 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007633 on spellchecking will be done for these languages. Example: >
7634 set spelllang=en_us,nl,medical
7635< This means US English, Dutch and medical words are recognized. Words
7636 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007637 The word list name must consist of alphanumeric characters, a dash or
7638 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007639 recommended to separate the two letter language name from a
7640 specification. Thus "en-rare" is used for rare English words.
7641 A region name must come last and have the form "_xx", where "xx" is
7642 the two-letter, lower case region name. You can use more than one
7643 region by listing them: "en_us,en_ca" supports both US and Canadian
7644 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007645 Britain. (Note: currently en_au and en_nz dictionaries are older than
7646 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007647 If the name "cjk" is included East Asian characters are excluded from
7648 spell checking. This is useful when editing text that also has Asian
7649 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007650 Note that the "medical" dictionary does not exist, it is just an
7651 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007652 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007653 As a special case the name of a .spl file can be given as-is. The
7654 first "_xx" in the name is removed and used as the region name
7655 (_xx is an underscore, two letters and followed by a non-letter).
7656 This is mainly for testing purposes. You must make sure the correct
7657 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007658 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007659 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7660 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007661 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007662
Bram Moolenaar98692072006-02-04 00:57:42 +00007663 If the |spellfile.vim| plugin is active and you use a language name
7664 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7665 will ask you if you want to download the file.
7666
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007667 After this option has been set successfully, Vim will source the files
7668 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007669 up to the first character that is not an ASCII letter or number and
7670 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007671
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007672 *'spelloptions'* *'spo'*
7673'spelloptions' 'spo' string (default "")
7674 local to buffer
7675 {not available when compiled without the |+syntax|
7676 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007677 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007678 camel When a word is CamelCased, assume "Cased" is a
7679 separate word: every upper-case character in a word
7680 that comes after a lower case character indicates the
7681 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007682
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007683 *'spellsuggest'* *'sps'*
7684'spellsuggest' 'sps' string (default "best")
7685 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007686 {not available when compiled without the |+syntax|
7687 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007688 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007689 the |spellsuggest()| function. This is a comma-separated list of
7690 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007691
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007692 best Internal method that works best for English. Finds
7693 changes like "fast" and uses a bit of sound-a-like
7694 scoring to improve the ordering.
7695
7696 double Internal method that uses two methods and mixes the
7697 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007698 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007699 word. That only works when the language specifies
7700 sound folding. Can be slow and doesn't always give
7701 better results.
7702
7703 fast Internal method that only checks for simple changes:
7704 character inserts/deletes/swaps. Works well for
7705 simple typing mistakes.
7706
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007707 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007708 Not used for |spellsuggest()|. The number of
7709 suggestions is never more than the value of 'lines'
7710 minus two.
7711
Bram Moolenaar585ee072022-01-29 11:22:17 +00007712 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007713 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007714 methods. When omitted the limit is 5000. When
7715 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007716 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007717
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007718 file:{filename} Read file {filename}, which must have two columns,
7719 separated by a slash. The first column contains the
7720 bad word, the second column the suggested good word.
7721 Example:
7722 theribal/terrible ~
7723 Use this for common mistakes that do not appear at the
7724 top of the suggestion list with the internal methods.
7725 Lines without a slash are ignored, use this for
7726 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007727 The word in the second column must be correct,
7728 otherwise it will not be used. Add the word to an
7729 ".add" file if it is currently flagged as a spelling
7730 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007731 The file is used for all languages.
7732
7733 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007734 trouble with spaces. Best is to call a function
7735 without arguments, see |expr-option-function|.
7736 |v:val| holds the badly spelled word. The expression
7737 must evaluate to a List of Lists, each with a
7738 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007739 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007740 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007741 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007742 internal methods use. A lower score is better.
7743 This may invoke |spellsuggest()| if you temporarily
7744 set 'spellsuggest' to exclude the "expr:" part.
7745 Errors are silently ignored, unless you set the
7746 'verbose' option to a non-zero value.
7747
7748 Only one of "best", "double" or "fast" may be used. The others may
7749 appear several times in any order. Example: >
7750 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7751<
7752 This option cannot be set from a |modeline| or in the |sandbox|, for
7753 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007754
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7756'splitbelow' 'sb' boolean (default off)
7757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 When on, splitting a window will put the new window below the current
7759 one. |:split|
7760
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007761 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007762'splitkeep' 'spk' string (default "cursor")
7763 global
7764 The value of this option determines the scroll behavior when opening,
7765 closing or resizing horizontal splits.
7766
7767 Possible values are:
7768 cursor Keep the same relative cursor position.
7769 screen Keep the text on the same screen line.
7770 topline Keep the topline the same.
7771
7772 For the "screen" and "topline" values, the cursor position will be
7773 changed when necessary. In this case, the jumplist will be populated
7774 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007775 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007776
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7778'splitright' 'spr' boolean (default off)
7779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 When on, splitting a window will put the new window right of the
7781 current one. |:vsplit|
7782
7783 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7784'startofline' 'sol' boolean (default on)
7785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007787 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007788 (if possible). This applies to the commands:
7789 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007790 - "d", "<<", "==" and ">>" with a linewise operator
7791 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007792 - "%" with a count
7793 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7794 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 In case of buffer changing commands the cursor is placed at the column
7796 where it was the last time the buffer was edited.
7797 NOTE: This option is set when 'compatible' is set.
7798
Bram Moolenaar00654022011-02-25 14:42:19 +01007799 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007801 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 {not available when compiled without the |+statusline|
7803 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007804 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 Also see |status-line|.
7806
7807 The option consists of printf style '%' items interspersed with
7808 normal text. Each status line item is of the form:
7809 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007810 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007811 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812
Bram Moolenaar238a5642006-02-21 22:12:05 +00007813 When the option starts with "%!" then it is used as an expression,
7814 evaluated and the result is used as the option value. Example: >
7815 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007816< The *g:statusline_winid* variable will be set to the |window-ID| of the
7817 window that the status line belongs to.
7818 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007819 Note that the "%!" expression is evaluated in the context of the
7820 current window and buffer, while %{} items are evaluated in the
7821 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007822
7823 When there is error while evaluating the option then it will be made
7824 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007825 When the result contains unprintable characters the result is
7826 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007827
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 Note that the only effect of 'ruler' when this option is set (and
7829 'laststatus' is 2) is controlling the output of |CTRL-G|.
7830
7831 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007832 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007834 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 minwid Minimum width of the item, padding as set by '-' & '0'.
7836 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007837 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 on the left for text items. Numeric items will be
7839 shifted down to maxwid-2 digits followed by '>'number
7840 where number is the amount of missing digits, much like
7841 an exponential notation.
7842 item A one letter code as described below.
7843
7844 Following is a description of the possible statusline items. The
7845 second character in "item" is the type:
7846 N for number
7847 S for string
7848 F for flags as described below
7849 - not applicable
7850
7851 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007852 f S Path to the file in the buffer, as typed or relative to current
7853 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 F S Full path to the file in the buffer.
7855 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007856 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007858 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007860 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007862 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007864 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007866 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7868 being used: "<keymap>"
7869 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007870 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 B N As above, in hexadecimal.
7872 o N Byte number in file of byte under cursor, first byte is 1.
7873 Mnemonic: Offset from start of file (with one added)
7874 {not available when compiled without |+byte_offset| feature}
7875 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007876 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 l N Line number.
7878 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007879 c N Column number (byte index).
7880 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007881 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 p N Percentage through file in lines as in |CTRL-G|.
7883 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007884 percentage described for 'ruler'. Always 3 in length, unless
7885 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007886 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007887 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007889 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007890 Note that there is no '%' before the closing '}'. The
7891 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007892 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007893 {% - This is almost same as { except the result of the expression is
7894 re-evaluated as a statusline format string. Thus if the
7895 return value of expr contains % items they will get expanded.
7896 The expression can contain the } character, the end of
7897 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007898 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007899 func! Stl_filename() abort
7900 return "%t"
7901 endfunc
7902< `stl=%{Stl_filename()}` results in `"%t"`
7903 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007904 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 ( - Start of item group. Can be used for setting the width and
7906 alignment of a section. Must be followed by %) somewhere.
7907 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007908 T N For 'tabline': start of tab page N label. Use %T after the last
7909 label. This information is used for mouse clicks.
7910 X N For 'tabline': start of close tab N label. Use %X after the
7911 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7912 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 < - Where to truncate line if too long. Default is at the start.
7914 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007915 = - Separation point between alignment sections. Each section will
7916 be separated by an equal number of spaces. With one %= what
7917 comes after it will be right-aligned. With two %= there is a
7918 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007920 # - Set highlight group. The name must follow and then a # again.
7921 Thus use %#HLname# for highlight group HLname. The same
7922 highlighting is used, also for the statusline of non-current
7923 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007925 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007926 The difference between User{N} and StatusLine will be applied to
7927 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 The number N must be between 1 and 9. See |hl-User1..9|
7929
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007930 When displaying a flag, Vim removes the leading comma, if any, when
7931 that flag comes right after plaintext. This will make a nice display
7932 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933
Bram Moolenaar582fd852005-03-28 20:58:01 +00007934 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 not set) and a minwid is not set for the group, the whole group will
7936 become empty. This will make a group like the following disappear
7937 completely from the statusline when none of the flags are set. >
7938 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007939< Beware that an expression is evaluated each and every time the status
7940 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007941 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007942 While evaluating %{} the current buffer and current window will be set
7943 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007944 currently being drawn. The expression will evaluate in this context.
7945 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7946 real current buffer and "g:actual_curwin" to the |window-ID| of the
7947 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007948
Bram Moolenaar30b65812012-07-12 22:01:11 +02007949 The 'statusline' option will be evaluated in the |sandbox| if set from
7950 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007951 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007952
7953 It is not allowed to change text or jump to another window while
7954 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955
7956 If the statusline is not updated when you want it (e.g., after setting
7957 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007958 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007960 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 Otherwise the result is taken as flag text and applied to the rules
7962 described above.
7963
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007964 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007966 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967
7968 Examples:
7969 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02007970 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971< Similar, but add ASCII value of char under the cursor (like "ga") >
7972 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7973< Display byte count and byte value, modified flag in red. >
7974 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7975 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7976< Display a ,GZ flag if a compressed file is loaded >
7977 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7978< In the |:autocmd|'s: >
7979 :let b:gzflag = 1
7980< And: >
7981 :unlet b:gzflag
7982< And define this function: >
7983 :function VarExists(var, val)
7984 : if exists(a:var) | return a:val | else | return '' | endif
7985 :endfunction
7986<
7987 *'suffixes'* *'su'*
7988'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 Files with these suffixes get a lower priority when multiple files
7991 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007992 suffixes. Spaces after the comma are ignored. A dot is also seen as
7993 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 separator, precede it with a backslash (see |option-backslash| about
7995 including spaces and backslashes).
7996 See 'wildignore' for completely ignoring files.
7997 The use of |:set+=| and |:set-=| is preferred when adding or removing
7998 suffixes from the list. This avoids problems when a future version
7999 uses another default.
8000
8001 *'suffixesadd'* *'sua'*
8002'suffixesadd' 'sua' string (default "")
8003 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008004 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 file for the "gf", "[I", etc. commands. Example: >
8006 :set suffixesadd=.java
8007<
8008 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8009'swapfile' 'swf' boolean (default on)
8010 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008011 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 swapfile is not wanted for a specific buffer. For example, with
8013 confidential information that even root must not be able to access.
8014 Careful: All text will be in memory:
8015 - Don't use this for big files.
8016 - Recovery will be impossible!
8017 A swapfile will only be present when |'updatecount'| is non-zero and
8018 'swapfile' is set.
8019 When 'swapfile' is reset, the swap file for the current buffer is
8020 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8021 non-zero, a swap file is immediately created.
8022 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008023 If you want to open a new buffer without creating a swap file for it,
8024 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008025 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026
8027 This option is used together with 'bufhidden' and 'buftype' to
8028 specify special kinds of buffers. See |special-buffers|.
8029
8030 *'swapsync'* *'sws'*
8031'swapsync' 'sws' string (default "fsync")
8032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008034 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 When this option is empty parts of the swap file may be in memory and
8036 not written to disk. When the system crashes you may lose more work.
8037 On Unix the system does a sync now and then without Vim asking for it,
8038 so the disadvantage of setting this option off is small. On some
8039 systems the swap file will not be written at all. For a unix system
8040 setting it to "sync" will use the sync() call instead of the default
8041 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008042 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043
8044 *'switchbuf'* *'swb'*
8045'switchbuf' 'swb' string (default "")
8046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008048 This option is checked, when
8049 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008050 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008051 - jumping to a tag using the |:stag| command.
8052 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8053 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8054 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008055 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008056 useopen If included, jump to the first open window in the
8057 current tab page that contains the specified buffer
8058 (if there is one). Otherwise: Do not examine other
8059 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008060 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008061 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008063 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008064 Otherwise: do not split, use current window (when used
8065 in the quickfix window: the previously used window or
8066 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008067 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008068 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008069 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008070 uselast If included, jump to the previously used window when
8071 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008072 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8073 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008075 *'synmaxcol'* *'smc'*
8076'synmaxcol' 'smc' number (default 3000)
8077 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008078 {not available when compiled without the |+syntax|
8079 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008080 Maximum column in which to search for syntax items. In long lines the
8081 text after this column is not highlighted and following lines may not
8082 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008083 This helps to avoid very slow redrawing for an XML file that is one
8084 long line.
8085 Set to zero to remove the limit.
8086
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 *'syntax'* *'syn'*
8088'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008089 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 {not available when compiled without the |+syntax|
8091 feature}
8092 When this option is set, the syntax with this name is loaded, unless
8093 syntax highlighting has been switched off with ":syntax off".
8094 Otherwise this option does not always reflect the current syntax (the
8095 b:current_syntax variable does).
8096 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008097 not automatically recognized. Example, in an IDL file:
8098 /* vim: set syntax=idl : */ ~
8099 When a dot appears in the value then this separates two filetype
8100 names. Example:
8101 /* vim: set syntax=c.doxygen : */ ~
8102 This will use the "c" syntax first, then the "doxygen" syntax.
8103 Note that the second one must be prepared to be loaded as an addition,
8104 otherwise it will be skipped. More than one dot may appear.
8105 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 :set syntax=OFF
8107< To switch syntax highlighting on according to the current value of the
8108 'filetype' option: >
8109 :set syntax=ON
8110< What actually happens when setting the 'syntax' option is that the
8111 Syntax autocommand event is triggered with the value as argument.
8112 This option is not copied to another buffer, independent of the 's' or
8113 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008114 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115
LemonBoy5247b0b2024-07-12 19:30:58 +02008116 *'tabclose'* *'tcl'*
8117'tabclose' 'tcl' string (default "")
8118 global
8119 This option controls the behavior when closing tab pages (e.g., using
8120 |:tabclose|). When empty Vim goes to the next (right) tab page.
8121
8122 Possible values (comma-separated list):
8123 left If included, go to the previous tab page instead of
8124 the next one.
8125 uselast If included, go to the previously used tab page if
8126 possible. This option takes precedence over the
8127 others.
8128
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008129 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008130'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008131 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008132 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008133 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008134 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008135
8136 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008137 option and only when there is no GUI tab line. When 'e' is in
8138 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008139 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008140
8141 The value is evaluated like with 'statusline'. You can use
8142 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008143 the text to be displayed. Use "%1T" for the first label, "%2T" for
8144 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008145
Bram Moolenaare12bab32019-01-08 22:02:56 +01008146 When changing something that is used in 'tabline' that does not
8147 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008148 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008149
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008150 Keep in mind that only one of the tab pages is the current one, others
8151 are invisible and you can't jump to their windows.
8152
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008153 *'tabpagemax'* *'tpm'*
8154'tabpagemax' 'tpm' number (default 10)
8155 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008156 Maximum number of tab pages to be opened by the |-p| command line
8157 argument or the ":tab all" command. |tabpage|
8158
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008159 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160'tabstop' 'ts' number (default 8)
8161 local to buffer
8162 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008163 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164
8165 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008166 appear wrong in many places, e.g., when printing it.
8167 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008169 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8171 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008172 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008174 This is the recommended way, the file will look the same with other
8175 tools and when listing it in a terminal.
8176 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8177 'expandtab'. This way you will always insert spaces. The
8178 formatting will never be messed up when 'tabstop' is changed (leave
8179 it at 8 just in case). The file will be a bit larger.
8180 You do need to check if no Tabs exist in the file. You can get rid
8181 of them by first setting 'expandtab' and using `%retab!`, making
8182 sure the value of 'tabstop' is set correctly.
8183 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 'expandtab'. This way you will always insert spaces. The
8185 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008186 You do need to check if no Tabs exist in the file, just like in the
8187 item just above.
8188 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008189 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008190 works when using Vim to edit the file, other tools assume a tabstop
8191 is worth 8 spaces.
8192 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 'noexpandtab'. This should then work (for initial indents only)
8194 for any tabstop setting that people use. It might be nice to have
8195 tabs after the first non-blank inserted as spaces if you do this
8196 though. Otherwise aligned comments will be wrong when 'tabstop' is
8197 changed.
8198
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008199 If Vim is compiled with the |+vartabs| feature then the value of
8200 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8201 than an empty string.
8202
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8204'tagbsearch' 'tbs' boolean (default on)
8205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008207 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 searching makes searching for a tag a LOT faster, but a linear search
8209 will find more tags if the tags file wasn't properly sorted.
8210 Vim normally assumes that your tags files are sorted, or indicate that
8211 they are not sorted. Only when this is not the case does the
8212 'tagbsearch' option need to be switched off.
8213
8214 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008215 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 certain files, or retry all files with a linear search. When
8217 'tagbsearch' is off, only a linear search is done.
8218
8219 Linear searching is done anyway, for one file, when Vim finds a line
8220 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008221 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222< [The whitespace before and after the '0' must be a single <Tab>]
8223
8224 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008225 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 instead of a normal tag name, a retry is done with a linear search.
8227 Tags in unsorted tags files, and matches with different case will only
8228 be found in the retry.
8229
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008230 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008231 linear search can be avoided when case is ignored. Use a value of '2'
8232 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8233 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008234 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8235 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8236 used for this as well. Note that case must be folded to uppercase for
8237 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008238
8239 By default, tag searches are case-sensitive. Case is ignored when
8240 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8241 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008242 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8243 'tagcase' is "smart", and the pattern contains only lowercase
8244 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245
8246 When 'tagbsearch' is off, tags searching is slower when a full match
8247 exists, but faster when no full match exists. Tags in unsorted tags
8248 files may only be found with 'tagbsearch' off.
8249 When the tags file is not sorted, or sorted in a wrong way (not on
8250 ASCII byte value), 'tagbsearch' should be off, or the line given above
8251 must be included in the tags file.
8252 This option doesn't affect commands that find all matching tags (e.g.,
8253 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008255 *'tagcase'* *'tc'*
8256'tagcase' 'tc' string (default "followic")
8257 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008258 This option specifies how case is handled when searching the tags
8259 file:
8260 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008261 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008262 ignore Ignore case
8263 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008264 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008265 NOTE: This option is set to the Vi default value when 'compatible' is
8266 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008267
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008268 *'tagfunc'* *'tfu'*
8269'tagfunc' 'tfu' string (default: empty)
8270 local to buffer
8271 {not available when compiled without the |+eval|
8272 feature}
8273 This option specifies a function to be used to perform tag searches.
8274 The function gets the tag pattern and should return a List of matching
8275 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008276 function and an example. The value can be the name of a function, a
8277 |lambda| or a |Funcref|. See |option-value-function| for more
8278 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008279 This option cannot be set from a |modeline| or in the |sandbox|, for
8280 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008281
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 *'taglength'* *'tl'*
8283'taglength' 'tl' number (default 0)
8284 global
8285 If non-zero, tags are significant up to this number of characters.
8286
8287 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8288'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8289 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008290 If on and using a tags file in another directory, file names in that
8291 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 NOTE: This option is set to the Vi default value when 'compatible' is
8293 set and to the Vim default value when 'compatible' is reset.
8294
8295 *'tags'* *'tag'* *E433*
8296'tags' 'tag' string (default "./tags,tags", when compiled with
8297 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8298 global or local to buffer |global-local|
8299 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008300 include a space or comma in a file name, precede it with backslashes
8301 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 When a file name starts with "./", the '.' is replaced with the path
8303 of the current file. But only when the 'd' flag is not included in
8304 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8305 |tags-option|.
8306 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008307 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8308 find all files named "tags" below "/lib". The filename itself cannot
8309 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008310 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008311 The |tagfiles()| function can be used to get a list of the file names
8312 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8314 files are also supported. They are automatically recognized. The
8315 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8316 differences are ignored (MS-Windows). |emacs-tags|
8317 The use of |:set+=| and |:set-=| is preferred when adding or removing
8318 file names from the list. This avoids problems when a future version
8319 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320
8321 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8322'tagstack' 'tgst' boolean (default on)
8323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 When on, the |tagstack| is used normally. When off, a ":tag" or
8325 ":tselect" command with an argument will not push the tag onto the
8326 tagstack. A following ":tag" without an argument, a ":pop" command or
8327 any other command that uses the tagstack will use the unmodified
8328 tagstack, but does change the pointer to the active entry.
8329 Resetting this option is useful when using a ":tag" command in a
8330 mapping which should not change the tagstack.
8331
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008332 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008333'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008334 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008335 {only available when compiled with the |+tcl/dyn|
8336 feature}
8337 Specifies the name of the Tcl shared library. The default is
8338 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008339 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008340 This option cannot be set from a |modeline| or in the |sandbox|, for
8341 security reasons.
8342
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 *'term'* *E529* *E530* *E531*
8344'term' string (default is $TERM, if that fails:
8345 in the GUI: "builtin_gui"
8346 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008347 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 on Unix: "ansi"
8350 on VMS: "ansi"
8351 on Win 32: "win32")
8352 global
8353 Name of the terminal. Used for choosing the terminal control
8354 characters. Environment variables are expanded |:set_env|.
8355 For example: >
8356 :set term=$TERM
8357< See |termcap|.
8358
8359 *'termbidi'* *'tbidi'*
8360 *'notermbidi'* *'notbidi'*
8361'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 {only available when compiled with the |+arabic|
8364 feature}
8365 The terminal is in charge of Bi-directionality of text (as specified
8366 by Unicode). The terminal is also expected to do the required shaping
8367 that some languages (such as Arabic) require.
8368 Setting this option implies that 'rightleft' will not be set when
8369 'arabic' is set and the value of 'arabicshape' will be ignored.
8370 Note that setting 'termbidi' has the immediate effect that
8371 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8372 This option is reset when the GUI is started.
8373 For further details see |arabic.txt|.
8374
8375 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008376'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 Encoding used for the terminal. This specifies what character
8379 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008380 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008381 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008382 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008383 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8385 Any attempts to set a different value will be rejected, and an error
8386 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008387 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 because the Win32 system always passes Unicode characters.
8389 When empty, the same encoding is used as for the 'encoding' option.
8390 This is the normal value.
8391 Not all combinations for 'termencoding' and 'encoding' are valid. See
8392 |encoding-table|.
8393 The value for this option must be supported by internal conversions or
8394 iconv(). When this is not possible no conversion will be done and you
8395 will probably experience problems with non-ASCII characters.
8396 Example: You are working with the locale set to euc-jp (Japanese) and
8397 want to edit a UTF-8 file: >
8398 :let &termencoding = &encoding
8399 :set encoding=utf-8
8400< You need to do this when your system has no locale support for UTF-8.
8401
Bram Moolenaar938ae282023-02-20 20:44:55 +00008402 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008403'termguicolors' 'tgc' boolean (default off)
8404 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008405 {not available when compiled without the
8406 |+termguicolors| feature}
8407 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008408 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008409
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008410 Requires a ISO-8613-3 compatible terminal. If setting this option
8411 does not work (produces a colorless UI) reading |xterm-true-color|
8412 might help.
8413
8414 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8415 is required. Use this check to find out: >
8416 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008417< This requires Vim to be built with the |+vtp| feature.
8418
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008419 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008420
8421 When using Vim with Windows Terminal, the background of Windows
8422 Terminal is normally filled with the Vim background color. Setting
8423 'termguicolors' and the guibg of the Normal highlight group to NONE
8424 will make the background transparent: >
8425 :hi Normal guibg=NONE
8426<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008427 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008428
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008429 *'termwinkey'* *'twk'*
8430'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008431 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008432 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008433 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008434 The key can be specified as a single character, a |key-notation| (e.g.
8435 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8436 :set twk=X
8437 :set twk=^I
8438 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008439< The string must be one key stroke but can be multiple bytes.
8440 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008441 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008442 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008443
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008444 *'termwinscroll'* *'twsl'*
8445'termwinscroll' 'twsl' number (default 10000)
8446 local to buffer
8447 {not available when compiled without the
8448 |+terminal| feature}
8449 Number of scrollback lines to keep. When going over this limit the
8450 first 10% of the scrollback lines are deleted. This is just to reduce
8451 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008452 Also used as a limit for text sent to the terminal in one write,
8453 multiplied by the number of columns times 3 (average number of bytes
8454 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008455
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008456 *'termwinsize'* *'tws'*
8457'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008458 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008459 Size used when opening the |terminal| window. Format:
8460 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008461 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008462 - When set with a "x" (e.g., "24x80") the terminal size is not
8463 adjusted to the window size. If the window is smaller only the
8464 top-left part is displayed.
8465 - When set with a "*" (e.g., "10*50") the terminal size follows the
8466 window size, but will not be smaller than the specified rows and/or
8467 columns.
8468 - When rows is zero then use the height of the window.
8469 - When columns is zero then use the width of the window.
8470 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008471 - Can be overruled in the |term_start()| options with "term_rows" and
8472 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008473
8474 Examples:
8475 "30x0" uses 30 rows and the current window width.
8476 "20*0" uses at least 20 rows and the current window width.
8477 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008478 Note that the command running in the terminal window may still change
8479 the size of the terminal. In that case the Vim window will be
8480 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008481
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008482 *'termwintype'* *'twt'*
8483'termwintype' 'twt' string (default "")
8484 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008485 {only available when compiled with the |terminal|
8486 feature on MS-Windows}
8487 Specify the virtual console (pty) used when opening the terminal
8488 window.
8489
8490 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008491 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008492 "winpty" use winpty, fail if not supported
8493 "conpty" use |ConPTY|, fail if not supported
8494
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008495 |ConPTY| support depends on the platform. Windows 10 October 2018
8496 Update is the first version that supports ConPTY, however it is still
8497 considered unstable. ConPTY might become stable in the next release
8498 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008499 supported then you cannot open a terminal window.
8500
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 *'terse'* *'noterse'*
8502'terse' boolean (default off)
8503 global
8504 When set: Add 's' flag to 'shortmess' option (this makes the message
8505 for a search that hits the start or end of the file not being
8506 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8507 shortens a lot of messages}
8508
8509 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8510'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 This option is obsolete. Use 'fileformats'.
8513 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8514 set to the default value for the current system. When 'textauto' is
8515 reset, 'fileformats' is made empty.
8516 NOTE: This option is set to the Vi default value when 'compatible' is
8517 set and to the Vim default value when 'compatible' is reset.
8518
8519 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008520'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 others: default off)
8522 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 This option is obsolete. Use 'fileformat'.
8524 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8525 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8526 "unix".
8527
8528 *'textwidth'* *'tw'*
8529'textwidth' 'tw' number (default 0)
8530 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531 Maximum width of text that is being inserted. A longer line will be
8532 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008533 this.
8534 'textwidth' is set to 0 when the 'paste' option is set and restored
8535 when 'paste' is reset.
8536 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008538 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 NOTE: This option is set to 0 when 'compatible' is set.
8540
8541 *'thesaurus'* *'tsr'*
8542'thesaurus' 'tsr' string (default "")
8543 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008545 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8546 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008547
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008548 This option is not used if 'thesaurusfunc' is set, either for the
8549 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008550
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008551 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008553 name. See |option-backslash| about using backslashes. The use of
8554 |:set+=| and |:set-=| is preferred when adding or removing directories
8555 from the list. This avoids problems when a future version uses
8556 another default. Backticks cannot be used in this option for security
8557 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008558
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008559 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008560'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008561 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008562 {not available when compiled without the |+eval|
8563 feature}
8564 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008565 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008566 The value can be the name of a function, a |lambda| or a |Funcref|.
8567 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008568
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008569 This option cannot be set from a |modeline| or in the |sandbox|, for
8570 security reasons.
8571
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8573'tildeop' 'top' boolean (default off)
8574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 When on: The tilde command "~" behaves like an operator.
8576 NOTE: This option is reset when 'compatible' is set.
8577
8578 *'timeout'* *'to'* *'notimeout'* *'noto'*
8579'timeout' 'to' boolean (default on)
8580 global
laburnumT3f7855a2023-12-05 18:37:03 +01008581
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008583'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 These two options together determine the behavior when part of a
8586 mapped key sequence or keyboard code has been received:
8587
8588 'timeout' 'ttimeout' action ~
8589 off off do not time out
8590 on on or off time out on :mappings and key codes
8591 off on time out on key codes
8592
8593 If both options are off, Vim will wait until either the complete
8594 mapping or key sequence has been received, or it is clear that there
8595 is no mapping or key sequence for the received characters. For
8596 example: if you have mapped "vl" and Vim has received 'v', the next
8597 character is needed to see if the 'v' is followed by an 'l'.
8598 When one of the options is on, Vim will wait for about 1 second for
8599 the next character to arrive. After that the already received
8600 characters are interpreted as single characters. The waiting time can
8601 be changed with the 'timeoutlen' option.
8602 On slow terminals or very busy systems timing out may cause
8603 malfunctioning cursor keys. If both options are off, Vim waits
8604 forever after an entered <Esc> if there are key codes that start
8605 with <Esc>. You will have to type <Esc> twice. If you do not have
8606 problems with key codes, but would like to have :mapped key
8607 sequences not timing out in 1 second, set the 'ttimeout' option and
8608 reset the 'timeout' option.
8609
8610 NOTE: 'ttimeout' is reset when 'compatible' is set.
8611
8612 *'timeoutlen'* *'tm'*
8613'timeoutlen' 'tm' number (default 1000)
8614 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008615
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008617'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 The time in milliseconds that is waited for a key code or mapped key
8620 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8621 when part of a command has been typed.
8622 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8623 different timeout value for key codes is desired set 'ttimeoutlen' to
8624 a non-negative number.
8625
8626 ttimeoutlen mapping delay key code delay ~
8627 < 0 'timeoutlen' 'timeoutlen'
8628 >= 0 'timeoutlen' 'ttimeoutlen'
8629
8630 The timeout only happens when the 'timeout' and 'ttimeout' options
8631 tell so. A useful setting would be >
8632 :set timeout timeoutlen=3000 ttimeoutlen=100
8633< (time out on mapping after three seconds, time out on key codes after
8634 a tenth of a second).
8635
8636 *'title'* *'notitle'*
8637'title' boolean (default off, on when title can be restored)
8638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 When on, the title of the window will be set to the value of
8640 'titlestring' (if it is not empty), or to:
8641 filename [+=-] (path) - VIM
8642 Where:
8643 filename the name of the file being edited
8644 - indicates the file cannot be modified, 'ma' off
8645 + indicates the file was modified
8646 = indicates the file is read-only
8647 =+ indicates the file is read-only and modified
8648 (path) is the path of the file being edited
8649 - VIM the server name |v:servername| or "VIM"
8650 Only works if the terminal supports setting window titles
8651 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008652 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8654 *X11*
8655 When Vim was compiled with HAVE_X11 defined, the original title will
8656 be restored if possible. The output of ":version" will include "+X11"
8657 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8658 works for the icon name |'icon'|.
8659 But: When Vim was started with the |-X| argument, restoring the title
8660 will not work (except in the GUI).
8661 If the title cannot be restored, it is set to the value of 'titleold'.
8662 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008663 When using an xterm from a remote machine you can use this command: >
8664
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008666 ssh -X machine_name xterm &
8667<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 then the WINDOWID environment variable should be inherited and the
8669 title of the window should change back to what it should be after
8670 exiting Vim.
8671
8672 *'titlelen'*
8673'titlelen' number (default 85)
8674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008676 title. When the title is longer, only the end of the path name is
8677 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678 Using a percentage makes this adapt to the width of the window. But
8679 it won't work perfectly, because the actual number of characters
8680 available also depends on the font used and other things in the title
8681 bar. When 'titlelen' is zero the full path is used. Otherwise,
8682 values from 1 to 30000 percent can be used.
8683 'titlelen' is also used for the 'titlestring' option.
8684
8685 *'titleold'*
8686'titleold' string (default "Thanks for flying Vim")
8687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 This option will be used for the window title when exiting Vim if the
8689 original title cannot be restored. Only happens if 'title' is on or
8690 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008691 This option cannot be set from a |modeline| or in the |sandbox|, for
8692 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 *'titlestring'*
8694'titlestring' string (default "")
8695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 When this option is not empty, it will be used for the title of the
8697 window. This happens only when the 'title' option is on.
8698 Only works if the terminal supports setting window titles (currently
8699 Amiga console, Win32 console, all GUI versions and terminals with a
8700 non-empty 't_ts' option).
8701 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008702 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008703
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008705 expanded according to the rules used for 'statusline'. If it contains
8706 an invalid '%' format, the value is used as-is and no error or warning
8707 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008708 This option cannot be set in a modeline when 'modelineexpr' is off.
8709
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008711 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8713< The value of 'titlelen' is used to align items in the middle or right
8714 of the available space.
8715 Some people prefer to have the file name first: >
8716 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8717< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008718 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 separating space only when needed.
8720 NOTE: Use of special characters in 'titlestring' may cause the display
8721 to be garbled (e.g., when it contains a CR or NL character).
8722 {not available when compiled without the |+statusline| feature}
8723
8724 *'toolbar'* *'tb'*
8725'toolbar' 'tb' string (default "icons,tooltips")
8726 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008727 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008728 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 possible values are:
8730 icons Toolbar buttons are shown with icons.
8731 text Toolbar buttons shown with text.
8732 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008733 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 tooltips Tooltips are active for toolbar buttons.
8735 Tooltips refer to the popup help text which appears after the mouse
8736 cursor is placed over a toolbar button for a brief moment.
8737
8738 If you want the toolbar to be shown with icons as well as text, do the
8739 following: >
8740 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008741< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 will show icons if both are requested.
8743
8744 If none of the strings specified in 'toolbar' are valid or if
8745 'toolbar' is empty, this option is ignored. If you want to disable
8746 the toolbar, you need to set the 'guioptions' option. For example: >
8747 :set guioptions-=T
8748< Also see |gui-toolbar|.
8749
8750 *'toolbariconsize'* *'tbis'*
8751'toolbariconsize' 'tbis' string (default "small")
8752 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008753 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008755 tiny Use tiny icons.
8756 small Use small icons (default).
8757 medium Use medium-sized icons.
8758 large Use large icons.
8759 huge Use even larger icons.
8760 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008762 the current theme. Common dimensions are giant=48x48, huge=32x32,
8763 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764
8765 If 'toolbariconsize' is empty, the global default size as determined
8766 by user preferences or the current theme is used.
8767
8768 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8769'ttybuiltin' 'tbi' boolean (default on)
8770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 When on, the builtin termcaps are searched before the external ones.
8772 When off the builtin termcaps are searched after the external ones.
8773 When this option is changed, you should set the 'term' option next for
8774 the change to take effect, for example: >
8775 :set notbi term=$TERM
8776< See also |termcap|.
8777 Rationale: The default for this option is "on", because the builtin
8778 termcap entries are generally better (many systems contain faulty
8779 xterm entries...).
8780
8781 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008782'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 Indicates a fast terminal connection. More characters will be sent to
8785 the screen for redrawing, instead of using insert/delete line
8786 commands. Improves smoothness of redrawing when there are multiple
8787 windows and the terminal does not support a scrolling region.
8788 Also enables the extra writing of characters at the end of each screen
8789 line for lines that wrap. This helps when using copy/paste with the
8790 mouse in an xterm and other terminals.
8791
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008792 The default used to be set only for some terminal names, but these
8793 days nearly all terminals are fast, therefore the default is now "on".
8794 If you have a slow connection you may want to set this option off,
8795 e.g. depending on the host name: >
8796 if hostname() =~ 'faraway'
8797 set nottyfast
8798 endif
8799<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 *'ttymouse'* *'ttym'*
8801'ttymouse' 'ttym' string (default depends on 'term')
8802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 {only in Unix and VMS, doesn't work in the GUI; not
8804 available when compiled without |+mouse|}
8805 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008806 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 *xterm-mouse*
8808 xterm xterm-like mouse handling. The mouse generates
8809 "<Esc>[Mscr", where "scr" is three bytes:
8810 "s" = button state
8811 "c" = column plus 33
8812 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008813 This only works up to 223 columns! See "dec",
8814 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 xterm2 Works like "xterm", but with the xterm reporting the
8816 mouse position while the mouse is dragged. This works
8817 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008818 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 work. See below for how Vim detects this
8820 automatically.
8821 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008822 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008824 for the row and column. No other mouse events are
8825 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 *dec-mouse*
8827 dec DEC terminal mouse handling. The mouse generates a
8828 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008829 This is also available for an Xterm, if it was
8830 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 *jsbterm-mouse*
8832 jsbterm JSB term mouse handling.
8833 *pterm-mouse*
8834 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008835 *urxvt-mouse*
8836 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008837 The mouse works only if the terminal supports this
8838 encoding style, but it does not have 223 columns limit
8839 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008840 *sgr-mouse*
8841 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008842 mouse reporting. The mouse works even in columns
8843 beyond 223. This option is backward compatible with
8844 "xterm2" because it can also decode "xterm2" style
8845 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846
8847 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008848 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8849 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8851 recognized, if enabled at compile time. DEC terminal mouse codes
8852 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008853 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8854 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008856 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8857 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8858 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008859 If the terminfo/termcap entry "XM" exists and the first number is
8860 "1006" then 'ttymouse' will be set to "sgr". This works for many
8861 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008862 Additionally, if vim is compiled with the |+termresponse| feature and
8863 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008864 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008866 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8867 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8868 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008869 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8870 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 :set t_RV=
8872<
8873 *'ttyscroll'* *'tsl'*
8874'ttyscroll' 'tsl' number (default 999)
8875 global
8876 Maximum number of lines to scroll the screen. If there are more lines
8877 to scroll the window is redrawn. For terminals where scrolling is
8878 very slow and redrawing is not slow this can be set to a small number,
8879 e.g., 3, to speed up displaying.
8880
8881 *'ttytype'* *'tty'*
8882'ttytype' 'tty' string (default from $TERM)
8883 global
8884 Alias for 'term', see above.
8885
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008886 *'undodir'* *'udir'*
8887'undodir' 'udir' string (default ".")
8888 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008889 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008890 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008891 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008892 "." means using the directory of the file. The undo file name for
8893 "file.txt" is ".file.txt.un~".
8894 For other directories the file name is the full path of the edited
8895 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008896 When writing: The first directory that exists is used. "." always
8897 works, no directories after "." will be used for writing.
8898 When reading all entries are tried to find an undo file. The first
8899 undo file that exists is used. When it cannot be read an error is
8900 given, no further entry is used.
8901 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008902 This option cannot be set from a |modeline| or in the |sandbox|, for
8903 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008904
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008905 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008906'undofile' 'udf' boolean (default off)
8907 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008908 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008909 When on, Vim automatically saves undo history to an undo file when
8910 writing a buffer to a file, and restores undo history from the same
8911 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008912 The directory where the undo file is stored is specified by 'undodir'.
8913 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008914 The undo file is not read when 'undoreload' causes the buffer from
8915 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008916 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008917 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008918
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008920'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008921 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008923 is kept in memory, higher numbers will cause more memory to be used.
8924 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8926 itself: >
8927 set ul=0
8928< But you can also get Vi compatibility by including the 'u' flag in
8929 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008930 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008931 Set to -1 for no undo at all. You might want to do this only for the
8932 current buffer: >
8933 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008935
8936 The local value is set to -123456 when the global value is to be used.
8937
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008938 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008940 *'undoreload'* *'ur'*
8941'undoreload' 'ur' number (default 10000)
8942 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008943 Save the whole buffer for undo when reloading it. This applies to the
8944 ":e!" command and reloading for when the buffer changed outside of
8945 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008946 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008947 of lines is smaller than the value of this option.
8948 Set this option to zero to disable undo for a reload.
8949
8950 When saving undo for a reload, any undo file is not read.
8951
8952 Note that this causes the whole buffer to be stored in memory. Set
8953 this option to a lower value if you run out of memory.
8954
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 *'updatecount'* *'uc'*
8956'updatecount' 'uc' number (default: 200)
8957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 After typing this many characters the swap file will be written to
8959 disk. When zero, no swap file will be created at all (see chapter on
8960 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8961 Vim with the "-n" option, see |startup|. When editing in readonly
8962 mode this option will be initialized to 10000.
8963 The swapfile can be disabled per buffer with |'swapfile'|.
8964 When 'updatecount' is set from zero to non-zero, swap files are
8965 created for all buffers that have 'swapfile' set. When 'updatecount'
8966 is set to zero, existing swap files are not deleted.
8967 Also see |'swapsync'|.
8968 This option has no meaning in buffers where |'buftype'| is "nofile"
8969 or "nowrite".
8970
8971 *'updatetime'* *'ut'*
8972'updatetime' 'ut' number (default 4000)
8973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 If this many milliseconds nothing is typed the swap file will be
8975 written to disk (see |crash-recovery|). Also used for the
8976 |CursorHold| autocommand event.
8977
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008978 *'varsofttabstop'* *'vsts'*
8979'varsofttabstop' 'vsts' string (default "")
8980 local to buffer
8981 {only available when compiled with the |+vartabs|
8982 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008983 A list of the number of spaces that a <Tab> counts for while editing,
8984 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8985 width <Tab>s are being inserted, while in fact a mixture of spaces
8986 and <Tab>s is used. Tab widths are separated with commas, with the
8987 final value applying to all subsequent tabs.
8988
8989 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008990 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008991 to use the following: >
8992 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008993< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8994 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008995
8996 Note that the value of |'softtabstop'| will be ignored while
8997 'varsofttabstop' is set.
8998
8999 *'vartabstop'* *'vts'*
9000'vartabstop' 'vts' string (default "")
9001 local to buffer
9002 {only available when compiled with the |+vartabs|
9003 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009004 A list of the number of spaces that a <Tab> in the file counts for,
9005 separated by commas. Each value corresponds to one tab, with the
9006 final value applying to all subsequent tabs. For example: >
9007 :set vartabstop=4,20,10,8
9008< This will make the first tab 4 spaces wide, the second 20 spaces,
9009 the third 10 spaces, and all following tabs 8 spaces.
9010
9011 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9012 is set.
9013
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 *'verbose'* *'vbs'*
9015'verbose' 'vbs' number (default 0)
9016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 When bigger than zero, Vim will give messages about what it is doing.
9018 Currently, these messages are given:
9019 >= 1 When the viminfo file is read or written.
9020 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009021 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009022 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 >= 8 Files for which a group of autocommands is executed.
9024 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009025 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 >= 12 Every executed function.
9027 >= 13 When an exception is thrown, caught, finished, or discarded.
9028 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009029 >= 15 Every executed Ex command from a script (truncated at 200
9030 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009031 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032
9033 This option can also be set with the "-V" argument. See |-V|.
9034 This option is also set by the |:verbose| command.
9035
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009036 When the 'verbosefile' option is set then the verbose messages are not
9037 displayed.
9038
9039 *'verbosefile'* *'vfile'*
9040'verbosefile' 'vfile' string (default empty)
9041 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009042 When not empty all messages are written in a file with this name.
9043 When the file exists messages are appended.
9044 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009045 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009046 Setting 'verbosefile' to a new value is like making it empty first.
9047 The difference with |:redir| is that verbose messages are not
9048 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009049 This option cannot be set from a |modeline| or in the |sandbox|, for
9050 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009051
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009053'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009054 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009055 for Unix: "$HOME/.vim/view" or
9056 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009057 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009059 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 feature}
9061 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009062 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 This option cannot be set from a |modeline| or in the |sandbox|, for
9064 security reasons.
9065
9066 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009067'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009069 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009071 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009072 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 word save and restore ~
9074 cursor cursor position in file and in window
9075 folds manually created folds, opened/closed folds and local
9076 fold options
9077 options options and mappings local to a window or buffer (not
9078 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009079 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 slash backslashes in file names replaced with forward
9081 slashes
9082 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009083 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009084 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009086 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009088 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089
9090 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009091'viminfo' 'vi' string (Vi default: "", Vim default for
9092 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009093 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9094 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009096 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 feature}
9098 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009099 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9100 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009101 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009102 consisting of a single character identifying the particular parameter,
9103 followed by a number or string which specifies the value of that
9104 parameter. If a particular character is left out, then the default
9105 value is used for that parameter. The following is a list of the
9106 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009108 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 ! When included, save and restore global variables that start
9110 with an uppercase letter, and don't contain a lowercase
9111 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009112 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009113 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009114 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 " Maximum number of lines saved for each register. Old name of
9116 the '<' item, with the disadvantage that you need to put a
9117 backslash before the ", otherwise it will be recognized as the
9118 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009119 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 % When included, save and restore the buffer list. If Vim is
9121 started with a file name argument, the buffer list is not
9122 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009123 buffer list is restored from the viminfo file. Quickfix
9124 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9125 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009126 When followed by a number, the number specifies the maximum
9127 number of buffers that are stored. Without a number all
9128 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009129 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 ' Maximum number of previously edited files for which the marks
9131 are remembered. This parameter must always be included when
9132 'viminfo' is non-empty.
9133 Including this item also means that the |jumplist| and the
9134 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009135 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009137 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 patterns are also saved. When not included, the value of
9139 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009140 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009142 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009143 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 < Maximum number of lines saved for each register. If zero then
9145 registers are not saved. When not included, all lines are
9146 saved. '"' is the old name for this item.
9147 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009148 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009150 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009151 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 c When included, convert the text in the viminfo file from the
9153 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009154 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009155 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 f Whether file marks need to be stored. If zero, file marks ('0
9157 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009158 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009160 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 h Disable the effect of 'hlsearch' when loading the viminfo
9162 file. When not included, it depends on whether ":nohlsearch"
9163 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009164 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009166 the 'n'. Must be at the end of the option! If the
9167 'viminfofile' option is set, that file name overrides the one
9168 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009169 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009170 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 r Removable media. The argument is a string (up to the next
9172 ','). This parameter can be given several times. Each
9173 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009174 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9176 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9177 ignored. Maximum length of each 'r' argument is 50
9178 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009179 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 s Maximum size of an item in Kbyte. If zero then registers are
9181 not saved. Currently only applies to registers. The default
9182 "s10" will exclude registers with more than 10 Kbyte of text.
9183 Also see the '<' item above: line count limit.
9184
9185 Example: >
9186 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9187<
9188 '50 Marks will be remembered for the last 50 files you
9189 edited.
9190 <1000 Contents of registers (up to 1000 lines each) will be
9191 remembered.
9192 s100 Registers with more than 100 Kbyte text are skipped.
9193 :0 Command-line history will not be saved.
9194 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9195 no / Since '/' is not specified, the default will be used,
9196 that is, save all of the search history, and also the
9197 previous search and substitute patterns.
9198 no % The buffer list will not be saved nor read back.
9199 no h 'hlsearch' highlighting will be restored.
9200
9201 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9202 load the contents of the file, this is not done automatically.
9203
9204 This option cannot be set from a |modeline| or in the |sandbox|, for
9205 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009206 NOTE: This option is set to the Vim default value when 'compatible'
9207 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009209 *'viminfofile'* *'vif'*
9210'viminfofile' 'vif' string (default: "")
9211 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009212 {not available when compiled without the |+viminfo|
9213 feature}
9214 When non-empty, overrides the file name used for viminfo.
9215 When equal to "NONE" no viminfo file will be read or written.
9216 This option can be set with the |-i| command line flag. The |--clean|
9217 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009218 This option cannot be set from a |modeline| or in the |sandbox|, for
9219 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009220
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 *'virtualedit'* *'ve'*
9222'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009223 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009224 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 block Allow virtual editing in Visual block mode.
9226 insert Allow virtual editing in Insert mode.
9227 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009228 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009229 none When used as the local value, do not allow virtual
9230 editing even when the global value is set. When used
9231 as the global value, "none" is the same as "".
9232 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009233
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009235 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009236 of the line. Useful for selecting a rectangle in Visual mode and
9237 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009238 "onemore" is not the same, it will only allow moving the cursor just
9239 after the last character of the line. This makes some commands more
9240 consistent. Previously the cursor was always past the end of the line
9241 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009242 break some plugins or Vim scripts. For example because |l| can move
9243 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009244 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009245 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009246 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009247 It doesn't make sense to combine "all" with "onemore", but you will
9248 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009249 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009250 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251
9252 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9253'visualbell' 'vb' boolean (default off)
9254 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009255 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009257 use: >
9258 :set vb t_vb=
9259< If you want a short flash, you can use this on many terminals: >
9260 :set vb t_vb=[?5h$<100>[?5l
9261< Here $<100> specifies the time, you can use a smaller or bigger value
9262 to get a shorter or longer flash.
9263
9264 Note: Vim will limit the bell to once per half a second. This avoids
9265 having to wait for the flashing to finish when there are lots of
9266 bells, e.g. on key repeat. This also happens without 'visualbell'
9267 set.
9268
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9270 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9271 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009272
9273 Note: When the GUI starts, 't_vb' is reset to its default value. You
9274 might want to set it again in your |gvimrc|.
9275
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 Does not work on the Amiga, you always get a screen flash.
9277 Also see 'errorbells'.
9278
9279 *'warn'* *'nowarn'*
9280'warn' boolean (default on)
9281 global
9282 Give a warning message when a shell command is used while the buffer
9283 has been changed.
9284
9285 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9286'weirdinvert' 'wiv' boolean (default off)
9287 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009288 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 It is provided for backwards compatibility with version 4.x.
9290 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9291 vice versa. Has no effect when the GUI is running.
9292
9293 *'whichwrap'* *'ww'*
9294'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 Allow specified keys that move the cursor left/right to move to the
9297 previous/next line when the cursor is on the first/last character in
9298 the line. Concatenate characters to allow this for these keys:
9299 char key mode ~
9300 b <BS> Normal and Visual
9301 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009302 h "h" Normal and Visual (not recommended)
9303 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304 < <Left> Normal and Visual
9305 > <Right> Normal and Visual
9306 ~ "~" Normal
9307 [ <Left> Insert and Replace
9308 ] <Right> Insert and Replace
9309 For example: >
9310 :set ww=<,>,[,]
9311< allows wrap only when cursor keys are used.
9312 When the movement keys are used in combination with a delete or change
9313 operator, the <EOL> also counts for a character. This makes "3h"
9314 different from "3dh" when the cursor crosses the end of a line. This
9315 is also true for "x" and "X", because they do the same as "dl" and
9316 "dh". If you use this, you may also want to use the mapping
9317 ":map <BS> X" to make backspace delete the character in front of the
9318 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009319 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009320 line (not an empty line) then it will not move to the next line. This
9321 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009322 NOTE: This option is set to the Vi default value when 'compatible' is
9323 set and to the Vim default value when 'compatible' is reset.
9324
9325 *'wildchar'* *'wc'*
9326'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 Character you have to type to start wildcard expansion in the
9329 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009330 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 The character is not recognized when used inside a macro. See
9332 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009333 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009334 <Esc> can be used, but hitting it twice in a row will still exit
9335 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009336 Although 'wc' is a number option, it can be specified as a number, a
9337 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9338 preceded with a caret (e.g. `^F` is CTRL-F): >
9339 :set wc=27
9340 :set wc=X
9341 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009342 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343< NOTE: This option is set to the Vi default value when 'compatible' is
9344 set and to the Vim default value when 'compatible' is reset.
9345
9346 *'wildcharm'* *'wcm'*
9347'wildcharm' 'wcm' number (default: none (0))
9348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009350 recognized when used inside a macro. You can find "spare" command-line
9351 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352 you'll never actually type 'wildcharm', just use it in mappings that
9353 automatically invoke completion mode, e.g.: >
9354 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009355 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356< Then after typing :ss you can use CTRL-P & CTRL-N.
9357
9358 *'wildignore'* *'wig'*
9359'wildignore' 'wig' string (default "")
9360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009362 patterns is ignored when expanding |wildcards|, completing file or
9363 directory names, and influences the result of |expand()|, |glob()| and
9364 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009365 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9366 Also see 'suffixes'.
9367 Example: >
9368 :set wildignore=*.o,*.obj
9369< The use of |:set+=| and |:set-=| is preferred when adding or removing
9370 a pattern from the list. This avoids problems when a future version
9371 uses another default.
9372
h_east596a9f22023-11-21 21:24:23 +09009373 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009374'wildignorecase' 'wic' boolean (default off)
9375 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009376 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009377 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009378 Does not apply when the shell is used to expand wildcards, which
9379 happens when there are special characters.
9380
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009382'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009384 When 'wildmenu' is on, command-line completion operates in an enhanced
9385 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009386 the possible matches are shown.
9387 When 'wildoptions' contains "pum", then the completion matches are
9388 shown in a popup menu. Otherwise they are displayed just above the
9389 command line, with the first match highlighted (overwriting the status
9390 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009391 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009392 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9393 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9394 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009395 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009396 If there are more matches than can fit in the line, a ">" is shown on
9397 the right and/or a "<" is shown on the left. The status line scrolls
9398 as needed.
9399 The "wildmenu" mode is abandoned when a key is hit that is not used
9400 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009401 While the "wildmenu" is active, the following keys have special
9402 meanings:
9403 CTRL-P - go to the previous entry
9404 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 <CR> - in menu completion, when the cursor is just after a
9406 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009407 CTRL-E - end completion, go back to what was there before
9408 selecting a match.
9409 CTRL-Y - accept the currently selected match and stop
9410 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009411
9412 When not using the popup menu for command line completion, the
9413 following keys have special meanings:
9414 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009415 <Up> - in filename/menu name completion: move up into
9416 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009417 <Down> - in filename/menu name completion: move into a
9418 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009419
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009420 When using the popup menu for command line completion, the following
9421 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009422 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009423 <PageUp> - select a match several entries back
9424 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009425 <Left> - in filename/menu name completion: move up into
9426 parent directory or parent menu.
9427 <Right> - in filename/menu name completion: move into a
9428 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009429
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430 This makes the menus accessible from the console |console-menus|.
9431
9432 If you prefer the <Left> and <Right> keys to move the cursor instead
9433 of selecting a different match, use this: >
9434 :cnoremap <Left> <Space><BS><Left>
9435 :cnoremap <Right> <Space><BS><Right>
9436<
9437 The "WildMenu" highlighting is used for displaying the current match
9438 |hl-WildMenu|.
9439
9440 *'wildmode'* *'wim'*
9441'wildmode' 'wim' string (Vim default: "full")
9442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009443 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009444 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009445 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009446 first part specifies the behavior for the first use of 'wildchar',
9447 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009448
9449 Each part consists of a colon separated list consisting of the
9450 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009451 "" Complete only the first match.
9452 "full" Complete the next full match. After the last match,
9453 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009454 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009455 "longest" Complete till longest common string. If this doesn't
9456 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009458 "lastused" When completing buffer names and more than one buffer
9459 matches, sort buffers by time last used (other than
9460 the current buffer).
9461 When there is only a single match, it is fully completed in all cases.
9462
9463 Examples of useful colon-separated values:
9464 "longest:full" Like "longest", but also start 'wildmenu' if it is
9465 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466 "list:full" When more than one match, list all matches and
9467 complete first match.
9468 "list:longest" When more than one match, list all matches and
9469 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009470 "list:lastused" When more than one buffer matches, list all matches
9471 and sort buffers by time last used (other than the
9472 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009473
9474 Examples: >
9475 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009476< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 :set wildmode=longest,full
9478< Complete longest common string, then each full match >
9479 :set wildmode=list:full
9480< List all matches and complete each full match >
9481 :set wildmode=list,full
9482< List all matches without completing, then each full match >
9483 :set wildmode=longest,list
9484< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009485 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009486
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009487 *'wildoptions'* *'wop'*
9488'wildoptions' 'wop' string (default "")
9489 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009490 A list of words that change how |cmdline-completion| is done.
9491 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009492 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009493 this value is specified, wildcard expansion will not
9494 be used for completion. The matches will be sorted by
9495 the "best match" rather than alphabetically sorted.
9496 This will find more matches than the wildcard
9497 expansion. Currently fuzzy matching based completion
9498 is not supported for file and directory names and
9499 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009500 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009501 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009502 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009503 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009504 is displayed per line. Often used tag kinds are:
9505 d #define
9506 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009507
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508 *'winaltkeys'* *'wak'*
9509'winaltkeys' 'wak' string (default "menu")
9510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511 {only used in Win32, Motif, GTK and Photon GUI}
9512 Some GUI versions allow the access to menu entries by using the ALT
9513 key in combination with a character that appears underlined in the
9514 menu. This conflicts with the use of the ALT key for mappings and
9515 entering special characters. This option tells what to do:
9516 no Don't use ALT keys for menus. ALT key combinations can be
9517 mapped, but there is no automatic handling. This can then be
9518 done with the |:simalt| command.
9519 yes ALT key handling is done by the windowing system. ALT key
9520 combinations cannot be mapped.
9521 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009522 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 keys can be mapped.
9524 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9525 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009526 This option is not used for <F10>; on Win32 and with GTK <F10> will
9527 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009528
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009529 *'wincolor'* *'wcr'*
9530'wincolor' 'wcr' string (default empty)
9531 local to window
9532 Highlight group name to use for this window instead of the Normal
9533 color |hl-Normal|.
9534
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009535 *'window'* *'wi'*
9536'window' 'wi' number (default screen height - 1)
9537 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009538 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9539 window and the value is smaller than 'lines' minus one. The screen
9540 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009541 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9542 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009543 When resizing the Vim window, and the value is smaller than 1 or more
9544 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009545 Note: Do not confuse this with the height of the Vim window, use
9546 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009547
Colin Kennedy21570352024-03-03 16:16:47 +01009548 *'winfixbuf'*
9549'winfixbuf' 'wfb' boolean (default off)
9550 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009551 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009552 For example, attempting to change the buffer with |:edit| will fail.
9553 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009554 also skip any window with 'winfixbuf' enabled. However if an Ex
9555 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009556
laburnumT3f7855a2023-12-05 18:37:03 +01009557 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9558'winfixheight' 'wfh' boolean (default off)
9559 local to window |local-noglobal|
9560 Keep the window height when windows are opened or closed and
9561 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9562 |preview-window| and |quickfix-window|.
9563 The height may be changed anyway when running out of room.
9564
9565 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9566'winfixwidth' 'wfw' boolean (default off)
9567 local to window |local-noglobal|
9568 Keep the window width when windows are opened or closed and
9569 'equalalways' is set. Also for |CTRL-W_=|.
9570 The width may be changed anyway when running out of room.
9571
Bram Moolenaar071d4272004-06-13 20:20:40 +00009572 *'winheight'* *'wh'* *E591*
9573'winheight' 'wh' number (default 1)
9574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009576 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009577 focus goes to a window that is smaller, its size is increased, at the
9578 cost of the height of other windows.
9579 Set 'winheight' to a small number for normal editing.
9580 Set it to 999 to make the current window fill most of the screen.
9581 Other windows will be only 'winminheight' high. This has the drawback
9582 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9583 to create only two windows, set the option after startup is done,
9584 using the |VimEnter| event: >
9585 au VimEnter * set winheight=999
9586< Minimum value is 1.
9587 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 height of the current window.
9589 'winheight' applies to the current window. Use 'winminheight' to set
9590 the minimal height for other windows.
9591
Bram Moolenaar071d4272004-06-13 20:20:40 +00009592 *'winminheight'* *'wmh'*
9593'winminheight' 'wmh' number (default 1)
9594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009595 The minimal height of a window, when it's not the current window.
9596 This is a hard minimum, windows will never become smaller.
9597 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9598 status bar) if necessary. They will return to at least one line when
9599 they become active (since the cursor has to have somewhere to go.)
9600 Use 'winheight' to set the minimal height of the current window.
9601 This option is only checked when making a window smaller. Don't use a
9602 large number, it will cause errors when opening more than a few
9603 windows. A value of 0 to 3 is reasonable.
9604
9605 *'winminwidth'* *'wmw'*
9606'winminwidth' 'wmw' number (default 1)
9607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009608 The minimal width of a window, when it's not the current window.
9609 This is a hard minimum, windows will never become smaller.
9610 When set to zero, windows may be "squashed" to zero columns (i.e. just
9611 a vertical separator) if necessary. They will return to at least one
9612 line when they become active (since the cursor has to have somewhere
9613 to go.)
9614 Use 'winwidth' to set the minimal width of the current window.
9615 This option is only checked when making a window smaller. Don't use a
9616 large number, it will cause errors when opening more than a few
9617 windows. A value of 0 to 12 is reasonable.
9618
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009619 *'winptydll'*
9620'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9621 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009622 {only available when compiled with the |terminal|
9623 feature on MS-Windows}
9624 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009625 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009626 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009627 a fallback.
9628 Environment variables are expanded |:set_env|.
9629 This option cannot be set from a |modeline| or in the |sandbox|, for
9630 security reasons.
9631
Bram Moolenaar071d4272004-06-13 20:20:40 +00009632 *'winwidth'* *'wiw'* *E592*
9633'winwidth' 'wiw' number (default 20)
9634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009635 Minimal number of columns for the current window. This is not a hard
9636 minimum, Vim will use fewer columns if there is not enough room. If
9637 the current window is smaller, its size is increased, at the cost of
9638 the width of other windows. Set it to 999 to make the current window
9639 always fill the screen. Set it to a small number for normal editing.
9640 The width is not adjusted after one of the commands to change the
9641 width of the current window.
9642 'winwidth' applies to the current window. Use 'winminwidth' to set
9643 the minimal width for other windows.
9644
9645 *'wrap'* *'nowrap'*
9646'wrap' boolean (default on)
9647 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009648 This option changes how text is displayed. It doesn't change the text
9649 in the buffer, see 'textwidth' for that.
9650 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009651 displaying continues on the next line. When off lines will not wrap
9652 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009653 moved to a part that is not shown, the screen will scroll
9654 horizontally.
9655 The line will be broken in the middle of a word if necessary. See
9656 'linebreak' to get the break at a word boundary.
9657 To make scrolling horizontally a bit more useful, try this: >
9658 :set sidescroll=5
9659 :set listchars+=precedes:<,extends:>
9660< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009661 This option can't be set from a |modeline| when the 'diff' option is
9662 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009663
9664 *'wrapmargin'* *'wm'*
9665'wrapmargin' 'wm' number (default 0)
9666 local to buffer
9667 Number of characters from the right window border where wrapping
9668 starts. When typing text beyond this limit, an <EOL> will be inserted
9669 and inserting continues on the next line.
9670 Options that add a margin, such as 'number' and 'foldcolumn', cause
9671 the text width to be further reduced. This is Vi compatible.
9672 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009673 This option is set to 0 when 'paste' is set and restored when 'paste'
9674 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009675 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009676
9677 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9678'wrapscan' 'ws' boolean (default on) *E384* *E385*
9679 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009680 Searches wrap around the end of the file. Also applies to |]s| and
9681 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009682
9683 *'write'* *'nowrite'*
9684'write' boolean (default on)
9685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009686 Allows writing files. When not set, writing a file is not allowed.
9687 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009688 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009689 argument. Filtering text is still possible, even though this requires
9690 writing a temporary file.
9691
9692 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9693'writeany' 'wa' boolean (default off)
9694 global
9695 Allows writing to any file with no need for "!" override.
9696
9697 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9698'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9699 otherwise)
9700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009701 Make a backup before overwriting a file. The backup is removed after
9702 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009703 also on.
9704 WARNING: Switching this option off means that when Vim fails to write
9705 your buffer correctly and then, for whatever reason, Vim exits, you
9706 lose both the original file and what you were writing. Only reset
9707 this option if your file system is almost full and it makes the write
9708 fail (and make sure not to exit Vim until the write was successful).
9709 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009710 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009711 Depending on 'backupcopy' the backup is a new file or the original
9712 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009713 NOTE: This option is set to the default value when 'compatible' is
9714 set.
9715
9716 *'writedelay'* *'wd'*
9717'writedelay' 'wd' number (default 0)
9718 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009719 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009720 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009721 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009722
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009723 *'xtermcodes'* *'noxtermcodes'*
9724'xtermcodes' boolean (default on)
9725 global
9726 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009727 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009728 key codes and number of colors from the terminal. This takes care of
9729 various configuration options of the terminal that cannot be obtained
9730 from the termlib/terminfo entry, see |xterm-codes|.
9731 A side effect may be that t_Co changes and Vim will redraw the
9732 display.
9733
9734
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009735 vim:tw=78:ts=8:noet:ft=help:norl: