blob: 48b4b599ae34fad1624baf25a6e5e52accecd97b [file] [log] [blame]
glepnira2c55592025-02-28 17:43:42 +01001*options.txt* For Vim version 9.1. Last change: 2025 Feb 28
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*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
1720 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1721'cindent' 'cin' boolean (default off)
1722 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001723 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 that trigger reindenting in insert mode and 'cinoptions' to set your
1725 preferred indent style.
1726 If 'indentexpr' is not empty, it overrules 'cindent'.
1727 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1728 the "=" operator indents using this algorithm rather than calling an
1729 external program.
1730 See |C-indenting|.
1731 When you don't like the way 'cindent' works, try the 'smartindent'
1732 option or 'indentexpr'.
1733 This option is not used when 'paste' is set.
1734 NOTE: This option is reset when 'compatible' is set.
1735
1736 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001737'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 A list of keys that, when typed in Insert mode, cause reindenting of
1740 the current line. Only used if 'cindent' is on and 'indentexpr' is
1741 empty.
1742 For the format of this option see |cinkeys-format|.
1743 See |C-indenting|.
1744
1745 *'cinoptions'* *'cino'*
1746'cinoptions' 'cino' string (default "")
1747 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1749 program. See |cinoptions-values| for the values of this option, and
1750 |C-indenting| for info on C indenting in general.
1751
laburnumT3f7855a2023-12-05 18:37:03 +01001752 *'cinscopedecls'* *'cinsd'*
1753'cinscopedecls' 'cinsd' string (default "public,protected,private")
1754 local to buffer
1755 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1756 Useful e.g. for working with the Qt framework that defines additional
1757 scope declarations "signals", "public slots" and "private slots": >
1758 set cinscopedecls+=signals,public\ slots,private\ slots
1759<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *'cinwords'* *'cinw'*
1761'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 These keywords start an extra indent in the next line when
1764 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1765 an appropriate place (inside {}).
1766 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1767 matter, include the keyword both the uppercase and lowercase:
1768 "if,If,IF".
1769
laburnumT3f7855a2023-12-05 18:37:03 +01001770 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1772 for X-windows, "" otherwise)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 {only in GUI versions or when the |+xterm_clipboard|
1775 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001776 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001778 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001779 prepend, e.g.: >
1780 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001781< When using the GUI see |'go-A'|.
1782 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001784 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 unnamed When included, Vim will use the clipboard register '*'
1786 for all yank, delete, change and put operations which
1787 would normally go to the unnamed register. When a
1788 register is explicitly specified, it will always be
1789 used regardless of whether "unnamed" is in 'clipboard'
1790 or not. The clipboard register can always be
1791 explicitly accessed using the "* notation. Also see
1792 |gui-clipboard|.
1793
Bram Moolenaar30b65812012-07-12 22:01:11 +02001794 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001795 unnamedplus A variant of the "unnamed" flag which uses the
1796 clipboard register '+' (|quoteplus|) instead of
1797 register '*' for all yank, delete, change and put
1798 operations which would normally go to the unnamed
1799 register. When "unnamed" is also included to the
1800 option, yank operations (but not delete, change or
1801 put) will additionally copy the text into register
1802 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001803 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001804 Availability can be checked with: >
1805 if has('unnamedplus')
1806<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 autoselect Works like the 'a' flag in 'guioptions': If present,
1809 then whenever Visual mode is started, or the Visual
1810 area extended, Vim tries to become the owner of the
1811 windowing system's global selection or put the
1812 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001813 register "*. See |'go-a'| and |quotestar| for details.
1814 When the GUI is active, the 'a' flag in 'guioptions'
1815 is used, when the GUI is not active, this "autoselect"
1816 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 Also applies to the modeless selection.
1818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-autoselectplus*
1820 autoselectplus Like "autoselect" but using the + register instead of
1821 the * register. Compare to the 'P' flag in
1822 'guioptions'.
1823
1824 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 autoselectml Like "autoselect", but for the modeless selection
1826 only. Compare to the 'A' flag in 'guioptions'.
1827
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001828 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001829 html When the clipboard contains HTML, use this when
1830 pasting. When putting text on the clipboard, mark it
1831 as HTML. This works to copy rendered HTML from
1832 Firefox, paste it as raw HTML in Vim, select the HTML
1833 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001834 You probably want to add this only temporarily,
1835 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001837
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001838 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 exclude:{pattern}
1840 Defines a pattern that is matched against the name of
1841 the terminal 'term'. If there is a match, no
1842 connection will be made to the X server. This is
1843 useful in this situation:
1844 - Running Vim in a console.
1845 - $DISPLAY is set to start applications on another
1846 display.
1847 - You do not want to connect to the X server in the
1848 console, but do want this in a terminal emulator.
1849 To never connect to the X server use: >
1850 exclude:.*
1851< This has the same effect as using the |-X| argument.
1852 Note that when there is no connection to the X server
1853 the window title won't be restored and the clipboard
1854 cannot be accessed.
1855 The value of 'magic' is ignored, {pattern} is
1856 interpreted as if 'magic' was on.
1857 The rest of the option value will be used for
1858 {pattern}, this must be the last entry.
1859
1860 *'cmdheight'* *'ch'*
1861'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001862 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001863 Number of screen lines to use for the command-line. A larger value
1864 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001865 The value of this option is stored with the tab page, so that each tab
1866 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867
1868 *'cmdwinheight'* *'cwh'*
1869'cmdwinheight' 'cwh' number (default 7)
1870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 Number of screen lines to use for the command-line window. |cmdwin|
1872
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001873 *'colorcolumn'* *'cc'*
1874'colorcolumn' 'cc' string (default "")
1875 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001876 {not available when compiled without the |+syntax|
1877 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001878 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001879 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1880 text. Will make screen redrawing slower.
1881 The screen column can be an absolute number, or a number preceded with
1882 '+' or '-', which is added to or subtracted from 'textwidth'. >
1883
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001884 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001885 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1886 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1887<
1888 When 'textwidth' is zero then the items with '-' and '+' are not used.
1889 A maximum of 256 columns are highlighted.
1890
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *'columns'* *'co'* *E594*
1892'columns' 'co' number (default 80 or terminal width)
1893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001895 initialization and does not have to be set by hand. Also see
1896 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 When Vim is running in the GUI or in a resizable window, setting this
1898 option will cause the window size to be changed. When you only want
1899 to use the size for the GUI, put the command in your |gvimrc| file.
1900 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001901 number of columns of the display, the display may be messed up. For
1902 the GUI it is always possible and Vim limits the number of columns to
1903 what fits on the screen. You can use this command to get the widest
1904 window possible: >
1905 :set columns=9999
1906< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907
1908 *'comments'* *'com'* *E524* *E525*
1909'comments' 'com' string (default
1910 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1911 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001912 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 |format-comments|. See |option-backslash| about using backslashes to
1914 insert a space.
1915
1916 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001917'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 {not available when compiled without the |+folding|
1920 feature}
1921 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001922 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001923 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001924 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
1926 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001928 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 This option has the effect of making Vim either more Vi-compatible, or
1931 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 other options are also changed as a side effect.
1935 NOTE: Setting or resetting this option can have a lot of unexpected
1936 effects: Mappings are interpreted in another way, undo behaves
1937 differently, etc. If you set this option in your vimrc file, you
1938 should probably put it at the very start.
1939
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 By default this option is on and the Vi defaults are used for the
1941 options. This default was chosen for those people who want to use Vim
1942 just like Vi, and don't even (want to) know about the 'compatible'
1943 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001944 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001945 this option is switched off, and all options that have not been
1946 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001947 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001948 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001949 happen for the system-wide vimrc or gvimrc file, nor for a file given
1950 with the |-u| argument). Also see |compatible-default| and
1951 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 You can also set this option with the "-C" argument, and reset it with
1953 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 When this option is set, numerous other options are set to make Vim as
1957 Vi-compatible as possible. When this option is unset, various options
1958 are set to make Vim more useful. The table below lists all the
1959 options affected.
1960 The {?} column indicates when the options are affected:
1961 + Means that the option is set to the value given in {set value} when
1962 'compatible' is set.
1963 & Means that the option is set to the value given in {set value} when
1964 'compatible' is set AND is set to its Vim default value when
1965 'compatible' is unset.
1966 - Means the option is NOT changed when setting 'compatible' but IS
1967 set to its Vim default when 'compatible' is unset.
1968 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
Bram Moolenaar036986f2017-03-16 17:41:02 +01001970 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971
1972 'allowrevins' + off no CTRL-_ command
1973 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001974 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001975 'arabicshape' + on correct character shapes
1976 'backspace' + "" normal backspace
1977 'backup' + off no backup file
1978 'backupcopy' & Unix: "yes" backup file is a copy
1979 else: "auto" copy or rename backup file
1980 'balloonexpr' + "" text to show in evaluation balloon
1981 'breakindent' + off don't indent when wrapping lines
1982 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001983 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cindent' + off no C code indentation
1985 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1986 'copyindent' + off don't copy indent structure
1987 'cpoptions' & (all flags) Vi-compatible flags
1988 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001989 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001991 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'cscopeverbose' + off see |cscopeverbose|
1993 'delcombine' + off unicode: delete whole char combination
1994 'digraph' + off no digraphs
1995 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001996 this also disables |modifyOtherKeys|
1997 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001998 'expandtab' + off tabs not expanded to spaces
1999 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002000 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002001 'formatexpr' + "" use 'formatprg' for auto-formatting
2002 'formatoptions' & "vt" Vi compatible formatting
2003 'gdefault' + off no default 'g' flag for ":s"
2004 'history' & 0 no commandline history
2005 'hkmap' + off no Hebrew keyboard mapping
2006 'hkmapp' + off no phonetic Hebrew keyboard mapping
2007 'hlsearch' + off no highlighting of search matches
2008 'incsearch' + off no incremental searching
2009 'indentexpr' + "" no indenting by expression
2010 'insertmode' + off do not start in Insert mode
2011 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002013 'joinspaces' + on insert 2 spaces after period
2014 'modeline' & off no modelines
2015 'more' & off no pauses in listings
2016 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2017 'numberwidth' & 8 min number of columns for line number
2018 'preserveindent'+ off don't preserve current indent structure
2019 when changing it
2020 'revins' + off no reverse insert
2021 'ruler' + off no ruler
2022 'scrolljump' + 1 no jump scroll
2023 'scrolloff' + 0 no scroll offset
2024 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2025 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002026 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002027 'showcmd' & off command characters not shown
2028 'showmode' & off current mode not shown
2029 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2030 'smartcase' + off no automatic ignore case switch
2031 'smartindent' + off no smart indentation
2032 'smarttab' + off no smart tab size
2033 'softtabstop' + 0 tabs are always 'tabstop' positions
2034 'startofline' + on goto startofline with some commands
2035 'tagcase' & "followic" 'ignorecase' when searching tags file
2036 'tagrelative' & off tag file names are not relative
2037 'termguicolors' + off don't use highlight-(guifg|guibg)
2038 'textauto' & off no automatic textmode detection
2039 'textwidth' + 0 no automatic line wrap
2040 'tildeop' + off tilde is not an operator
2041 'ttimeout' + off no terminal timeout
2042 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'virtualedit' + "" cursor can only be placed on characters
2045 'whichwrap' & "" left-right movements don't wrap
2046 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002048 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
2050 *'complete'* *'cpt'* *E535*
2051'complete' 'cpt' string (default: ".,w,b,u,t,i")
2052 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 This option specifies how keyword completion |ins-completion| works
2054 when CTRL-P or CTRL-N are used. It is also used for whole-line
2055 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002056 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002057 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 w scan buffers from other windows
2059 b scan other loaded buffers that are in the buffer list
2060 u scan the unloaded buffers that are in the buffer list
2061 U scan the buffers that are not in the buffer list
2062 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002063 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 k{dict} scan the file {dict}. Several "k" flags can be given,
2065 patterns are valid too. For example: >
2066 :set cpt=k/usr/dict/*,k~/spanish
2067< s scan the files given with the 'thesaurus' option
2068 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2069 are valid too.
2070 i scan current and included files
2071 d scan current and included files for defined name or macro
2072 |i_CTRL-X_CTRL-D|
2073 ] tag completion
2074 t same as "]"
2075
2076 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2077 not executed, this may lead to unexpected completions from some files
2078 (gzipped files for example). Unloaded buffers are not scanned for
2079 whole-line completion.
2080
2081 The default is ".,w,b,u,t,i", which means to scan:
2082 1. the current buffer
2083 2. buffers in other windows
2084 3. other loaded buffers
2085 4. unloaded buffers
2086 5. tags
2087 6. included files
2088
2089 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002090 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2091 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002093 *'completefunc'* *'cfu'*
2094'completefunc' 'cfu' string (default: empty)
2095 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002096 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002097 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002098 This option specifies a function to be used for Insert mode completion
2099 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002100 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002101 invoked and what it should return. The value can be the name of a
2102 function, a |lambda| or a |Funcref|. See |option-value-function| for
2103 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002104 This option cannot be set from a |modeline| or in the |sandbox|, for
2105 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002106
glepnir6a89c942024-10-01 20:32:12 +02002107 *'completeitemalign'* *'cia'*
2108'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2109 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002110 A comma-separated list of strings that controls the alignment and
2111 display order of items in the popup menu during Insert mode
2112 completion. The supported values are "abbr", "kind", and "menu".
2113 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002114 popup menu. Note: must always contain those three values in any
2115 order.
2116
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002117 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002118'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002119 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002120 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002121 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002122
glepnira2c55592025-02-28 17:43:42 +01002123 fuzzy Enable |fuzzy-matching| for completion candidates. This
2124 allows for more flexible and intuitive matching, where
2125 characters can be skipped and matches can be found even
2126 if the exact sequence is not typed.
2127
2128 longest Only insert the longest common text of the matches. If
2129 the menu is displayed you can use CTRL-L to add more
2130 characters. Whether case is ignored depends on the kind
2131 of completion. For buffer text the 'ignorecase' option is
2132 used.
2133
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002134 menu Use a popup menu to show the possible completions. The
2135 menu is only shown when there is more than one match and
2136 sufficient colors are available. |ins-completion-menu|
2137
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002138 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002139 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002140 match, e.g., what file it comes from.
2141
glepnira2c55592025-02-28 17:43:42 +01002142 noinsert Do not insert any text for a match until the user selects
2143 a match from the menu. Only works in combination with
2144 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002145
glepnira2c55592025-02-28 17:43:42 +01002146 noselect Same as "noinsert", except that no menu item is
2147 pre-selected. If both "noinsert" and "noselect" are
2148 present, "noselect" has precedence.
2149
2150 nosort Disable sorting of completion candidates based on fuzzy
2151 scores when "fuzzy" is enabled. Candidates will appear
2152 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002153
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002154 popup Show extra information about the currently selected
2155 completion in a popup window. Only works in combination
2156 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002157 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002158 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002159
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002160 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002161 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002162 |CompleteChanged| autocommand to fetch the info and call
2163 |popup_show()| once the popup has been filled.
2164 See the example at |complete-popuphidden|.
2165 {only works when compiled with the |+textprop| feature}
2166
glepniredd4ac32025-01-29 18:53:51 +01002167 preinsert
2168 Preinsert the portion of the first candidate word that is
2169 not part of the current completion leader and using the
2170 |hl-ComplMatchIns| highlight group. Does not work when
glepnira2c55592025-02-28 17:43:42 +01002171 "fuzzy" is set. Requires both "menu" and "menuone" to be
2172 set.
2173
2174 preview Show extra information about the currently selected
2175 completion in the preview window. Only works in
2176 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002177
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002178 *'completepopup'* *'cpp'*
2179'completepopup' 'cpp' string (default empty)
2180 global
2181 {not available when compiled without the |+textprop|
2182 or |+quickfix| feature}
2183 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002184 properties of the info popup when it is created. If an info popup
2185 window already exists it is closed, so that the option value is
2186 applied when it is created again.
2187 You can also use |popup_findinfo()| and then set properties for an
2188 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002189
laburnumT3f7855a2023-12-05 18:37:03 +01002190 *'completeslash'* *'csl'*
2191'completeslash' 'csl' string (default: "")
2192 local to buffer
2193 {only for MS-Windows}
2194 When this option is set it overrules 'shellslash' for completion:
2195 - When this option is set to "slash", a forward slash is used for path
2196 completion in insert mode. This is useful when editing HTML tag, or
2197 Makefile with 'noshellslash' on MS-Windows.
2198 - When this option is set to "backslash", backslash is used. This is
2199 useful when editing a batch file with 'shellslash' set on MS-Windows.
2200 - When this option is empty, same character is used as for
2201 'shellslash'.
2202 For Insert mode completion the buffer-local value is used. For
2203 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002204
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002205 *'concealcursor'* *'cocu'*
2206'concealcursor' 'cocu' string (default: "")
2207 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002208 {not available when compiled without the |+conceal|
2209 feature}
2210 Sets the modes in which text in the cursor line can also be concealed.
2211 When the current mode is listed then concealing happens just like in
2212 other lines.
2213 n Normal mode
2214 v Visual mode
2215 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002216 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002217
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002218 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002219 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002220 are moving around text is concealed, but when starting to insert text
2221 or selecting a Visual area the concealed text is displayed, so that
2222 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002223 Keep in mind that the cursor position is not always where it's
2224 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002225
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002226 *'conceallevel'* *'cole'*
2227'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002228 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002229 {not available when compiled without the |+conceal|
2230 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002231 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2232 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002233
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002234 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002235 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002236 1 Each block of concealed text is replaced with one
2237 character. If the syntax item does not have a custom
2238 replacement character defined (see |:syn-cchar|) the
2239 character defined in 'listchars' is used (default is a
2240 space).
2241 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002242 2 Concealed text is completely hidden unless it has a
2243 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002244 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002245 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002246
Bram Moolenaara7781e02010-07-19 20:13:22 +02002247 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002248 edit and copy the text. This can be changed with the 'concealcursor'
2249 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002250
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2252'confirm' 'cf' boolean (default off)
2253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 When 'confirm' is on, certain operations that would normally
2255 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2256 instead raise a |dialog| asking if you wish to save the current
2257 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2258 If 'confirm' is off you can still activate confirmation for one
2259 command only (this is most useful in mappings) with the |:confirm|
2260 command.
2261 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2262
2263 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2264'conskey' 'consk' boolean (default off)
2265 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002266 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267
2268 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2269'copyindent' 'ci' boolean (default off)
2270 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 Copy the structure of the existing lines indent when autoindenting a
2272 new line. Normally the new indent is reconstructed by a series of
2273 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2274 in which case only spaces are used). Enabling this option makes the
2275 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002276 existing line. 'expandtab' has no effect on these characters, a Tab
2277 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002279 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 Also see 'preserveindent'.
2281
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002282 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002283'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2284 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002285 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002288 this indicates Vi-compatible behavior. This is used for things where
2289 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 'cpoptions' stands for "compatible-options".
2291 Commas can be added for readability.
2292 To avoid problems with flags that are added in the future, use the
2293 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002294
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 NOTE: This option is set to the Vi default value when 'compatible' is
2296 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002297
2298 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2299 is saved, 'cpoptions' is set to the Vim default, and the saved value
2300 is restored at the end of the script. Changes to the value of
2301 'cpoptions' will be applied to the saved value, but keep in mind that
2302 removing a flag that is not present when 'cpoptions' is changed has no
2303 effect. In the |.vimrc| file the value is not restored, thus using
2304 `vim9script` in the |.vimrc| file results in using the Vim default.
2305
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002306 NOTE: This option is set to the POSIX default value at startup when
2307 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002308 variable exists |posix|. This means Vim tries to behave like the
2309 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310
2311 contains behavior ~
2312 *cpo-a*
2313 a When included, a ":read" command with a file name
2314 argument will set the alternate file name for the
2315 current window.
2316 *cpo-A*
2317 A When included, a ":write" command with a file name
2318 argument will set the alternate file name for the
2319 current window.
2320 *cpo-b*
2321 b "\|" in a ":map" command is recognized as the end of
2322 the map command. The '\' is included in the mapping,
2323 the text after the '|' is interpreted as the next
2324 command. Use a CTRL-V instead of a backslash to
2325 include the '|' in the mapping. Applies to all
2326 mapping, abbreviation, menu and autocmd commands.
2327 See also |map_bar|.
2328 *cpo-B*
2329 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002330 abbreviations, user commands and the "to" part of the
2331 menu commands. Remove this flag to be able to use a
2332 backslash like a CTRL-V. For example, the command
2333 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 'B' included: "\^[" (^[ is a real <Esc>)
2335 'B' excluded: "<Esc>" (5 characters)
2336 ('<' excluded in both cases)
2337 *cpo-c*
2338 c Searching continues at the end of any match at the
2339 cursor position, but not further than the start of the
2340 next line. When not present searching continues
2341 one character from the cursor position. With 'c'
2342 "abababababab" only gets three matches when repeating
2343 "/abab", without 'c' there are five matches.
2344 *cpo-C*
2345 C Do not concatenate sourced lines that start with a
2346 backslash. See |line-continuation|.
2347 *cpo-d*
2348 d Using "./" in the 'tags' option doesn't mean to use
2349 the tags file relative to the current file, but the
2350 tags file in the current directory.
2351 *cpo-D*
2352 D Can't use CTRL-K to enter a digraph after Normal mode
2353 commands with a character argument, like |r|, |f| and
2354 |t|.
2355 *cpo-e*
2356 e When executing a register with ":@r", always add a
2357 <CR> to the last line, also when the register is not
2358 linewise. If this flag is not present, the register
2359 is not linewise and the last line does not end in a
2360 <CR>, then the last line is put on the command-line
2361 and can be edited before hitting <CR>.
2362 *cpo-E*
2363 E It is an error when using "y", "d", "c", "g~", "gu" or
2364 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002365 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 This makes "y0" fail in the first column.
2367 *cpo-f*
2368 f When included, a ":read" command with a file name
2369 argument will set the file name for the current buffer,
2370 if the current buffer doesn't have a file name yet.
2371 *cpo-F*
2372 F When included, a ":write" command with a file name
2373 argument will set the file name for the current
2374 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002375 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 *cpo-g*
2377 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002378 *cpo-H*
2379 H When using "I" on a line with only blanks, insert
2380 before the last blank. Without this flag insert after
2381 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 *cpo-i*
2383 i When included, interrupting the reading of a file will
2384 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002385 *cpo-I*
2386 I When moving the cursor up or down just after inserting
2387 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 *cpo-j*
2389 j When joining lines, only add two spaces after a '.',
2390 not after '!' or '?'. Also see 'joinspaces'.
2391 *cpo-J*
2392 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002393 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 white space.
2395 *cpo-k*
2396 k Disable the recognition of raw key codes in
2397 mappings, abbreviations, and the "to" part of menu
2398 commands. For example, if <Key> sends ^[OA (where ^[
2399 is <Esc>), the command ":map X ^[OA" results in X
2400 being mapped to:
2401 'k' included: "^[OA" (3 characters)
2402 'k' excluded: "<Key>" (one key code)
2403 Also see the '<' flag below.
2404 *cpo-K*
2405 K Don't wait for a key code to complete when it is
2406 halfway a mapping. This breaks mapping <F1><F1> when
2407 only part of the second <F1> has been read. It
2408 enables cancelling the mapping by typing <F1><Esc>.
2409 *cpo-l*
2410 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002411 literally, only "\]", "\^", "\-" and "\\" are special.
2412 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2414 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002415 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 *cpo-L*
2417 L When the 'list' option is set, 'wrapmargin',
2418 'textwidth', 'softtabstop' and Virtual Replace mode
2419 (see |gR|) count a <Tab> as two characters, instead of
2420 the normal behavior of a <Tab>.
2421 *cpo-m*
2422 m When included, a showmatch will always wait half a
2423 second. When not included, a showmatch will wait half
2424 a second or until a character is typed. |'showmatch'|
2425 *cpo-M*
2426 M When excluded, "%" matching will take backslashes into
2427 account. Thus in "( \( )" and "\( ( \)" the outer
2428 parenthesis match. When included "%" ignores
2429 backslashes, which is Vi compatible.
2430 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002431 n When included, the column used for 'number' and
2432 'relativenumber' will also be used for text of wrapped
2433 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 *cpo-o*
2435 o Line offset to search command is not remembered for
2436 next search.
2437 *cpo-O*
2438 O Don't complain if a file is being overwritten, even
2439 when it didn't exist when editing it. This is a
2440 protection against a file unexpectedly created by
2441 someone else. Vi didn't complain about this.
2442 *cpo-p*
2443 p Vi compatible Lisp indenting. When not present, a
2444 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002445 *cpo-P*
2446 P When included, a ":write" command that appends to a
2447 file will set the file name for the current buffer, if
2448 the current buffer doesn't have a file name yet and
2449 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002450 *cpo-q*
2451 q When joining multiple lines leave the cursor at the
2452 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 *cpo-r*
2454 r Redo ("." command) uses "/" to repeat a search
2455 command, instead of the actually used search string.
2456 *cpo-R*
2457 R Remove marks from filtered lines. Without this flag
2458 marks are kept like |:keepmarks| was used.
2459 *cpo-s*
2460 s Set buffer options when entering the buffer for the
2461 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002462 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 set when the buffer is created.
2464 *cpo-S*
2465 S Set buffer options always when entering a buffer
2466 (except 'readonly', 'fileformat', 'filetype' and
2467 'syntax'). This is the (most) Vi compatible setting.
2468 The options are set to the values in the current
2469 buffer. When you change an option and go to another
2470 buffer, the value is copied. Effectively makes the
2471 buffer options global to all buffers.
2472
2473 's' 'S' copy buffer options
2474 no no when buffer created
2475 yes no when buffer first entered (default)
2476 X yes each time when buffer entered (vi comp.)
2477 *cpo-t*
2478 t Search pattern for the tag command is remembered for
2479 "n" command. Otherwise Vim only puts the pattern in
2480 the history for search pattern, but doesn't change the
2481 last used search pattern.
2482 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002483 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 *cpo-v*
2485 v Backspaced characters remain visible on the screen in
2486 Insert mode. Without this flag the characters are
2487 erased from the screen right away. With this flag the
2488 screen newly typed text overwrites backspaced
2489 characters.
2490 *cpo-w*
2491 w When using "cw" on a blank character, only change one
2492 character and not all blanks until the start of the
2493 next word.
2494 *cpo-W*
2495 W Don't overwrite a readonly file. When omitted, ":w!"
2496 overwrites a readonly file, if possible.
2497 *cpo-x*
2498 x <Esc> on the command-line executes the command-line.
2499 The default in Vim is to abandon the command-line,
2500 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002501 *cpo-X*
2502 X When using a count with "R" the replaced text is
2503 deleted only once. Also when repeating "R" with "."
2504 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002506 y A yank command can be redone with ".". Think twice if
2507 you really want to use this, it may break some
2508 plugins, since most people expect "." to only repeat a
2509 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002510 *cpo-Z*
2511 Z When using "w!" while the 'readonly' option is set,
2512 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002513 *cpo-z*
2514 z Special casing the "cw" and "d" command (see |cw| and
2515 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 *cpo-!*
2517 ! When redoing a filter command, use the last used
2518 external command, whatever it was. Otherwise the last
2519 used -filter- command is used.
2520 *cpo-$*
2521 $ When making a change to one line, don't redisplay the
2522 line, but put a '$' at the end of the changed text.
2523 The changed text will be overwritten when you type the
2524 new text. The line is redisplayed if you type any
2525 command that moves the cursor from the insertion
2526 point.
2527 *cpo-%*
2528 % Vi-compatible matching is done for the "%" command.
2529 Does not recognize "#if", "#endif", etc.
2530 Does not recognize "/*" and "*/".
2531 Parens inside single and double quotes are also
2532 counted, causing a string that contains a paren to
2533 disturb the matching. For example, in a line like
2534 "if (strcmp("foo(", s))" the first paren does not
2535 match the last one. When this flag is not included,
2536 parens inside single and double quotes are treated
2537 specially. When matching a paren outside of quotes,
2538 everything inside quotes is ignored. When matching a
2539 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002540 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002541 This flag is also used for other features, such as
2542 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002543 *cpo--*
2544 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002545 it would go above the first line or below the last
2546 line. Without it the cursor moves to the first or
2547 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002548 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002549 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002550 *cpo-+*
2551 + When included, a ":write file" command will reset the
2552 'modified' flag of the buffer, even though the buffer
2553 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002554 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 * Use ":*" in the same way as ":@". When not included,
2556 ":*" is an alias for ":'<,'>", select the Visual area.
2557 *cpo-<*
2558 < Disable the recognition of special key codes in |<>|
2559 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002560 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 ":map X <Tab>" results in X being mapped to:
2562 '<' included: "<Tab>" (5 characters)
2563 '<' excluded: "^I" (^I is a real <Tab>)
2564 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002565 *cpo->*
2566 > When appending to a register, put a line break before
2567 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002568 *cpo-;*
2569 ; When using |,| or |;| to repeat the last |t| search
2570 and the cursor is right in front of the searched
2571 character, the cursor won't move. When not included,
2572 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002573 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002574
2575 POSIX flags. These are not included in the Vi default value, except
2576 when $VIM_POSIX was set on startup. |posix|
2577
2578 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002579 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002580 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002581 *cpo-&*
2582 & When ":preserve" was used keep the swap file when
2583 exiting normally while this buffer is still loaded.
2584 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002585 *cpo-\*
2586 \ Backslash in a [] range in a search pattern is taken
2587 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002588 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2589 '\' excluded: "/[ \-]" finds <Space> and '-'
2590 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002591 *cpo-/*
2592 / When "%" is used as the replacement string in a |:s|
2593 command, use the previous replacement string. |:s%|
2594 *cpo-{*
2595 { The |{| and |}| commands also stop at a "{" character
2596 at the start of a line.
2597 *cpo-.*
2598 . The ":chdir" and ":cd" commands fail if the current
2599 buffer is modified, unless ! is used. Vim doesn't
2600 need this, since it remembers the full path of an
2601 opened file.
2602 *cpo-bar*
2603 | The value of the $LINES and $COLUMNS environment
2604 variables overrule the terminal size values obtained
2605 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002606
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002607 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002608'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002609 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002610 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002611 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002612 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002613 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002614 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002615 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002616 blowfish Blowfish method. Medium strong encryption but it has
2617 an implementation flaw. Requires Vim 7.3 or later,
2618 files can NOT be read by Vim 7.2 and older. This adds
2619 a "seed" to the file, every time you write the file
2620 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002621 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002622 *blowfish2*
2623 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002624 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002625 and older. This adds a "seed" to the file, every time
2626 you write the file the encrypted bytes will be
2627 different. The whole undo file is encrypted, not just
2628 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002629 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002630 *E1197* *E1198* *E1199* *E1200* *E1201*
2631 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2632 Code. Medium strong till strong encryption.
2633 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002634 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002635 It adds a seed and a message authentication code (MAC)
2636 to the file. This needs at least a Vim 8.2.3022 to
2637 read the encrypted file.
2638 Encryption of swap files is not supported, therefore
2639 no swap file will be used when xchacha20 encryption is
2640 enabled.
2641 Encryption of undo files is not yet supported,
2642 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002643 CAREFUL: Files written with this method might have to
2644 be read back with the same version of Vim if the
2645 binary format changes later.
2646 Obsolete, please do no longer use.
2647 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2648 stores the key derivation parameters together with the
2649 encrypted file. Should work better in case the
2650 parameters in the libsodium library ever change.
2651 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002652 might have to be read back with the same version of
2653 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002654
Christian Brabandtaae58342023-04-23 17:50:22 +01002655 You should use "blowfish2", also to re-encrypt older files. The
2656 "xchacha20" method provides better encryption, but it does not work
2657 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002658
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002659 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002660 to the detected method of the file being read. Thus if you write it
2661 without changing 'cryptmethod' the same method will be used.
2662 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002663 explicitly write it, you don't get a warning unless there are other
2664 modifications. Also see |:X|.
2665
2666 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002667 the value "blowfish2". When setting the local value to an empty
2668 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002669
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002670 When a new encryption method is added in a later version of Vim, and
2671 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002672 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002673
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 *'cscopepathcomp'* *'cspc'*
2675'cscopepathcomp' 'cspc' number (default 0)
2676 global
2677 {not available when compiled without the |+cscope|
2678 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 Determines how many components of the path to show in a list of tags.
2680 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002681 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682
2683 *'cscopeprg'* *'csprg'*
2684'cscopeprg' 'csprg' string (default "cscope")
2685 global
2686 {not available when compiled without the |+cscope|
2687 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 Specifies the command to execute cscope. See |cscopeprg|.
2689 This option cannot be set from a |modeline| or in the |sandbox|, for
2690 security reasons.
2691
2692 *'cscopequickfix'* *'csqf'*
2693'cscopequickfix' 'csqf' string (default "")
2694 global
2695 {not available when compiled without the |+cscope|
2696 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 Specifies whether to use quickfix window to show cscope results.
2698 See |cscopequickfix|.
2699
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002700 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002701'cscoperelative' 'csre' boolean (default off)
2702 global
2703 {not available when compiled without the |+cscope|
2704 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002705 In the absence of a prefix (-P) for cscope. setting this option enables
2706 to use the basename of cscope.out path as the prefix.
2707 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002708 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002709
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2711'cscopetag' 'cst' boolean (default off)
2712 global
2713 {not available when compiled without the |+cscope|
2714 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 Use cscope for tag commands. See |cscope-options|.
2716 NOTE: This option is reset when 'compatible' is set.
2717
2718 *'cscopetagorder'* *'csto'*
2719'cscopetagorder' 'csto' number (default 0)
2720 global
2721 {not available when compiled without the |+cscope|
2722 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Determines the order in which ":cstag" performs a search. See
2724 |cscopetagorder|.
2725 NOTE: This option is set to 0 when 'compatible' is set.
2726
2727 *'cscopeverbose'* *'csverb'*
2728 *'nocscopeverbose'* *'nocsverb'*
2729'cscopeverbose' 'csverb' boolean (default off)
2730 global
2731 {not available when compiled without the |+cscope|
2732 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 Give messages when adding a cscope database. See |cscopeverbose|.
2734 NOTE: This option is reset when 'compatible' is set.
2735
Bram Moolenaar860cae12010-06-05 23:22:07 +02002736 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2737'cursorbind' 'crb' boolean (default off)
2738 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002739 When this option is set, as the cursor in the current
2740 window moves other cursorbound windows (windows that also have
2741 this option set) move their cursors to the corresponding line and
2742 column. This option is useful for viewing the
2743 differences between two versions of a file (see 'diff'); in diff mode,
2744 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002745 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002746
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002747 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2748'cursorcolumn' 'cuc' boolean (default off)
2749 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002750 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002751 feature}
2752 Highlight the screen column of the cursor with CursorColumn
2753 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2754 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002755 If you only want the highlighting in the current window you can use
2756 these autocommands: >
2757 au WinLeave * set nocursorline nocursorcolumn
2758 au WinEnter * set cursorline cursorcolumn
2759<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002760
2761 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2762'cursorline' 'cul' boolean (default off)
2763 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002764 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002765 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002766 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2767 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002768 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002769 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002770
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002771 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002772'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002773 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002774 {not available when compiled without the |+syntax|
2775 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002776 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002777 Valid values:
2778 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002779 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002780 "screenline" Highlight only the screen line of the cursor with
2781 CursorLine |hl-CursorLine|.
2782 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002783 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002784
2785 Special value:
2786 "both" Alias for the values "line,number".
2787
2788 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002789
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 *'debug'*
2791'debug' string (default "")
2792 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002793 These values can be used:
2794 msg Error messages that would otherwise be omitted will be given
2795 anyway.
2796 throw Error messages that would otherwise be omitted will be given
2797 anyway and also throw an exception and set |v:errmsg|.
2798 beep A message will be given when otherwise only a beep would be
2799 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002800 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002801 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2802 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803
2804 *'define'* *'def'*
2805'define' 'def' string (default "^\s*#\s*define")
2806 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002807 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 pattern, just like for the "/" command. This option is used for the
2809 commands like "[i" and "[d" |include-search|. The 'isident' option is
2810 used to recognize the defined name after the match:
2811 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2812 See |option-backslash| about inserting backslashes to include a space
2813 or backslash.
2814 The default value is for C programs. For C++ this value would be
2815 useful, to include const type declarations: >
2816 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002817< You can also use "\ze" just before the name and continue the pattern
2818 to check what is following. E.g. for Javascript, if a function is
2819 defined with "func_name = function(args)": >
2820 ^\s*\ze\i\+\s*=\s*function(
2821< If the function is defined with "func_name : function() {...": >
2822 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002824 To avoid that use `:let` with a single quote string: >
2825 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002826<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
2828 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2829'delcombine' 'deco' boolean (default off)
2830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 If editing Unicode and this option is set, backspace and Normal mode
2832 "x" delete each combining character on its own. When it is off (the
2833 default) the character along with its combining characters are
2834 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002835 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836
2837 This is useful for Arabic, Hebrew and many other languages where one
2838 may have combining characters overtop of base characters, and want
2839 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002840 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'dictionary'* *'dict'*
2843'dictionary' 'dict' string (default "")
2844 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 List of file names, separated by commas, that are used to lookup words
2846 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2847 contain a list of words. This can be one word per line, or several
2848 words per line, separated by non-keyword characters (white space is
2849 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002850
2851 When this option is empty or an entry "spell" is present, and spell
2852 checking is enabled, words in the word lists for the currently active
2853 'spelllang' are used. See |spell|.
2854
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002855 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 after a comma are ignored, otherwise spaces are included in the file
2857 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002858 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 Where to find a list of words?
2860 - On FreeBSD, there is the file "/usr/share/dict/words".
2861 - In the Simtel archive, look in the "msdos/linguist" directory.
2862 - In "miscfiles" of the GNU collection.
2863 The use of |:set+=| and |:set-=| is preferred when adding or removing
2864 directories from the list. This avoids problems when a future version
2865 uses another default.
2866 Backticks cannot be used in this option for security reasons.
2867
2868 *'diff'* *'nodiff'*
2869'diff' boolean (default off)
2870 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 {not available when compiled without the |+diff|
2872 feature}
2873 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002874 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875
2876 *'dex'* *'diffexpr'*
2877'diffexpr' 'dex' string (default "")
2878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 {not available when compiled without the |+diff|
2880 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002881 Expression which is evaluated to obtain a diff file (either ed-style
2882 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 This option cannot be set from a |modeline| or in the |sandbox|, for
2884 security reasons.
2885
2886 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002887'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 {not available when compiled without the |+diff|
2890 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002891 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 All are optional. Items must be separated by a comma.
2893
Jonathon7c7a4e62025-01-12 09:58:00 +01002894 algorithm:{text} Use the specified diff algorithm with the
2895 internal diff engine. Currently supported
2896 algorithms are:
2897 myers the default algorithm
2898 minimal spend extra time to generate the
2899 smallest possible diff
2900 patience patience diff algorithm
2901 histogram histogram diff algorithm
2902
2903 closeoff When a window is closed where 'diff' is set
2904 and there is only one window remaining in the
2905 same tab page with 'diff' set, execute
2906 `:diffoff` in that window. This undoes a
2907 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908
2909 context:{n} Use a context of {n} lines between a change
2910 and a fold that contains unchanged lines.
2911 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002912 When using zero the context is actually one,
2913 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002914 for a deleted line. Set it to a very large
2915 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 See |fold-diff|.
2917
Jonathon7c7a4e62025-01-12 09:58:00 +01002918 filler Show filler lines, to keep the text
2919 synchronized with a window that has inserted
2920 lines at the same position. Mostly useful
2921 when windows are side-by-side and 'scrollbind'
2922 is set.
2923
2924 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2925 starting diff mode. Without this 2 is used.
2926
2927 followwrap Follow the 'wrap' option and leave as it is.
2928
2929 horizontal Start diff mode with horizontal splits (unless
2930 explicitly specified otherwise).
2931
2932 hiddenoff Do not use diff mode for a buffer when it
2933 becomes hidden.
2934
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002935 iblank Ignore changes where lines are all blank. Adds
2936 the "-B" flag to the "diff" command if
2937 'diffexpr' is empty. Check the documentation
2938 of the "diff" command for what this does
2939 exactly.
2940 NOTE: the diff windows will get out of sync,
2941 because no differences between blank lines are
2942 taken into account.
2943
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 icase Ignore changes in case of text. "a" and "A"
2945 are considered the same. Adds the "-i" flag
2946 to the "diff" command if 'diffexpr' is empty.
2947
Jonathon7c7a4e62025-01-12 09:58:00 +01002948 indent-heuristic
2949 Use the indent heuristic for the internal
2950 diff library.
2951
2952 internal Use the internal diff library. This is
2953 ignored when 'diffexpr' is set. *E960*
2954 When running out of memory when writing a
2955 buffer this item will be ignored for diffs
2956 involving that buffer. Set the 'verbose'
2957 option to see when this happens.
2958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 iwhite Ignore changes in amount of white space. Adds
2960 the "-b" flag to the "diff" command if
2961 'diffexpr' is empty. Check the documentation
2962 of the "diff" command for what this does
2963 exactly. It should ignore adding trailing
2964 white space, but not leading white space.
2965
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002966 iwhiteall Ignore all white space changes. Adds
2967 the "-w" flag to the "diff" command if
2968 'diffexpr' is empty. Check the documentation
2969 of the "diff" command for what this does
2970 exactly.
2971
2972 iwhiteeol Ignore white space changes at end of line.
2973 Adds the "-Z" flag to the "diff" command if
2974 'diffexpr' is empty. Check the documentation
2975 of the "diff" command for what this does
2976 exactly.
2977
Jonathon7c7a4e62025-01-12 09:58:00 +01002978 linematch:{n} Align and mark changes between the most
2979 similar lines between the buffers. When the
2980 total number of lines in the diff hunk exceeds
2981 {n}, the lines will not be aligned because for
2982 very large diff hunks there will be a
2983 noticeable lag. A reasonable setting is
2984 "linematch:60", as this will enable alignment
2985 for a 2 buffer diff hunk of 30 lines each,
2986 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002987
2988 vertical Start diff mode with vertical splits (unless
2989 explicitly specified otherwise).
2990
Bram Moolenaare828b762018-09-10 17:51:58 +02002991 Examples: >
2992 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002994 :set diffopt=internal,filler,foldcolumn:3
2995 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996<
2997 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2998'digraph' 'dg' boolean (default off)
2999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 {not available when compiled without the |+digraphs|
3001 feature}
3002 Enable the entering of digraphs in Insert mode with {char1} <BS>
3003 {char2}. See |digraphs|.
3004 NOTE: This option is reset when 'compatible' is set.
3005
3006 *'directory'* *'dir'*
3007'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003008 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 for Unix: ".,~/tmp,/var/tmp,/tmp")
3010 global
3011 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003012 Recommended value: ".,~/vimswap//" - this will put the swap file next
3013 to the edited file if possible, and in your personal swap directory
3014 otherwise. Make sure "~/vimswap//" is only readable for you.
3015
3016 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 - The swap file will be created in the first directory where this is
3018 possible.
3019 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003020 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 - A directory "." means to put the swap file in the same directory as
3022 the edited file. On Unix, a dot is prepended to the file name, so
3023 it doesn't show in a directory listing. On MS-Windows the "hidden"
3024 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003025 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3026 the swap file relative to where the edited file is. The leading "."
3027 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003028 - For Unix and Win32, if a directory ends in two path separators "//",
3029 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003030 with all path separators replaced by percent '%' signs (including
3031 the colon following the drive letter on Win32). This will ensure
3032 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003033 On Win32, it is also possible to end with "\\". However, When a
3034 separating comma is following, you must use "//", since "\\" will
3035 include the comma in the file name. Therefore it is recommended to
3036 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 - Spaces after the comma are ignored, other spaces are considered part
3038 of the directory name. To have a space at the start of a directory
3039 name, precede it with a backslash.
3040 - To include a comma in a directory name precede it with a backslash.
3041 - A directory name may end in an ':' or '/'.
3042 - Environment variables are expanded |:set_env|.
3043 - Careful with '\' characters, type one before a space, type two to
3044 get one in the option (see |option-backslash|), for example: >
3045 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3046< - For backwards compatibility with Vim version 3.0 a '>' at the start
3047 of the option is removed.
3048 Using "." first in the list is recommended. This means that editing
3049 the same file twice will result in a warning. Using "/tmp" on Unix is
3050 discouraged: When the system crashes you lose the swap file.
3051 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003052 choice than "/tmp". But others on the computer may be able to see the
3053 files, and it can contain a lot of files, your swap files get lost in
3054 the crowd. That is why a "tmp" directory in your home directory is
3055 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 The use of |:set+=| and |:set-=| is preferred when adding or removing
3057 directories from the list. This avoids problems when a future version
3058 uses another default.
3059 This option cannot be set from a |modeline| or in the |sandbox|, for
3060 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061
3062 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003063'display' 'dy' string (default "", set to "truncate" in
3064 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003066 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 flags:
3068 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003069 in a window will be displayed. "@@@" is put in the
3070 last columns of the last screen line to indicate the
3071 rest of the line is not displayed.
3072 truncate Like "lastline", but "@@@" is displayed in the first
3073 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 uhex Show unprintable characters hexadecimal as <xx>
3075 instead of using ^C and ~C.
3076
Bram Moolenaard0796902016-09-16 20:02:31 +02003077 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003078 doesn't fit is replaced with "@" lines.
3079
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003080 The "@" character can be changed by setting the "lastline" item in
3081 'fillchars'. The character is highlighted with |hl-NonText|.
3082
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 *'eadirection'* *'ead'*
3084'eadirection' 'ead' string (default "both")
3085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 Tells when the 'equalalways' option applies:
3087 ver vertically, width of windows is not affected
3088 hor horizontally, height of windows is not affected
3089 both width and height of windows is affected
3090
3091 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3092'edcompatible' 'ed' boolean (default off)
3093 global
3094 Makes the 'g' and 'c' flags of the ":substitute" command to be
3095 toggled each time the flag is given. See |complex-change|. See
3096 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003097 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003098 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099
Bram Moolenaar03413f42016-04-12 21:07:15 +02003100 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003101'emoji' 'emo' boolean (default: on)
3102 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003103 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003104 This excludes "text emoji" characters, which are normally displayed as
3105 single width. Unfortunately there is no good specification for this
3106 and it has been determined on trial-and-error basis. Use the
3107 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003110'encoding' 'enc' string (default for MS-Windows: "utf-8",
3111 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 Sets the character encoding used inside Vim. It applies to text in
3114 the buffers, registers, Strings in expressions, text stored in the
3115 viminfo file, etc. It sets the kind of characters which Vim can work
3116 with. See |encoding-names| for the possible values.
3117
3118 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003119 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003121 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122
Bram Moolenaar865242e2010-07-14 21:12:05 +02003123 This option cannot be set from a |modeline|. It would most likely
3124 corrupt the text.
3125
Bram Moolenaar3df01732017-02-17 22:47:16 +01003126 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3127 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 'encoding', "utf-8" is the natural choice for the environment and
3129 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003130 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 versions, and to avoid changing the encoding of newly created files
3132 without your knowledge (in case 'fileencodings' is empty).
3133
3134 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003135 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 iconv() or as specified with 'charconvert'.
3137
Bram Moolenaar207f0092020-08-30 17:20:20 +02003138 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003139 can use: >
3140 if has("multi_byte_encoding")
3141<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 Normally 'encoding' will be equal to your current locale. This will
3143 be the default if Vim recognizes your environment settings. If
3144 'encoding' is not set to the current locale, 'termencoding' must be
3145 set to convert typed and displayed text. See |encoding-table|.
3146
3147 When you set this option, it fires the |EncodingChanged| autocommand
3148 event so that you can set up fonts if necessary.
3149
3150 When the option is set, the value is converted to lowercase. Thus
3151 you can set it with uppercase values too. Underscores are translated
3152 to '-' signs.
3153 When the encoding is recognized, it is changed to the standard name.
3154 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3155 "iso-8859-2" and "utf8" becomes "utf-8".
3156
3157 Note: "latin1" is also used when the encoding could not be detected.
3158 This only works when editing files in the same encoding! When the
3159 actual character set is not latin1, make sure 'fileencoding' and
3160 'fileencodings' are empty. When conversion is needed, switch to using
3161 utf-8.
3162
3163 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3164 You don't notice this while editing, but it does matter for the
3165 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3166 setting 'encoding' to one of these values instead of utf-8 only has
3167 effect for encoding used for files when 'fileencoding' is empty.
3168
Bram Moolenaar661b1822005-07-28 22:36:45 +00003169 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3170 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003172 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003173'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003175 Indicates that a CTRL-Z character was found at the end of the file
3176 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003178 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003179 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003180 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003181
3182 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3183'endofline' 'eol' boolean (default on)
3184 local to buffer
3185 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003186 is on, or 'fixeol' option is off, no <EOL> will be written for the
3187 last line in the file. This option is automatically set or reset when
3188 starting to edit a new file, depending on whether file has an <EOL>
3189 for the last line in the file. Normally you don't have to set or
3190 reset this option.
3191 When 'binary' is off and 'fixeol' is on the value is not used when
3192 writing the file. When 'binary' is on or 'fixeol' is off it is used
3193 to remember the presence of a <EOL> for the last line in the file, so
3194 that when you write the file the situation from the original file can
3195 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003196 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
3198 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3199'equalalways' 'ea' boolean (default on)
3200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003202 splitting or closing a window. This also happens the moment the
3203 option is switched on. When off, splitting a window will reduce the
3204 size of the current window and leave the other windows the same. When
3205 closing a window the extra lines are given to the window next to it
3206 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 When mixing vertically and horizontally split windows, a minimal size
3208 is computed and some windows may be larger if there is room. The
3209 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003210 Changing the height and width of a window can be avoided by setting
3211 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003212 If a window size is specified when creating a new window sizes are
3213 currently not equalized (it's complicated, but may be implemented in
3214 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215
3216 *'equalprg'* *'ep'*
3217'equalprg' 'ep' string (default "")
3218 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003220 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003221 or 'indentexpr'. When Vim was compiled without internal formatting,
3222 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003223 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 about including spaces and backslashes.
3225 This option cannot be set from a |modeline| or in the |sandbox|, for
3226 security reasons.
3227
3228 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3229'errorbells' 'eb' boolean (default off)
3230 global
3231 Ring the bell (beep or screen flash) for error messages. This only
3232 makes a difference for error messages, the bell will be used always
3233 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003235 screen flash or do nothing. See 'belloff' to finetune when to ring the
3236 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237
3238 *'errorfile'* *'ef'*
3239'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3240 others: "errors.err")
3241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 {not available when compiled without the |+quickfix|
3243 feature}
3244 Name of the errorfile for the QuickFix mode (see |:cf|).
3245 When the "-q" command-line argument is used, 'errorfile' is set to the
3246 following argument. See |-q|.
3247 NOT used for the ":make" command. See 'makeef' for that.
3248 Environment variables are expanded |:set_env|.
3249 See |option-backslash| about including spaces and backslashes.
3250 This option cannot be set from a |modeline| or in the |sandbox|, for
3251 security reasons.
3252
3253 *'errorformat'* *'efm'*
3254'errorformat' 'efm' string (default is very long)
3255 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 {not available when compiled without the |+quickfix|
3257 feature}
3258 Scanf-like description of the format for the lines in the error file
3259 (see |errorformat|).
3260
3261 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3262'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 Function keys that start with an <Esc> are recognized in Insert
3265 mode. When this option is off, the cursor and function keys cannot be
3266 used in Insert mode if they start with an <Esc>. The advantage of
3267 this is that the single <Esc> is recognized immediately, instead of
3268 after one second. Instead of resetting this option, you might want to
3269 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3270 when 'esckeys' is off, you can still map anything, but the cursor keys
3271 won't work by default.
3272 NOTE: This option is set to the Vi default value when 'compatible' is
3273 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003274 NOTE: when this option is off then the |modifyOtherKeys| and
3275 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3276 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277
3278 *'eventignore'* *'ei'*
3279'eventignore' 'ei' string (default "")
3280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003282 When set to "all" or when "all" is one of the items, all autocommand
3283 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003284 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 :set ei=WinEnter,WinLeave
3286<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003287 *'eventignorewin'* *'eiw'*
3288'eventignorewin' 'eiw' string (default "")
3289 window-local
3290 Similar to 'eventignore' but applies to a particular window and its
3291 buffers, for which window and buffer related autocommands can be
3292 ignored indefinitely without affecting the global 'eventignore'.
3293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3295'expandtab' 'et' boolean (default off)
3296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003298 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3300 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003301 This option is reset when the 'paste' option is set and restored when
3302 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 NOTE: This option is reset when 'compatible' is set.
3304
3305 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3306'exrc' 'ex' boolean (default off)
3307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003309 directory.
3310
3311 Setting this option is a potential security leak. E.g., consider
3312 unpacking a package or fetching files from github, a .vimrc in there
3313 might be a trojan horse. BETTER NOT SET THIS OPTION!
3314 Instead, define an autocommand in your .vimrc to set options for a
3315 matching directory.
3316
3317 If you do switch this option on you should also consider setting the
3318 'secure' option (see |initialization|).
3319 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 This option cannot be set from a |modeline| or in the |sandbox|, for
3321 security reasons.
3322
3323 *'fileencoding'* *'fenc'* *E213*
3324'fileencoding' 'fenc' string (default: "")
3325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003329 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 When 'fileencoding' is empty, the same value as 'encoding' will be
3331 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003332 No error will be given when the value is set, only when it is used,
3333 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003334 Conversion will also be done when 'encoding' and 'fileencoding' are
3335 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3336 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003338 'encoding' is "utf-8" or another Unicode encoding, conversion
3339 is most likely done in a way that the reverse conversion
3340 results in the same text. When 'encoding' is not "utf-8" some
3341 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003342
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 See 'encoding' for the possible values. Additionally, values may be
3344 specified that can be handled by the converter, see
3345 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 When reading a file 'fileencoding' will be set from 'fileencodings'.
3348 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003349 'fileencoding', use the |++enc| argument. One exception: when
3350 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003351 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003352
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3354 When the option is set, the value is converted to lowercase. Thus
3355 you can set it with uppercase values too. '_' characters are
3356 replaced with '-'. If a name is recognized from the list for
3357 'encoding', it is replaced by the standard name. For example
3358 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 When this option is set, after starting to edit a file, the 'modified'
3361 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003362
3363 Keep in mind that changing 'fenc' from a modeline happens
3364 AFTER the text has been read, thus it applies to when the file will be
3365 written. If you do set 'fenc' in a modeline, you might want to set
3366 'nomodified' to avoid not being able to ":q".
3367
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 This option can not be changed when 'modifiable' is off.
3369
3370 *'fe'*
3371 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003372 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 old short name was 'fe', which is no longer used.
3374
3375 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003376'fileencodings' 'fencs' string (default: "ucs-bom",
3377 "ucs-bom,utf-8,default,latin1" when
3378 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 This is a list of character encodings considered when starting to edit
3381 an existing file. When a file is read, Vim tries to use the first
3382 mentioned character encoding. If an error is detected, the next one
3383 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003384 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 an empty string, which means the value of 'encoding' is used.
3386 WARNING: Conversion can cause loss of information! When
3387 'encoding' is "utf-8" (or one of the other Unicode variants)
3388 conversion is most likely done in a way that the reverse
3389 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003390 "utf-8" some non-ASCII characters may be lost! You can use
3391 the |++bad| argument to specify what is done with characters
3392 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 For an empty file or a file with only ASCII characters most encodings
3394 will work and the first entry of 'fileencodings' will be used (except
3395 "ucs-bom", which requires the BOM to be present). If you prefer
3396 another encoding use an BufReadPost autocommand event to test if your
3397 preferred encoding is to be used. Example: >
3398 au BufReadPost * if search('\S', 'w') == 0 |
3399 \ set fenc=iso-2022-jp | endif
3400< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3401 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003402 When the |++enc| argument is used then the value of 'fileencodings' is
3403 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003404 Note that 'fileencodings' is not used for a new file, the global value
3405 of 'fileencoding' is used instead. You can set it with: >
3406 :setglobal fenc=iso-8859-2
3407< This means that a non-existing file may get a different encoding than
3408 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 The special value "ucs-bom" can be used to check for a Unicode BOM
3410 (Byte Order Mark) at the start of the file. It must not be preceded
3411 by "utf-8" or another Unicode encoding for this to work properly.
3412 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3413 because Vim cannot detect an error, thus the encoding is always
3414 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003415 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003416 environment. On MS-Windows this is the system encoding. Otherwise
3417 this is the default value for 'encoding'. It is useful when
3418 'encoding' is set to "utf-8" and your environment uses a non-latin1
3419 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003420 When 'encoding' is "utf-8" and a file contains an illegal byte
3421 sequence it won't be recognized as UTF-8. You can use the |8g8|
3422 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 WRONG VALUES: WHAT'S WRONG:
3424 latin1,utf-8 "latin1" will always be used
3425 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3426 file
3427 cp1250,latin1 "cp1250" will always be used
3428 If 'fileencodings' is empty, 'fileencoding' is not modified.
3429 See 'fileencoding' for the possible values.
3430 Setting this option does not have an effect until the next time a file
3431 is read.
3432
3433 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003434'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003435 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 This gives the <EOL> of the current buffer, which is used for
3438 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003439 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 unix <NL>
3441 mac <CR>
3442 When "dos" is used, CTRL-Z at the end of a file is ignored.
3443 See |file-formats| and |file-read|.
3444 For the character encoding of the file see 'fileencoding'.
3445 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003446 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 This option is set automatically when starting to edit a file and
3448 'fileformats' is not empty and 'binary' is off.
3449 When this option is set, after starting to edit a file, the 'modified'
3450 option is set, because the file would be different when written.
3451 This option can not be changed when 'modifiable' is off.
3452 For backwards compatibility: When this option is set to "dos",
3453 'textmode' is set, otherwise 'textmode' is reset.
3454
3455 *'fileformats'* *'ffs'*
3456'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003457 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003458 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 Vi Cygwin: "unix,dos",
3460 Vi others: "")
3461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 This gives the end-of-line (<EOL>) formats that will be tried when
3463 starting to edit a new buffer and when reading a file into an existing
3464 buffer:
3465 - When empty, the format defined with 'fileformat' will be used
3466 always. It is not set automatically.
3467 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003468 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 'fileformats' name will be used when a file is read into an existing
3470 buffer, no matter what 'fileformat' for that buffer is set to.
3471 - When more than one name is present, separated by commas, automatic
3472 <EOL> detection will be done when reading a file. When starting to
3473 edit a file, a check is done for the <EOL>:
3474 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3475 'fileformat' is set to "dos".
3476 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003477 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003479 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3480 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003481 This means that "mac" is only chosen when:
3482 "unix" is not present or no <NL> is found in the file, and
3483 "dos" is not present or no <CR><NL> is found in the file.
3484 Except: if "unix" was chosen, but there is a <CR> before
3485 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003486 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 4. If 'fileformat' is still not set, the first name from
3488 'fileformats' is used.
3489 When reading a file into an existing buffer, the same is done, but
3490 this happens like 'fileformat' has been set appropriately for that
3491 file only, the option is not changed.
3492 When 'binary' is set, the value of 'fileformats' is not used.
3493
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003494 When Vim starts up with an empty buffer the first item is used. You
3495 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003496
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3498 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3499 done:
3500 - When 'fileformats' is empty, there is no automatic detection. Dos
3501 format will be used.
3502 - When 'fileformats' is set to one or more names, automatic detection
3503 is done. This is based on the first <NL> in the file: If there is a
3504 <CR> in front of it, Dos format is used, otherwise Unix format is
3505 used.
3506 Also see |file-formats|.
3507 For backwards compatibility: When this option is set to an empty
3508 string or one format (no comma is included), 'textauto' is reset,
3509 otherwise 'textauto' is set.
3510 NOTE: This option is set to the Vi default value when 'compatible' is
3511 set and to the Vim default value when 'compatible' is reset.
3512
Bram Moolenaarbf884932013-04-05 22:26:15 +02003513 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3514'fileignorecase' 'fic' boolean (default on for systems where case in file
3515 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003516 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003517 When set case is ignored when using file names and directories.
3518 See 'wildignorecase' for only ignoring case when doing completion.
3519
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 *'filetype'* *'ft'*
3521'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003522 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 When this option is set, the FileType autocommand event is triggered.
3524 All autocommands that match with the value of this option will be
3525 executed. Thus the value of 'filetype' is used in place of the file
3526 name.
3527 Otherwise this option does not always reflect the current file type.
3528 This option is normally set when the file type is detected. To enable
3529 this use the ":filetype on" command. |:filetype|
3530 Setting this option to a different value is most useful in a modeline,
3531 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003532 Example, for in an IDL file:
3533 /* vim: set filetype=idl : */ ~
3534 |FileType| |filetypes|
3535 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003536 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003537 /* vim: set filetype=c.doxygen : */ ~
3538 This will use the "c" filetype first, then the "doxygen" filetype.
3539 This works both for filetype plugins and for syntax files. More than
3540 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 This option is not copied to another buffer, independent of the 's' or
3542 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003543 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
3545 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003546'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003547 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003548 Characters to fill the statuslines, vertical separators and special
3549 lines in the window.
3550 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003551 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003553 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003554 stl ' ' statusline of the current window
3555 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003556 vert '|' vertical separators |:vsplit|
3557 fold '-' filling 'foldtext'
3558 foldopen '-' mark the beginning of a fold
3559 foldclose '+' show a closed fold
3560 foldsep '|' open fold middle character
3561 diff '-' deleted lines of the 'diff' option
3562 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003563 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003565 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566
3567 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003568 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3569<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003570 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3571 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003572 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003573
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003575 item name highlight group ~
3576 stl StatusLine |hl-StatusLine|
3577 stlnc StatusLineNC |hl-StatusLineNC|
3578 vert VertSplit |hl-VertSplit|
3579 fold Folded |hl-Folded|
3580 diff DiffDelete |hl-DiffDelete|
3581 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003582 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003584 *'findfunc'* *'ffu'* *E1514*
3585'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003586 global or local to buffer |global-local|
3587 {not available when compiled without the |+eval|
3588 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003589 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003590 command. When this option is empty, the internal |file-searching|
3591 mechanism is used.
3592
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003593 The value can be the name of a function, a |lambda| or a |Funcref|.
3594 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003595
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003596 The function is called with two arguments. The first argument is a
3597 |String| and is the |:find| command argument. The second argument is
3598 a |Boolean| and is set to |v:true| when the function is called to get
3599 a List of command-line completion matches for the |:find| command.
3600 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003601
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003602 The function is called only once per |:find| command invocation.
3603 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003604
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003605 If a match is found, the function should return a |List| containing
3606 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003607 should return an empty List.
3608
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003609 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003610 empty List is used as the return value.
3611
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003612 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003613 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003614
3615 This option cannot be set from a |modeline| or in the |sandbox|, for
3616 security reasons.
3617
3618 Examples:
3619>
3620 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003621 func FindFuncGlob(cmdarg, cmdcomplete)
3622 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003623 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003624 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003625 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003626
3627 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003628 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003629 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003630 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003631 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003632 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003633<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003634 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3635'fixendofline' 'fixeol' boolean (default on)
3636 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003637 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003638 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003639 preserve the situation from the original file.
3640 When the 'binary' option is set the value of this option doesn't
3641 matter.
3642 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003643 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003644
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003646'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {only available when compiled with the |+rightleft|
3649 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003650 This option was for using Farsi, which has been removed. See
3651 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652
3653 *'foldclose'* *'fcl'*
3654'foldclose' 'fcl' string (default "")
3655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 {not available when compiled without the |+folding|
3657 feature}
3658 When set to "all", a fold is closed when the cursor isn't in it and
3659 its level is higher than 'foldlevel'. Useful if you want folds to
3660 automatically close when moving out of them.
3661
3662 *'foldcolumn'* *'fdc'*
3663'foldcolumn' 'fdc' number (default 0)
3664 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 {not available when compiled without the |+folding|
3666 feature}
3667 When non-zero, a column with the specified width is shown at the side
3668 of the window which indicates open and closed folds. The maximum
3669 value is 12.
3670 See |folding|.
3671
3672 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3673'foldenable' 'fen' boolean (default on)
3674 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {not available when compiled without the |+folding|
3676 feature}
3677 When off, all folds are open. This option can be used to quickly
3678 switch between showing all text unfolded and viewing the text with
3679 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003680 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 'foldenable' is off.
3682 This option is set by commands that create a new fold or close a fold.
3683 See |folding|.
3684
3685 *'foldexpr'* *'fde'*
3686'foldexpr' 'fde' string (default: "0")
3687 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003689 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003691 for each line to obtain its fold level. The context is set to the
3692 script where 'foldexpr' was set, script-local items can be accessed.
3693 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003694
Bram Moolenaar30b65812012-07-12 22:01:11 +02003695 The expression will be evaluated in the |sandbox| if set from a
3696 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003697 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003698 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003699
3700 It is not allowed to change text or jump to another window while
3701 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702
3703 *'foldignore'* *'fdi'*
3704'foldignore' 'fdi' string (default: "#")
3705 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 {not available when compiled without the |+folding|
3707 feature}
3708 Used only when 'foldmethod' is "indent". Lines starting with
3709 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003710 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 The default "#" works well for C programs. See |fold-indent|.
3712
3713 *'foldlevel'* *'fdl'*
3714'foldlevel' 'fdl' number (default: 0)
3715 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 {not available when compiled without the |+folding|
3717 feature}
3718 Sets the fold level: Folds with a higher level will be closed.
3719 Setting this option to zero will close all folds. Higher numbers will
3720 close fewer folds.
3721 This option is set by commands like |zm|, |zM| and |zR|.
3722 See |fold-foldlevel|.
3723
3724 *'foldlevelstart'* *'fdls'*
3725'foldlevelstart' 'fdls' number (default: -1)
3726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 {not available when compiled without the |+folding|
3728 feature}
3729 Sets 'foldlevel' when starting to edit another buffer in a window.
3730 Useful to always start editing with all folds closed (value zero),
3731 some folds closed (one) or no folds closed (99).
3732 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 ignores this option and closes all folds.
3735 It is also done before BufReadPre autocommands, to allow an autocmd to
3736 overrule the 'foldlevel' value for specific files.
3737 When the value is negative, it is not used.
3738
3739 *'foldmarker'* *'fmr'* *E536*
3740'foldmarker' 'fmr' string (default: "{{{,}}}")
3741 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 {not available when compiled without the |+folding|
3743 feature}
3744 The start and end marker used when 'foldmethod' is "marker". There
3745 must be one comma, which separates the start and end marker. The
3746 marker is a literal string (a regular expression would be too slow).
3747 See |fold-marker|.
3748
3749 *'foldmethod'* *'fdm'*
3750'foldmethod' 'fdm' string (default: "manual")
3751 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 {not available when compiled without the |+folding|
3753 feature}
3754 The kind of folding used for the current window. Possible values:
3755 |fold-manual| manual Folds are created manually.
3756 |fold-indent| indent Lines with equal indent form a fold.
3757 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3758 |fold-marker| marker Markers are used to specify folds.
3759 |fold-syntax| syntax Syntax highlighting items specify folds.
3760 |fold-diff| diff Fold text that is not changed.
3761
3762 *'foldminlines'* *'fml'*
3763'foldminlines' 'fml' number (default: 1)
3764 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 {not available when compiled without the |+folding|
3766 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003767 Sets the number of screen lines above which a fold can be displayed
3768 closed. Also for manually closed folds. With the default value of
3769 one a fold can only be closed if it takes up two or more screen lines.
3770 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003771 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 "zc" to close a fold, which is displayed open because it's smaller
3773 than 'foldminlines', a following "zc" may close a containing fold.
3774
3775 *'foldnestmax'* *'fdn'*
3776'foldnestmax' 'fdn' number (default: 20)
3777 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 {not available when compiled without the |+folding|
3779 feature}
3780 Sets the maximum nesting of folds for the "indent" and "syntax"
3781 methods. This avoids that too many folds will be created. Using more
3782 than 20 doesn't work, because the internal limit is 20.
3783
3784 *'foldopen'* *'fdo'*
3785'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3786 search,tag,undo")
3787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 {not available when compiled without the |+folding|
3789 feature}
3790 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003791 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003793 NOTE: When the command is part of a mapping this option is not used.
3794 Add the |zv| command to the mapping to get the same effect.
3795 (rationale: the mapping may want to control opening folds itself)
3796
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 item commands ~
3798 all any
3799 block "(", "{", "[[", "[{", etc.
3800 hor horizontal movements: "l", "w", "fx", etc.
3801 insert any command in Insert mode
3802 jump far jumps: "G", "gg", etc.
3803 mark jumping to a mark: "'m", CTRL-O, etc.
3804 percent "%"
3805 quickfix ":cn", ":crew", ":make", etc.
3806 search search for a pattern: "/", "n", "*", "gd", etc.
3807 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003808 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 tag jumping to a tag: ":ta", CTRL-T, etc.
3810 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 When a movement command is used for an operator (e.g., "dl" or "y%")
3812 this option is not used. This means the operator will include the
3813 whole closed fold.
3814 Note that vertical movements are not here, because it would make it
3815 very difficult to move onto a closed fold.
3816 In insert mode the folds containing the cursor will always be open
3817 when text is inserted.
3818 To close folds you can re-apply 'foldlevel' with the |zx| command or
3819 set the 'foldclose' option to "all".
3820
3821 *'foldtext'* *'fdt'*
3822'foldtext' 'fdt' string (default: "foldtext()")
3823 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 {not available when compiled without the |+folding|
3825 feature}
3826 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003827 fold. The context is set to the script where 'foldexpr' was set,
3828 script-local items can be accessed. See |fold-foldtext| for the
3829 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830
Bram Moolenaar30b65812012-07-12 22:01:11 +02003831 The expression will be evaluated in the |sandbox| if set from a
3832 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003833 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003834
3835 It is not allowed to change text or jump to another window while
3836 evaluating 'foldtext' |textlock|.
3837
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003838 *'formatexpr'* *'fex'*
3839'formatexpr' 'fex' string (default "")
3840 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003841 {not available when compiled without the |+eval|
3842 feature}
3843 Expression which is evaluated to format a range of lines for the |gq|
3844 operator or automatic formatting (see 'formatoptions'). When this
3845 option is empty 'formatprg' is used.
3846
3847 The |v:lnum| variable holds the first line to be formatted.
3848 The |v:count| variable holds the number of lines to be formatted.
3849 The |v:char| variable holds the character that is going to be
3850 inserted if the expression is being evaluated due to
3851 automatic formatting. This can be empty. Don't insert
3852 it yet!
3853
3854 Example: >
3855 :set formatexpr=mylang#Format()
3856< This will invoke the mylang#Format() function in the
3857 autoload/mylang.vim file in 'runtimepath'. |autoload|
3858
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003859 The advantage of using a function call without arguments is that it is
3860 faster, see |expr-option-function|.
3861
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003862 The expression is also evaluated when 'textwidth' is set and adding
3863 text beyond that limit. This happens under the same conditions as
3864 when internal formatting is used. Make sure the cursor is kept in the
3865 same spot relative to the text then! The |mode()| function will
3866 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003867
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003868 When the expression evaluates to non-zero Vim will fall back to using
3869 the internal format mechanism.
3870
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003871 If the expression starts with s: or |<SID>|, then it is replaced with
3872 the script ID (|local-function|). Example: >
3873 set formatexpr=s:MyFormatExpr()
3874 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003875< Otherwise, the expression is evaluated in the context of the script
3876 where the option was set, thus script-local items are available.
3877
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003878 The expression will be evaluated in the |sandbox| when set from a
3879 modeline, see |sandbox-option|. That stops the option from working,
3880 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003881 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003882 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003883
Bram Moolenaar86b68352004-12-27 21:59:20 +00003884 *'formatlistpat'* *'flp'*
3885'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3886 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003887 A pattern that is used to recognize a list header. This is used for
3888 the "n" flag in 'formatoptions'.
3889 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003890 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003891 while still checking more characters. There must be a character
3892 following the pattern, when it matches the whole line it is handled
3893 like there is no match.
3894 The default recognizes a number, followed by an optional punctuation
3895 character and white space.
3896
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003897 *'formatoptions'* *'fo'*
3898'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3899 local to buffer
3900 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003901 formatting is to be done.
3902 See |fo-table| for possible values and |gq| for how to format text.
3903 When the 'paste' option is on, no formatting is done (like
3904 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003905 To avoid problems with flags that are added in the future, use the
3906 "+=" and "-=" feature of ":set" |add-option-flags|.
3907 NOTE: This option is set to the Vi default value when 'compatible' is
3908 set and to the Vim default value when 'compatible' is reset.
3909
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 *'formatprg'* *'fp'*
3911'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003912 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003914 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003916 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003917 If the 'formatexpr' option is not empty it will be used instead.
3918 Otherwise, if 'formatprg' option is an empty string, the internal
3919 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003920 Environment variables are expanded |:set_env|. See |option-backslash|
3921 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003922 This option cannot be set from a |modeline| or in the |sandbox|, for
3923 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924
Bram Moolenaard94464e2015-11-02 15:28:18 +01003925 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003926'fsync' 'fs' boolean (default on)
3927 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003928 When on, the library function fsync() will be called after writing a
3929 file. This will flush a file to disk, ensuring that it is safely
3930 written even on filesystems which do metadata-only journaling. This
3931 will force the harddrive to spin up on Linux systems running in laptop
3932 mode, so it may be undesirable in some situations. Be warned that
3933 turning this off increases the chances of data loss after a crash. On
3934 systems without an fsync() implementation, this variable is always
3935 off.
3936 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003937 'fsync' also applies to |writefile()| (unless a flag is used to
3938 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003939 This option cannot be set from a |modeline| or in the |sandbox|, for
3940 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003941
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3943'gdefault' 'gd' boolean (default off)
3944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 When on, the ":substitute" flag 'g' is default on. This means that
3946 all matches in a line are substituted instead of one. When a 'g' flag
3947 is given to a ":substitute" command, this will toggle the substitution
3948 of all or one match. See |complex-change|.
3949
3950 command 'gdefault' on 'gdefault' off ~
3951 :s/// subst. all subst. one
3952 :s///g subst. one subst. all
3953 :s///gg subst. all subst. one
3954
3955 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003956 Setting this option may break plugins that rely on the default
3957 behavior of the 'g' flag. This will also make the 'g' flag have the
3958 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003959 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960
3961 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003962'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 Format to recognize for the ":grep" command output.
3965 This is a scanf-like string that uses the same format as the
3966 'errorformat' option: see |errorformat|.
3967
3968 *'grepprg'* *'gp'*
3969'grepprg' 'gp' string (default "grep -n ",
3970 Unix: "grep -n $* /dev/null",
3971 Win32: "findstr /n" or "grep -n",
3972 VMS: "SEARCH/NUMBERS ")
3973 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003974 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 and '#' characters, which are expanded like when used in a command-
3976 line. The placeholder "$*" is allowed to specify where the arguments
3977 will be included. Environment variables are expanded |:set_env|. See
3978 |option-backslash| about including spaces and backslashes.
3979 When your "grep" accepts the "-H" argument, use this to make ":grep"
3980 also work well with a single file: >
3981 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003982< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003983 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3984 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003985 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 apply equally to 'grepprg'.
3987 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3988 otherwise it's "grep -n".
3989 This option cannot be set from a |modeline| or in the |sandbox|, for
3990 security reasons.
3991
3992 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3993'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3994 ve:ver35-Cursor,
3995 o:hor50-Cursor,
3996 i-ci:ver25-Cursor/lCursor,
3997 r-cr:hor20-Cursor/lCursor,
3998 sm:block-Cursor
3999 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004000 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 "n-v-c:block,o:hor50,i-ci:hor15,
4002 r-cr:hor30,sm:block")
4003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004005 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004007 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004008 height of the cursor can be changed. This can be done by specifying a
4009 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004010 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4011 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004013 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 mode-list and an argument-list:
4015 mode-list:argument-list,mode-list:argument-list,..
4016 The mode-list is a dash separated list of these modes:
4017 n Normal mode
4018 v Visual mode
4019 ve Visual mode with 'selection' "exclusive" (same as 'v',
4020 if not specified)
4021 o Operator-pending mode
4022 i Insert mode
4023 r Replace mode
4024 c Command-line Normal (append) mode
4025 ci Command-line Insert mode
4026 cr Command-line Replace mode
4027 sm showmatch in Insert mode
4028 a all modes
4029 The argument-list is a dash separated list of these arguments:
4030 hor{N} horizontal bar, {N} percent of the character height
4031 ver{N} vertical bar, {N} percent of the character width
4032 block block cursor, fills the whole character
4033 [only one of the above three should be present]
4034 blinkwait{N} *cursor-blinking*
4035 blinkon{N}
4036 blinkoff{N}
4037 blink times for cursor: blinkwait is the delay before
4038 the cursor starts blinking, blinkon is the time that
4039 the cursor is shown and blinkoff is the time that the
4040 cursor is not shown. The times are in msec. When one
4041 of the numbers is zero, there is no blinking. The
4042 default is: "blinkwait700-blinkon400-blinkoff250".
4043 These numbers are used for a missing entry. This
4044 means that blinking is enabled by default. To switch
4045 blinking off you can use "blinkon0". The cursor only
4046 blinks when Vim is waiting for input, not while
4047 executing a command.
4048 To make the cursor blink in an xterm, see
4049 |xterm-blink|.
4050 {group-name}
4051 a highlight group name, that sets the color and font
4052 for the cursor
4053 {group-name}/{group-name}
4054 Two highlight group names, the first is used when
4055 no language mappings are used, the other when they
4056 are. |language-mapping|
4057
4058 Examples of parts:
4059 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4060 block cursor with colors from the "nCursor"
4061 highlight group
4062 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4063 In Insert and Command-line Insert mode, use a
4064 30% vertical bar cursor with colors from the
4065 "iCursor" highlight group. Blink a bit
4066 faster.
4067
4068 The 'a' mode is different. It will set the given argument-list for
4069 all modes. It does not reset anything to defaults. This can be used
4070 to do a common setting for all modes. For example, to switch off
4071 blinking: "a:blinkon0"
4072
4073 Examples of cursor highlighting: >
4074 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4075 :highlight Cursor gui=NONE guifg=bg guibg=fg
4076<
4077 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004078 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079'guifont' 'gfn' string (default "")
4080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 {only available when compiled with GUI enabled}
4082 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004083 In its simplest form the value is just one font name.
4084 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 *'guifontset'* *'gfs'*
4087 *E250* *E252* *E234* *E597* *E598*
4088'guifontset' 'gfs' string (default "")
4089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 {only available when compiled with GUI enabled and
4091 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004092 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 When not empty, specifies two (or more) fonts to be used. The first
4094 one for normal English, the second one for your special language. See
4095 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004096
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4098'guifontwide' 'gfw' string (default "")
4099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 {only available when compiled with GUI enabled}
4101 When not empty, specifies a comma-separated list of fonts to be used
4102 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004103 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004104
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 *'guiheadroom'* *'ghr'*
4106'guiheadroom' 'ghr' number (default 50)
4107 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004108 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 The number of pixels subtracted from the screen height when fitting
4110 the GUI window on the screen. Set this before the GUI is started,
4111 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004112 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 lines will be left for window decorations and other items on the
4114 screen. Set it to a negative value to allow windows taller than the
4115 screen.
4116
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004117 *'guiligatures'* *'gli'* *E1243*
4118'guiligatures' 'gli' string (default "")
4119 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004120 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004121 List of ASCII characters that, when combined together, can create more
4122 complex shapes. Each character must be a printable ASCII character
4123 with a value in the 32-127 range.
4124 Example: >
4125 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4126< Changing this option updates screen output immediately. Set it to an
4127 empty string to disable ligatures.
4128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004130'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4131 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004132 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004133 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004136 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 sequence of letters which describes what components and options of the
4138 GUI should be used.
4139 To avoid problems with flags that are added in the future, use the
4140 "+=" and "-=" feature of ":set" |add-option-flags|.
4141
Bram Moolenaar13568252018-03-16 20:46:58 +01004142 Valid characters are as follows:
4143 *'go-!'*
4144 '!' External commands are executed in a terminal window. Without
4145 this flag the MS-Windows GUI will open a console window to
4146 execute the command. The Unix GUI will simulate a dumb
4147 terminal to list the command output.
4148 The terminal window will be positioned at the bottom, and grow
4149 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004150 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 'a' Autoselect: If present, then whenever VISUAL mode is started,
4152 or the Visual area extended, Vim tries to become the owner of
4153 the windowing system's global selection. This means that the
4154 Visually highlighted text is available for pasting into other
4155 applications as well as into Vim itself. When the Visual mode
4156 ends, possibly due to an operation on the text, or when an
4157 application wants to paste the selection, the highlighted text
4158 is automatically yanked into the "* selection register.
4159 Thus the selection is still available for pasting into other
4160 applications after the VISUAL mode has ended.
4161 If not present, then Vim won't become the owner of the
4162 windowing system's global selection unless explicitly told to
4163 by a yank or delete operation for the "* register.
4164 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004165 *'go-P'*
4166 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004167 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004168 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004169 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 applies to the modeless selection.
4171
4172 'guioptions' autoselect Visual autoselect modeless ~
4173 "" - -
4174 "a" yes yes
4175 "A" - yes
4176 "aA" yes yes
4177
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004178 When using a terminal see the 'clipboard' option.
4179
Bram Moolenaar02467872007-05-06 13:22:01 +00004180 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 'c' Use console dialogs instead of popup dialogs for simple
4182 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004183 *'go-d'*
4184 'd' Use dark theme variant if available. Currently only works for
4185 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004186 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004187 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004188 'guitablabel' can be used to change the text in the labels.
4189 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004190 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004191 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004192 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 'f' Foreground: Don't use fork() to detach the GUI from the shell
4194 where it was started. Use this for programs that wait for the
4195 editor to finish (e.g., an e-mail program). Alternatively you
4196 can use "gvim -f" or ":gui -f" to start the GUI in the
4197 foreground. |gui-fork|
4198 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004199 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004200 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4202 corner of the window. It's black&white on non-GTK, because of
4203 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004204 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004206 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004207 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004209 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004211 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004212 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 'g' Grey menu items: Make menu items that are not active grey. If
4214 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004215 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 't' Include tearoff menu items. Currently only works for Win32,
4217 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004218 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004219 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4220 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004221 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004223 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 'R' Right-hand scrollbar is present when there is a vertically
4225 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004226 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004228 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 'L' Left-hand scrollbar is present when there is a vertically
4230 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004231 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4233 the longest visible line, or on the cursor line if the 'h'
4234 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004235 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 'h' Limit horizontal scrollbar size to the length of the cursor
4237 line. Reduces computations. |gui-horiz-scroll|
4238
4239 And yes, you may even have scrollbars on the left AND the right if
4240 you really want to :-). See |gui-scrollbars| for more information.
4241
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004242 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 'v' Use a vertical button layout for dialogs. When not included,
4244 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004245 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004246 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 'p' Use Pointer callbacks for X11 GUI. This is required for some
4248 window managers. If the cursor is not blinking or hollow at
4249 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004250 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004252 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004253 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004254 *'go-k'*
4255 'k' Keep the GUI window size when adding/removing a scrollbar, or
4256 toolbar, tabline, etc. Instead, the behavior is similar to
4257 when the window is maximized and will adjust 'lines' and
4258 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004259 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004260 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004261
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 *'guipty'* *'noguipty'*
4263'guipty' boolean (default on)
4264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 {only available when compiled with GUI enabled}
4266 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4267 I/O to/from shell commands. See |gui-pty|.
4268
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004269 *'guitablabel'* *'gtl'*
4270'guitablabel' 'gtl' string (default empty)
4271 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004272 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004273 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004274 pages line. When empty and when the result is empty Vim will use a
4275 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004276
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004277 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004278 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004279 The expression will be evaluated in the |sandbox| when set from a
4280 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004281 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004282
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004283 Only used when the GUI tab pages line is displayed. 'e' must be
4284 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4285 used.
4286
Bram Moolenaar57657d82006-04-21 22:12:41 +00004287 *'guitabtooltip'* *'gtt'*
4288'guitabtooltip' 'gtt' string (default empty)
4289 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004290 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004291 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004292 pages line. When empty Vim will use a default tooltip.
4293 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004294 You can include a line break. Simplest method is to use |:let|: >
4295 :let &guitabtooltip = "line one\nline two"
4296<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004297
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004299'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 (others) "$VIMRUNTIME/doc/help.txt")
4301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Name of the main help file. All distributed help files should be
4303 placed together in one directory. Additionally, all "doc" directories
4304 in 'runtimepath' will be used.
4305 Environment variables are expanded |:set_env|. For example:
4306 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004307 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 spaces and backslashes.
4309 This option cannot be set from a |modeline| or in the |sandbox|, for
4310 security reasons.
4311
4312 *'helpheight'* *'hh'*
4313'helpheight' 'hh' number (default 20)
4314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 Minimal initial height of the help window when it is opened with the
4316 ":help" command. The initial height of the help window is half of the
4317 current window, or (when the 'ea' option is on) the same as other
4318 windows. When the height is less than 'helpheight', the height is
4319 set to 'helpheight'. Set to zero to disable.
4320
4321 *'helplang'* *'hlg'*
4322'helplang' 'hlg' string (default: messages language or empty)
4323 global
4324 {only available when compiled with the |+multi_lang|
4325 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004326 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 for which the desired help can be found. The English help will always
4328 be used as a last resort. You can add "en" to prefer English over
4329 another language, but that will only find tags that exist in that
4330 language and not in the English help.
4331 Example: >
4332 :set helplang=de,it
4333< This will first search German, then Italian and finally English help
4334 files.
4335 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4336 try to find the tag in the current language before using this option.
4337 See |help-translated|.
4338
4339 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4340'hidden' 'hid' boolean (default off)
4341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 When off a buffer is unloaded when it is |abandon|ed. When on a
4343 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4344 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004345
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004347 hidden even if the 'hidden' option is off when these three are true:
4348 - the buffer is modified
4349 - 'autowrite' is off or writing is not possible
4350 - the '!' flag was used
4351 Also see |windows.txt|.
4352
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004353 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 This option is set for one command with ":hide {command}" |:hide|.
4355 WARNING: It's easy to forget that you have changes in hidden buffers.
4356 Think twice when using ":q!" or ":qa!".
4357
4358 *'highlight'* *'hl'*
4359'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004360 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4361 d:Directory,e:ErrorMsg,i:IncSearch,
4362 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004363 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004364 N:CursorLineNr,r:Question,s:StatusLine,
4365 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004366 v:Visual,V:VisualNOS,w:WarningMsg,
4367 W:WildMenu,f:Folded,F:FoldColumn,
4368 A:DiffAdd,C:DiffChange,D:DiffDelete,
4369 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004370 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004371 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004372 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004373 [:PmenuKind,]:PmenuKindSel,
4374 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004375 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4376 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004377 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004378 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004379 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004382 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004384 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004386 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4387 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 characters from 'showbreak'
4389 |hl-Directory| d directories in CTRL-D listing and other special
4390 things in listings
4391 |hl-ErrorMsg| e error messages
4392 h (obsolete, ignored)
4393 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004394 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4396 |hl-MoreMsg| m |more-prompt|
4397 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004398 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004399 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004400 |hl-LineNr| n line number for ":number" and ":#" commands, and
4401 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004402 |hl-LineNrAbove| a line number above the cursor for when the
4403 'relativenumber' option is set.
4404 |hl-LineNrBelow| b line number below the cursor for when the
4405 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004406 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4407 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 |hl-Question| r |hit-enter| prompt and yes/no questions
4409 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004410 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4412 |hl-VertSplit| c column used to separate vertically split windows
4413 |hl-Visual| v Visual mode
4414 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4415 Selection" Only X11 Gui's |gui-x11| and
4416 |xterm-clipboard|.
4417 |hl-WarningMsg| w warning messages
4418 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4419 |hl-Folded| f line used for closed folds
4420 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004421 |hl-DiffAdd| A added line in diff mode
4422 |hl-DiffChange| C changed line in diff mode
4423 |hl-DiffDelete| D deleted line in diff mode
4424 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004426 |hl-Conceal| - the placeholders used for concealed characters
4427 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004428 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004429 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004430 |hl-SpellRare| R rare word |spell|
4431 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004432 |hl-Pmenu| + popup menu normal line
4433 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004434 |hl-PmenuKind| [ popup menu "kind" normal line
4435 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004436 |hl-PmenuExtra| { popup menu "extra" normal line
4437 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004438 |hl-PmenuSbar| x popup menu scrollbar
4439 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004440 |hl-PmenuMatch| k popup menu matched text
4441 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442
4443 The display modes are:
4444 r reverse (termcap entry "mr" and "me")
4445 i italic (termcap entry "ZH" and "ZR")
4446 b bold (termcap entry "md" and "me")
4447 s standout (termcap entry "so" and "se")
4448 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004449 c undercurl (termcap entry "Us" and "Ce")
4450 2 double underline (termcap entry "Ds" and "Ce")
4451 d dotted underline (termcap entry "ds" and "Ce")
4452 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004453 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 n no highlighting
4455 - no highlighting
4456 : use a highlight group
4457 The default is used for occasions that are not included.
4458 If you want to change what the display modes do, see |dos-colors|
4459 for an example.
4460 When using the ':' display mode, this must be followed by the name of
4461 a highlight group. A highlight group can be used to define any type
4462 of highlighting, including using color. See |:highlight| on how to
4463 define one. The default uses a different group for each occasion.
4464 See |highlight-default| for the default highlight groups.
4465
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004467'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004470 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004471 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004472 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004473 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 NOTE: This option is set to the Vi default value when 'compatible' is
4475 set and to the Vim default value when 'compatible' is reset.
4476
4477 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4478'hkmap' 'hk' boolean (default off)
4479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 {only available when compiled with the |+rightleft|
4481 feature}
4482 When on, the keyboard is mapped for the Hebrew character set.
4483 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4484 toggle this option. See |rileft.txt|.
4485 NOTE: This option is reset when 'compatible' is set.
4486
4487 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4488'hkmapp' 'hkp' boolean (default off)
4489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 {only available when compiled with the |+rightleft|
4491 feature}
4492 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4493 This is useful if you have a non-Hebrew keyboard.
4494 See |rileft.txt|.
4495 NOTE: This option is reset when 'compatible' is set.
4496
Bram Moolenaar036986f2017-03-16 17:41:02 +01004497 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4498'hlsearch' 'hls' boolean (default off)
4499 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004500 {not available when compiled without the
4501 |+extra_search| feature}
4502 When there is a previous search pattern, highlight all its matches.
4503 The type of highlighting used can be set with the 'l' occasion in the
4504 'highlight' option. This uses the "Search" highlight group by
4505 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004506 are not applied. If the "CurSearch" highlight group is set then the
4507 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004508 See also: 'incsearch' and |:match|.
4509 When you get bored looking at the highlighted matches, you can turn it
4510 off with |:nohlsearch|. This does not change the option value, as
4511 soon as you use a search command, the highlighting comes back.
4512 'redrawtime' specifies the maximum time spent on finding matches.
4513 When the search pattern can match an end-of-line, Vim will try to
4514 highlight all of the matched text. However, this depends on where the
4515 search starts. This will be the first line in the window or the first
4516 line below a closed fold. A match in a previous line which is not
4517 drawn may not continue in a newly drawn line.
4518 You can specify whether the highlight status is restored on startup
4519 with the 'h' flag in 'viminfo' |viminfo-h|.
4520 NOTE: This option is reset when 'compatible' is set.
4521
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 *'icon'* *'noicon'*
4523'icon' boolean (default off, on when title can be restored)
4524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 When on, the icon text of the window will be set to the value of
4526 'iconstring' (if it is not empty), or to the name of the file
4527 currently being edited. Only the last part of the name is used.
4528 Overridden by the 'iconstring' option.
4529 Only works if the terminal supports setting window icons (currently
4530 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4531 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4532 builtin termcap).
4533 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004534 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004536 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537
4538 *'iconstring'*
4539'iconstring' string (default "")
4540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 When this option is not empty, it will be used for the icon text of
4542 the window. This happens only when the 'icon' option is on.
4543 Only works if the terminal supports setting window icon text
4544 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004545 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 When Vim was compiled with HAVE_X11 defined, the original icon will be
4547 restored if possible |X11|.
4548 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004549 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004551 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 {not available when compiled without the |+statusline| feature}
4553
4554 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4555'ignorecase' 'ic' boolean (default off)
4556 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004557 Ignore case in search patterns, |cmdline-completion|, when
4558 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004559 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 Can be overruled by using "\c" or "\C" in the pattern, see
4561 |/ignorecase|.
4562
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004563 *'imactivatefunc'* *'imaf'*
4564'imactivatefunc' 'imaf' string (default "")
4565 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004566 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004567 activate or deactivate the Input Method. The value can be the name of
4568 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4569 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004570 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004571 The expression will be evaluated in the |sandbox| when set from a
4572 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004573
4574 Example: >
4575 function ImActivateFunc(active)
4576 if a:active
4577 ... do something
4578 else
4579 ... do something
4580 endif
4581 " return value is not used
4582 endfunction
4583 set imactivatefunc=ImActivateFunc
4584<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 *'imactivatekey'* *'imak'*
4586'imactivatekey' 'imak' string (default "")
4587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004589 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 Specifies the key that your Input Method in X-Windows uses for
4591 activation. When this is specified correctly, vim can fully control
4592 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4593 You can't use this option to change the activation key, the option
4594 tells Vim what the key is.
4595 Format:
4596 [MODIFIER_FLAG-]KEY_STRING
4597
4598 These characters can be used for MODIFIER_FLAG (case is ignored):
4599 S Shift key
4600 L Lock key
4601 C Control key
4602 1 Mod1 key
4603 2 Mod2 key
4604 3 Mod3 key
4605 4 Mod4 key
4606 5 Mod5 key
4607 Combinations are allowed, for example "S-C-space" or "SC-space" are
4608 both shift+ctrl+space.
4609 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4610
4611 Example: >
4612 :set imactivatekey=S-space
4613< "S-space" means shift+space. This is the activation key for kinput2 +
4614 canna (Japanese), and ami (Korean).
4615
4616 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4617'imcmdline' 'imc' boolean (default off)
4618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 When set the Input Method is always on when starting to edit a command
4620 line, unless entering a search pattern (see 'imsearch' for that).
4621 Setting this option is useful when your input method allows entering
4622 English characters directly, e.g., when it's used to type accented
4623 characters with dead keys.
4624
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004625 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 When set the Input Method is never used. This is useful to disable
4629 the IM when it doesn't work properly.
4630 Currently this option is on by default for SGI/IRIX machines. This
4631 may change in later releases.
4632
4633 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004634'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Specifies whether :lmap or an Input Method (IM) is to be used in
4637 Insert mode. Valid values:
4638 0 :lmap is off and IM is off
4639 1 :lmap is ON and IM is off
4640 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 To always reset the option to zero when leaving Insert mode with <Esc>
4642 this can be used: >
4643 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4644< This makes :lmap and IM turn off automatically when leaving Insert
4645 mode.
4646 Note that this option changes when using CTRL-^ in Insert mode
4647 |i_CTRL-^|.
4648 The value is set to 1 when setting 'keymap' to a valid keymap name.
4649 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004650 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 methods. Use 'imdisable' to disable XIM then.
4652
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004653 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004654 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004655 |+multi_byte_ime| or |global-ime|.
4656
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004658'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 Specifies whether :lmap or an Input Method (IM) is to be used when
4661 entering a search pattern. Valid values:
4662 -1 the value of 'iminsert' is used, makes it look like
4663 'iminsert' is also used when typing a search pattern
4664 0 :lmap is off and IM is off
4665 1 :lmap is ON and IM is off
4666 2 :lmap is off and IM is ON
4667 Note that this option changes when using CTRL-^ in Command-line mode
4668 |c_CTRL-^|.
4669 The value is set to 1 when it is not -1 and setting the 'keymap'
4670 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004671 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 methods. Use 'imdisable' to disable XIM then.
4673
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004674 *'imstatusfunc'* *'imsf'*
4675'imstatusfunc' 'imsf' string (default "")
4676 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004677 This option specifies a function that is called to obtain the status
4678 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004679 The value can be the name of a function, a |lambda| or a |Funcref|.
4680 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004681 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004682
4683 Example: >
4684 function ImStatusFunc()
4685 let is_active = ...do something
4686 return is_active ? 1 : 0
4687 endfunction
4688 set imstatusfunc=ImStatusFunc
4689<
4690 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004691 The expression will be evaluated in the |sandbox| when set from a
4692 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004693
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004694 *'imstyle'* *'imst'*
4695'imstyle' 'imst' number (default 1)
4696 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004697 {only available when compiled with |+xim| and
4698 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004699 This option specifies the input style of Input Method:
4700 0 use on-the-spot style
4701 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004702 See: |xim-input-style|
4703
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004704 For a long time on-the-spot style had been used in the GTK version of
4705 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004706 |single-repeat|, etc. Therefore over-the-spot style becomes the
4707 default now. This should work fine for most people, however if you
4708 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004709 The expression will be evaluated in the |sandbox| when set from a
4710 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004711
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 *'include'* *'inc'*
4713'include' 'inc' string (default "^\s*#\s*include")
4714 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 {not available when compiled without the
4716 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004717 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 pattern, just like for the "/" command (See |pattern|). The default
4719 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004720 "]I", "[d", etc.
4721 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004722 comes after the matched pattern. But if "\zs" appears in the pattern
4723 then the text matched from "\zs" to the end, or until "\ze" if it
4724 appears, is used as the file name. Use this to include characters
4725 that are not in 'isfname', such as a space. You can then use
4726 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004727 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728
4729 *'includeexpr'* *'inex'*
4730'includeexpr' 'inex' string (default "")
4731 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004733 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004735 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004736 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004738 Note the double backslash: the `:set` command first halves them, then
4739 one remains it the value, where "\." matches a dot literally. For
4740 simple character replacements `tr()` avoids the need for escaping: >
4741 :setlocal includeexpr=tr(v:fname,'.','/')
4742<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004744 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 Also used for |<cfile>|.
4746
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004747 If the expression starts with s: or |<SID>|, then it is replaced with
4748 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004749 setlocal includeexpr=s:MyIncludeExpr()
4750 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004751< Otherwise, the expression is evaluated in the context of the script
4752 where the option was set, thus script-local items are available.
4753
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004754 It is more efficient if the value is just a function call without
4755 arguments, see |expr-option-function|.
4756
Bram Moolenaar30b65812012-07-12 22:01:11 +02004757 The expression will be evaluated in the |sandbox| when set from a
4758 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004759 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004760
4761 It is not allowed to change text or jump to another window while
4762 evaluating 'includeexpr' |textlock|.
4763
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004765'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004766 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004769 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004770 While typing a search command, show where the pattern, as it was typed
4771 so far, matches. The matched string is highlighted. If the pattern
4772 is invalid or not found, nothing is shown. The screen will be updated
4773 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004774 Also applies to the pattern in commands: >
4775 :global
4776 :lvimgrep
4777 :lvimgrepadd
4778 :smagic
4779 :snomagic
4780 :sort
4781 :substitute
4782 :vglobal
4783 :vimgrep
4784 :vimgrepadd
4785< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004786 original position when no match is found and when pressing <Esc>. You
4787 still need to finish the search command with <Enter> to move the
4788 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004789 You can use the CTRL-G and CTRL-T keys to move to the next and
4790 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004791 When compiled with the |+reltime| feature Vim only searches for about
4792 half a second. With a complicated pattern and/or a lot of text the
4793 match may not be found. This is to avoid that Vim hangs while you
4794 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004795 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004796 When 'hlsearch' is on, all matched strings are highlighted too while
4797 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004798 If you don't want to turn 'hlsearch' on, but want to highlight all
4799 matches while searching, you can turn on and off 'hlsearch' with
4800 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004801 augroup vimrc-incsearch-highlight
4802 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004803 autocmd CmdlineEnter /,\? :set hlsearch
4804 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004805 augroup END
4806<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004807 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004808 to the command line. If 'ignorecase' and 'smartcase' are set and the
4809 command line has no uppercase characters, the added character is
4810 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004811 CTRL-R CTRL-W can be used to add the word at the end of the current
4812 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 NOTE: This option is reset when 'compatible' is set.
4814
4815 *'indentexpr'* *'inde'*
4816'indentexpr' 'inde' string (default "")
4817 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004818 {not available when compiled without the |+eval|
4819 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 Expression which is evaluated to obtain the proper indent for a line.
4821 It is used when a new line is created, for the |=| operator and
4822 in Insert mode as specified with the 'indentkeys' option.
4823 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004824 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004825 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 When 'paste' is set this option is not used for indenting.
4827 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004828 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004830
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004831 If the expression starts with s: or |<SID>|, then it is replaced with
4832 the script ID (|local-function|). Example: >
4833 set indentexpr=s:MyIndentExpr()
4834 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004835< Otherwise, the expression is evaluated in the context of the script
4836 where the option was set, thus script-local items are available.
4837
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004838 The advantage of using a function call without arguments is that it is
4839 faster, see |expr-option-function|.
4840
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 The expression must return the number of spaces worth of indent. It
4842 can return "-1" to keep the current indent (this means 'autoindent' is
4843 used for the indent).
4844 Functions useful for computing the indent are |indent()|, |cindent()|
4845 and |lispindent()|.
4846 The evaluation of the expression must not have side effects! It must
4847 not change the text, jump to another window, etc. Afterwards the
4848 cursor position is always restored, thus the cursor may be moved.
4849 Normally this option would be set to call a function: >
4850 :set indentexpr=GetMyIndent()
4851< Error messages will be suppressed, unless the 'debug' option contains
4852 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004853 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004854 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
Bram Moolenaar30b65812012-07-12 22:01:11 +02004856 The expression will be evaluated in the |sandbox| when set from a
4857 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004858 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004859
4860 It is not allowed to change text or jump to another window while
4861 evaluating 'indentexpr' |textlock|.
4862
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004864'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 A list of keys that, when typed in Insert mode, cause reindenting of
4867 the current line. Only happens if 'indentexpr' isn't empty.
4868 The format is identical to 'cinkeys', see |indentkeys-format|.
4869 See |C-indenting| and |indent-expression|.
4870
4871 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4872'infercase' 'inf' boolean (default off)
4873 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004875 'ignorecase' is also on, the case of the match is adjusted depending
4876 on the typed text. If the typed text contains a lowercase letter
4877 where the match has an upper case letter, the completed part is made
4878 lowercase. If the typed text has no lowercase letters and the match
4879 has a lowercase letter where the typed text has an uppercase letter,
4880 and there is a letter before it, the completed part is made uppercase.
4881 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
4883 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4884'insertmode' 'im' boolean (default off)
4885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 Makes Vim work in a way that Insert mode is the default mode. Useful
4887 if you want to use Vim as a modeless editor. Used for |evim|.
4888 These Insert mode commands will be useful:
4889 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004890 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 this is a mapping, it is executed as if 'insertmode' was off.
4892 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004894 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4895 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
4897 These items change when 'insertmode' is set:
4898 - when starting to edit of a file, Vim goes to Insert mode.
4899 - <Esc> in Insert mode is a no-op and beeps.
4900 - <Esc> in Normal mode makes Vim go to Insert mode.
4901 - CTRL-L in Insert mode is a command, it is not inserted.
4902 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4903 However, when <Esc> is used inside a mapping, it behaves like
4904 'insertmode' was not set. This was done to be able to use the same
4905 mappings with 'insertmode' set or not set.
4906 When executing commands with |:normal| 'insertmode' is not used.
4907
4908 NOTE: This option is reset when 'compatible' is set.
4909
4910 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004911'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4913 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4914 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4915 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4916 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 The characters specified by this option are included in file names and
4919 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004920 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 Multi-byte characters 256 and above are always included, only the
4922 characters up to 255 are specified with this option.
4923 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004924 Think twice before adding white space to this option. Although a
4925 space may appear inside a file name, the effect will be that Vim
4926 doesn't know where a file name starts or ends when doing completion.
4927 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928
4929 Note that on systems using a backslash as path separator, Vim tries to
4930 do its best to make it work as you would expect. That is a bit
4931 tricky, since Vi originally used the backslash to escape special
4932 characters. Vim will not remove a backslash in front of a normal file
4933 name character on these systems, but it will on Unix and alikes. The
4934 '&' and '^' are not included by default, because these are special for
4935 cmd.exe.
4936
4937 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004938 Each part can be a single character number or a range. A range is two
4939 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 decimal number between 0 and 255 or the ASCII character itself (does
4941 not work for digits). Example:
4942 "_,-,128-140,#-43" (include '_' and '-' and the range
4943 128 to 140 and '#' to 43)
4944 If a part starts with '^', the following character number or range
4945 will be excluded from the option. The option is interpreted from left
4946 to right. Put the excluded character after the range where it is
4947 included. To include '^' itself use it as the last character of the
4948 option or the end of a range. Example:
4949 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4950 If the character is '@', all characters where isalpha() returns TRUE
4951 are included. Normally these are the characters a to z and A to Z,
4952 plus accented characters. To include '@' itself use "@-@". Examples:
4953 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004954 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 "a-z,A-Z,@-@" All letters plus the '@' character.
4956 A comma can be included by using it where a character number is
4957 expected. Example:
4958 "48-57,,,_" Digits, comma and underscore.
4959 A comma can be excluded by prepending a '^'. Example:
4960 " -~,^,,9" All characters from space to '~', excluding
4961 comma, plus <Tab>.
4962 See |option-backslash| about including spaces and backslashes.
4963
4964 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004965'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 "@,48-57,_,128-167,224-235"
4967 otherwise: "@,48-57,_,192-255")
4968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 The characters given by this option are included in identifiers.
4970 Identifiers are used in recognizing environment variables and after a
4971 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004972 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004973 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004975 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4977
4978 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004979'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 "@,48-57,_,128-167,224-235"
4981 otherwise: "@,48-57,_,192-255"
4982 Vi default: "@,48-57,_")
4983 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004985 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004986 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004987 characters above 255 check the "word" character class (any character
4988 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004989 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 For a help file it is set to all non-blank printable characters except
4991 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4992 command).
4993 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004994 This option also influences syntax highlighting, unless the syntax
4995 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 NOTE: This option is set to the Vi default value when 'compatible' is
4997 set and to the Vim default value when 'compatible' is reset.
4998
4999 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005000'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 "@,~-255"; otherwise: "@,161-255")
5002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 The characters given by this option are displayed directly on the
5004 screen. It is also used for "\p" in a |pattern|. The characters from
5005 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5006 even when they are not included in 'isprint' or excluded. See
5007 'isfname' for a description of the format of this option.
5008
5009 Non-printable characters are displayed with two characters:
5010 0 - 31 "^@" - "^_"
5011 32 - 126 always single characters
5012 127 "^?"
5013 128 - 159 "~@" - "~_"
5014 160 - 254 "| " - "|~"
5015 255 "~?"
5016 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5017 displayed as <xx>, with the hexadecimal value of the byte.
5018 When 'display' contains "uhex" all unprintable characters are
5019 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005020 The SpecialKey highlighting will be used for unprintable characters.
5021 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022
5023 Multi-byte characters 256 and above are always included, only the
5024 characters up to 255 are specified with this option. When a character
5025 is printable but it is not available in the current font, a
5026 replacement character will be shown.
5027 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5028 There is no option to specify these characters.
5029
5030 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5031'joinspaces' 'js' boolean (default on)
5032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 Insert two spaces after a '.', '?' and '!' with a join command.
5034 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5035 Otherwise only one space is inserted.
5036 NOTE: This option is set when 'compatible' is set.
5037
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005038 *'jumpoptions'* *'jop'*
5039'jumpoptions' 'jop' string (default "")
5040 global
5041 List of words that change the behavior of the |jumplist|.
5042 stack Make the jumplist behave like the tagstack.
5043 Relative location of entries in the jumplist is
5044 preserved at the cost of discarding subsequent entries
5045 when navigating backwards in the jumplist and then
5046 jumping to a location. |jumplist-stack|
5047
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 *'key'*
5049'key' string (default "")
5050 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005051 {only available when compiled with the |+cryptv|
5052 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005054 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 Careful: Do not set the key value by hand, someone might see the typed
5056 key. Use the |:X| command. But you can make 'key' empty: >
5057 :set key=
5058< It is not possible to get the value of this option with ":set key" or
5059 "echo &key". This is to avoid showing it to someone who shouldn't
5060 know. It also means you cannot see it yourself once you have set it,
5061 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005062 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5063 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005064 You can use "&key" in an expression to detect whether encryption is
5065 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066
5067 *'keymap'* *'kmp'* *E544*
5068'keymap' 'kmp' string (default "")
5069 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 {only available when compiled with the |+keymap|
5071 feature}
5072 Name of a keyboard mapping. See |mbyte-keymap|.
5073 Setting this option to a valid keymap name has the side effect of
5074 setting 'iminsert' to one, so that the keymap becomes effective.
5075 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005076 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077
5078 *'keymodel'* *'km'*
5079'keymodel' 'km' string (default "")
5080 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005081 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 can do. These values can be used:
5083 startsel Using a shifted special key starts selection (either
5084 Select mode or Visual mode, depending on "key" being
5085 present in 'selectmode').
5086 stopsel Using a not-shifted special key stops selection.
5087 Special keys in this context are the cursor keys, <End>, <Home>,
5088 <PageUp> and <PageDown>.
5089 The 'keymodel' option is set by the |:behave| command.
5090
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005091 *'keyprotocol'* *'kpc'*
5092'keyprotocol' 'kpc' string (default: see below)
5093 global
5094 Specifies what keyboard protocol to use depending on the value of
5095 'term'. The supported keyboard protocols names are:
5096 none whatever the terminal uses
5097 mok2 modifyOtherKeys level 2, as supported by xterm
5098 kitty Kitty keyboard protocol, as supported by Kitty
5099
Bram Moolenaara87749e2022-11-30 10:23:17 +00005100 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005101 a pattern that is matched against the 'term' option, a colon and the
5102 protocol name to be used. To illustrate this, the default value would
5103 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005104 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5105 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005106
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005107< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005108 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5109 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005110
5111 The first match is used, thus if you want to have "kitty" use the
5112 kitty protocol, but "badkitty" not, then you should match "badkitty"
5113 first and use the "none" value: >
5114 set keyprotocol=badkitty:none,kitty:kitty
5115<
5116 The option is used after 'term' has been changed. First the termcap
5117 entries are set, possibly using the builtin list, see |builtin-terms|.
5118 Then this option is inspected and if there is a match and a protocol
5119 is specified the following happens:
5120 none Nothing, the regular t_TE and t_TI values remain
5121
5122 mok2 The t_TE value is changed to:
5123 CSI >4;m disables modifyOtherKeys
5124 The t_TI value is changed to:
5125 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005126 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005127
5128 kitty The t_TE value is changed to:
5129 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005130 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005131 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005132 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005133 CSI ?u request kitty keyboard protocol state
5134 CSI >c request the termresponse
5135
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005136 If you notice problems, such as characters being displayed that
5137 disappear after `CTRL-L`, you might want to try making this option
5138 empty. Then set the 'term' option to have it take effect: >
5139 set keyprotocol=
5140 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005141<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005142
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 *'keywordprg'* *'kp'*
5144'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005145 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 Program to use for the |K| command. Environment variables are
5148 expanded |:set_env|. ":help" may be used to access the Vim internal
5149 help. (Note that previously setting the global option to the empty
5150 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005151 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005152 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005153 When "man", "man -s" or an Ex command is used, Vim will automatically
5154 translate a count for the "K" command and pass it as the first
5155 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 See |option-backslash| about including spaces and backslashes.
5157 Example: >
5158 :set keywordprg=man\ -s
5159< This option cannot be set from a |modeline| or in the |sandbox|, for
5160 security reasons.
5161
5162 *'langmap'* *'lmap'* *E357* *E358*
5163'langmap' 'lmap' string (default "")
5164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 {only available when compiled with the |+langmap|
5166 feature}
5167 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005168 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005169 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 care of translating these special characters to the original meaning
5171 of the key. This means you don't have to change the keyboard mode to
5172 be able to execute Normal mode commands.
5173 This is the opposite of the 'keymap' option, where characters are
5174 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005175 Also consider setting 'langremap' to off, to prevent 'langmap' from
5176 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005177 This option cannot be set from a |modeline| or in the |sandbox|, for
5178 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005180 Example (for Greek, in UTF-8): *greek* >
5181 :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 +00005182< Example (exchanges meaning of z and y for commands): >
5183 :set langmap=zy,yz,ZY,YZ
5184<
5185 The 'langmap' option is a list of parts, separated with commas. Each
5186 part can be in one of two forms:
5187 1. A list of pairs. Each pair is a "from" character immediately
5188 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005189 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 characters. Example: "abc;ABC"
5191 Example: "aA,fgh;FGH,cCdDeE"
5192 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005193 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 This will allow you to activate vim actions without having to switch
5196 back and forth between the languages. Your language characters will
5197 be understood as normal vim English characters (according to the
5198 langmap mappings) in the following cases:
5199 o Normal/Visual mode (commands, buffer/register names, user mappings)
5200 o Insert/Replace Mode: Register names after CTRL-R
5201 o Insert/Replace Mode: Mappings
5202 Characters entered in Command-line mode will NOT be affected by
5203 this option. Note that this option can be changed at any time
5204 allowing to switch between mappings for different languages/encodings.
5205 Use a mapping to avoid having to type it each time!
5206
5207 *'langmenu'* *'lm'*
5208'langmenu' 'lm' string (default "")
5209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 {only available when compiled with the |+menu| and
5211 |+multi_lang| features}
5212 Language to use for menu translation. Tells which file is loaded
5213 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005214 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215< (without the spaces). For example, to always use the Dutch menus, no
5216 matter what $LANG is set to: >
5217 :set langmenu=nl_NL.ISO_8859-1
5218< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005219 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 If your $LANG is set to a non-English language but you do want to use
5221 the English menus: >
5222 :set langmenu=none
5223< This option must be set before loading menus, switching on filetype
5224 detection or syntax highlighting. Once the menus are defined setting
5225 this option has no effect. But you could do this: >
5226 :source $VIMRUNTIME/delmenu.vim
5227 :set langmenu=de_DE.ISO_8859-1
5228 :source $VIMRUNTIME/menu.vim
5229< Warning: This deletes all menus that you defined yourself!
5230
Bram Moolenaard94464e2015-11-02 15:28:18 +01005231 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005232'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005233 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005234 {only available when compiled with the |+langmap|
5235 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005236 This is just like 'langremap' but with the value inverted. It only
5237 exists for backwards compatibility. When setting 'langremap' then
5238 'langnoremap' is set to the inverted value, and the other way around.
5239
5240 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005241'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005242 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005243 {only available when compiled with the |+langmap|
5244 feature}
5245 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005246 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005247 'langmap' disables some of your mappings, try resetting this option.
5248 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005249 that works for you to avoid mappings to break.
5250
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 *'laststatus'* *'ls'*
5252'laststatus' 'ls' number (default 1)
5253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 The value of this option influences when the last window will have a
5255 status line:
5256 0: never
5257 1: only if there are at least two windows
5258 2: always
5259 The screen looks nicer with a status line if you have several
5260 windows, but it takes another screen line. |status-line|
5261
5262 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5263'lazyredraw' 'lz' boolean (default off)
5264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 When this option is set, the screen will not be redrawn while
5266 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005267 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005269 This may occasionally cause display errors. It is only meant to be set
5270 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005271 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272
5273 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5274'linebreak' 'lbr' boolean (default off)
5275 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005276 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005278 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 than at the last character that fits on the screen. Unlike
5280 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005281 it only affects the way the file is displayed, not its contents.
5282 If 'breakindent' is set, line is visually indented. Then, the value
5283 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005284 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 Note that <Tab> characters after an <EOL> are mostly not displayed
5286 with the right amount of white space.
5287
5288 *'lines'* *E593*
5289'lines' number (default 24 or terminal height)
5290 global
5291 Number of lines of the Vim window.
5292 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005293 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 When Vim is running in the GUI or in a resizable window, setting this
5295 option will cause the window size to be changed. When you only want
5296 to use the size for the GUI, put the command in your |gvimrc| file.
5297 Vim limits the number of lines to what fits on the screen. You can
5298 use this command to get the tallest window possible: >
5299 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005300< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005301 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 When you set this option and Vim is unable to change the physical
5303 number of lines of the display, the display may be messed up.
5304
5305 *'linespace'* *'lsp'*
5306'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 {only in the GUI}
5309 Number of pixel lines inserted between characters. Useful if the font
5310 uses the full character cell height, making lines touch each other.
5311 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005312 With some fonts there can be too much room between lines (to have
5313 space for ascents and descents). Then it makes sense to set
5314 'linespace' to a negative value. This may cause display problems
5315 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
5317 *'lisp'* *'nolisp'*
5318'lisp' boolean (default off)
5319 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 Lisp mode: When <Enter> is typed in insert mode set the indent for
5321 the next line to Lisp standards (well, sort of). Also happens with
5322 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5323 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5324 better. Also see 'lispwords'.
5325 The '-' character is included in keyword characters. Redefines the
5326 "=" operator to use this same indentation algorithm rather than
5327 calling an external program if 'equalprg' is empty.
5328 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005330 *'lispoptions'* *'lop'*
5331'lispoptions' 'lop' string (default "")
5332 local to buffer
5333 Comma-separated list of items that influence the Lisp indenting when
5334 enabled with the |'lisp'| option. Currently only one item is
5335 supported:
5336 expr:1 use 'indentexpr' for Lisp indenting when it is set
5337 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5338 Note that when using 'indentexpr' the `=` operator indents all the
5339 lines, otherwise the first line is not indented (Vi-compatible).
5340
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 *'lispwords'* *'lw'*
5342'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005343 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005344 Comma-separated list of words that influence the Lisp indenting when
5345 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346
5347 *'list'* *'nolist'*
5348'list' boolean (default off)
5349 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005350 List mode: By default show tabs as CTRL-I is displayed, display $
5351 after end of line. Useful to see the difference between tabs and
5352 spaces and for trailing blanks. Further changed by the 'listchars'
5353 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005354
5355 The cursor is displayed at the start of the space a Tab character
5356 occupies, not at the end as usual in Normal mode. To get this cursor
5357 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005358 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005359<
5360 Note that list mode will also affect formatting (set with 'textwidth'
5361 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 changing the way tabs are displayed.
5363
5364 *'listchars'* *'lcs'*
5365'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005366 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005367 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005368 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005369 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 eol:c Character to show at the end of each line. When
5371 omitted, there is no extra character at the end of the
5372 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005373 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005374 tab:xy[z] Two or three characters to be used to show a tab.
5375 The third character is optional.
5376
5377 tab:xy The 'x' is always used, then 'y' as many times as will
5378 fit. Thus "tab:>-" displays:
5379 >
5380 >-
5381 >--
5382 etc.
5383
5384 tab:xyz The 'z' is always used, then 'x' is prepended, and
5385 then 'y' is used as many times as will fit. Thus
5386 "tab:<->" displays:
5387 >
5388 <>
5389 <->
5390 <-->
5391 etc.
5392
5393 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005394 *lcs-space*
5395 space:c Character to show for a space. When omitted, spaces
5396 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005397 *lcs-multispace*
5398 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005399 One or more characters to use cyclically to show for
5400 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005401 setting, except for single spaces. When omitted, the
5402 "space" setting is used. For example,
5403 `:set listchars=multispace:---+` shows ten consecutive
5404 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005405 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005406 *lcs-lead*
5407 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005408 leading spaces are blank. Overrides the "space" and
5409 "multispace" settings for leading spaces. You can
5410 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005411 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005412< *lcs-leadmultispace*
5413 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005414 Like the |lcs-multispace| value, but for leading
5415 spaces only. Also overrides |lcs-lead| for leading
5416 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005417 `:set listchars=leadmultispace:---+` shows ten
5418 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005419 ---+---+--XXX ~
5420 Where "XXX" denotes the first non-blank characters in
5421 the line.
5422 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005423 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005424 trailing spaces are blank. Overrides the "space" and
5425 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005426 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 extends:c Character to show in the last column, when 'wrap' is
5428 off and the line continues beyond the right of the
5429 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005430 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005431 precedes:c Character to show in the first visible column of the
5432 physical line, when there is text preceding the
5433 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005434 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005435 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005436 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005437 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005438 nbsp:c Character to show for a non-breakable space character
5439 (0xA0 (160 decimal) and U+202F). Left blank when
5440 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005442 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005444 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005446 Each character can be specified as hex: >
5447 set listchars=eol:\\x24
5448 set listchars=eol:\\u21b5
5449 set listchars=eol:\\U000021b5
5450< Note that a double backslash is used. The number of hex characters
5451 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5452
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 Examples: >
5454 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005455 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 :set lcs=extends:>,precedes:<
5457< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005458 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5459 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005460 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5463'loadplugins' 'lpl' boolean (default on)
5464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 When on the plugin scripts are loaded when starting up |load-plugins|.
5466 This option can be reset in your |vimrc| file to disable the loading
5467 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005468 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5469 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470
Bram Moolenaard94464e2015-11-02 15:28:18 +01005471 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005472'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005473 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005474 {only available when compiled with the |+lua/dyn|
5475 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005476 Specifies the name of the Lua shared library. The default is
5477 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005478 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005479 This option cannot be set from a |modeline| or in the |sandbox|, for
5480 security reasons.
5481
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005482 *'macatsui'* *'nomacatsui'*
5483'macatsui' boolean (default on)
5484 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005485 {not supported}
5486 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005487
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 *'magic'* *'nomagic'*
5489'magic' boolean (default on)
5490 global
5491 Changes the special characters that can be used in search patterns.
5492 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005493 WARNING: Switching this option off most likely breaks plugins! That
5494 is because many patterns assume it's on and will fail when it's off.
5495 Only switch it off when working with old Vi scripts. In any other
5496 situation write patterns that work when 'magic' is on. Include "\M"
5497 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005498 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5499 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500
5501 *'makeef'* *'mef'*
5502'makeef' 'mef' string (default: "")
5503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 {not available when compiled without the |+quickfix|
5505 feature}
5506 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5507 and the |:grep| command.
5508 When it is empty, an internally generated temp file will be used.
5509 When "##" is included, it is replaced by a number to make the name
5510 unique. This makes sure that the ":make" command doesn't overwrite an
5511 existing file.
5512 NOT used for the ":cf" command. See 'errorfile' for that.
5513 Environment variables are expanded |:set_env|.
5514 See |option-backslash| about including spaces and backslashes.
5515 This option cannot be set from a |modeline| or in the |sandbox|, for
5516 security reasons.
5517
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005518 *'makeencoding'* *'menc'*
5519'makeencoding' 'menc' string (default "")
5520 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005521 Encoding used for reading the output of external commands. When empty,
5522 encoding is not converted.
5523 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5524 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5525 and `:laddfile`.
5526
5527 This would be mostly useful when you use MS-Windows and set 'encoding'
5528 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5529 'makeencoding' to "char" has the same effect as setting to the system
5530 locale encoding. Example: >
5531 :set encoding=utf-8
5532 :set makeencoding=char " system locale is used
5533<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 *'makeprg'* *'mp'*
5535'makeprg' 'mp' string (default "make", VMS: "MMS")
5536 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005537 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005538 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5539 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005540 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005541 Environment variables are expanded |:set_env|. See |option-backslash|
5542 about including spaces and backslashes.
5543 Note that a '|' must be escaped twice: once for ":set" and once for
5544 the interpretation of a command. When you use a filter called
5545 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 :set makeprg=gmake\ \\\|\ myfilter
5547< The placeholder "$*" can be given (even multiple times) to specify
5548 where the arguments will be included, for example: >
5549 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5550< This option cannot be set from a |modeline| or in the |sandbox|, for
5551 security reasons.
5552
5553 *'matchpairs'* *'mps'*
5554'matchpairs' 'mps' string (default "(:),{:},[:]")
5555 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005557 other.
5558 Only character pairs are allowed that are different, thus you cannot
5559 jump between two double quotes.
5560 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005561 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005562 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 :set mps+=<:>
5564
5565< A more exotic example, to jump between the '=' and ';' in an
5566 assignment, useful for languages like C and Java: >
5567 :au FileType c,cpp,java set mps+==:;
5568
5569< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005570 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571
5572 *'matchtime'* *'mat'*
5573'matchtime' 'mat' number (default 5)
5574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 Tenths of a second to show the matching paren, when 'showmatch' is
5576 set. Note that this is not in milliseconds, like other options that
5577 set a time. This is to be compatible with Nvi.
5578
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005579 *'maxcombine'* *'mco'*
5580'maxcombine' 'mco' number (default 2)
5581 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005582 The maximum number of combining characters supported for displaying.
5583 Only used when 'encoding' is "utf-8".
5584 The default is OK for most languages. Hebrew may require 4.
5585 Maximum value is 6.
5586 Even when this option is set to 2 you can still edit text with more
5587 combining characters, you just can't see them. Use |g8| or |ga|.
5588 See |mbyte-combining|.
5589
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 *'maxfuncdepth'* *'mfd'*
5591'maxfuncdepth' 'mfd' number (default 100)
5592 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005593 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005594 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 Maximum depth of function calls for user functions. This normally
5596 catches endless recursion. When using a recursive function with
5597 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5598 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005599 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005600 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005602 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603
5604 *'maxmapdepth'* *'mmd'* *E223*
5605'maxmapdepth' 'mmd' number (default 1000)
5606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 Maximum number of times a mapping is done without resulting in a
5608 character to be used. This normally catches endless mappings, like
5609 ":map x y" with ":map y x". It still does not catch ":map g wg",
5610 because the 'w' is used before the next mapping is done. See also
5611 |key-mapping|.
5612
5613 *'maxmem'* *'mm'*
5614'maxmem' 'mm' number (default between 256 to 5120 (system
5615 dependent) or half the amount of memory
5616 available)
5617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5619 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005620 other memory to be freed.
5621 The maximum usable value is about 2000000. Use this to work without a
5622 limit.
5623 The value is ignored when 'swapfile' is off.
5624 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005626 *'maxmempattern'* *'mmp'*
5627'maxmempattern' 'mmp' number (default 1000)
5628 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005629 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005630 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005631 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005632 When Vim runs into the limit it gives an error message and mostly
5633 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005634 Running into the limit often means that the pattern is very
5635 inefficient or too complex. This may already happen with the pattern
5636 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005637 Might also happen on redraw, when syntax rules try to match a complex
5638 text structure.
5639 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5640 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005641
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 *'maxmemtot'* *'mmt'*
5643'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5644 dependent) or half the amount of memory
5645 available)
5646 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005647 Maximum amount of memory in Kbyte to use for all buffers together.
5648 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005649 without a limit.
5650 On 64 bit machines higher values might work. But hey, do you really
5651 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005652 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005653 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005654 Buffers with 'swapfile' off still count to the total amount of memory
5655 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005656 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657
5658 *'menuitems'* *'mis'*
5659'menuitems' 'mis' number (default 25)
5660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 {not available when compiled without the |+menu|
5662 feature}
5663 Maximum number of items to use in a menu. Used for menus that are
5664 generated from a list of items, e.g., the Buffers menu. Changing this
5665 option has no direct effect, the menu must be refreshed first.
5666
Christian Brabandt51d4d842024-12-06 17:26:25 +01005667 *'messagesopt'* *'mopt'*
5668'messagesopt' 'mopt' string (default "hit-enter,history:500")
5669 global
5670
zeertzjq8cc43da2024-12-07 16:09:08 +01005671 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005672 following items. Items must be separated by a comma.
5673
zeertzjq8cc43da2024-12-07 16:09:08 +01005674 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005675 'cmdheight' size.
5676
zeertzjq8cc43da2024-12-07 16:09:08 +01005677 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5678 {n} milliseconds so that the user has a chance to read
5679 the message. The maximum value of {n} is 10000. Use
5680 0 to disable the wait (but then the user may miss an
5681 important message).
5682 This item is ignored when "hit-enter" is present, but
5683 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005684
5685 history:{n} Determines how many entries are remembered in the
5686 |:messages| history. The maximum value is 10000.
5687 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005688 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005689
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005690 *'mkspellmem'* *'msm'*
5691'mkspellmem' 'msm' string (default "460000,2000,500")
5692 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005693 {not available when compiled without the |+syntax|
5694 feature}
5695 Parameters for |:mkspell|. This tunes when to start compressing the
5696 word tree. Compression can be slow when there are many words, but
5697 it's needed to avoid running out of memory. The amount of memory used
5698 per word depends very much on how similar the words are, that's why
5699 this tuning is complicated.
5700
5701 There are three numbers, separated by commas:
5702 {start},{inc},{added}
5703
5704 For most languages the uncompressed word tree fits in memory. {start}
5705 gives the amount of memory in Kbyte that can be used before any
5706 compression is done. It should be a bit smaller than the amount of
5707 memory that is available to Vim.
5708
5709 When going over the {start} limit the {inc} number specifies the
5710 amount of memory in Kbyte that can be allocated before another
5711 compression is done. A low number means compression is done after
5712 less words are added, which is slow. A high number means more memory
5713 will be allocated.
5714
5715 After doing compression, {added} times 1024 words can be added before
5716 the {inc} limit is ignored and compression is done when any extra
5717 amount of memory is needed. A low number means there is a smaller
5718 chance of hitting the {inc} limit, less memory is used but it's
5719 slower.
5720
5721 The languages for which these numbers are important are Italian and
5722 Hungarian. The default works for when you have about 512 Mbyte. If
5723 you have 1 Gbyte you could use: >
5724 :set mkspellmem=900000,3000,800
5725< If you have less than 512 Mbyte |:mkspell| may fail for some
5726 languages, no matter what you set 'mkspellmem' to.
5727
dkearns8ebdbc92023-10-29 06:26:19 +11005728 This option cannot be set from a |modeline| or in the |sandbox|, for
5729 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005730
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005732'modeline' 'ml' boolean (Vim default: on (off for root),
5733 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005735 If 'modeline' is on 'modelines' gives the number of lines that is
5736 checked for set commands. If 'modeline' is off or 'modelines' is zero
5737 no lines are checked. See |modeline|.
5738
5739 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5740'modelineexpr' 'mle' boolean (default: off)
5741 global
5742 When on allow some options that are an expression to be set in the
5743 modeline. Check the option for whether it is affected by
5744 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005745 This option cannot be set from a |modeline| or in the |sandbox|, for
5746 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005747
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 *'modelines'* *'mls'*
5749'modelines' 'mls' number (default 5)
5750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 If 'modeline' is on 'modelines' gives the number of lines that is
5752 checked for set commands. If 'modeline' is off or 'modelines' is zero
5753 no lines are checked. See |modeline|.
5754 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5755 set and to the Vim default value when 'compatible' is reset.
5756
5757 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005758 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759'modifiable' 'ma' boolean (default on)
5760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 When off the buffer contents cannot be changed. The 'fileformat' and
5762 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005763 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764
5765 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5766'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005767 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 When on, the buffer is considered to be modified. This option is set
5769 when:
5770 1. A change was made to the text since it was last written. Using the
5771 |undo| command to go back to the original text will reset the
5772 option. But undoing changes that were made before writing the
5773 buffer will set the option again, since the text is different from
5774 when it was written.
5775 2. 'fileformat' or 'fileencoding' is different from its original
5776 value. The original value is set when the buffer is read or
5777 written. A ":set nomodified" command also resets the original
5778 values to the current values and the 'modified' option will be
5779 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005780 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005781 This option is not set when a change is made to the buffer as the
5782 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5783 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5784 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5786 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005787 Note that the text may actually be the same, e.g. 'modified' is set
5788 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
5790 *'more'* *'nomore'*
5791'more' boolean (Vim default: on, Vi default: off)
5792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 When on, listings pause when the whole screen is filled. You will get
5794 the |more-prompt|. When this option is off there are no pauses, the
5795 listing continues until finished.
5796 NOTE: This option is set to the Vi default value when 'compatible' is
5797 set and to the Vim default value when 'compatible' is reset.
5798
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005799 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005800'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005801 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005803 Enable the use of the mouse. Works for most terminals (xterm, Win32
5804 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5805 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5806 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005807 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 v Visual mode
5809 i Insert mode
5810 c Command-line mode
5811 h all previous modes when editing a help file
5812 a all previous modes
5813 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005814 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005816< If your terminal can't overrule the mouse events going to the
5817 application, use: >
5818 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005819< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005820 back to Vim using the mouse events.
5821 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5822 "xterm".
5823
5824 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 modeless selection. This doesn't move the text cursor.
5826
5827 See |mouse-using|. Also see |'clipboard'|.
5828
5829 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005830 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 the mouse buttons can still be used by keeping the shift key pressed.
5832 Also see the 'clipboard' option.
5833
5834 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5835'mousefocus' 'mousef' boolean (default off)
5836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 {only works in the GUI}
5838 The window that the mouse pointer is on is automatically activated.
5839 When changing the window layout or window focus in another way, the
5840 mouse pointer is moved to the window with keyboard focus. Off is the
5841 default because it makes using the pull down menus a little goofy, as
5842 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005843 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005844 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845
5846 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5847'mousehide' 'mh' boolean (default on)
5848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 {only works in the GUI}
5850 When on, the mouse pointer is hidden when characters are typed.
5851 The mouse pointer is restored when the mouse is moved.
5852
5853 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005854'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 Sets the model to use for the mouse. The name mostly specifies what
5857 the right mouse button is used for:
5858 extend Right mouse button extends a selection. This works
5859 like in an xterm.
5860 popup Right mouse button pops up a menu. The shifted left
5861 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005862 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 popup_setpos Like "popup", but the cursor will be moved to the
5864 position where the mouse was clicked, and thus the
5865 selected operation will act upon the clicked object.
5866 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005867 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 course, that right clicking outside a selection will
5869 end Visual mode.
5870 Overview of what button does what for each model:
5871 mouse extend popup(_setpos) ~
5872 left click place cursor place cursor
5873 left drag start selection start selection
5874 shift-left search word extend selection
5875 right click extend selection popup menu (place cursor)
5876 right drag extend selection -
5877 middle click paste paste
5878
5879 In the "popup" model the right mouse button produces a pop-up menu.
5880 You need to define this first, see |popup-menu|.
5881
5882 Note that you can further refine the meaning of buttons with mappings.
5883 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5884 selection (because that's handled in the GUI code directly).
5885
5886 The 'mousemodel' option is set by the |:behave| command.
5887
h_east59858792023-10-25 22:47:05 +09005888 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005889'mousemoveevent' 'mousemev' boolean (default off)
5890 global
5891 {only works in the GUI}
5892 When on, mouse move events are delivered to the input queue and are
5893 available for mapping. The default, off, avoids the mouse movement
5894 overhead except when needed. See |gui-mouse-mapping|.
5895 Warning: Setting this option can make pending mappings to be aborted
5896 when the mouse is moved.
5897 Currently only works in the GUI, may be made to work in a terminal
5898 later.
5899
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005901'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5902 vs:leftright,vd:lrsizing,m:no,
5903 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 {only available when compiled with the |+mouseshape|
5906 feature}
5907 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005908 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 like used for 'guicursor'. Each part consist of a mode/location-list
5910 and an argument-list:
5911 mode-list:shape,mode-list:shape,..
5912 The mode-list is a dash separated list of these modes/locations:
5913 In a normal window: ~
5914 n Normal mode
5915 v Visual mode
5916 ve Visual mode with 'selection' "exclusive" (same as 'v',
5917 if not specified)
5918 o Operator-pending mode
5919 i Insert mode
5920 r Replace mode
5921
5922 Others: ~
5923 c appending to the command-line
5924 ci inserting in the command-line
5925 cr replacing in the command-line
5926 m at the 'Hit ENTER' or 'More' prompts
5927 ml idem, but cursor in the last line
5928 e any mode, pointer below last window
5929 s any mode, pointer on a status line
5930 sd any mode, while dragging a status line
5931 vs any mode, pointer on a vertical separator line
5932 vd any mode, while dragging a vertical separator line
5933 a everywhere
5934
5935 The shape is one of the following:
5936 avail name looks like ~
5937 w x arrow Normal mouse pointer
5938 w x blank no pointer at all (use with care!)
5939 w x beam I-beam
5940 w x updown up-down sizing arrows
5941 w x leftright left-right sizing arrows
5942 w x busy The system's usual busy pointer
5943 w x no The system's usual 'no input' pointer
5944 x udsizing indicates up-down resizing
5945 x lrsizing indicates left-right resizing
5946 x crosshair like a big thin +
5947 x hand1 black hand
5948 x hand2 white hand
5949 x pencil what you write with
5950 x question big ?
5951 x rightup-arrow arrow pointing right-up
5952 w x up-arrow arrow pointing up
5953 x <number> any X11 pointer number (see X11/cursorfont.h)
5954
5955 The "avail" column contains a 'w' if the shape is available for Win32,
5956 x for X11.
5957 Any modes not specified or shapes not available use the normal mouse
5958 pointer.
5959
5960 Example: >
5961 :set mouseshape=s:udsizing,m:no
5962< will make the mouse turn to a sizing arrow over the status lines and
5963 indicate no input when the hit-enter prompt is displayed (since
5964 clicking the mouse has no effect in this state.)
5965
5966 *'mousetime'* *'mouset'*
5967'mousetime' 'mouset' number (default 500)
5968 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005969 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 time in msec between two mouse clicks for the second click to be
5971 recognized as a multi click.
5972
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01005973
laburnumT3f7855a2023-12-05 18:37:03 +01005974 *'mzquantum'* *'mzq'*
5975'mzquantum' 'mzq' number (default 100)
5976 global
5977 {not available when compiled without the |+mzscheme|
5978 feature}
5979 The number of milliseconds between polls for MzScheme threads.
5980 Negative or zero value means no thread scheduling.
5981 NOTE: This option is set to the Vim default value when 'compatible'
5982 is reset.
5983
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005984 *'mzschemedll'*
5985'mzschemedll' string (default depends on the build)
5986 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005987 {only available when compiled with the |+mzscheme/dyn|
5988 feature}
5989 Specifies the name of the MzScheme shared library. The default is
5990 DYNAMIC_MZSCH_DLL which was specified at compile time.
5991 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005992 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005993 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
5996
5997 *'mzschemegcdll'*
5998'mzschemegcdll' string (default depends on the build)
5999 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006000 {only available when compiled with the |+mzscheme/dyn|
6001 feature}
6002 Specifies the name of the MzScheme GC shared library. The default is
6003 DYNAMIC_MZGC_DLL which was specified at compile time.
6004 The value can be equal to 'mzschemedll' if it includes the GC code.
6005 Environment variables are expanded |:set_env|.
6006 This option cannot be set from a |modeline| or in the |sandbox|, for
6007 security reasons.
6008
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006010'nrformats' 'nf' string (default "bin,octal,hex",
6011 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 This defines what bases Vim will consider for numbers when using the
6014 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6015 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006016 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006018 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006019 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006021 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 considered to be hexadecimal. Example: Using CTRL-X on
6023 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006024 bin If included, numbers starting with "0b" or "0B" will be
6025 considered to be binary. Example: Using CTRL-X on
6026 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006027 unsigned If included, numbers are recognized as unsigned. Thus a
6028 leading dash or negative sign won't be considered as part of
6029 the number. Examples:
6030 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6031 (without "unsigned" it would become "9-2021").
6032 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6033 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006034 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6035 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006036 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006037 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006038 dash immediately preceded by a non-whitespace character (i.e.,
6039 not a tab or a " "), the negative sign won't be considered as
6040 part of the number. For example:
6041 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6042 (without "blank" it would become "Carbon-13").
6043 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006044 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006045 set, it would result in "Carbon -7").
6046 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006047 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006048 included, "unsigned" will take precedence.
6049
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 Numbers which simply begin with a digit in the range 1-9 are always
6051 considered decimal. This also happens for numbers that are not
6052 recognized as octal or hex.
6053
6054 *'number'* *'nu'* *'nonumber'* *'nonu'*
6055'number' 'nu' boolean (default off)
6056 local to window
6057 Print the line number in front of each line. When the 'n' option is
6058 excluded from 'cpoptions' a wrapped line will not use the column of
6059 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006060 The 'numberwidth' option can be used to set the room used for the line
6061 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 When a long, wrapped line doesn't start with the first character, '-'
6063 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006064 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6065 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006066 *number_relativenumber*
6067 The 'relativenumber' option changes the displayed number to be
6068 relative to the cursor. Together with 'number' there are these
6069 four combinations (cursor in line 3):
6070
Bram Moolenaar3848e002016-03-19 18:42:29 +01006071 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006072 'nornu' 'nornu' 'rnu' 'rnu'
6073
6074 |apple | 1 apple | 2 apple | 2 apple
6075 |pear | 2 pear | 1 pear | 1 pear
6076 |nobody | 3 nobody | 0 nobody |3 nobody
6077 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006079 *'numberwidth'* *'nuw'*
6080'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6081 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006082 {only available when compiled with the |+linebreak|
6083 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006084 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006085 when the 'number' or 'relativenumber' option is set or printing lines
6086 with a line number. Since one space is always between the number and
6087 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006088 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006089 fit the highest line number in the buffer respectively the number of
6090 rows in the window, depending on whether 'number' or 'relativenumber'
6091 is set. Thus with the Vim default of 4 there is room for a line number
6092 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006093 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006094 NOTE: This option is set to the Vi default value when 'compatible' is
6095 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006096
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006097 *'omnifunc'* *'ofu'*
6098'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006099 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006100 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006101 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006102 This option specifies a function to be used for Insert mode omni
6103 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006104 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006105 invoked and what it should return. The value can be the name of a
6106 function, a |lambda| or a |Funcref|. See |option-value-function| for
6107 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006108 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006109 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006110 This option cannot be set from a |modeline| or in the |sandbox|, for
6111 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006112
Bram Moolenaar02467872007-05-06 13:22:01 +00006113 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006114'opendevice' 'odev' boolean (default off)
6115 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006116 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006117 Enable reading and writing from devices. This may get Vim stuck on a
6118 device that can be opened but doesn't actually do the I/O. Therefore
6119 it is off by default.
6120 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6121 result in editing a device.
6122
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006123 *'operatorfunc'* *'opfunc'*
6124'operatorfunc' 'opfunc' string (default: empty)
6125 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006126 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006127 See |:map-operator| for more info and an example. The value can be
6128 the name of a function, a |lambda| or a |Funcref|. See
6129 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006130
6131 This option cannot be set from a |modeline| or in the |sandbox|, for
6132 security reasons.
6133
Bram Moolenaar251e1912011-06-19 05:09:16 +02006134 *'osfiletype'* *'oft'*
6135'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006137 This option was supported on RISC OS, which has been removed.
6138
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006139 *'packpath'* *'pp'*
6140'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006141 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006144
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006146'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 global
6148 Specifies the nroff macros that separate paragraphs. These are pairs
6149 of two letters (see |object-motions|).
6150
6151 *'paste'* *'nopaste'*
6152'paste' boolean (default off)
6153 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006154 Put Vim in Paste mode. This is useful if you want to cut or copy
6155 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 unexpected effects.
6157 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006158 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 knows about pasting and will mostly do the right thing without 'paste'
6160 being set. The same is true for a terminal where Vim handles the
6161 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006162 This option is reset when starting the GUI. Thus if you set it in
6163 your .vimrc it will work in a terminal, but not in the GUI. Setting
6164 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6165 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 When the 'paste' option is switched on (also when it was already on):
6167 - mapping in Insert mode and Command-line mode is disabled
6168 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006170 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006171 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 - 'revins' is reset
6173 - 'ruler' is reset
6174 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006175 - 'smarttab' is reset
6176 - 'softtabstop' is set to 0
6177 - 'textwidth' is set to 0
6178 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006179 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006182 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006183 - 'indentexpr'
6184 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006185 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 NOTE: When you start editing another file while the 'paste' option is
6187 on, settings from the modelines or autocommands may change the
6188 settings again, causing trouble when pasting text. You might want to
6189 set the 'paste' option again.
6190 When the 'paste' option is reset the mentioned options are restored to
6191 the value before the moment 'paste' was switched from off to on.
6192 Resetting 'paste' before ever setting it does not have any effect.
6193 Since mapping doesn't work while 'paste' is active, you need to use
6194 the 'pastetoggle' option to toggle the 'paste' option with some key.
6195
6196 *'pastetoggle'* *'pt'*
6197'pastetoggle' 'pt' string (default "")
6198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 When non-empty, specifies the key sequence that toggles the 'paste'
6200 option. This is like specifying a mapping: >
6201 :map {keys} :set invpaste<CR>
6202< Where {keys} is the value of 'pastetoggle'.
6203 The difference is that it will work even when 'paste' is set.
6204 'pastetoggle' works in Insert mode and Normal mode, but not in
6205 Command-line mode.
6206 Mappings are checked first, thus overrule 'pastetoggle'. However,
6207 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6208 this: >
6209 :map <F10> :set paste<CR>
6210 :map <F11> :set nopaste<CR>
6211 :imap <F10> <C-O>:set paste<CR>
6212 :imap <F11> <nop>
6213 :set pastetoggle=<F11>
6214< This will make <F10> start paste mode and <F11> stop paste mode.
6215 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6216 mode everything is inserted literally, except the 'pastetoggle' key
6217 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006218 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219
6220 *'pex'* *'patchexpr'*
6221'patchexpr' 'pex' string (default "")
6222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 {not available when compiled without the |+diff|
6224 feature}
6225 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006226 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006227 This option cannot be set from a |modeline| or in the |sandbox|, for
6228 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229
Bram Moolenaardbc28022014-07-26 13:40:44 +02006230 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231'patchmode' 'pm' string (default "")
6232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 When non-empty the oldest version of a file is kept. This can be used
6234 to keep the original version of a file if you are changing files in a
6235 source distribution. Only the first time that a file is written a
6236 copy of the original file will be kept. The name of the copy is the
6237 name of the original file with the string in the 'patchmode' option
6238 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006239 ".orig" or ".org". 'backupdir' must not be empty for this to work
6240 (Detail: The backup file is renamed to the patchmode file after the
6241 new file has been successfully written, that's why it must be possible
6242 to write a backup file). If there was no file to be backed up, an
6243 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 When the 'backupskip' pattern matches, a patchmode file is not made.
6245 Using 'patchmode' for compressed files appends the extension at the
6246 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6247 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006248 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006250 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 other systems: ".,,")
6253 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006255 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6256 provided that the file being searched for has a relative path (not
6257 starting with "/", "./" or "../"). The directories in the 'path'
6258 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 - Use commas to separate directory names: >
6260 :set path=.,/usr/local/include,/usr/include
6261< - Spaces can also be used to separate directory names (for backwards
6262 compatibility with version 3.0). To have a space in a directory
6263 name, precede it with an extra backslash, and escape the space: >
6264 :set path=.,/dir/with\\\ space
6265< - To include a comma in a directory name precede it with an extra
6266 backslash: >
6267 :set path=.,/dir/with\\,comma
6268< - To search relative to the directory of the current file, use: >
6269 :set path=.
6270< - To search in the current directory use an empty string between two
6271 commas: >
6272 :set path=,,
6273< - A directory name may end in a ':' or '/'.
6274 - Environment variables are expanded |:set_env|.
6275 - When using |netrw.vim| URLs can be used. For example, adding
6276 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006277 - Search upwards and downwards in a directory tree using "*", "**" and
6278 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 - Careful with '\' characters, type two to get one in the option: >
6280 :set path=.,c:\\include
6281< Or just use '/' instead: >
6282 :set path=.,c:/include
6283< Don't forget "." or files won't even be found in the same directory as
6284 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006285 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 it is something like 256 or 1024 characters.
6287 You can check if all the include files are found, using the value of
6288 'path', see |:checkpath|.
6289 The use of |:set+=| and |:set-=| is preferred when adding or removing
6290 directories from the list. This avoids problems when a future version
6291 uses another default. To remove the current directory use: >
6292 :set path-=
6293< To add the current directory use: >
6294 :set path+=
6295< To use an environment variable, you probably need to replace the
6296 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006297 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006298 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299< Replace the ';' with a ':' or whatever separator is used. Note that
6300 this doesn't work when $INCL contains a comma or white space.
6301
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006302 *'perldll'*
6303'perldll' string (default depends on the build)
6304 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006305 {only available when compiled with the |+perl/dyn|
6306 feature}
6307 Specifies the name of the Perl shared library. The default is
6308 DYNAMIC_PERL_DLL, which was specified at compile time.
6309 Environment variables are expanded |:set_env|.
6310 This option cannot be set from a |modeline| or in the |sandbox|, for
6311 security reasons.
6312
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6314'preserveindent' 'pi' boolean (default off)
6315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 When changing the indent of the current line, preserve as much of the
6317 indent structure as possible. Normally the indent is replaced by a
6318 series of tabs followed by spaces as required (unless |'expandtab'| is
6319 enabled, in which case only spaces are used). Enabling this option
6320 means the indent will preserve as many existing characters as possible
6321 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006322 'expandtab' does not apply to the preserved white space, a Tab remains
6323 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 NOTE: When using ">>" multiple times the resulting indent is a mix of
6325 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006326 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 Also see 'copyindent'.
6328 Use |:retab| to clean up white space.
6329
6330 *'previewheight'* *'pvh'*
6331'previewheight' 'pvh' number (default 12)
6332 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006333 {not available when compiled without the |+quickfix|
6334 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006336 commands. Used for |CTRL-W_}| when no count is given. Not used when
6337 'previewpopup' is set.
6338
6339 *'previewpopup'* *'pvp'*
6340'previewpopup' 'pvp' string (default empty)
6341 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006342 {not available when compiled without the |+textprop|
6343 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006344 When not empty a popup window is used for commands that would open a
6345 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006346 Not used for the insert completion info, add "popup" to
6347 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348
6349 *'previewwindow'* *'nopreviewwindow'*
6350 *'pvw'* *'nopvw'* *E590*
6351'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006352 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006353 {not available when compiled without the |+quickfix|
6354 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006355 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 set. It's normally not set directly, but by using one of the commands
6357 |:ptag|, |:pedit|, etc.
6358
6359 *'printdevice'* *'pdev'*
6360'printdevice' 'pdev' string (default empty)
6361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 {only available when compiled with the |+printer|
6363 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006364 The name of the printer to be used for |:hardcopy|.
6365 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006366 This option cannot be set from a |modeline| or in the |sandbox|, for
6367 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368
Bram Moolenaar8299df92004-07-10 09:47:34 +00006369 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006370'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 {only available when compiled with the |+printer|
6373 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006374 Sets the character encoding used when printing.
6375 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376
6377 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006378'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 {only available when compiled with the |+printer|
6381 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006382 Expression used to print the PostScript produced with |:hardcopy|.
6383 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006384 This option cannot be set from a |modeline| or in the |sandbox|, for
6385 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386
Bram Moolenaar8299df92004-07-10 09:47:34 +00006387 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388'printfont' 'pfn' string (default "courier")
6389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 {only available when compiled with the |+printer|
6391 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006392 The name of the font that will be used for |:hardcopy|.
6393 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394
6395 *'printheader'* *'pheader'*
6396'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 {only available when compiled with the |+printer|
6399 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006400 The format of the header produced in |:hardcopy| output.
6401 See |pheader-option|.
6402
6403 *'printmbcharset'* *'pmbcs'*
6404'printmbcharset' 'pmbcs' string (default "")
6405 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006406 {only available when compiled with the |+printer|
6407 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006408 The CJK character set to be used for CJK output from |:hardcopy|.
6409 See |pmbcs-option|.
6410
6411 *'printmbfont'* *'pmbfn'*
6412'printmbfont' 'pmbfn' string (default "")
6413 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006414 {only available when compiled with the |+printer|
6415 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006416 List of font names to be used for CJK output from |:hardcopy|.
6417 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418
6419 *'printoptions'* *'popt'*
6420'printoptions' 'popt' string (default "")
6421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006423 List of items that control the format of the output of |:hardcopy|.
6424 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006426 *'prompt'* *'noprompt'*
6427'prompt' boolean (default on)
6428 global
6429 When on a ":" prompt is used in Ex mode.
6430
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006431 *'pumheight'* *'ph'*
6432'pumheight' 'ph' number (default 0)
6433 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006434 Determines the maximum number of items to show in the popup menu for
6435 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006436 |ins-completion-menu|.
6437
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006438 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006439'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006440 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006441 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006442 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006443
Bram Moolenaard94464e2015-11-02 15:28:18 +01006444 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006445'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006446 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006447 {only available when compiled with the |+python/dyn|
6448 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006449 Specifies the name of the Python 2.x shared library. The default is
6450 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006451 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006452 This option cannot be set from a |modeline| or in the |sandbox|, for
6453 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006454
Bram Moolenaar94073162018-01-31 21:49:05 +01006455 *'pythonhome'*
6456'pythonhome' string (default "")
6457 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006458 {only available when compiled with the |+python/dyn|
6459 feature}
6460 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6461 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6462 which was specified at compile time, will be used for the Python 2.x
6463 home directory.
6464 Environment variables are expanded |:set_env|.
6465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006468 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006469'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006470 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006471 {only available when compiled with the |+python3/dyn|
6472 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006473 Specifies the name of the Python 3 shared library. The default is
6474 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006475 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006476 This option cannot be set from a |modeline| or in the |sandbox|, for
6477 security reasons.
6478
Bram Moolenaar94073162018-01-31 21:49:05 +01006479 *'pythonthreehome'*
6480'pythonthreehome' string (default "")
6481 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006482 {only available when compiled with the |+python3/dyn|
6483 feature}
6484 Specifies the name of the Python 3 home directory. When
6485 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6486 PYTHON3_HOME, which was specified at compile time, will be used for
6487 the Python 3 home directory.
6488 Environment variables are expanded |:set_env|.
6489 This option cannot be set from a |modeline| or in the |sandbox|, for
6490 security reasons.
6491
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006492 *'pyxversion'* *'pyx'*
6493'pyxversion' 'pyx' number (default depends on the build)
6494 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006495 {only available when compiled with the |+python| or
6496 the |+python3| feature}
6497 Specifies the python version used for pyx* functions and commands
6498 |python_x|. The default value is as follows:
6499
6500 Compiled with Default ~
6501 |+python| and |+python3| 0
6502 only |+python| 2
6503 only |+python3| 3
6504
6505 Available values are 0, 2 and 3.
6506 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6507 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6508 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6509 to 2 if Python 2 is available.
6510 See also: |has-pythonx|
6511
6512 If Vim is compiled with only |+python| or |+python3| setting
6513 'pyxversion' has no effect. The pyx* functions and commands are
6514 always the same as the compiled version.
6515
6516 This option cannot be set from a |modeline| or in the |sandbox|, for
6517 security reasons.
6518
Bram Moolenaar858ba062020-05-31 23:11:59 +02006519 *'quickfixtextfunc'* *'qftf'*
6520'quickfixtextfunc' 'qftf' string (default "")
6521 global
6522 {only available when compiled with the |+quickfix|
6523 feature}
6524 This option specifies a function to be used to get the text to display
6525 in the quickfix and location list windows. This can be used to
6526 customize the information displayed in the quickfix or location window
6527 for each entry in the corresponding quickfix or location list. See
6528 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006529 function and an example. The value can be the name of a function, a
6530 |lambda| or a |Funcref|. See |option-value-function| for more
6531 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006532
6533 This option cannot be set from a |modeline| or in the |sandbox|, for
6534 security reasons.
6535
Bram Moolenaar677ee682005-01-27 14:41:15 +00006536 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006537'quoteescape' 'qe' string (default "\")
6538 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006539 The characters that are used to escape quotes in a string. Used for
6540 objects like a', a" and a` |a'|.
6541 When one of the characters in this option is found inside a string,
6542 the following character will be skipped. The default value makes the
6543 text "foo\"bar\\" considered to be one string.
6544
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6546'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006547 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 If on, writes fail unless you use a '!'. Protects you from
6549 accidentally overwriting a file. Default on when Vim is started
6550 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006551 When using ":w!" the 'readonly' option is reset for the current
6552 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006553 When using the ":view" command the 'readonly' option is set for the
6554 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006555 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006557 *'redrawtime'* *'rdt'*
6558'redrawtime' 'rdt' number (default 2000)
6559 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006560 {only available when compiled with the |+reltime|
6561 feature}
6562 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006563 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006564 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006565 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006566 matches will be highlighted.
6567 For syntax highlighting the time applies per window. When over the
6568 limit syntax highlighting is disabled until |CTRL-L| is used.
6569 This is used to avoid that Vim hangs when using a very complicated
6570 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006571
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006572 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006573'regexpengine' 're' number (default 0)
6574 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006575 This selects the default regexp engine. |two-engines|
6576 The possible values are:
6577 0 automatic selection
6578 1 old engine
6579 2 NFA engine
6580 Note that when using the NFA engine and the pattern contains something
6581 that is not supported the pattern will not match. This is only useful
6582 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006583 Using automatic selection enables Vim to switch the engine, if the
6584 default engine becomes too costly. E.g., when the NFA engine uses too
6585 many states. This should prevent Vim from hanging on a combination of
6586 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006587
Bram Moolenaar64486672010-05-16 15:46:46 +02006588 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6589'relativenumber' 'rnu' boolean (default off)
6590 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006591 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006592 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006593 precede some vertical motion commands (e.g. j k + -) with, without
6594 having to calculate it yourself. Especially useful in combination with
6595 other commands (e.g. y d c < > gq gw =).
6596 When the 'n' option is excluded from 'cpoptions' a wrapped
6597 line will not use the column of line numbers (this is the default when
6598 'compatible' isn't set).
6599 The 'numberwidth' option can be used to set the room used for the line
6600 number.
6601 When a long, wrapped line doesn't start with the first character, '-'
6602 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006603 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6604 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006605
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006606 The number in front of the cursor line also depends on the value of
6607 'number', see |number_relativenumber| for all combinations of the two
6608 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006609
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 *'remap'* *'noremap'*
6611'remap' boolean (default on)
6612 global
6613 Allows for mappings to work recursively. If you do not want this for
6614 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006615 NOTE: To avoid portability problems with Vim scripts, always keep
6616 this option at the default "on". Only switch it off when working with
6617 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618
zeertzjqd086b8f2024-02-25 15:42:52 +08006619 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006620'renderoptions' 'rop' string (default: empty)
6621 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006622 {only available when compiled with GUI and DIRECTX on
6623 MS-Windows}
6624 Select a text renderer and set its options. The options depend on the
6625 renderer.
6626
6627 Syntax: >
6628 set rop=type:{renderer}(,{name}:{value})*
6629<
6630 Currently, only one optional renderer is available.
6631
6632 render behavior ~
6633 directx Vim will draw text using DirectX (DirectWrite). It makes
6634 drawn glyphs more beautiful than default GDI.
6635 It requires 'encoding' is "utf-8", and only works on
6636 MS-Windows Vista or newer version.
6637
6638 Options:
6639 name meaning type value ~
6640 gamma gamma float 1.0 - 2.2 (maybe)
6641 contrast enhancedContrast float (unknown)
6642 level clearTypeLevel float (unknown)
6643 geom pixelGeometry int 0 - 2 (see below)
6644 renmode renderingMode int 0 - 6 (see below)
6645 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006646 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006647
Bram Moolenaar92467d32017-12-05 13:22:16 +01006648 See this URL for detail (except for scrlines):
6649 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006650
6651 For geom: structure of a device pixel.
6652 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6653 1 - DWRITE_PIXEL_GEOMETRY_RGB
6654 2 - DWRITE_PIXEL_GEOMETRY_BGR
6655
6656 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006657 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006658
6659 For renmode: method of rendering glyphs.
6660 0 - DWRITE_RENDERING_MODE_DEFAULT
6661 1 - DWRITE_RENDERING_MODE_ALIASED
6662 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6663 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6664 4 - DWRITE_RENDERING_MODE_NATURAL
6665 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6666 6 - DWRITE_RENDERING_MODE_OUTLINE
6667
6668 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006669 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006670
6671 For taamode: antialiasing mode used for drawing text.
6672 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6673 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6674 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6675 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6676
6677 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006678 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6679
Bram Moolenaara338adc2018-01-31 20:51:47 +01006680 For scrlines:
6681 This was used for optimizing scrolling behavior, however this
6682 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006683
6684 Example: >
6685 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006686 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006687 set rop=type:directx
6688<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006689 If select a raster font (Courier, Terminal or FixedSys which
6690 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006691 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006692
6693 NOTE: It is known that some fonts and options combination
6694 causes trouble on drawing glyphs.
6695
Bram Moolenaar92467d32017-12-05 13:22:16 +01006696 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006697 special made fonts (True-Type fonts which includes only
6698 bitmap glyphs).
6699 - 'taamode:3' will not work with some vector fonts.
6700
6701 NOTE: With this option, you can display colored emoji
6702 (emoticon) in Windows 8.1 or later. To display colored emoji,
6703 there are some conditions which you should notice.
6704
6705 - If your font includes non-colored emoji already, it will
6706 be used.
6707 - If your font doesn't have emoji, the system chooses an
6708 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6709 will be used.
6710 - When this alternative font didn't have fixed width glyph,
6711 emoji might be rendered beyond the bounding box of drawing
6712 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006713
6714 Other render types are currently not supported.
6715
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 *'report'*
6717'report' number (default 2)
6718 global
6719 Threshold for reporting number of lines changed. When the number of
6720 changed lines is more than 'report' a message will be given for most
6721 ":" commands. If you want it always, set 'report' to 0.
6722 For the ":substitute" command the number of substitutions is used
6723 instead of the number of lines.
6724
6725 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6726'restorescreen' 'rs' boolean (default on)
6727 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006728 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 When set, the screen contents is restored when exiting Vim. This also
6730 happens when executing external commands.
6731
6732 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6733 options in your .vimrc. To disable restoring:
6734 set t_ti= t_te=
6735 To enable restoring (for an xterm):
6736 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6737 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6738
6739 *'revins'* *'ri'* *'norevins'* *'nori'*
6740'revins' 'ri' boolean (default off)
6741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 {only available when compiled with the |+rightleft|
6743 feature}
6744 Inserting characters in Insert mode will work backwards. See "typing
6745 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6746 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006747 NOTE: This option is reset when 'compatible' is set.
6748 This option is reset when 'paste' is set and restored when 'paste' is
6749 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750
6751 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6752'rightleft' 'rl' boolean (default off)
6753 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 {only available when compiled with the |+rightleft|
6755 feature}
6756 When on, display orientation becomes right-to-left, i.e., characters
6757 that are stored in the file appear from the right to the left.
6758 Using this option, it is possible to edit files for languages that
6759 are written from the right to the left such as Hebrew and Arabic.
6760 This option is per window, so it is possible to edit mixed files
6761 simultaneously, or to view the same file in both ways (this is
6762 useful whenever you have a mixed text file with both right-to-left
6763 and left-to-right strings so that both sets are displayed properly
6764 in different windows). Also see |rileft.txt|.
6765
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006766 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767'rightleftcmd' 'rlc' string (default "search")
6768 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 {only available when compiled with the |+rightleft|
6770 feature}
6771 Each word in this option enables the command line editing to work in
6772 right-to-left mode for a group of commands:
6773
6774 search "/" and "?" commands
6775
6776 This is useful for languages such as Hebrew, Arabic and Farsi.
6777 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6778
Bram Moolenaard94464e2015-11-02 15:28:18 +01006779 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006780'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006781 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006782 {only available when compiled with the |+ruby/dyn|
6783 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006784 Specifies the name of the Ruby shared library. The default is
6785 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006786 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006787 This option cannot be set from a |modeline| or in the |sandbox|, for
6788 security reasons.
6789
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006791'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006794 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 text in the file is shown on the far right:
6796 Top first line is visible
6797 Bot last line is visible
6798 All first and last line are visible
6799 45% relative position in the file
6800 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006801 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006802 ruler is shown there. Otherwise it is shown in the last line of the
6803 screen. If the statusline is given by 'statusline' (i.e. not empty),
6804 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006806 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 the text column (byte number) and the screen column are shown,
6808 separated with a dash.
6809 For an empty line "0-1" is shown.
6810 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006811 This option is reset when 'paste' is set and restored when 'paste' is
6812 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 If you don't want to see the ruler all the time but want to know where
6814 you are, use "g CTRL-G" |g_CTRL-G|.
6815 NOTE: This option is reset when 'compatible' is set.
6816
6817 *'rulerformat'* *'ruf'*
6818'rulerformat' 'ruf' string (default empty)
6819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 {not available when compiled without the |+statusline|
6821 feature}
6822 When this option is not empty, it determines the content of the ruler
6823 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006824 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006825 This option cannot be set in a modeline when 'modelineexpr' is off.
6826
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 The default ruler width is 17 characters. To make the ruler 15
6828 characters wide, put "%15(" at the start and "%)" at the end.
6829 Example: >
6830 :set rulerformat=%15(%c%V\ %p%%%)
6831<
6832 *'runtimepath'* *'rtp'* *vimfiles*
6833'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006834 Unix: "$HOME/.vim or
6835 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 $VIM/vimfiles,
6837 $VIMRUNTIME,
6838 $VIM/vimfiles/after,
6839 $HOME/.vim/after"
6840 Amiga: "home:vimfiles,
6841 $VIM/vimfiles,
6842 $VIMRUNTIME,
6843 $VIM/vimfiles/after,
6844 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006845 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 $VIM/vimfiles,
6847 $VIMRUNTIME,
6848 $VIM/vimfiles/after,
6849 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006850 Haiku: "$BE_USER_SETTINGS/vim,
6851 $VIM/vimfiles,
6852 $VIMRUNTIME,
6853 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006854 $BE_USER_SETTINGS/vim/after"
6855 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 $VIM/vimfiles,
6857 $VIMRUNTIME,
6858 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006859 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 This is a list of directories which will be searched for runtime
6862 files:
6863 filetype.vim filetypes by file name |new-filetype|
6864 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006865 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 colors/ color scheme files |:colorscheme|
6867 compiler/ compiler files |:compiler|
6868 doc/ documentation |write-local-help|
6869 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006870 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 indent/ indent scripts |indent-expression|
6872 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006873 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006875 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 plugin/ plugin scripts |write-plugin|
6877 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006878 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 syntax/ syntax files |mysyntaxfile|
6880 tutor/ files for vimtutor |tutor|
6881
6882 And any other file searched for with the |:runtime| command.
6883
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006884 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6885
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 The defaults for most systems are setup to search five locations:
6887 1. In your home directory, for your personal preferences.
6888 2. In a system-wide Vim directory, for preferences from the system
6889 administrator.
6890 3. In $VIMRUNTIME, for files distributed with Vim.
6891 *after-directory*
6892 4. In the "after" directory in the system-wide Vim directory. This is
6893 for the system administrator to overrule or add to the distributed
6894 defaults (rarely needed)
6895 5. In the "after" directory in your home directory. This is for
6896 personal preferences to overrule or add to the distributed defaults
6897 or system-wide settings (rarely needed).
6898
Bram Moolenaard0796902016-09-16 20:02:31 +02006899 More entries are added when using |packages|. If it gets very long
6900 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6901 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006902
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6904 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006905 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 wildcards.
6907 See |:runtime|.
6908 Example: >
6909 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6910< This will use the directory "~/vimruntime" first (containing your
6911 personal Vim runtime files), then "/mygroup/vim" (shared between a
6912 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6913 files).
6914 You probably should always include $VIMRUNTIME somewhere, to use the
6915 distributed runtime files. You can put a directory before $VIMRUNTIME
6916 to find files which replace a distributed runtime files. You can put
6917 a directory after $VIMRUNTIME to find files which add to distributed
6918 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006919 When Vim is started with |--clean| the home directory entries are not
6920 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 This option cannot be set from a |modeline| or in the |sandbox|, for
6922 security reasons.
6923
6924 *'scroll'* *'scr'*
6925'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006926 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6928 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006929 changes. This may happen when enabling the |status-line| or
6930 'tabline' option after setting the 'scroll' option.
6931 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006932 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006933 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934
6935 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6936'scrollbind' 'scb' boolean (default off)
6937 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006938 See also |scroll-binding|. When this option is set, scrolling the
6939 current window also scrolls other scrollbind windows (windows that
6940 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 differences between two versions of a file, see 'diff'.
6942 See |'scrollopt'| for options that determine how this option should be
6943 interpreted.
6944 This option is mostly reset when splitting a window to edit another
6945 file. This means that ":split | edit file" results in two windows
6946 with scroll-binding, but ":split file" does not.
6947
Bram Moolenaarae20f342019-11-05 21:09:23 +01006948 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6949'scrollfocus' 'scf' boolean (default off)
6950 global
6951 {only for MS-Windows GUI}
6952 When using the scroll wheel and this option is set, the window under
6953 the mouse pointer is scrolled. With this option off the current
6954 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006955 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006956
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 *'scrolljump'* *'sj'*
6958'scrolljump' 'sj' number (default 1)
6959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 Minimal number of lines to scroll when the cursor gets off the
6961 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6962 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006963 When set to a negative number from -1 to -100 this is used as the
6964 percentage of the window height. Thus -50 scrolls half the window
6965 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 NOTE: This option is set to 1 when 'compatible' is set.
6967
6968 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006969'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006970 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 Minimal number of screen lines to keep above and below the cursor.
6972 This will make some context visible around where you are working. If
6973 you set it to a very large value (999) the cursor line will always be
6974 in the middle of the window (except at the start or end of the file or
6975 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006976 After using the local value, go back the global value with one of
6977 these two: >
6978 setlocal scrolloff<
6979 setlocal scrolloff=-1
6980< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 NOTE: This option is set to 0 when 'compatible' is set.
6982
6983 *'scrollopt'* *'sbo'*
6984'scrollopt' 'sbo' string (default "ver,jump")
6985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006987 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6988 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 The following words are available:
6990 ver Bind vertical scrolling for 'scrollbind' windows
6991 hor Bind horizontal scrolling for 'scrollbind' windows
6992 jump Applies to the offset between two windows for vertical
6993 scrolling. This offset is the difference in the first
6994 displayed line of the bound windows. When moving
6995 around in a window, another 'scrollbind' window may
6996 reach a position before the start or after the end of
6997 the buffer. The offset is not changed though, when
6998 moving back the 'scrollbind' window will try to scroll
6999 to the desired position when possible.
7000 When now making that window the current one, two
7001 things can be done with the relative offset:
7002 1. When "jump" is not included, the relative offset is
7003 adjusted for the scroll position in the new current
7004 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007005 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 2. When "jump" is included, the other windows are
7007 scrolled to keep the same relative offset. When
7008 going back to the other window, it still uses the
7009 same relative offset.
7010 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007011 When 'diff' mode is active there always is vertical scroll binding,
7012 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013
7014 *'sections'* *'sect'*
7015'sections' 'sect' string (default "SHNHH HUnhsh")
7016 global
7017 Specifies the nroff macros that separate sections. These are pairs of
7018 two letters (See |object-motions|). The default makes a section start
7019 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7020
7021 *'secure'* *'nosecure'* *E523*
7022'secure' boolean (default off)
7023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 When on, ":autocmd", shell and write commands are not allowed in
7025 ".vimrc" and ".exrc" in the current directory and map commands are
7026 displayed. Switch it off only if you know that you will not run into
7027 problems, or when the 'exrc' option is off. On Unix this option is
7028 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007029 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 'secure' at the end of your ~/.vimrc then.
7031 This option cannot be set from a |modeline| or in the |sandbox|, for
7032 security reasons.
7033
7034 *'selection'* *'sel'*
7035'selection' 'sel' string (default "inclusive")
7036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 This option defines the behavior of the selection. It is only used
7038 in Visual and Select mode.
7039 Possible values:
7040 value past line inclusive ~
7041 old no yes
7042 inclusive yes yes
7043 exclusive yes no
7044 "past line" means that the cursor is allowed to be positioned one
7045 character past the line.
7046 "inclusive" means that the last character of the selection is included
7047 in an operation. For example, when "x" is used to delete the
7048 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007049 When "old" is used and 'virtualedit' allows the cursor to move past
7050 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007051 When "exclusive" is used, cursor position in visual mode will be
7052 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 Note that when "exclusive" is used and selecting from the end
7054 backwards, you cannot include the last character of a line, when
7055 starting in Normal mode and 'virtualedit' empty.
7056
7057 The 'selection' option is set by the |:behave| command.
7058
7059 *'selectmode'* *'slm'*
7060'selectmode' 'slm' string (default "")
7061 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007062 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 Select mode instead of Visual mode, when a selection is started.
7064 Possible values:
7065 mouse when using the mouse
7066 key when using shifted special keys
7067 cmd when using "v", "V" or CTRL-V
7068 See |Select-mode|.
7069 The 'selectmode' option is set by the |:behave| command.
7070
7071 *'sessionoptions'* *'ssop'*
7072'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007073 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007075 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 feature}
7077 Changes the effect of the |:mksession| command. It is a comma
7078 separated list of words. Each word enables saving and restoring
7079 something:
7080 word save and restore ~
7081 blank empty windows
7082 buffers hidden and unloaded buffers, not just those in windows
7083 curdir the current directory
7084 folds manually created folds, opened/closed folds and local
7085 fold options
7086 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007087 and contain at least one lowercase letter. Only
7088 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 help the help window
7090 localoptions options and mappings local to a window or buffer (not
7091 global values for local options)
7092 options all options and mappings (also global values for local
7093 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007094 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 resize size of the Vim window: 'lines' and 'columns'
7096 sesdir the directory in which the session file is located
7097 will become the current directory (useful with
7098 projects accessed over a network from different
7099 systems)
7100 slash backslashes in file names replaced with forward
7101 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007102 tabpages all tab pages; without this only the current tab page
7103 is restored, so that you can make a session for each
7104 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007105 terminal include terminal windows where the command can be
7106 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 unix with Unix end-of-line format (single <NL>), even when
7108 on Windows or DOS
7109 winpos position of the whole Vim window
7110 winsize window sizes
7111
7112 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007113 When neither "curdir" nor "sesdir" is included, file names are stored
7114 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007115 If you leave out "options" many things won't work well after restoring
7116 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 "slash" and "unix" are useful on Windows when sharing session files
7118 with Unix. The Unix version of Vim cannot source dos format scripts,
7119 but the Windows version of Vim can source unix format scripts.
7120
7121 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007122'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 global
7124 Name of the shell to use for ! and :! commands. When changing the
7125 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7126 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007127 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 See |option-backslash| about including spaces and backslashes.
7129 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007130
Bram Moolenaara2baa732022-02-04 16:09:54 +00007131 In |restricted-mode| shell commands will not be possible. This mode
7132 is used if the value of $SHELL ends in "false" or "nologin".
7133
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007134 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007135 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7137< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007138 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007140 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007142 Example with escaped space (Vim will do this when initializing the
7143 option from $SHELL): >
7144 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007145< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007146 backslashes are consumed by `:set`.
7147
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 Under MS-Windows, when the executable ends in ".com" it must be
7149 included. Thus setting the shell to "command.com" or "4dos.com"
7150 works, but "command" and "4dos" do not work for all commands (e.g.,
7151 filtering).
7152 For unknown reasons, when using "4dos.com" the current directory is
7153 changed to "C:\". To avoid this set 'shell' like this: >
7154 :set shell=command.com\ /c\ 4dos
7155< This option cannot be set from a |modeline| or in the |sandbox|, for
7156 security reasons.
7157
7158 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007159'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007160 Win32, when 'shell' contains "powershell":
7161 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007162 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007165 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7166 For MS-Windows, the default is set according to the value of 'shell',
7167 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007168 On Unix it can have more than one flag. Each white space separated
7169 part is passed as an argument to the shell command.
7170 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007171 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 This option cannot be set from a |modeline| or in the |sandbox|, for
7173 security reasons.
7174
7175 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007176'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7177 "2>&1| tee", or
7178 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 {not available when compiled without the |+quickfix|
7181 feature}
7182 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007183 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 including spaces and backslashes.
7185 The name of the temporary file can be represented by "%s" if necessary
7186 (the file name is appended automatically if no %s appears in the value
7187 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007188 For the Amiga the default is ">". For MS-Windows using powershell the
7189 default is "2>&1 | Out-File -Encoding default", otherwise the default
7190 is ">%s 2>&1". The output is directly saved in a file and not echoed
7191 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007192 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 in a file and echoed to the screen. If the 'shell' option is "csh" or
7194 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007195 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007196 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7197 means that stderr is also included. Before using the 'shell' option a
7198 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007199 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7200 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 The initialization of this option is done after reading the ".vimrc"
7202 and the other initializations, so that when the 'shell' option is set
7203 there, the 'shellpipe' option changes automatically, unless it was
7204 explicitly set before.
7205 When 'shellpipe' is set to an empty string, no redirection of the
7206 ":make" output will be done. This is useful if you use a 'makeprg'
7207 that writes to 'makeef' by itself. If you want no piping, but do
7208 want to include the 'makeef', set 'shellpipe' to a single space.
7209 Don't forget to precede the space with a backslash: ":set sp=\ ".
7210 In the future pipes may be used for filtering and this option will
7211 become obsolete (at least for Unix).
7212 This option cannot be set from a |modeline| or in the |sandbox|, for
7213 security reasons.
7214
7215 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007216'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 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. The redirection is kept outside of the
7220 quoting. See 'shellxquote' to include the redirection. It's
7221 probably not useful to set both options.
7222 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007223 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007224 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 This option cannot be set from a |modeline| or in the |sandbox|, for
7226 security reasons.
7227
7228 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007229'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7230 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 String to be used to put the output of a filter command in a temporary
7233 file. See also |:!|. See |option-backslash| about including spaces
7234 and backslashes.
7235 The name of the temporary file can be represented by "%s" if necessary
7236 (the file name is appended automatically if no %s appears in the value
7237 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007238 The default is ">". For Unix, if the 'shell' option is "csh" or
7239 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007240 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007241 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7242 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007243 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7244 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007245 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7246 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 The initialization of this option is done after reading the ".vimrc"
7248 and the other initializations, so that when the 'shell' option is set
7249 there, the 'shellredir' option changes automatically unless it was
7250 explicitly set before.
7251 In the future pipes may be used for filtering and this option will
7252 become obsolete (at least for Unix).
7253 This option cannot be set from a |modeline| or in the |sandbox|, for
7254 security reasons.
7255
7256 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7257'shellslash' 'ssl' boolean (default off)
7258 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007259 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007261 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007262 powershell.exe. Backward slashes can still be typed, but they are
7263 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 Note that setting or resetting this option has no effect for some
7265 existing file names, thus this option needs to be set before opening
7266 any file for best results. This might change in the future.
7267 'shellslash' only works when a backslash can be used as a path
7268 separator. To test if this is so use: >
7269 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007270< Also see 'completeslash'.
7271
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007272 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7273'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7274 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007275 When on, use temp files for shell commands. When off use a pipe.
7276 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007277 Currently a pipe is only supported on Unix and MS-Windows 2K and
7278 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007279 :if has("filterpipe")
7280< The advantage of using a pipe is that nobody can read the temp file
7281 and the 'shell' command does not need to support redirection.
7282 The advantage of using a temp file is that the file type and encoding
7283 can be detected.
7284 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7285 |FilterWritePost| autocommands event are not triggered when
7286 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007287 The `system()` function does not respect this option and always uses
7288 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007289 NOTE: This option is set to the Vim default value when 'compatible'
7290 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007291
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 *'shelltype'* *'st'*
7293'shelltype' 'st' number (default 0)
7294 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007295 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 On the Amiga this option influences the way how the commands work
7297 which use a shell.
7298 0 and 1: always use the shell
7299 2 and 3: use the shell only to filter lines
7300 4 and 5: use shell only for ':sh' command
7301 When not using the shell, the command is executed directly.
7302
7303 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7304 1 and 3: use "shell cmd" to start external commands
7305
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007306 *'shellxescape'* *'sxe'*
7307'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007308 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007309 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007310 When 'shellxquote' is set to "(" then the characters listed in this
7311 option will be escaped with a '^' character. This makes it possible
7312 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007313 This option cannot be set from a |modeline| or in the |sandbox|, for
7314 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007315
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 *'shellxquote'* *'sxq'*
7317'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007318 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007319 for Win32, when 'shell' is
7320 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007321 for Win32, when 'shell' contains "sh"
7322 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 for Unix, when using system(): "\"")
7324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 Quoting character(s), put around the command passed to the shell, for
7326 the "!" and ":!" commands. Includes the redirection. See
7327 'shellquote' to exclude the redirection. It's probably not useful
7328 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007329 When the value is '(' then ')' is appended. When the value is '"('
7330 then ')"' is appended.
7331 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007332 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007333 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7334 pwsh.exe which automatically strips off the first and last quote on a
7335 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7336 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007337 'shell', to reduce the need to set this option by the user. See
7338 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 This option cannot be set from a |modeline| or in the |sandbox|, for
7340 security reasons.
7341
7342 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7343'shiftround' 'sr' boolean (default off)
7344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 Round indent to multiple of 'shiftwidth'. Applies to > and <
7346 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7347 a multiple of 'shiftwidth' (this is Vi compatible).
7348 NOTE: This option is reset when 'compatible' is set.
7349
7350 *'shiftwidth'* *'sw'*
7351'shiftwidth' 'sw' number (default 8)
7352 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007353 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007355 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007356 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357
7358 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007359'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7360 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007361 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007363 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 It is a list of flags:
7365 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007366 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7367 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7368 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7369 m use "[+]" instead of "[Modified]" *shm-m*
7370 n use "[New]" instead of "[New File]" *shm-n*
7371 r use "[RO]" instead of "[readonly]" *shm-r*
7372 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007374 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7375 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007376 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007377 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007379 o overwrite message for writing a file with subsequent *shm-o*
7380 message for reading a file (useful for ":wn" or when
7381 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007382 O message for reading a file overwrites any previous *shm-O*
7383 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007384 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7385 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007386 the search count do not show "W" before the count message
7387 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007388 t truncate file message at the start if it is too long *shm-t*
7389 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007390 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007391 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007392 long to fit on the command line; "..." will appear in the
7393 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007394 W don't give "written" or "[w]" when writing a file *shm-W*
7395 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007396 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007397 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007398 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007399 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007400 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7401 match", "Pattern not found", "Back at original", etc.
7402 C don't give messages while scanning for ins-completion *shm-C*
7403 items, for instance "scanning tags"
7404 q use "recording" instead of "recording @a" *shm-q*
7405 F don't give the file info when editing a file, like *shm-F*
7406 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007407 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007408 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007409 "[1/5]". When the "S" flag is not present (e.g. search count
7410 is shown), the "search hit BOTTOM, continuing at TOP" and
7411 "search hit TOP, continuing at BOTTOM" messages are only
7412 indicated by a "W" (Mnemonic: Wrapped) letter before the
7413 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414
7415 This gives you the opportunity to avoid that a change between buffers
7416 requires you to hit <Enter>, but still gives as useful a message as
7417 possible for the space available. To get the whole message that you
7418 would have got with 'shm' empty, use ":file!"
7419 Useful values:
7420 shm= No abbreviation of message.
7421 shm=a Abbreviation, but no loss of information.
7422 shm=at Abbreviation, and truncate message when necessary.
7423
7424 NOTE: This option is set to the Vi default value when 'compatible' is
7425 set and to the Vim default value when 'compatible' is reset.
7426
7427 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7428'shortname' 'sn' boolean (default off)
7429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 Filenames are assumed to be 8 characters plus one extension of 3
7431 characters. Multiple dots in file names are not allowed. When this
7432 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007433 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007435 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436
7437 *'showbreak'* *'sbr'* *E595*
7438'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007439 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007440 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 feature}
7442 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007443 values are "> " or "+++ ": >
7444 :set showbreak=>\
7445< Note the backslash to escape the trailing space. It's easier like
7446 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007447 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007448< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 comma (in a future version the comma might be used to separate the
7450 part that is shown at the end and at the start of a line).
7451 The characters are highlighted according to the '@' flag in
7452 'highlight'.
7453 Note that tabs after the showbreak will be displayed differently.
7454 If you want the 'showbreak' to appear in between line numbers, add the
7455 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007456 A window-local value overrules a global value. If the global value is
7457 set and you want no value in the current window use NONE: >
7458 :setlocal showbreak=NONE
7459<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007461'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7462 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007464 Show (partial) command in the last line of the screen. Set this
7465 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 In Visual mode the size of the selected area is shown:
7467 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007468 If the number of bytes is different it is also displayed: "2-6"
7469 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007471 - When selecting a block, the size in screen characters:
7472 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007473 This information can be displayed in an alternative location using the
7474 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 NOTE: This option is set to the Vi default value when 'compatible' is
7476 set and to the Vim default value when 'compatible' is reset.
7477
Luuk van Baalba936f62022-12-15 13:15:39 +00007478 *'showcmdloc'* *'sloc'*
7479'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007480 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007481 This option can be used to display the (partially) entered command in
7482 another location. Possible values are:
7483 last Last line of the screen (default).
7484 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007485 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007486 Setting this option to "statusline" or "tabline" means that these will
7487 be redrawn whenever the command changes, which can be on every key
7488 pressed.
7489 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7490 place the text. Without a custom 'statusline' or 'tabline' it will be
7491 displayed in a convenient location.
7492
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7494'showfulltag' 'sft' boolean (default off)
7495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 When completing a word in insert mode (see |ins-completion|) from the
7497 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007498 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 matched a C function, you can see a template for what arguments are
7500 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007501 Note that this doesn't work well together with having "longest" in
7502 'completeopt', because the completion from the search pattern may not
7503 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504
7505 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7506'showmatch' 'sm' boolean (default off)
7507 global
7508 When a bracket is inserted, briefly jump to the matching one. The
7509 jump is only done if the match can be seen on the screen. The time to
7510 show the match can be set with 'matchtime'.
7511 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007512 seen or not).
7513 This option is reset when 'paste' is set and restored when 'paste' is
7514 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 When the 'm' flag is not included in 'cpoptions', typing a character
7516 will immediately move the cursor back to where it belongs.
7517 See the "sm" field in 'guicursor' for setting the cursor shape and
7518 blinking when showing the match.
7519 The 'matchpairs' option can be used to specify the characters to show
7520 matches for. 'rightleft' and 'revins' are used to look for opposite
7521 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007522 Also see the matchparen plugin for highlighting the match when moving
7523 around |pi_paren.txt|.
7524 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7527'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7528 global
7529 If in Insert, Replace or Visual mode put a message on the last line.
7530 Use the 'M' flag in 'highlight' to set the type of highlighting for
7531 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007532 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 doesn't mean XIM is really active, especially when 'imactivatekey' is
7534 not set.
7535 NOTE: This option is set to the Vi default value when 'compatible' is
7536 set and to the Vim default value when 'compatible' is reset.
7537
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007538 *'showtabline'* *'stal'*
7539'showtabline' 'stal' number (default 1)
7540 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007541 The value of this option specifies when the line with tab page labels
7542 will be displayed:
7543 0: never
7544 1: only if there are at least two tab pages
7545 2: always
7546 This is both for the GUI and non-GUI implementation of the tab pages
7547 line.
7548 See |tab-page| for more information about tab pages.
7549
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 *'sidescroll'* *'ss'*
7551'sidescroll' 'ss' number (default 0)
7552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 The minimal number of columns to scroll horizontally. Used only when
7554 the 'wrap' option is off and the cursor is moved off of the screen.
7555 When it is zero the cursor will be put in the middle of the screen.
7556 When using a slow terminal set it to a large number or 0. When using
7557 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7558 commands.
7559
7560 *'sidescrolloff'* *'siso'*
7561'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007562 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007564 right of the cursor if 'nowrap' is set. Setting this option to a
7565 value greater than 0 while having |'sidescroll'| also at a non-zero
7566 value makes some context visible in the line you are scrolling in
7567 horizontally (except at beginning of the line). Setting this option
7568 to a large value (like 999) has the effect of keeping the cursor
7569 horizontally centered in the window, as long as one does not come too
7570 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007571 After using the local value, go back the global value with one of
7572 these two: >
7573 setlocal sidescrolloff<
7574 setlocal sidescrolloff=-1
7575< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576
7577 Example: Try this together with 'sidescroll' and 'listchars' as
7578 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007579 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
7581 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7582 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007583<
7584 *'signcolumn'* *'scl'*
7585'signcolumn' 'scl' string (default "auto")
7586 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007587 {not available when compiled without the |+signs|
7588 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007589 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007590 "auto" only when there is a sign to display
7591 "no" never
7592 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007593 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007594 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7597'smartcase' 'scs' boolean (default off)
7598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 Override the 'ignorecase' option if the search pattern contains upper
7600 case characters. Only used when the search pattern is typed and
7601 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007602 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7604 recalling the search pattern from history and hitting <Enter>.
7605 NOTE: This option is reset when 'compatible' is set.
7606
7607 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7608'smartindent' 'si' boolean (default off)
7609 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 Do smart autoindenting when starting a new line. Works for C-like
7611 programs, but can also be used for other languages. 'cindent' does
7612 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007613 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007614 setting 'si' has no effect. 'indentexpr' is a more advanced
7615 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 Normally 'autoindent' should also be on when using 'smartindent'.
7617 An indent is automatically inserted:
7618 - After a line ending in '{'.
7619 - After a line starting with a keyword from 'cinwords'.
7620 - Before a line starting with '}' (only with the "O" command).
7621 When typing '}' as the first character in a new line, that line is
7622 given the same indent as the matching '{'.
7623 When typing '#' as the first character in a new line, the indent for
7624 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007625 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7627 When using the ">>" command, lines starting with '#' are not shifted
7628 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007629 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007630 This option is reset when 'paste' is set and restored when 'paste' is
7631 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632
7633 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7634'smarttab' 'sta' boolean (default off)
7635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007637 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7638 <BS> will delete a 'shiftwidth' worth of space at the start of the
7639 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007640 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007641 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7642 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007643 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007645 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007646 This option is reset when 'paste' is set and restored when 'paste' is
7647 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 NOTE: This option is reset when 'compatible' is set.
7649
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007650 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7651'smoothscroll' 'sms' boolean (default off)
7652 local to window
7653 Scrolling works with screen lines. When 'wrap' is set and the first
7654 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007655 above the window. "<<<" is displayed at the start of the first line,
7656 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007657 You may also want to add "lastline" to the 'display' option to show as
7658 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007659 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007660
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 *'softtabstop'* *'sts'*
7662'softtabstop' 'sts' number (default 0)
7663 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 Number of spaces that a <Tab> counts for while performing editing
7665 operations, like inserting a <Tab> or using <BS>. It "feels" like
7666 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7667 used. This is useful to keep the 'ts' setting at its standard value
7668 of 8, while being able to edit like it is set to 'sts'. However,
7669 commands like "x" still work on the actual characters.
7670 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007671 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007672 'softtabstop' is set to 0 when the 'paste' option is set and restored
7673 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7675 spaces is minimized by using <Tab>s.
7676 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7677 set.
7678 NOTE: This option is set to 0 when 'compatible' is set.
7679
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007680 If Vim is compiled with the |+vartabs| feature then the value of
7681 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7682 anything other than an empty string.
7683
Bram Moolenaar217ad922005-03-20 22:37:15 +00007684 *'spell'* *'nospell'*
7685'spell' boolean (default off)
7686 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007687 {not available when compiled without the |+syntax|
7688 feature}
7689 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007690 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007691
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007692 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007693'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007694 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007695 {not available when compiled without the |+syntax|
7696 feature}
7697 Pattern to locate the end of a sentence. The following word will be
7698 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007699 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007700 When this check is not wanted make this option empty.
7701 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007702 Be careful with special characters, see |option-backslash| about
7703 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007704 To set this option automatically depending on the language, see
7705 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007706
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007707 *'spellfile'* *'spf'*
7708'spellfile' 'spf' string (default empty)
7709 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007710 {not available when compiled without the |+syntax|
7711 feature}
7712 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007713 commands. It must end in ".{encoding}.add". You need to include the
7714 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007715 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007716 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007717 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007718 |zg| and |zw| commands can be used to access each. This allows using
7719 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007720 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007721 you: Using the first directory in 'runtimepath' that is writable. If
7722 there is no "spell" directory yet it will be created. For the file
7723 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007724 ignoring the region.
7725 The resulting ".spl" file will be used for spell checking, it does not
7726 have to appear in 'spelllang'.
7727 Normally one file is used for all regions, but you can add the region
7728 name if you want to. However, it will then only be used when
7729 'spellfile' is set to it, for entries in 'spelllang' only files
7730 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007731 This option cannot be set from a |modeline| or in the |sandbox|, for
7732 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007733
Bram Moolenaar217ad922005-03-20 22:37:15 +00007734 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007735'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007736 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007737 {not available when compiled without the |+syntax|
7738 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007739 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007740 on spellchecking will be done for these languages. Example: >
7741 set spelllang=en_us,nl,medical
7742< This means US English, Dutch and medical words are recognized. Words
7743 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007744 The word list name must consist of alphanumeric characters, a dash or
7745 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007746 recommended to separate the two letter language name from a
7747 specification. Thus "en-rare" is used for rare English words.
7748 A region name must come last and have the form "_xx", where "xx" is
7749 the two-letter, lower case region name. You can use more than one
7750 region by listing them: "en_us,en_ca" supports both US and Canadian
7751 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007752 Britain. (Note: currently en_au and en_nz dictionaries are older than
7753 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007754 If the name "cjk" is included East Asian characters are excluded from
7755 spell checking. This is useful when editing text that also has Asian
7756 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007757 Note that the "medical" dictionary does not exist, it is just an
7758 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007759 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007760 As a special case the name of a .spl file can be given as-is. The
7761 first "_xx" in the name is removed and used as the region name
7762 (_xx is an underscore, two letters and followed by a non-letter).
7763 This is mainly for testing purposes. You must make sure the correct
7764 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007765 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007766 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7767 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007768 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007769
Bram Moolenaar98692072006-02-04 00:57:42 +00007770 If the |spellfile.vim| plugin is active and you use a language name
7771 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7772 will ask you if you want to download the file.
7773
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007774 After this option has been set successfully, Vim will source the files
7775 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007776 up to the first character that is not an ASCII letter or number and
7777 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007778
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007779 *'spelloptions'* *'spo'*
7780'spelloptions' 'spo' string (default "")
7781 local to buffer
7782 {not available when compiled without the |+syntax|
7783 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007784 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007785 camel When a word is CamelCased, assume "Cased" is a
7786 separate word: every upper-case character in a word
7787 that comes after a lower case character indicates the
7788 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007789
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007790 *'spellsuggest'* *'sps'*
7791'spellsuggest' 'sps' string (default "best")
7792 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007793 {not available when compiled without the |+syntax|
7794 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007795 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007796 the |spellsuggest()| function. This is a comma-separated list of
7797 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007798
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007799 best Internal method that works best for English. Finds
7800 changes like "fast" and uses a bit of sound-a-like
7801 scoring to improve the ordering.
7802
7803 double Internal method that uses two methods and mixes the
7804 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007805 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007806 word. That only works when the language specifies
7807 sound folding. Can be slow and doesn't always give
7808 better results.
7809
7810 fast Internal method that only checks for simple changes:
7811 character inserts/deletes/swaps. Works well for
7812 simple typing mistakes.
7813
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007814 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007815 Not used for |spellsuggest()|. The number of
7816 suggestions is never more than the value of 'lines'
7817 minus two.
7818
Bram Moolenaar585ee072022-01-29 11:22:17 +00007819 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007820 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007821 methods. When omitted the limit is 5000. When
7822 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007823 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007824
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007825 file:{filename} Read file {filename}, which must have two columns,
7826 separated by a slash. The first column contains the
7827 bad word, the second column the suggested good word.
7828 Example:
7829 theribal/terrible ~
7830 Use this for common mistakes that do not appear at the
7831 top of the suggestion list with the internal methods.
7832 Lines without a slash are ignored, use this for
7833 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007834 The word in the second column must be correct,
7835 otherwise it will not be used. Add the word to an
7836 ".add" file if it is currently flagged as a spelling
7837 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007838 The file is used for all languages.
7839
7840 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007841 trouble with spaces. Best is to call a function
7842 without arguments, see |expr-option-function|.
7843 |v:val| holds the badly spelled word. The expression
7844 must evaluate to a List of Lists, each with a
7845 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007846 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007847 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007848 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007849 internal methods use. A lower score is better.
7850 This may invoke |spellsuggest()| if you temporarily
7851 set 'spellsuggest' to exclude the "expr:" part.
7852 Errors are silently ignored, unless you set the
7853 'verbose' option to a non-zero value.
7854
7855 Only one of "best", "double" or "fast" may be used. The others may
7856 appear several times in any order. Example: >
7857 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7858<
7859 This option cannot be set from a |modeline| or in the |sandbox|, for
7860 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007861
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7863'splitbelow' 'sb' boolean (default off)
7864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 When on, splitting a window will put the new window below the current
7866 one. |:split|
7867
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007868 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007869'splitkeep' 'spk' string (default "cursor")
7870 global
7871 The value of this option determines the scroll behavior when opening,
7872 closing or resizing horizontal splits.
7873
7874 Possible values are:
7875 cursor Keep the same relative cursor position.
7876 screen Keep the text on the same screen line.
7877 topline Keep the topline the same.
7878
7879 For the "screen" and "topline" values, the cursor position will be
7880 changed when necessary. In this case, the jumplist will be populated
7881 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007882 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007883
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7885'splitright' 'spr' boolean (default off)
7886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 When on, splitting a window will put the new window right of the
7888 current one. |:vsplit|
7889
7890 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7891'startofline' 'sol' boolean (default on)
7892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007894 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007895 (if possible). This applies to the commands:
7896 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007897 - "d", "<<", "==" and ">>" with a linewise operator
7898 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007899 - "%" with a count
7900 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7901 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 In case of buffer changing commands the cursor is placed at the column
7903 where it was the last time the buffer was edited.
7904 NOTE: This option is set when 'compatible' is set.
7905
Bram Moolenaar00654022011-02-25 14:42:19 +01007906 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007908 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 {not available when compiled without the |+statusline|
7910 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007911 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 Also see |status-line|.
7913
7914 The option consists of printf style '%' items interspersed with
7915 normal text. Each status line item is of the form:
7916 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007917 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007918 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007920 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007921 When the option starts with "%!" then it is used as an expression,
7922 evaluated and the result is used as the option value. Example: >
7923 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007924< The *g:statusline_winid* variable will be set to the |window-ID| of the
7925 window that the status line belongs to.
7926 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007927 Note that the "%!" expression is evaluated in the context of the
7928 current window and buffer, while %{} items are evaluated in the
7929 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007930
7931 When there is error while evaluating the option then it will be made
7932 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007933 When the result contains unprintable characters the result is
7934 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007935
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 Note that the only effect of 'ruler' when this option is set (and
7937 'laststatus' is 2) is controlling the output of |CTRL-G|.
7938
7939 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007940 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007942 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 minwid Minimum width of the item, padding as set by '-' & '0'.
7944 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007945 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 on the left for text items. Numeric items will be
7947 shifted down to maxwid-2 digits followed by '>'number
7948 where number is the amount of missing digits, much like
7949 an exponential notation.
7950 item A one letter code as described below.
7951
7952 Following is a description of the possible statusline items. The
7953 second character in "item" is the type:
7954 N for number
7955 S for string
7956 F for flags as described below
7957 - not applicable
7958
7959 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007960 f S Path to the file in the buffer, as typed or relative to current
7961 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 F S Full path to the file in the buffer.
7963 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007964 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007966 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007968 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007970 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007972 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007974 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7976 being used: "<keymap>"
7977 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007978 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 B N As above, in hexadecimal.
7980 o N Byte number in file of byte under cursor, first byte is 1.
7981 Mnemonic: Offset from start of file (with one added)
7982 {not available when compiled without |+byte_offset| feature}
7983 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007984 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 l N Line number.
7986 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007987 c N Column number (byte index).
7988 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007989 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 p N Percentage through file in lines as in |CTRL-G|.
7991 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007992 percentage described for 'ruler'. Always 3 in length, unless
7993 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007994 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007995 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007997 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007998 Note that there is no '%' before the closing '}'. The
7999 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008000 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008001 {% - This is almost same as { except the result of the expression is
8002 re-evaluated as a statusline format string. Thus if the
8003 return value of expr contains % items they will get expanded.
8004 The expression can contain the } character, the end of
8005 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008006 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008007 func! Stl_filename() abort
8008 return "%t"
8009 endfunc
8010< `stl=%{Stl_filename()}` results in `"%t"`
8011 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008012 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 ( - Start of item group. Can be used for setting the width and
8014 alignment of a section. Must be followed by %) somewhere.
8015 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008016 T N For 'tabline': start of tab page N label. Use %T after the last
8017 label. This information is used for mouse clicks.
8018 X N For 'tabline': start of close tab N label. Use %X after the
8019 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8020 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 < - Where to truncate line if too long. Default is at the start.
8022 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008023 = - Separation point between alignment sections. Each section will
8024 be separated by an equal number of spaces. With one %= what
8025 comes after it will be right-aligned. With two %= there is a
8026 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008028 # - Set highlight group. The name must follow and then a # again.
8029 Thus use %#HLname# for highlight group HLname. The same
8030 highlighting is used, also for the statusline of non-current
8031 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008033 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008034 The difference between User{N} and StatusLine will be applied to
8035 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 The number N must be between 1 and 9. See |hl-User1..9|
8037
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008038 When displaying a flag, Vim removes the leading comma, if any, when
8039 that flag comes right after plaintext. This will make a nice display
8040 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041
Bram Moolenaar582fd852005-03-28 20:58:01 +00008042 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 not set) and a minwid is not set for the group, the whole group will
8044 become empty. This will make a group like the following disappear
8045 completely from the statusline when none of the flags are set. >
8046 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008047< Beware that an expression is evaluated each and every time the status
8048 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008049 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008050 While evaluating %{} the current buffer and current window will be set
8051 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008052 currently being drawn. The expression will evaluate in this context.
8053 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8054 real current buffer and "g:actual_curwin" to the |window-ID| of the
8055 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008056
Bram Moolenaar30b65812012-07-12 22:01:11 +02008057 The 'statusline' option will be evaluated in the |sandbox| if set from
8058 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008059 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008060
8061 It is not allowed to change text or jump to another window while
8062 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063
8064 If the statusline is not updated when you want it (e.g., after setting
8065 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008066 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008068 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 Otherwise the result is taken as flag text and applied to the rules
8070 described above.
8071
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008072 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008074 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075
8076 Examples:
8077 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008078 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079< Similar, but add ASCII value of char under the cursor (like "ga") >
8080 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8081< Display byte count and byte value, modified flag in red. >
8082 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8083 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8084< Display a ,GZ flag if a compressed file is loaded >
8085 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8086< In the |:autocmd|'s: >
8087 :let b:gzflag = 1
8088< And: >
8089 :unlet b:gzflag
8090< And define this function: >
8091 :function VarExists(var, val)
8092 : if exists(a:var) | return a:val | else | return '' | endif
8093 :endfunction
8094<
8095 *'suffixes'* *'su'*
8096'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 Files with these suffixes get a lower priority when multiple files
8099 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008100 suffixes. Spaces after the comma are ignored. A dot is also seen as
8101 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 separator, precede it with a backslash (see |option-backslash| about
8103 including spaces and backslashes).
8104 See 'wildignore' for completely ignoring files.
8105 The use of |:set+=| and |:set-=| is preferred when adding or removing
8106 suffixes from the list. This avoids problems when a future version
8107 uses another default.
8108
8109 *'suffixesadd'* *'sua'*
8110'suffixesadd' 'sua' string (default "")
8111 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008112 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 file for the "gf", "[I", etc. commands. Example: >
8114 :set suffixesadd=.java
8115<
8116 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8117'swapfile' 'swf' boolean (default on)
8118 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008119 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 swapfile is not wanted for a specific buffer. For example, with
8121 confidential information that even root must not be able to access.
8122 Careful: All text will be in memory:
8123 - Don't use this for big files.
8124 - Recovery will be impossible!
8125 A swapfile will only be present when |'updatecount'| is non-zero and
8126 'swapfile' is set.
8127 When 'swapfile' is reset, the swap file for the current buffer is
8128 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8129 non-zero, a swap file is immediately created.
8130 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008131 If you want to open a new buffer without creating a swap file for it,
8132 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008133 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134
8135 This option is used together with 'bufhidden' and 'buftype' to
8136 specify special kinds of buffers. See |special-buffers|.
8137
8138 *'swapsync'* *'sws'*
8139'swapsync' 'sws' string (default "fsync")
8140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008142 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 When this option is empty parts of the swap file may be in memory and
8144 not written to disk. When the system crashes you may lose more work.
8145 On Unix the system does a sync now and then without Vim asking for it,
8146 so the disadvantage of setting this option off is small. On some
8147 systems the swap file will not be written at all. For a unix system
8148 setting it to "sync" will use the sync() call instead of the default
8149 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008150 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151
8152 *'switchbuf'* *'swb'*
8153'switchbuf' 'swb' string (default "")
8154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008156 This option is checked, when
8157 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008158 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008159 - jumping to a tag using the |:stag| command.
8160 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8161 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8162 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008163 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008164 useopen If included, jump to the first open window in the
8165 current tab page that contains the specified buffer
8166 (if there is one). Otherwise: Do not examine other
8167 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008168 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008169 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008171 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008172 Otherwise: do not split, use current window (when used
8173 in the quickfix window: the previously used window or
8174 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008175 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008176 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008177 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008178 uselast If included, jump to the previously used window when
8179 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008180 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8181 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008183 *'synmaxcol'* *'smc'*
8184'synmaxcol' 'smc' number (default 3000)
8185 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008186 {not available when compiled without the |+syntax|
8187 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008188 Maximum column in which to search for syntax items. In long lines the
8189 text after this column is not highlighted and following lines may not
8190 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008191 This helps to avoid very slow redrawing for an XML file that is one
8192 long line.
8193 Set to zero to remove the limit.
8194
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *'syntax'* *'syn'*
8196'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008197 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 {not available when compiled without the |+syntax|
8199 feature}
8200 When this option is set, the syntax with this name is loaded, unless
8201 syntax highlighting has been switched off with ":syntax off".
8202 Otherwise this option does not always reflect the current syntax (the
8203 b:current_syntax variable does).
8204 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008205 not automatically recognized. Example, in an IDL file:
8206 /* vim: set syntax=idl : */ ~
8207 When a dot appears in the value then this separates two filetype
8208 names. Example:
8209 /* vim: set syntax=c.doxygen : */ ~
8210 This will use the "c" syntax first, then the "doxygen" syntax.
8211 Note that the second one must be prepared to be loaded as an addition,
8212 otherwise it will be skipped. More than one dot may appear.
8213 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 :set syntax=OFF
8215< To switch syntax highlighting on according to the current value of the
8216 'filetype' option: >
8217 :set syntax=ON
8218< What actually happens when setting the 'syntax' option is that the
8219 Syntax autocommand event is triggered with the value as argument.
8220 This option is not copied to another buffer, independent of the 's' or
8221 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008222 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223
LemonBoy5247b0b2024-07-12 19:30:58 +02008224 *'tabclose'* *'tcl'*
8225'tabclose' 'tcl' string (default "")
8226 global
8227 This option controls the behavior when closing tab pages (e.g., using
8228 |:tabclose|). When empty Vim goes to the next (right) tab page.
8229
8230 Possible values (comma-separated list):
8231 left If included, go to the previous tab page instead of
8232 the next one.
8233 uselast If included, go to the previously used tab page if
8234 possible. This option takes precedence over the
8235 others.
8236
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008237 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008238'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008239 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008240 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008241 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008242 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008243
8244 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008245 option and only when there is no GUI tab line. When 'e' is in
8246 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008247 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008248
8249 The value is evaluated like with 'statusline'. You can use
8250 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008251 the text to be displayed. Use "%1T" for the first label, "%2T" for
8252 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008253
Bram Moolenaare12bab32019-01-08 22:02:56 +01008254 When changing something that is used in 'tabline' that does not
8255 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008256 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008257
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008258 Keep in mind that only one of the tab pages is the current one, others
8259 are invisible and you can't jump to their windows.
8260
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008261 *'tabpagemax'* *'tpm'*
8262'tabpagemax' 'tpm' number (default 10)
8263 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008264 Maximum number of tab pages to be opened by the |-p| command line
8265 argument or the ":tab all" command. |tabpage|
8266
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008267 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268'tabstop' 'ts' number (default 8)
8269 local to buffer
8270 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008271 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272
8273 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008274 appear wrong in many places, e.g., when printing it.
8275 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008277 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8279 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008280 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008282 This is the recommended way, the file will look the same with other
8283 tools and when listing it in a terminal.
8284 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8285 'expandtab'. This way you will always insert spaces. The
8286 formatting will never be messed up when 'tabstop' is changed (leave
8287 it at 8 just in case). The file will be a bit larger.
8288 You do need to check if no Tabs exist in the file. You can get rid
8289 of them by first setting 'expandtab' and using `%retab!`, making
8290 sure the value of 'tabstop' is set correctly.
8291 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 'expandtab'. This way you will always insert spaces. The
8293 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008294 You do need to check if no Tabs exist in the file, just like in the
8295 item just above.
8296 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008297 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008298 works when using Vim to edit the file, other tools assume a tabstop
8299 is worth 8 spaces.
8300 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 'noexpandtab'. This should then work (for initial indents only)
8302 for any tabstop setting that people use. It might be nice to have
8303 tabs after the first non-blank inserted as spaces if you do this
8304 though. Otherwise aligned comments will be wrong when 'tabstop' is
8305 changed.
8306
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008307 If Vim is compiled with the |+vartabs| feature then the value of
8308 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8309 than an empty string.
8310
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8312'tagbsearch' 'tbs' boolean (default on)
8313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008315 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 searching makes searching for a tag a LOT faster, but a linear search
8317 will find more tags if the tags file wasn't properly sorted.
8318 Vim normally assumes that your tags files are sorted, or indicate that
8319 they are not sorted. Only when this is not the case does the
8320 'tagbsearch' option need to be switched off.
8321
8322 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008323 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 certain files, or retry all files with a linear search. When
8325 'tagbsearch' is off, only a linear search is done.
8326
8327 Linear searching is done anyway, for one file, when Vim finds a line
8328 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008329 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330< [The whitespace before and after the '0' must be a single <Tab>]
8331
8332 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008333 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 instead of a normal tag name, a retry is done with a linear search.
8335 Tags in unsorted tags files, and matches with different case will only
8336 be found in the retry.
8337
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008338 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008339 linear search can be avoided when case is ignored. Use a value of '2'
8340 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8341 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008342 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8343 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8344 used for this as well. Note that case must be folded to uppercase for
8345 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008346
8347 By default, tag searches are case-sensitive. Case is ignored when
8348 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8349 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008350 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8351 'tagcase' is "smart", and the pattern contains only lowercase
8352 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353
8354 When 'tagbsearch' is off, tags searching is slower when a full match
8355 exists, but faster when no full match exists. Tags in unsorted tags
8356 files may only be found with 'tagbsearch' off.
8357 When the tags file is not sorted, or sorted in a wrong way (not on
8358 ASCII byte value), 'tagbsearch' should be off, or the line given above
8359 must be included in the tags file.
8360 This option doesn't affect commands that find all matching tags (e.g.,
8361 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008363 *'tagcase'* *'tc'*
8364'tagcase' 'tc' string (default "followic")
8365 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008366 This option specifies how case is handled when searching the tags
8367 file:
8368 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008369 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008370 ignore Ignore case
8371 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008372 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008373 NOTE: This option is set to the Vi default value when 'compatible' is
8374 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008375
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008376 *'tagfunc'* *'tfu'*
8377'tagfunc' 'tfu' string (default: empty)
8378 local to buffer
8379 {not available when compiled without the |+eval|
8380 feature}
8381 This option specifies a function to be used to perform tag searches.
8382 The function gets the tag pattern and should return a List of matching
8383 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008384 function and an example. The value can be the name of a function, a
8385 |lambda| or a |Funcref|. See |option-value-function| for more
8386 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008387 This option cannot be set from a |modeline| or in the |sandbox|, for
8388 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008389
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 *'taglength'* *'tl'*
8391'taglength' 'tl' number (default 0)
8392 global
8393 If non-zero, tags are significant up to this number of characters.
8394
8395 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8396'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8397 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008398 If on and using a tags file in another directory, file names in that
8399 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 NOTE: This option is set to the Vi default value when 'compatible' is
8401 set and to the Vim default value when 'compatible' is reset.
8402
8403 *'tags'* *'tag'* *E433*
8404'tags' 'tag' string (default "./tags,tags", when compiled with
8405 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8406 global or local to buffer |global-local|
8407 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008408 include a space or comma in a file name, precede it with backslashes
8409 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 When a file name starts with "./", the '.' is replaced with the path
8411 of the current file. But only when the 'd' flag is not included in
8412 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8413 |tags-option|.
8414 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008415 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8416 find all files named "tags" below "/lib". The filename itself cannot
8417 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008418 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008419 The |tagfiles()| function can be used to get a list of the file names
8420 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008421 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8422 files are also supported. They are automatically recognized. The
8423 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8424 differences are ignored (MS-Windows). |emacs-tags|
8425 The use of |:set+=| and |:set-=| is preferred when adding or removing
8426 file names from the list. This avoids problems when a future version
8427 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428
8429 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8430'tagstack' 'tgst' boolean (default on)
8431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 When on, the |tagstack| is used normally. When off, a ":tag" or
8433 ":tselect" command with an argument will not push the tag onto the
8434 tagstack. A following ":tag" without an argument, a ":pop" command or
8435 any other command that uses the tagstack will use the unmodified
8436 tagstack, but does change the pointer to the active entry.
8437 Resetting this option is useful when using a ":tag" command in a
8438 mapping which should not change the tagstack.
8439
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008440 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008441'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008442 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008443 {only available when compiled with the |+tcl/dyn|
8444 feature}
8445 Specifies the name of the Tcl shared library. The default is
8446 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008447 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008448 This option cannot be set from a |modeline| or in the |sandbox|, for
8449 security reasons.
8450
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 *'term'* *E529* *E530* *E531*
8452'term' string (default is $TERM, if that fails:
8453 in the GUI: "builtin_gui"
8454 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008455 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 on Unix: "ansi"
8458 on VMS: "ansi"
8459 on Win 32: "win32")
8460 global
8461 Name of the terminal. Used for choosing the terminal control
8462 characters. Environment variables are expanded |:set_env|.
8463 For example: >
8464 :set term=$TERM
8465< See |termcap|.
8466
8467 *'termbidi'* *'tbidi'*
8468 *'notermbidi'* *'notbidi'*
8469'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 {only available when compiled with the |+arabic|
8472 feature}
8473 The terminal is in charge of Bi-directionality of text (as specified
8474 by Unicode). The terminal is also expected to do the required shaping
8475 that some languages (such as Arabic) require.
8476 Setting this option implies that 'rightleft' will not be set when
8477 'arabic' is set and the value of 'arabicshape' will be ignored.
8478 Note that setting 'termbidi' has the immediate effect that
8479 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8480 This option is reset when the GUI is started.
8481 For further details see |arabic.txt|.
8482
8483 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008484'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 Encoding used for the terminal. This specifies what character
8487 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008488 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008489 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008490 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008491 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8493 Any attempts to set a different value will be rejected, and an error
8494 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008495 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 because the Win32 system always passes Unicode characters.
8497 When empty, the same encoding is used as for the 'encoding' option.
8498 This is the normal value.
8499 Not all combinations for 'termencoding' and 'encoding' are valid. See
8500 |encoding-table|.
8501 The value for this option must be supported by internal conversions or
8502 iconv(). When this is not possible no conversion will be done and you
8503 will probably experience problems with non-ASCII characters.
8504 Example: You are working with the locale set to euc-jp (Japanese) and
8505 want to edit a UTF-8 file: >
8506 :let &termencoding = &encoding
8507 :set encoding=utf-8
8508< You need to do this when your system has no locale support for UTF-8.
8509
Bram Moolenaar938ae282023-02-20 20:44:55 +00008510 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008511'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8512 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008513 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008514 {not available when compiled without the
8515 |+termguicolors| feature}
8516 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008517 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008518
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008519 Requires a ISO-8613-3 compatible terminal. If setting this option
8520 does not work (produces a colorless UI) reading |xterm-true-color|
8521 might help.
8522
8523 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8524 is required. Use this check to find out: >
8525 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008526< This requires Vim to be built with the |+vtp| feature.
8527
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008528 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008529
8530 When using Vim with Windows Terminal, the background of Windows
8531 Terminal is normally filled with the Vim background color. Setting
8532 'termguicolors' and the guibg of the Normal highlight group to NONE
8533 will make the background transparent: >
8534 :hi Normal guibg=NONE
8535<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008536 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008537
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008538 *'termwinkey'* *'twk'*
8539'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008540 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008541 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008542 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008543 The key can be specified as a single character, a |key-notation| (e.g.
8544 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8545 :set twk=X
8546 :set twk=^I
8547 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008548< The string must be one key stroke but can be multiple bytes.
8549 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008550 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008551 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008552
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008553 *'termwinscroll'* *'twsl'*
8554'termwinscroll' 'twsl' number (default 10000)
8555 local to buffer
8556 {not available when compiled without the
8557 |+terminal| feature}
8558 Number of scrollback lines to keep. When going over this limit the
8559 first 10% of the scrollback lines are deleted. This is just to reduce
8560 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008561 Also used as a limit for text sent to the terminal in one write,
8562 multiplied by the number of columns times 3 (average number of bytes
8563 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008564
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008565 *'termwinsize'* *'tws'*
8566'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008567 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008568 Size used when opening the |terminal| window. Format:
8569 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008570 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008571 - When set with a "x" (e.g., "24x80") the terminal size is not
8572 adjusted to the window size. If the window is smaller only the
8573 top-left part is displayed.
8574 - When set with a "*" (e.g., "10*50") the terminal size follows the
8575 window size, but will not be smaller than the specified rows and/or
8576 columns.
8577 - When rows is zero then use the height of the window.
8578 - When columns is zero then use the width of the window.
8579 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008580 - Can be overruled in the |term_start()| options with "term_rows" and
8581 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008582
8583 Examples:
8584 "30x0" uses 30 rows and the current window width.
8585 "20*0" uses at least 20 rows and the current window width.
8586 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008587 Note that the command running in the terminal window may still change
8588 the size of the terminal. In that case the Vim window will be
8589 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008590
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008591 *'termwintype'* *'twt'*
8592'termwintype' 'twt' string (default "")
8593 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008594 {only available when compiled with the |terminal|
8595 feature on MS-Windows}
8596 Specify the virtual console (pty) used when opening the terminal
8597 window.
8598
8599 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008600 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008601 "winpty" use winpty, fail if not supported
8602 "conpty" use |ConPTY|, fail if not supported
8603
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008604 |ConPTY| support depends on the platform. Windows 10 October 2018
8605 Update is the first version that supports ConPTY, however it is still
8606 considered unstable. ConPTY might become stable in the next release
8607 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008608 supported then you cannot open a terminal window.
8609
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 *'terse'* *'noterse'*
8611'terse' boolean (default off)
8612 global
8613 When set: Add 's' flag to 'shortmess' option (this makes the message
8614 for a search that hits the start or end of the file not being
8615 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8616 shortens a lot of messages}
8617
8618 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8619'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 This option is obsolete. Use 'fileformats'.
8622 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8623 set to the default value for the current system. When 'textauto' is
8624 reset, 'fileformats' is made empty.
8625 NOTE: This option is set to the Vi default value when 'compatible' is
8626 set and to the Vim default value when 'compatible' is reset.
8627
8628 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008629'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 others: default off)
8631 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 This option is obsolete. Use 'fileformat'.
8633 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8634 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8635 "unix".
8636
8637 *'textwidth'* *'tw'*
8638'textwidth' 'tw' number (default 0)
8639 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 Maximum width of text that is being inserted. A longer line will be
8641 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008642 this.
8643 'textwidth' is set to 0 when the 'paste' option is set and restored
8644 when 'paste' is reset.
8645 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008647 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 NOTE: This option is set to 0 when 'compatible' is set.
8649
8650 *'thesaurus'* *'tsr'*
8651'thesaurus' 'tsr' string (default "")
8652 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008654 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8655 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008656
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008657 This option is not used if 'thesaurusfunc' is set, either for the
8658 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008659
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008660 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008662 name. See |option-backslash| about using backslashes. The use of
8663 |:set+=| and |:set-=| is preferred when adding or removing directories
8664 from the list. This avoids problems when a future version uses
8665 another default. Backticks cannot be used in this option for security
8666 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008668 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008669'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008670 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008671 {not available when compiled without the |+eval|
8672 feature}
8673 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008674 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008675 The value can be the name of a function, a |lambda| or a |Funcref|.
8676 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008677
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008678 This option cannot be set from a |modeline| or in the |sandbox|, for
8679 security reasons.
8680
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8682'tildeop' 'top' boolean (default off)
8683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 When on: The tilde command "~" behaves like an operator.
8685 NOTE: This option is reset when 'compatible' is set.
8686
8687 *'timeout'* *'to'* *'notimeout'* *'noto'*
8688'timeout' 'to' boolean (default on)
8689 global
laburnumT3f7855a2023-12-05 18:37:03 +01008690
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008692'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 These two options together determine the behavior when part of a
8695 mapped key sequence or keyboard code has been received:
8696
8697 'timeout' 'ttimeout' action ~
8698 off off do not time out
8699 on on or off time out on :mappings and key codes
8700 off on time out on key codes
8701
8702 If both options are off, Vim will wait until either the complete
8703 mapping or key sequence has been received, or it is clear that there
8704 is no mapping or key sequence for the received characters. For
8705 example: if you have mapped "vl" and Vim has received 'v', the next
8706 character is needed to see if the 'v' is followed by an 'l'.
8707 When one of the options is on, Vim will wait for about 1 second for
8708 the next character to arrive. After that the already received
8709 characters are interpreted as single characters. The waiting time can
8710 be changed with the 'timeoutlen' option.
8711 On slow terminals or very busy systems timing out may cause
8712 malfunctioning cursor keys. If both options are off, Vim waits
8713 forever after an entered <Esc> if there are key codes that start
8714 with <Esc>. You will have to type <Esc> twice. If you do not have
8715 problems with key codes, but would like to have :mapped key
8716 sequences not timing out in 1 second, set the 'ttimeout' option and
8717 reset the 'timeout' option.
8718
8719 NOTE: 'ttimeout' is reset when 'compatible' is set.
8720
8721 *'timeoutlen'* *'tm'*
8722'timeoutlen' 'tm' number (default 1000)
8723 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008724
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008726'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 The time in milliseconds that is waited for a key code or mapped key
8729 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8730 when part of a command has been typed.
8731 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8732 different timeout value for key codes is desired set 'ttimeoutlen' to
8733 a non-negative number.
8734
8735 ttimeoutlen mapping delay key code delay ~
8736 < 0 'timeoutlen' 'timeoutlen'
8737 >= 0 'timeoutlen' 'ttimeoutlen'
8738
8739 The timeout only happens when the 'timeout' and 'ttimeout' options
8740 tell so. A useful setting would be >
8741 :set timeout timeoutlen=3000 ttimeoutlen=100
8742< (time out on mapping after three seconds, time out on key codes after
8743 a tenth of a second).
8744
8745 *'title'* *'notitle'*
8746'title' boolean (default off, on when title can be restored)
8747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 When on, the title of the window will be set to the value of
8749 'titlestring' (if it is not empty), or to:
8750 filename [+=-] (path) - VIM
8751 Where:
8752 filename the name of the file being edited
8753 - indicates the file cannot be modified, 'ma' off
8754 + indicates the file was modified
8755 = indicates the file is read-only
8756 =+ indicates the file is read-only and modified
8757 (path) is the path of the file being edited
8758 - VIM the server name |v:servername| or "VIM"
8759 Only works if the terminal supports setting window titles
8760 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008761 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8763 *X11*
8764 When Vim was compiled with HAVE_X11 defined, the original title will
8765 be restored if possible. The output of ":version" will include "+X11"
8766 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8767 works for the icon name |'icon'|.
8768 But: When Vim was started with the |-X| argument, restoring the title
8769 will not work (except in the GUI).
8770 If the title cannot be restored, it is set to the value of 'titleold'.
8771 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008772 When using an xterm from a remote machine you can use this command: >
8773
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008775 ssh -X machine_name xterm &
8776<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 then the WINDOWID environment variable should be inherited and the
8778 title of the window should change back to what it should be after
8779 exiting Vim.
8780
8781 *'titlelen'*
8782'titlelen' number (default 85)
8783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008785 title. When the title is longer, only the end of the path name is
8786 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 Using a percentage makes this adapt to the width of the window. But
8788 it won't work perfectly, because the actual number of characters
8789 available also depends on the font used and other things in the title
8790 bar. When 'titlelen' is zero the full path is used. Otherwise,
8791 values from 1 to 30000 percent can be used.
8792 'titlelen' is also used for the 'titlestring' option.
8793
8794 *'titleold'*
8795'titleold' string (default "Thanks for flying Vim")
8796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 This option will be used for the window title when exiting Vim if the
8798 original title cannot be restored. Only happens if 'title' is on or
8799 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008800 This option cannot be set from a |modeline| or in the |sandbox|, for
8801 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 *'titlestring'*
8803'titlestring' string (default "")
8804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 When this option is not empty, it will be used for the title of the
8806 window. This happens only when the 'title' option is on.
8807 Only works if the terminal supports setting window titles (currently
8808 Amiga console, Win32 console, all GUI versions and terminals with a
8809 non-empty 't_ts' option).
8810 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008811 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008812
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008814 expanded according to the rules used for 'statusline'. If it contains
8815 an invalid '%' format, the value is used as-is and no error or warning
8816 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008817 This option cannot be set in a modeline when 'modelineexpr' is off.
8818
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008820 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8822< The value of 'titlelen' is used to align items in the middle or right
8823 of the available space.
8824 Some people prefer to have the file name first: >
8825 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8826< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008827 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 separating space only when needed.
8829 NOTE: Use of special characters in 'titlestring' may cause the display
8830 to be garbled (e.g., when it contains a CR or NL character).
8831 {not available when compiled without the |+statusline| feature}
8832
8833 *'toolbar'* *'tb'*
8834'toolbar' 'tb' string (default "icons,tooltips")
8835 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008836 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008837 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 possible values are:
8839 icons Toolbar buttons are shown with icons.
8840 text Toolbar buttons shown with text.
8841 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008842 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 tooltips Tooltips are active for toolbar buttons.
8844 Tooltips refer to the popup help text which appears after the mouse
8845 cursor is placed over a toolbar button for a brief moment.
8846
8847 If you want the toolbar to be shown with icons as well as text, do the
8848 following: >
8849 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008850< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 will show icons if both are requested.
8852
8853 If none of the strings specified in 'toolbar' are valid or if
8854 'toolbar' is empty, this option is ignored. If you want to disable
8855 the toolbar, you need to set the 'guioptions' option. For example: >
8856 :set guioptions-=T
8857< Also see |gui-toolbar|.
8858
8859 *'toolbariconsize'* *'tbis'*
8860'toolbariconsize' 'tbis' string (default "small")
8861 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008862 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008864 tiny Use tiny icons.
8865 small Use small icons (default).
8866 medium Use medium-sized icons.
8867 large Use large icons.
8868 huge Use even larger icons.
8869 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008871 the current theme. Common dimensions are giant=48x48, huge=32x32,
8872 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873
8874 If 'toolbariconsize' is empty, the global default size as determined
8875 by user preferences or the current theme is used.
8876
8877 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8878'ttybuiltin' 'tbi' boolean (default on)
8879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 When on, the builtin termcaps are searched before the external ones.
8881 When off the builtin termcaps are searched after the external ones.
8882 When this option is changed, you should set the 'term' option next for
8883 the change to take effect, for example: >
8884 :set notbi term=$TERM
8885< See also |termcap|.
8886 Rationale: The default for this option is "on", because the builtin
8887 termcap entries are generally better (many systems contain faulty
8888 xterm entries...).
8889
8890 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008891'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 Indicates a fast terminal connection. More characters will be sent to
8894 the screen for redrawing, instead of using insert/delete line
8895 commands. Improves smoothness of redrawing when there are multiple
8896 windows and the terminal does not support a scrolling region.
8897 Also enables the extra writing of characters at the end of each screen
8898 line for lines that wrap. This helps when using copy/paste with the
8899 mouse in an xterm and other terminals.
8900
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008901 The default used to be set only for some terminal names, but these
8902 days nearly all terminals are fast, therefore the default is now "on".
8903 If you have a slow connection you may want to set this option off,
8904 e.g. depending on the host name: >
8905 if hostname() =~ 'faraway'
8906 set nottyfast
8907 endif
8908<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 *'ttymouse'* *'ttym'*
8910'ttymouse' 'ttym' string (default depends on 'term')
8911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912 {only in Unix and VMS, doesn't work in the GUI; not
8913 available when compiled without |+mouse|}
8914 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008915 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 *xterm-mouse*
8917 xterm xterm-like mouse handling. The mouse generates
8918 "<Esc>[Mscr", where "scr" is three bytes:
8919 "s" = button state
8920 "c" = column plus 33
8921 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008922 This only works up to 223 columns! See "dec",
8923 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 xterm2 Works like "xterm", but with the xterm reporting the
8925 mouse position while the mouse is dragged. This works
8926 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008927 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 work. See below for how Vim detects this
8929 automatically.
8930 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008931 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008933 for the row and column. No other mouse events are
8934 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 *dec-mouse*
8936 dec DEC terminal mouse handling. The mouse generates a
8937 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008938 This is also available for an Xterm, if it was
8939 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 *jsbterm-mouse*
8941 jsbterm JSB term mouse handling.
8942 *pterm-mouse*
8943 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008944 *urxvt-mouse*
8945 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008946 The mouse works only if the terminal supports this
8947 encoding style, but it does not have 223 columns limit
8948 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008949 *sgr-mouse*
8950 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008951 mouse reporting. The mouse works even in columns
8952 beyond 223. This option is backward compatible with
8953 "xterm2" because it can also decode "xterm2" style
8954 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955
8956 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008957 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8958 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8960 recognized, if enabled at compile time. DEC terminal mouse codes
8961 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008962 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8963 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008965 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8966 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8967 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008968 If the terminfo/termcap entry "XM" exists and the first number is
8969 "1006" then 'ttymouse' will be set to "sgr". This works for many
8970 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008971 Additionally, if vim is compiled with the |+termresponse| feature and
8972 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008973 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008975 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8976 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8977 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008978 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8979 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 :set t_RV=
8981<
8982 *'ttyscroll'* *'tsl'*
8983'ttyscroll' 'tsl' number (default 999)
8984 global
8985 Maximum number of lines to scroll the screen. If there are more lines
8986 to scroll the window is redrawn. For terminals where scrolling is
8987 very slow and redrawing is not slow this can be set to a small number,
8988 e.g., 3, to speed up displaying.
8989
8990 *'ttytype'* *'tty'*
8991'ttytype' 'tty' string (default from $TERM)
8992 global
8993 Alias for 'term', see above.
8994
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008995 *'undodir'* *'udir'*
8996'undodir' 'udir' string (default ".")
8997 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008998 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008999 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009000 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009001 "." means using the directory of the file. The undo file name for
9002 "file.txt" is ".file.txt.un~".
9003 For other directories the file name is the full path of the edited
9004 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009005 When writing: The first directory that exists is used. "." always
9006 works, no directories after "." will be used for writing.
9007 When reading all entries are tried to find an undo file. The first
9008 undo file that exists is used. When it cannot be read an error is
9009 given, no further entry is used.
9010 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009011 This option cannot be set from a |modeline| or in the |sandbox|, for
9012 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009013
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009014 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009015'undofile' 'udf' boolean (default off)
9016 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009017 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009018 When on, Vim automatically saves undo history to an undo file when
9019 writing a buffer to a file, and restores undo history from the same
9020 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009021 The directory where the undo file is stored is specified by 'undodir'.
9022 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009023 The undo file is not read when 'undoreload' causes the buffer from
9024 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009025 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009026 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009027
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009029'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009030 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009032 is kept in memory, higher numbers will cause more memory to be used.
9033 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9035 itself: >
9036 set ul=0
9037< But you can also get Vi compatibility by including the 'u' flag in
9038 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009039 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009040 Set to -1 for no undo at all. You might want to do this only for the
9041 current buffer: >
9042 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009044
9045 The local value is set to -123456 when the global value is to be used.
9046
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009047 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009049 *'undoreload'* *'ur'*
9050'undoreload' 'ur' number (default 10000)
9051 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009052 Save the whole buffer for undo when reloading it. This applies to the
9053 ":e!" command and reloading for when the buffer changed outside of
9054 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009055 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009056 of lines is smaller than the value of this option.
9057 Set this option to zero to disable undo for a reload.
9058
9059 When saving undo for a reload, any undo file is not read.
9060
9061 Note that this causes the whole buffer to be stored in memory. Set
9062 this option to a lower value if you run out of memory.
9063
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 *'updatecount'* *'uc'*
9065'updatecount' 'uc' number (default: 200)
9066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 After typing this many characters the swap file will be written to
9068 disk. When zero, no swap file will be created at all (see chapter on
9069 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9070 Vim with the "-n" option, see |startup|. When editing in readonly
9071 mode this option will be initialized to 10000.
9072 The swapfile can be disabled per buffer with |'swapfile'|.
9073 When 'updatecount' is set from zero to non-zero, swap files are
9074 created for all buffers that have 'swapfile' set. When 'updatecount'
9075 is set to zero, existing swap files are not deleted.
9076 Also see |'swapsync'|.
9077 This option has no meaning in buffers where |'buftype'| is "nofile"
9078 or "nowrite".
9079
9080 *'updatetime'* *'ut'*
9081'updatetime' 'ut' number (default 4000)
9082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 If this many milliseconds nothing is typed the swap file will be
9084 written to disk (see |crash-recovery|). Also used for the
9085 |CursorHold| autocommand event.
9086
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009087 *'varsofttabstop'* *'vsts'*
9088'varsofttabstop' 'vsts' string (default "")
9089 local to buffer
9090 {only available when compiled with the |+vartabs|
9091 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009092 A list of the number of spaces that a <Tab> counts for while editing,
9093 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9094 width <Tab>s are being inserted, while in fact a mixture of spaces
9095 and <Tab>s is used. Tab widths are separated with commas, with the
9096 final value applying to all subsequent tabs.
9097
9098 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009099 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009100 to use the following: >
9101 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009102< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9103 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009104
9105 Note that the value of |'softtabstop'| will be ignored while
9106 'varsofttabstop' is set.
9107
9108 *'vartabstop'* *'vts'*
9109'vartabstop' 'vts' string (default "")
9110 local to buffer
9111 {only available when compiled with the |+vartabs|
9112 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009113 A list of the number of spaces that a <Tab> in the file counts for,
9114 separated by commas. Each value corresponds to one tab, with the
9115 final value applying to all subsequent tabs. For example: >
9116 :set vartabstop=4,20,10,8
9117< This will make the first tab 4 spaces wide, the second 20 spaces,
9118 the third 10 spaces, and all following tabs 8 spaces.
9119
9120 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9121 is set.
9122
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 *'verbose'* *'vbs'*
9124'verbose' 'vbs' number (default 0)
9125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126 When bigger than zero, Vim will give messages about what it is doing.
9127 Currently, these messages are given:
9128 >= 1 When the viminfo file is read or written.
9129 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009130 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009131 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132 >= 8 Files for which a group of autocommands is executed.
9133 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009134 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135 >= 12 Every executed function.
9136 >= 13 When an exception is thrown, caught, finished, or discarded.
9137 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009138 >= 15 Every executed Ex command from a script (truncated at 200
9139 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009140 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141
9142 This option can also be set with the "-V" argument. See |-V|.
9143 This option is also set by the |:verbose| command.
9144
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009145 When the 'verbosefile' option is set then the verbose messages are not
9146 displayed.
9147
9148 *'verbosefile'* *'vfile'*
9149'verbosefile' 'vfile' string (default empty)
9150 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009151 When not empty all messages are written in a file with this name.
9152 When the file exists messages are appended.
9153 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009154 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009155 Setting 'verbosefile' to a new value is like making it empty first.
9156 The difference with |:redir| is that verbose messages are not
9157 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009158 This option cannot be set from a |modeline| or in the |sandbox|, for
9159 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009160
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009162'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009163 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009164 for Unix: "$HOME/.vim/view" or
9165 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009166 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009168 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 feature}
9170 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009171 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 This option cannot be set from a |modeline| or in the |sandbox|, for
9173 security reasons.
9174
9175 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009176'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009178 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009179 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009180 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009181 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182 word save and restore ~
9183 cursor cursor position in file and in window
9184 folds manually created folds, opened/closed folds and local
9185 fold options
9186 options options and mappings local to a window or buffer (not
9187 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009188 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 slash backslashes in file names replaced with forward
9190 slashes
9191 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009192 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009193 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009194
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009195 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009197 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198
9199 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009200'viminfo' 'vi' string (Vi default: "", Vim default for
9201 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009202 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9203 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009205 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 feature}
9207 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009208 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9209 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009210 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009211 consisting of a single character identifying the particular parameter,
9212 followed by a number or string which specifies the value of that
9213 parameter. If a particular character is left out, then the default
9214 value is used for that parameter. The following is a list of the
9215 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009217 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009218 ! When included, save and restore global variables that start
9219 with an uppercase letter, and don't contain a lowercase
9220 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009221 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009222 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009223 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 " Maximum number of lines saved for each register. Old name of
9225 the '<' item, with the disadvantage that you need to put a
9226 backslash before the ", otherwise it will be recognized as the
9227 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009228 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 % When included, save and restore the buffer list. If Vim is
9230 started with a file name argument, the buffer list is not
9231 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009232 buffer list is restored from the viminfo file. Quickfix
9233 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9234 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009235 When followed by a number, the number specifies the maximum
9236 number of buffers that are stored. Without a number all
9237 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009238 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 ' Maximum number of previously edited files for which the marks
9240 are remembered. This parameter must always be included when
9241 'viminfo' is non-empty.
9242 Including this item also means that the |jumplist| and the
9243 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009244 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009246 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247 patterns are also saved. When not included, the value of
9248 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009249 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009251 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009252 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009253 < Maximum number of lines saved for each register. If zero then
9254 registers are not saved. When not included, all lines are
9255 saved. '"' is the old name for this item.
9256 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009257 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009259 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009260 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 c When included, convert the text in the viminfo file from the
9262 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009263 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009264 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 f Whether file marks need to be stored. If zero, file marks ('0
9266 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009267 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009269 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270 h Disable the effect of 'hlsearch' when loading the viminfo
9271 file. When not included, it depends on whether ":nohlsearch"
9272 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009273 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009275 the 'n'. Must be at the end of the option! If the
9276 'viminfofile' option is set, that file name overrides the one
9277 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009278 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009279 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 r Removable media. The argument is a string (up to the next
9281 ','). This parameter can be given several times. Each
9282 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009283 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9285 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9286 ignored. Maximum length of each 'r' argument is 50
9287 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009288 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 s Maximum size of an item in Kbyte. If zero then registers are
9290 not saved. Currently only applies to registers. The default
9291 "s10" will exclude registers with more than 10 Kbyte of text.
9292 Also see the '<' item above: line count limit.
9293
9294 Example: >
9295 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9296<
9297 '50 Marks will be remembered for the last 50 files you
9298 edited.
9299 <1000 Contents of registers (up to 1000 lines each) will be
9300 remembered.
9301 s100 Registers with more than 100 Kbyte text are skipped.
9302 :0 Command-line history will not be saved.
9303 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9304 no / Since '/' is not specified, the default will be used,
9305 that is, save all of the search history, and also the
9306 previous search and substitute patterns.
9307 no % The buffer list will not be saved nor read back.
9308 no h 'hlsearch' highlighting will be restored.
9309
9310 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9311 load the contents of the file, this is not done automatically.
9312
9313 This option cannot be set from a |modeline| or in the |sandbox|, for
9314 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009315 NOTE: This option is set to the Vim default value when 'compatible'
9316 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009318 *'viminfofile'* *'vif'*
9319'viminfofile' 'vif' string (default: "")
9320 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009321 {not available when compiled without the |+viminfo|
9322 feature}
9323 When non-empty, overrides the file name used for viminfo.
9324 When equal to "NONE" no viminfo file will be read or written.
9325 This option can be set with the |-i| command line flag. The |--clean|
9326 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009327 This option cannot be set from a |modeline| or in the |sandbox|, for
9328 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009329
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330 *'virtualedit'* *'ve'*
9331'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009332 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009333 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 block Allow virtual editing in Visual block mode.
9335 insert Allow virtual editing in Insert mode.
9336 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009337 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009338 none When used as the local value, do not allow virtual
9339 editing even when the global value is set. When used
9340 as the global value, "none" is the same as "".
9341 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009342
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009344 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009345 of the line. Useful for selecting a rectangle in Visual mode and
9346 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009347 "onemore" is not the same, it will only allow moving the cursor just
9348 after the last character of the line. This makes some commands more
9349 consistent. Previously the cursor was always past the end of the line
9350 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009351 break some plugins or Vim scripts. For example because |l| can move
9352 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009353 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009354 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009355 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009356 It doesn't make sense to combine "all" with "onemore", but you will
9357 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009358 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009359 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360
9361 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9362'visualbell' 'vb' boolean (default off)
9363 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009364 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009365 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009366 use: >
9367 :set vb t_vb=
9368< If you want a short flash, you can use this on many terminals: >
9369 :set vb t_vb=[?5h$<100>[?5l
9370< Here $<100> specifies the time, you can use a smaller or bigger value
9371 to get a shorter or longer flash.
9372
9373 Note: Vim will limit the bell to once per half a second. This avoids
9374 having to wait for the flashing to finish when there are lots of
9375 bells, e.g. on key repeat. This also happens without 'visualbell'
9376 set.
9377
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9379 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9380 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009381
9382 Note: When the GUI starts, 't_vb' is reset to its default value. You
9383 might want to set it again in your |gvimrc|.
9384
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 Does not work on the Amiga, you always get a screen flash.
9386 Also see 'errorbells'.
9387
9388 *'warn'* *'nowarn'*
9389'warn' boolean (default on)
9390 global
9391 Give a warning message when a shell command is used while the buffer
9392 has been changed.
9393
9394 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9395'weirdinvert' 'wiv' boolean (default off)
9396 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009397 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009398 It is provided for backwards compatibility with version 4.x.
9399 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9400 vice versa. Has no effect when the GUI is running.
9401
9402 *'whichwrap'* *'ww'*
9403'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9404 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 Allow specified keys that move the cursor left/right to move to the
9406 previous/next line when the cursor is on the first/last character in
9407 the line. Concatenate characters to allow this for these keys:
9408 char key mode ~
9409 b <BS> Normal and Visual
9410 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009411 h "h" Normal and Visual (not recommended)
9412 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009413 < <Left> Normal and Visual
9414 > <Right> Normal and Visual
9415 ~ "~" Normal
9416 [ <Left> Insert and Replace
9417 ] <Right> Insert and Replace
9418 For example: >
9419 :set ww=<,>,[,]
9420< allows wrap only when cursor keys are used.
9421 When the movement keys are used in combination with a delete or change
9422 operator, the <EOL> also counts for a character. This makes "3h"
9423 different from "3dh" when the cursor crosses the end of a line. This
9424 is also true for "x" and "X", because they do the same as "dl" and
9425 "dh". If you use this, you may also want to use the mapping
9426 ":map <BS> X" to make backspace delete the character in front of the
9427 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009428 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009429 line (not an empty line) then it will not move to the next line. This
9430 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009431 NOTE: This option is set to the Vi default value when 'compatible' is
9432 set and to the Vim default value when 'compatible' is reset.
9433
9434 *'wildchar'* *'wc'*
9435'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009437 Character you have to type to start wildcard expansion in the
9438 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009439 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009440 The character is not recognized when used inside a macro. See
9441 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009442 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009443 <Esc> can be used, but hitting it twice in a row will still exit
9444 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009445 Although 'wc' is a number option, it can be specified as a number, a
9446 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9447 preceded with a caret (e.g. `^F` is CTRL-F): >
9448 :set wc=27
9449 :set wc=X
9450 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009451 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009452< NOTE: This option is set to the Vi default value when 'compatible' is
9453 set and to the Vim default value when 'compatible' is reset.
9454
9455 *'wildcharm'* *'wcm'*
9456'wildcharm' 'wcm' number (default: none (0))
9457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009458 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009459 recognized when used inside a macro. You can find "spare" command-line
9460 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009461 you'll never actually type 'wildcharm', just use it in mappings that
9462 automatically invoke completion mode, e.g.: >
9463 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009464 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009465< Then after typing :ss you can use CTRL-P & CTRL-N.
9466
9467 *'wildignore'* *'wig'*
9468'wildignore' 'wig' string (default "")
9469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009470 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009471 patterns is ignored when expanding |wildcards|, completing file or
9472 directory names, and influences the result of |expand()|, |glob()| and
9473 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9475 Also see 'suffixes'.
9476 Example: >
9477 :set wildignore=*.o,*.obj
9478< The use of |:set+=| and |:set-=| is preferred when adding or removing
9479 a pattern from the list. This avoids problems when a future version
9480 uses another default.
9481
h_east596a9f22023-11-21 21:24:23 +09009482 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009483'wildignorecase' 'wic' boolean (default off)
9484 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009485 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009486 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009487 Does not apply when the shell is used to expand wildcards, which
9488 happens when there are special characters.
9489
Bram Moolenaar071d4272004-06-13 20:20:40 +00009490 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009491'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 When 'wildmenu' is on, command-line completion operates in an enhanced
9494 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009495 the possible matches are shown.
9496 When 'wildoptions' contains "pum", then the completion matches are
9497 shown in a popup menu. Otherwise they are displayed just above the
9498 command line, with the first match highlighted (overwriting the status
9499 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009500 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009501 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9502 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9503 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009504 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505 If there are more matches than can fit in the line, a ">" is shown on
9506 the right and/or a "<" is shown on the left. The status line scrolls
9507 as needed.
9508 The "wildmenu" mode is abandoned when a key is hit that is not used
9509 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009510 While the "wildmenu" is active, the following keys have special
9511 meanings:
9512 CTRL-P - go to the previous entry
9513 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009514 <CR> - in menu completion, when the cursor is just after a
9515 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009516 CTRL-E - end completion, go back to what was there before
9517 selecting a match.
9518 CTRL-Y - accept the currently selected match and stop
9519 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009520
9521 When not using the popup menu for command line completion, the
9522 following keys have special meanings:
9523 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009524 <Up> - in filename/menu name completion: move up into
9525 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009526 <Down> - in filename/menu name completion: move into a
9527 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009528
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009529 When using the popup menu for command line completion, the following
9530 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009531 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009532 <PageUp> - select a match several entries back
9533 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009534 <Left> - in filename/menu name completion: move up into
9535 parent directory or parent menu.
9536 <Right> - in filename/menu name completion: move into a
9537 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009538
Bram Moolenaar071d4272004-06-13 20:20:40 +00009539 This makes the menus accessible from the console |console-menus|.
9540
9541 If you prefer the <Left> and <Right> keys to move the cursor instead
9542 of selecting a different match, use this: >
9543 :cnoremap <Left> <Space><BS><Left>
9544 :cnoremap <Right> <Space><BS><Right>
9545<
9546 The "WildMenu" highlighting is used for displaying the current match
9547 |hl-WildMenu|.
9548
9549 *'wildmode'* *'wim'*
9550'wildmode' 'wim' string (Vim default: "full")
9551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009552 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009553 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009554 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 first part specifies the behavior for the first use of 'wildchar',
9556 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009557
9558 Each part consists of a colon separated list consisting of the
9559 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009560 "" Complete only the first match.
9561 "full" Complete the next full match. After the last match,
9562 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009563 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009564 "longest" Complete till longest common string. If this doesn't
9565 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009566 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009567 "lastused" When completing buffer names and more than one buffer
9568 matches, sort buffers by time last used (other than
9569 the current buffer).
9570 When there is only a single match, it is fully completed in all cases.
9571
9572 Examples of useful colon-separated values:
9573 "longest:full" Like "longest", but also start 'wildmenu' if it is
9574 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 "list:full" When more than one match, list all matches and
9576 complete first match.
9577 "list:longest" When more than one match, list all matches and
9578 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009579 "list:lastused" When more than one buffer matches, list all matches
9580 and sort buffers by time last used (other than the
9581 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009582
9583 Examples: >
9584 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009585< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009586 :set wildmode=longest,full
9587< Complete longest common string, then each full match >
9588 :set wildmode=list:full
9589< List all matches and complete each full match >
9590 :set wildmode=list,full
9591< List all matches without completing, then each full match >
9592 :set wildmode=longest,list
9593< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009594 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009595
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009596 *'wildoptions'* *'wop'*
9597'wildoptions' 'wop' string (default "")
9598 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009599 A list of words that change how |cmdline-completion| is done.
9600 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009601 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009602 this value is specified, wildcard expansion will not
9603 be used for completion. The matches will be sorted by
9604 the "best match" rather than alphabetically sorted.
9605 This will find more matches than the wildcard
9606 expansion. Currently fuzzy matching based completion
9607 is not supported for file and directory names and
9608 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009609 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009610 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009611 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009612 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009613 is displayed per line. Often used tag kinds are:
9614 d #define
9615 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009616
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617 *'winaltkeys'* *'wak'*
9618'winaltkeys' 'wak' string (default "menu")
9619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009620 {only used in Win32, Motif, GTK and Photon GUI}
9621 Some GUI versions allow the access to menu entries by using the ALT
9622 key in combination with a character that appears underlined in the
9623 menu. This conflicts with the use of the ALT key for mappings and
9624 entering special characters. This option tells what to do:
9625 no Don't use ALT keys for menus. ALT key combinations can be
9626 mapped, but there is no automatic handling. This can then be
9627 done with the |:simalt| command.
9628 yes ALT key handling is done by the windowing system. ALT key
9629 combinations cannot be mapped.
9630 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009631 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009632 keys can be mapped.
9633 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9634 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009635 This option is not used for <F10>; on Win32 and with GTK <F10> will
9636 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009638 *'wincolor'* *'wcr'*
9639'wincolor' 'wcr' string (default empty)
9640 local to window
9641 Highlight group name to use for this window instead of the Normal
9642 color |hl-Normal|.
9643
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009644 *'window'* *'wi'*
9645'window' 'wi' number (default screen height - 1)
9646 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009647 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9648 window and the value is smaller than 'lines' minus one. The screen
9649 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009650 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9651 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009652 When resizing the Vim window, and the value is smaller than 1 or more
9653 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009654 Note: Do not confuse this with the height of the Vim window, use
9655 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009656
Colin Kennedy21570352024-03-03 16:16:47 +01009657 *'winfixbuf'*
9658'winfixbuf' 'wfb' boolean (default off)
9659 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009660 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009661 For example, attempting to change the buffer with |:edit| will fail.
9662 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009663 also skip any window with 'winfixbuf' enabled. However if an Ex
9664 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009665
laburnumT3f7855a2023-12-05 18:37:03 +01009666 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9667'winfixheight' 'wfh' boolean (default off)
9668 local to window |local-noglobal|
9669 Keep the window height when windows are opened or closed and
9670 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9671 |preview-window| and |quickfix-window|.
9672 The height may be changed anyway when running out of room.
9673
9674 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9675'winfixwidth' 'wfw' boolean (default off)
9676 local to window |local-noglobal|
9677 Keep the window width when windows are opened or closed and
9678 'equalalways' is set. Also for |CTRL-W_=|.
9679 The width may be changed anyway when running out of room.
9680
Bram Moolenaar071d4272004-06-13 20:20:40 +00009681 *'winheight'* *'wh'* *E591*
9682'winheight' 'wh' number (default 1)
9683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009684 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009685 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009686 focus goes to a window that is smaller, its size is increased, at the
9687 cost of the height of other windows.
9688 Set 'winheight' to a small number for normal editing.
9689 Set it to 999 to make the current window fill most of the screen.
9690 Other windows will be only 'winminheight' high. This has the drawback
9691 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9692 to create only two windows, set the option after startup is done,
9693 using the |VimEnter| event: >
9694 au VimEnter * set winheight=999
9695< Minimum value is 1.
9696 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009697 height of the current window.
9698 'winheight' applies to the current window. Use 'winminheight' to set
9699 the minimal height for other windows.
9700
Bram Moolenaar071d4272004-06-13 20:20:40 +00009701 *'winminheight'* *'wmh'*
9702'winminheight' 'wmh' number (default 1)
9703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009704 The minimal height of a window, when it's not the current window.
9705 This is a hard minimum, windows will never become smaller.
9706 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9707 status bar) if necessary. They will return to at least one line when
9708 they become active (since the cursor has to have somewhere to go.)
9709 Use 'winheight' to set the minimal height of the current window.
9710 This option is only checked when making a window smaller. Don't use a
9711 large number, it will cause errors when opening more than a few
9712 windows. A value of 0 to 3 is reasonable.
9713
9714 *'winminwidth'* *'wmw'*
9715'winminwidth' 'wmw' number (default 1)
9716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009717 The minimal width of a window, when it's not the current window.
9718 This is a hard minimum, windows will never become smaller.
9719 When set to zero, windows may be "squashed" to zero columns (i.e. just
9720 a vertical separator) if necessary. They will return to at least one
9721 line when they become active (since the cursor has to have somewhere
9722 to go.)
9723 Use 'winwidth' to set the minimal width of the current window.
9724 This option is only checked when making a window smaller. Don't use a
9725 large number, it will cause errors when opening more than a few
9726 windows. A value of 0 to 12 is reasonable.
9727
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009728 *'winptydll'*
9729'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9730 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009731 {only available when compiled with the |terminal|
9732 feature on MS-Windows}
9733 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009734 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009735 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009736 a fallback.
9737 Environment variables are expanded |:set_env|.
9738 This option cannot be set from a |modeline| or in the |sandbox|, for
9739 security reasons.
9740
Bram Moolenaar071d4272004-06-13 20:20:40 +00009741 *'winwidth'* *'wiw'* *E592*
9742'winwidth' 'wiw' number (default 20)
9743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009744 Minimal number of columns for the current window. This is not a hard
9745 minimum, Vim will use fewer columns if there is not enough room. If
9746 the current window is smaller, its size is increased, at the cost of
9747 the width of other windows. Set it to 999 to make the current window
9748 always fill the screen. Set it to a small number for normal editing.
9749 The width is not adjusted after one of the commands to change the
9750 width of the current window.
9751 'winwidth' applies to the current window. Use 'winminwidth' to set
9752 the minimal width for other windows.
9753
9754 *'wrap'* *'nowrap'*
9755'wrap' boolean (default on)
9756 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009757 This option changes how text is displayed. It doesn't change the text
9758 in the buffer, see 'textwidth' for that.
9759 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009760 displaying continues on the next line. When off lines will not wrap
9761 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009762 moved to a part that is not shown, the screen will scroll
9763 horizontally.
9764 The line will be broken in the middle of a word if necessary. See
9765 'linebreak' to get the break at a word boundary.
9766 To make scrolling horizontally a bit more useful, try this: >
9767 :set sidescroll=5
9768 :set listchars+=precedes:<,extends:>
9769< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009770 This option can't be set from a |modeline| when the 'diff' option is
9771 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009772
9773 *'wrapmargin'* *'wm'*
9774'wrapmargin' 'wm' number (default 0)
9775 local to buffer
9776 Number of characters from the right window border where wrapping
9777 starts. When typing text beyond this limit, an <EOL> will be inserted
9778 and inserting continues on the next line.
9779 Options that add a margin, such as 'number' and 'foldcolumn', cause
9780 the text width to be further reduced. This is Vi compatible.
9781 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009782 This option is set to 0 when 'paste' is set and restored when 'paste'
9783 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009784 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009785
9786 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9787'wrapscan' 'ws' boolean (default on) *E384* *E385*
9788 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009789 Searches wrap around the end of the file. Also applies to |]s| and
9790 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009791
9792 *'write'* *'nowrite'*
9793'write' boolean (default on)
9794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009795 Allows writing files. When not set, writing a file is not allowed.
9796 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009797 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009798 argument. Filtering text is still possible, even though this requires
9799 writing a temporary file.
9800
9801 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9802'writeany' 'wa' boolean (default off)
9803 global
9804 Allows writing to any file with no need for "!" override.
9805
9806 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9807'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9808 otherwise)
9809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009810 Make a backup before overwriting a file. The backup is removed after
9811 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009812 also on.
9813 WARNING: Switching this option off means that when Vim fails to write
9814 your buffer correctly and then, for whatever reason, Vim exits, you
9815 lose both the original file and what you were writing. Only reset
9816 this option if your file system is almost full and it makes the write
9817 fail (and make sure not to exit Vim until the write was successful).
9818 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009819 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009820 Depending on 'backupcopy' the backup is a new file or the original
9821 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009822 NOTE: This option is set to the default value when 'compatible' is
9823 set.
9824
9825 *'writedelay'* *'wd'*
9826'writedelay' 'wd' number (default 0)
9827 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009828 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009829 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009830 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009831
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009832 *'xtermcodes'* *'noxtermcodes'*
9833'xtermcodes' boolean (default on)
9834 global
9835 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009836 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009837 key codes and number of colors from the terminal. This takes care of
9838 various configuration options of the terminal that cannot be obtained
9839 from the termlib/terminfo entry, see |xterm-codes|.
9840 A side effect may be that t_Co changes and Vim will redraw the
9841 display.
9842
9843
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009844 vim:tw=78:ts=8:noet:ft=help:norl: