blob: 780db60aba41fd77f79c3f6a9ecf65b472d9cebf [file] [log] [blame]
glepnirad409872025-01-10 20:08:20 +01001*options.txt* For Vim version 9.1. Last change: 2025 Jan 10
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
1036 screen is redrawn. This may have side effects, make t_BG 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
2110 A comma-separated list of |complete-items| that controls the alignment
2111 and display order of items in the popup menu during Insert mode
2112 completion. The supported values are abbr, kind, and menu. These
2113 options allow to customize how the completion items are shown in the
2114 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
2123 menu Use a popup menu to show the possible completions. The
2124 menu is only shown when there is more than one match and
2125 sufficient colors are available. |ins-completion-menu|
2126
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002127 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002128 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002129 match, e.g., what file it comes from.
2130
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002131 longest Only insert the longest common text of the matches. If
2132 the menu is displayed you can use CTRL-L to add more
2133 characters. Whether case is ignored depends on the kind
2134 of completion. For buffer text the 'ignorecase' option is
2135 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002136
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002137 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002138 completion in the preview window. Only works in
2139 combination with "menu" or "menuone".
2140
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002141 popup Show extra information about the currently selected
2142 completion in a popup window. Only works in combination
2143 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002144 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002145 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002146
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002147 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002148 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002149 |CompleteChanged| autocommand to fetch the info and call
2150 |popup_show()| once the popup has been filled.
2151 See the example at |complete-popuphidden|.
2152 {only works when compiled with the |+textprop| feature}
2153
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002154 noinsert Do not insert any text for a match until the user selects
2155 a match from the menu. Only works in combination with
2156 "menu" or "menuone". No effect if "longest" is present.
2157
dundargoc768728b2024-12-01 20:06:42 +01002158 noselect Same as "noinsert", except that no menu item is
h-eastb534e802024-12-03 20:37:52 +01002159 pre-selected. If both "noinsert" and "noselect" are
2160 present, "noselect" has precedence.
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002161
glepnira218cc62024-06-03 19:32:39 +02002162 fuzzy Enable |fuzzy-matching| for completion candidates. This
2163 allows for more flexible and intuitive matching, where
2164 characters can be skipped and matches can be found even
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002165 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002166
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002167 *'completepopup'* *'cpp'*
2168'completepopup' 'cpp' string (default empty)
2169 global
2170 {not available when compiled without the |+textprop|
2171 or |+quickfix| feature}
2172 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002173 properties of the info popup when it is created. If an info popup
2174 window already exists it is closed, so that the option value is
2175 applied when it is created again.
2176 You can also use |popup_findinfo()| and then set properties for an
2177 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002178
laburnumT3f7855a2023-12-05 18:37:03 +01002179 *'completeslash'* *'csl'*
2180'completeslash' 'csl' string (default: "")
2181 local to buffer
2182 {only for MS-Windows}
2183 When this option is set it overrules 'shellslash' for completion:
2184 - When this option is set to "slash", a forward slash is used for path
2185 completion in insert mode. This is useful when editing HTML tag, or
2186 Makefile with 'noshellslash' on MS-Windows.
2187 - When this option is set to "backslash", backslash is used. This is
2188 useful when editing a batch file with 'shellslash' set on MS-Windows.
2189 - When this option is empty, same character is used as for
2190 'shellslash'.
2191 For Insert mode completion the buffer-local value is used. For
2192 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002193
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002194 *'concealcursor'* *'cocu'*
2195'concealcursor' 'cocu' string (default: "")
2196 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002197 {not available when compiled without the |+conceal|
2198 feature}
2199 Sets the modes in which text in the cursor line can also be concealed.
2200 When the current mode is listed then concealing happens just like in
2201 other lines.
2202 n Normal mode
2203 v Visual mode
2204 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002205 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002206
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002207 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002208 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002209 are moving around text is concealed, but when starting to insert text
2210 or selecting a Visual area the concealed text is displayed, so that
2211 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002212 Keep in mind that the cursor position is not always where it's
2213 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002214
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002215 *'conceallevel'* *'cole'*
2216'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002217 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002218 {not available when compiled without the |+conceal|
2219 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002220 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2221 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002222
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002223 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002224 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002225 1 Each block of concealed text is replaced with one
2226 character. If the syntax item does not have a custom
2227 replacement character defined (see |:syn-cchar|) the
2228 character defined in 'listchars' is used (default is a
2229 space).
2230 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002231 2 Concealed text is completely hidden unless it has a
2232 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002233 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002234 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002235
Bram Moolenaara7781e02010-07-19 20:13:22 +02002236 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002237 edit and copy the text. This can be changed with the 'concealcursor'
2238 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002239
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2241'confirm' 'cf' boolean (default off)
2242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 When 'confirm' is on, certain operations that would normally
2244 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2245 instead raise a |dialog| asking if you wish to save the current
2246 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2247 If 'confirm' is off you can still activate confirmation for one
2248 command only (this is most useful in mappings) with the |:confirm|
2249 command.
2250 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2251
2252 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2253'conskey' 'consk' boolean (default off)
2254 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002255 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256
2257 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2258'copyindent' 'ci' boolean (default off)
2259 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 Copy the structure of the existing lines indent when autoindenting a
2261 new line. Normally the new indent is reconstructed by a series of
2262 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2263 in which case only spaces are used). Enabling this option makes the
2264 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002265 existing line. 'expandtab' has no effect on these characters, a Tab
2266 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002268 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 Also see 'preserveindent'.
2270
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002271 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002272'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2273 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002274 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002277 this indicates Vi-compatible behavior. This is used for things where
2278 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 'cpoptions' stands for "compatible-options".
2280 Commas can be added for readability.
2281 To avoid problems with flags that are added in the future, use the
2282 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002283
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 NOTE: This option is set to the Vi default value when 'compatible' is
2285 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002286
2287 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2288 is saved, 'cpoptions' is set to the Vim default, and the saved value
2289 is restored at the end of the script. Changes to the value of
2290 'cpoptions' will be applied to the saved value, but keep in mind that
2291 removing a flag that is not present when 'cpoptions' is changed has no
2292 effect. In the |.vimrc| file the value is not restored, thus using
2293 `vim9script` in the |.vimrc| file results in using the Vim default.
2294
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002295 NOTE: This option is set to the POSIX default value at startup when
2296 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002297 variable exists |posix|. This means Vim tries to behave like the
2298 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299
2300 contains behavior ~
2301 *cpo-a*
2302 a When included, a ":read" command with a file name
2303 argument will set the alternate file name for the
2304 current window.
2305 *cpo-A*
2306 A When included, a ":write" command with a file name
2307 argument will set the alternate file name for the
2308 current window.
2309 *cpo-b*
2310 b "\|" in a ":map" command is recognized as the end of
2311 the map command. The '\' is included in the mapping,
2312 the text after the '|' is interpreted as the next
2313 command. Use a CTRL-V instead of a backslash to
2314 include the '|' in the mapping. Applies to all
2315 mapping, abbreviation, menu and autocmd commands.
2316 See also |map_bar|.
2317 *cpo-B*
2318 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002319 abbreviations, user commands and the "to" part of the
2320 menu commands. Remove this flag to be able to use a
2321 backslash like a CTRL-V. For example, the command
2322 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 'B' included: "\^[" (^[ is a real <Esc>)
2324 'B' excluded: "<Esc>" (5 characters)
2325 ('<' excluded in both cases)
2326 *cpo-c*
2327 c Searching continues at the end of any match at the
2328 cursor position, but not further than the start of the
2329 next line. When not present searching continues
2330 one character from the cursor position. With 'c'
2331 "abababababab" only gets three matches when repeating
2332 "/abab", without 'c' there are five matches.
2333 *cpo-C*
2334 C Do not concatenate sourced lines that start with a
2335 backslash. See |line-continuation|.
2336 *cpo-d*
2337 d Using "./" in the 'tags' option doesn't mean to use
2338 the tags file relative to the current file, but the
2339 tags file in the current directory.
2340 *cpo-D*
2341 D Can't use CTRL-K to enter a digraph after Normal mode
2342 commands with a character argument, like |r|, |f| and
2343 |t|.
2344 *cpo-e*
2345 e When executing a register with ":@r", always add a
2346 <CR> to the last line, also when the register is not
2347 linewise. If this flag is not present, the register
2348 is not linewise and the last line does not end in a
2349 <CR>, then the last line is put on the command-line
2350 and can be edited before hitting <CR>.
2351 *cpo-E*
2352 E It is an error when using "y", "d", "c", "g~", "gu" or
2353 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002354 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 This makes "y0" fail in the first column.
2356 *cpo-f*
2357 f When included, a ":read" command with a file name
2358 argument will set the file name for the current buffer,
2359 if the current buffer doesn't have a file name yet.
2360 *cpo-F*
2361 F When included, a ":write" command with a file name
2362 argument will set the file name for the current
2363 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002364 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 *cpo-g*
2366 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002367 *cpo-H*
2368 H When using "I" on a line with only blanks, insert
2369 before the last blank. Without this flag insert after
2370 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *cpo-i*
2372 i When included, interrupting the reading of a file will
2373 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002374 *cpo-I*
2375 I When moving the cursor up or down just after inserting
2376 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 *cpo-j*
2378 j When joining lines, only add two spaces after a '.',
2379 not after '!' or '?'. Also see 'joinspaces'.
2380 *cpo-J*
2381 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002382 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 white space.
2384 *cpo-k*
2385 k Disable the recognition of raw key codes in
2386 mappings, abbreviations, and the "to" part of menu
2387 commands. For example, if <Key> sends ^[OA (where ^[
2388 is <Esc>), the command ":map X ^[OA" results in X
2389 being mapped to:
2390 'k' included: "^[OA" (3 characters)
2391 'k' excluded: "<Key>" (one key code)
2392 Also see the '<' flag below.
2393 *cpo-K*
2394 K Don't wait for a key code to complete when it is
2395 halfway a mapping. This breaks mapping <F1><F1> when
2396 only part of the second <F1> has been read. It
2397 enables cancelling the mapping by typing <F1><Esc>.
2398 *cpo-l*
2399 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002400 literally, only "\]", "\^", "\-" and "\\" are special.
2401 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2403 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002404 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 *cpo-L*
2406 L When the 'list' option is set, 'wrapmargin',
2407 'textwidth', 'softtabstop' and Virtual Replace mode
2408 (see |gR|) count a <Tab> as two characters, instead of
2409 the normal behavior of a <Tab>.
2410 *cpo-m*
2411 m When included, a showmatch will always wait half a
2412 second. When not included, a showmatch will wait half
2413 a second or until a character is typed. |'showmatch'|
2414 *cpo-M*
2415 M When excluded, "%" matching will take backslashes into
2416 account. Thus in "( \( )" and "\( ( \)" the outer
2417 parenthesis match. When included "%" ignores
2418 backslashes, which is Vi compatible.
2419 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002420 n When included, the column used for 'number' and
2421 'relativenumber' will also be used for text of wrapped
2422 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 *cpo-o*
2424 o Line offset to search command is not remembered for
2425 next search.
2426 *cpo-O*
2427 O Don't complain if a file is being overwritten, even
2428 when it didn't exist when editing it. This is a
2429 protection against a file unexpectedly created by
2430 someone else. Vi didn't complain about this.
2431 *cpo-p*
2432 p Vi compatible Lisp indenting. When not present, a
2433 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002434 *cpo-P*
2435 P When included, a ":write" command that appends to a
2436 file will set the file name for the current buffer, if
2437 the current buffer doesn't have a file name yet and
2438 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002439 *cpo-q*
2440 q When joining multiple lines leave the cursor at the
2441 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *cpo-r*
2443 r Redo ("." command) uses "/" to repeat a search
2444 command, instead of the actually used search string.
2445 *cpo-R*
2446 R Remove marks from filtered lines. Without this flag
2447 marks are kept like |:keepmarks| was used.
2448 *cpo-s*
2449 s Set buffer options when entering the buffer for the
2450 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002451 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 set when the buffer is created.
2453 *cpo-S*
2454 S Set buffer options always when entering a buffer
2455 (except 'readonly', 'fileformat', 'filetype' and
2456 'syntax'). This is the (most) Vi compatible setting.
2457 The options are set to the values in the current
2458 buffer. When you change an option and go to another
2459 buffer, the value is copied. Effectively makes the
2460 buffer options global to all buffers.
2461
2462 's' 'S' copy buffer options
2463 no no when buffer created
2464 yes no when buffer first entered (default)
2465 X yes each time when buffer entered (vi comp.)
2466 *cpo-t*
2467 t Search pattern for the tag command is remembered for
2468 "n" command. Otherwise Vim only puts the pattern in
2469 the history for search pattern, but doesn't change the
2470 last used search pattern.
2471 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002472 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 *cpo-v*
2474 v Backspaced characters remain visible on the screen in
2475 Insert mode. Without this flag the characters are
2476 erased from the screen right away. With this flag the
2477 screen newly typed text overwrites backspaced
2478 characters.
2479 *cpo-w*
2480 w When using "cw" on a blank character, only change one
2481 character and not all blanks until the start of the
2482 next word.
2483 *cpo-W*
2484 W Don't overwrite a readonly file. When omitted, ":w!"
2485 overwrites a readonly file, if possible.
2486 *cpo-x*
2487 x <Esc> on the command-line executes the command-line.
2488 The default in Vim is to abandon the command-line,
2489 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002490 *cpo-X*
2491 X When using a count with "R" the replaced text is
2492 deleted only once. Also when repeating "R" with "."
2493 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002495 y A yank command can be redone with ".". Think twice if
2496 you really want to use this, it may break some
2497 plugins, since most people expect "." to only repeat a
2498 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002499 *cpo-Z*
2500 Z When using "w!" while the 'readonly' option is set,
2501 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002502 *cpo-z*
2503 z Special casing the "cw" and "d" command (see |cw| and
2504 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 *cpo-!*
2506 ! When redoing a filter command, use the last used
2507 external command, whatever it was. Otherwise the last
2508 used -filter- command is used.
2509 *cpo-$*
2510 $ When making a change to one line, don't redisplay the
2511 line, but put a '$' at the end of the changed text.
2512 The changed text will be overwritten when you type the
2513 new text. The line is redisplayed if you type any
2514 command that moves the cursor from the insertion
2515 point.
2516 *cpo-%*
2517 % Vi-compatible matching is done for the "%" command.
2518 Does not recognize "#if", "#endif", etc.
2519 Does not recognize "/*" and "*/".
2520 Parens inside single and double quotes are also
2521 counted, causing a string that contains a paren to
2522 disturb the matching. For example, in a line like
2523 "if (strcmp("foo(", s))" the first paren does not
2524 match the last one. When this flag is not included,
2525 parens inside single and double quotes are treated
2526 specially. When matching a paren outside of quotes,
2527 everything inside quotes is ignored. When matching a
2528 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002529 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002530 This flag is also used for other features, such as
2531 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002532 *cpo--*
2533 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002534 it would go above the first line or below the last
2535 line. Without it the cursor moves to the first or
2536 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002537 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002538 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002539 *cpo-+*
2540 + When included, a ":write file" command will reset the
2541 'modified' flag of the buffer, even though the buffer
2542 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002543 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 * Use ":*" in the same way as ":@". When not included,
2545 ":*" is an alias for ":'<,'>", select the Visual area.
2546 *cpo-<*
2547 < Disable the recognition of special key codes in |<>|
2548 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002549 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 ":map X <Tab>" results in X being mapped to:
2551 '<' included: "<Tab>" (5 characters)
2552 '<' excluded: "^I" (^I is a real <Tab>)
2553 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002554 *cpo->*
2555 > When appending to a register, put a line break before
2556 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002557 *cpo-;*
2558 ; When using |,| or |;| to repeat the last |t| search
2559 and the cursor is right in front of the searched
2560 character, the cursor won't move. When not included,
2561 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002562 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002563
2564 POSIX flags. These are not included in the Vi default value, except
2565 when $VIM_POSIX was set on startup. |posix|
2566
2567 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002568 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002569 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002570 *cpo-&*
2571 & When ":preserve" was used keep the swap file when
2572 exiting normally while this buffer is still loaded.
2573 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002574 *cpo-\*
2575 \ Backslash in a [] range in a search pattern is taken
2576 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002577 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2578 '\' excluded: "/[ \-]" finds <Space> and '-'
2579 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002580 *cpo-/*
2581 / When "%" is used as the replacement string in a |:s|
2582 command, use the previous replacement string. |:s%|
2583 *cpo-{*
2584 { The |{| and |}| commands also stop at a "{" character
2585 at the start of a line.
2586 *cpo-.*
2587 . The ":chdir" and ":cd" commands fail if the current
2588 buffer is modified, unless ! is used. Vim doesn't
2589 need this, since it remembers the full path of an
2590 opened file.
2591 *cpo-bar*
2592 | The value of the $LINES and $COLUMNS environment
2593 variables overrule the terminal size values obtained
2594 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002595
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002596 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002597'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002598 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002599 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002600 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002601 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002602 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002603 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002604 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002605 blowfish Blowfish method. Medium strong encryption but it has
2606 an implementation flaw. Requires Vim 7.3 or later,
2607 files can NOT be read by Vim 7.2 and older. This adds
2608 a "seed" to the file, every time you write the file
2609 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002610 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002611 *blowfish2*
2612 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002613 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002614 and older. This adds a "seed" to the file, every time
2615 you write the file the encrypted bytes will be
2616 different. The whole undo file is encrypted, not just
2617 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002618 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002619 *E1197* *E1198* *E1199* *E1200* *E1201*
2620 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2621 Code. Medium strong till strong encryption.
2622 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002623 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002624 It adds a seed and a message authentication code (MAC)
2625 to the file. This needs at least a Vim 8.2.3022 to
2626 read the encrypted file.
2627 Encryption of swap files is not supported, therefore
2628 no swap file will be used when xchacha20 encryption is
2629 enabled.
2630 Encryption of undo files is not yet supported,
2631 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002632 CAREFUL: Files written with this method might have to
2633 be read back with the same version of Vim if the
2634 binary format changes later.
2635 Obsolete, please do no longer use.
2636 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2637 stores the key derivation parameters together with the
2638 encrypted file. Should work better in case the
2639 parameters in the libsodium library ever change.
2640 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002641 might have to be read back with the same version of
2642 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002643
Christian Brabandtaae58342023-04-23 17:50:22 +01002644 You should use "blowfish2", also to re-encrypt older files. The
2645 "xchacha20" method provides better encryption, but it does not work
2646 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002647
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002648 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002649 to the detected method of the file being read. Thus if you write it
2650 without changing 'cryptmethod' the same method will be used.
2651 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002652 explicitly write it, you don't get a warning unless there are other
2653 modifications. Also see |:X|.
2654
2655 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002656 the value "blowfish2". When setting the local value to an empty
2657 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002658
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002659 When a new encryption method is added in a later version of Vim, and
2660 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002661 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002662
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 *'cscopepathcomp'* *'cspc'*
2664'cscopepathcomp' 'cspc' number (default 0)
2665 global
2666 {not available when compiled without the |+cscope|
2667 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 Determines how many components of the path to show in a list of tags.
2669 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002670 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 *'cscopeprg'* *'csprg'*
2673'cscopeprg' 'csprg' string (default "cscope")
2674 global
2675 {not available when compiled without the |+cscope|
2676 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 Specifies the command to execute cscope. See |cscopeprg|.
2678 This option cannot be set from a |modeline| or in the |sandbox|, for
2679 security reasons.
2680
2681 *'cscopequickfix'* *'csqf'*
2682'cscopequickfix' 'csqf' string (default "")
2683 global
2684 {not available when compiled without the |+cscope|
2685 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 Specifies whether to use quickfix window to show cscope results.
2687 See |cscopequickfix|.
2688
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002689 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002690'cscoperelative' 'csre' boolean (default off)
2691 global
2692 {not available when compiled without the |+cscope|
2693 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002694 In the absence of a prefix (-P) for cscope. setting this option enables
2695 to use the basename of cscope.out path as the prefix.
2696 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002697 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002698
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2700'cscopetag' 'cst' boolean (default off)
2701 global
2702 {not available when compiled without the |+cscope|
2703 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 Use cscope for tag commands. See |cscope-options|.
2705 NOTE: This option is reset when 'compatible' is set.
2706
2707 *'cscopetagorder'* *'csto'*
2708'cscopetagorder' 'csto' number (default 0)
2709 global
2710 {not available when compiled without the |+cscope|
2711 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 Determines the order in which ":cstag" performs a search. See
2713 |cscopetagorder|.
2714 NOTE: This option is set to 0 when 'compatible' is set.
2715
2716 *'cscopeverbose'* *'csverb'*
2717 *'nocscopeverbose'* *'nocsverb'*
2718'cscopeverbose' 'csverb' boolean (default off)
2719 global
2720 {not available when compiled without the |+cscope|
2721 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 Give messages when adding a cscope database. See |cscopeverbose|.
2723 NOTE: This option is reset when 'compatible' is set.
2724
Bram Moolenaar860cae12010-06-05 23:22:07 +02002725 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2726'cursorbind' 'crb' boolean (default off)
2727 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002728 When this option is set, as the cursor in the current
2729 window moves other cursorbound windows (windows that also have
2730 this option set) move their cursors to the corresponding line and
2731 column. This option is useful for viewing the
2732 differences between two versions of a file (see 'diff'); in diff mode,
2733 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002734 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002735
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002736 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2737'cursorcolumn' 'cuc' boolean (default off)
2738 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002739 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002740 feature}
2741 Highlight the screen column of the cursor with CursorColumn
2742 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2743 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002744 If you only want the highlighting in the current window you can use
2745 these autocommands: >
2746 au WinLeave * set nocursorline nocursorcolumn
2747 au WinEnter * set cursorline cursorcolumn
2748<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002749
2750 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2751'cursorline' 'cul' boolean (default off)
2752 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002753 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002754 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002755 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2756 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002757 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002758 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002759
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002760 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002761'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002762 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002763 {not available when compiled without the |+syntax|
2764 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002765 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002766 Valid values:
2767 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002768 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002769 "screenline" Highlight only the screen line of the cursor with
2770 CursorLine |hl-CursorLine|.
2771 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002772 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002773
2774 Special value:
2775 "both" Alias for the values "line,number".
2776
2777 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002778
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 *'debug'*
2780'debug' string (default "")
2781 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002782 These values can be used:
2783 msg Error messages that would otherwise be omitted will be given
2784 anyway.
2785 throw Error messages that would otherwise be omitted will be given
2786 anyway and also throw an exception and set |v:errmsg|.
2787 beep A message will be given when otherwise only a beep would be
2788 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002789 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002790 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2791 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792
2793 *'define'* *'def'*
2794'define' 'def' string (default "^\s*#\s*define")
2795 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002796 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 pattern, just like for the "/" command. This option is used for the
2798 commands like "[i" and "[d" |include-search|. The 'isident' option is
2799 used to recognize the defined name after the match:
2800 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2801 See |option-backslash| about inserting backslashes to include a space
2802 or backslash.
2803 The default value is for C programs. For C++ this value would be
2804 useful, to include const type declarations: >
2805 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002806< You can also use "\ze" just before the name and continue the pattern
2807 to check what is following. E.g. for Javascript, if a function is
2808 defined with "func_name = function(args)": >
2809 ^\s*\ze\i\+\s*=\s*function(
2810< If the function is defined with "func_name : function() {...": >
2811 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002813 To avoid that use `:let` with a single quote string: >
2814 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002815<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
2817 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2818'delcombine' 'deco' boolean (default off)
2819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 If editing Unicode and this option is set, backspace and Normal mode
2821 "x" delete each combining character on its own. When it is off (the
2822 default) the character along with its combining characters are
2823 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002824 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825
2826 This is useful for Arabic, Hebrew and many other languages where one
2827 may have combining characters overtop of base characters, and want
2828 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002829 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830
2831 *'dictionary'* *'dict'*
2832'dictionary' 'dict' string (default "")
2833 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 List of file names, separated by commas, that are used to lookup words
2835 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2836 contain a list of words. This can be one word per line, or several
2837 words per line, separated by non-keyword characters (white space is
2838 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002839
2840 When this option is empty or an entry "spell" is present, and spell
2841 checking is enabled, words in the word lists for the currently active
2842 'spelllang' are used. See |spell|.
2843
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002844 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 after a comma are ignored, otherwise spaces are included in the file
2846 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002847 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 Where to find a list of words?
2849 - On FreeBSD, there is the file "/usr/share/dict/words".
2850 - In the Simtel archive, look in the "msdos/linguist" directory.
2851 - In "miscfiles" of the GNU collection.
2852 The use of |:set+=| and |:set-=| is preferred when adding or removing
2853 directories from the list. This avoids problems when a future version
2854 uses another default.
2855 Backticks cannot be used in this option for security reasons.
2856
2857 *'diff'* *'nodiff'*
2858'diff' boolean (default off)
2859 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 {not available when compiled without the |+diff|
2861 feature}
2862 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002863 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864
2865 *'dex'* *'diffexpr'*
2866'diffexpr' 'dex' string (default "")
2867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 {not available when compiled without the |+diff|
2869 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002870 Expression which is evaluated to obtain a diff file (either ed-style
2871 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 This option cannot be set from a |modeline| or in the |sandbox|, for
2873 security reasons.
2874
2875 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002876'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 {not available when compiled without the |+diff|
2879 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002880 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 All are optional. Items must be separated by a comma.
2882
2883 filler Show filler lines, to keep the text
2884 synchronized with a window that has inserted
2885 lines at the same position. Mostly useful
2886 when windows are side-by-side and 'scrollbind'
2887 is set.
2888
2889 context:{n} Use a context of {n} lines between a change
2890 and a fold that contains unchanged lines.
2891 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002892 When using zero the context is actually one,
2893 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002894 for a deleted line. Set it to a very large
2895 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 See |fold-diff|.
2897
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002898 iblank Ignore changes where lines are all blank. Adds
2899 the "-B" flag to the "diff" command if
2900 'diffexpr' is empty. Check the documentation
2901 of the "diff" command for what this does
2902 exactly.
2903 NOTE: the diff windows will get out of sync,
2904 because no differences between blank lines are
2905 taken into account.
2906
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 icase Ignore changes in case of text. "a" and "A"
2908 are considered the same. Adds the "-i" flag
2909 to the "diff" command if 'diffexpr' is empty.
2910
2911 iwhite Ignore changes in amount of white space. Adds
2912 the "-b" flag to the "diff" command if
2913 'diffexpr' is empty. Check the documentation
2914 of the "diff" command for what this does
2915 exactly. It should ignore adding trailing
2916 white space, but not leading white space.
2917
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002918 iwhiteall Ignore all white space changes. Adds
2919 the "-w" flag to the "diff" command if
2920 'diffexpr' is empty. Check the documentation
2921 of the "diff" command for what this does
2922 exactly.
2923
2924 iwhiteeol Ignore white space changes at end of line.
2925 Adds the "-Z" flag to the "diff" command if
2926 'diffexpr' is empty. Check the documentation
2927 of the "diff" command for what this does
2928 exactly.
2929
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002930 horizontal Start diff mode with horizontal splits (unless
2931 explicitly specified otherwise).
2932
2933 vertical Start diff mode with vertical splits (unless
2934 explicitly specified otherwise).
2935
Bram Moolenaarc8234772019-11-10 21:00:27 +01002936 closeoff When a window is closed where 'diff' is set
2937 and there is only one window remaining in the
2938 same tab page with 'diff' set, execute
2939 `:diffoff` in that window. This undoes a
2940 `:diffsplit` command.
2941
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002942 hiddenoff Do not use diff mode for a buffer when it
2943 becomes hidden.
2944
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002945 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2946 starting diff mode. Without this 2 is used.
2947
Bram Moolenaar4223d432021-02-10 13:18:17 +01002948 followwrap Follow the 'wrap' option and leave as it is.
2949
Bram Moolenaare828b762018-09-10 17:51:58 +02002950 internal Use the internal diff library. This is
2951 ignored when 'diffexpr' is set. *E960*
2952 When running out of memory when writing a
2953 buffer this item will be ignored for diffs
2954 involving that buffer. Set the 'verbose'
2955 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956
Bram Moolenaare828b762018-09-10 17:51:58 +02002957 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002958 Use the indent heuristic for the internal
2959 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002960
zeertzjqd086b8f2024-02-25 15:42:52 +08002961 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002962 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002963 algorithms are:
2964 myers the default algorithm
2965 minimal spend extra time to generate the
2966 smallest possible diff
2967 patience patience diff algorithm
2968 histogram histogram diff algorithm
2969
2970 Examples: >
2971 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002973 :set diffopt=internal,filler,foldcolumn:3
2974 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975<
2976 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2977'digraph' 'dg' boolean (default off)
2978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 {not available when compiled without the |+digraphs|
2980 feature}
2981 Enable the entering of digraphs in Insert mode with {char1} <BS>
2982 {char2}. See |digraphs|.
2983 NOTE: This option is reset when 'compatible' is set.
2984
2985 *'directory'* *'dir'*
2986'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002987 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 for Unix: ".,~/tmp,/var/tmp,/tmp")
2989 global
2990 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002991 Recommended value: ".,~/vimswap//" - this will put the swap file next
2992 to the edited file if possible, and in your personal swap directory
2993 otherwise. Make sure "~/vimswap//" is only readable for you.
2994
2995 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 - The swap file will be created in the first directory where this is
2997 possible.
2998 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002999 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 - A directory "." means to put the swap file in the same directory as
3001 the edited file. On Unix, a dot is prepended to the file name, so
3002 it doesn't show in a directory listing. On MS-Windows the "hidden"
3003 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003004 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3005 the swap file relative to where the edited file is. The leading "."
3006 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003007 - For Unix and Win32, if a directory ends in two path separators "//",
3008 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003009 with all path separators replaced by percent '%' signs (including
3010 the colon following the drive letter on Win32). This will ensure
3011 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003012 On Win32, it is also possible to end with "\\". However, When a
3013 separating comma is following, you must use "//", since "\\" will
3014 include the comma in the file name. Therefore it is recommended to
3015 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 - Spaces after the comma are ignored, other spaces are considered part
3017 of the directory name. To have a space at the start of a directory
3018 name, precede it with a backslash.
3019 - To include a comma in a directory name precede it with a backslash.
3020 - A directory name may end in an ':' or '/'.
3021 - Environment variables are expanded |:set_env|.
3022 - Careful with '\' characters, type one before a space, type two to
3023 get one in the option (see |option-backslash|), for example: >
3024 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3025< - For backwards compatibility with Vim version 3.0 a '>' at the start
3026 of the option is removed.
3027 Using "." first in the list is recommended. This means that editing
3028 the same file twice will result in a warning. Using "/tmp" on Unix is
3029 discouraged: When the system crashes you lose the swap file.
3030 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003031 choice than "/tmp". But others on the computer may be able to see the
3032 files, and it can contain a lot of files, your swap files get lost in
3033 the crowd. That is why a "tmp" directory in your home directory is
3034 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 The use of |:set+=| and |:set-=| is preferred when adding or removing
3036 directories from the list. This avoids problems when a future version
3037 uses another default.
3038 This option cannot be set from a |modeline| or in the |sandbox|, for
3039 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040
3041 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003042'display' 'dy' string (default "", set to "truncate" in
3043 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003045 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 flags:
3047 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003048 in a window will be displayed. "@@@" is put in the
3049 last columns of the last screen line to indicate the
3050 rest of the line is not displayed.
3051 truncate Like "lastline", but "@@@" is displayed in the first
3052 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 uhex Show unprintable characters hexadecimal as <xx>
3054 instead of using ^C and ~C.
3055
Bram Moolenaard0796902016-09-16 20:02:31 +02003056 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003057 doesn't fit is replaced with "@" lines.
3058
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003059 The "@" character can be changed by setting the "lastline" item in
3060 'fillchars'. The character is highlighted with |hl-NonText|.
3061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 *'eadirection'* *'ead'*
3063'eadirection' 'ead' string (default "both")
3064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 Tells when the 'equalalways' option applies:
3066 ver vertically, width of windows is not affected
3067 hor horizontally, height of windows is not affected
3068 both width and height of windows is affected
3069
3070 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3071'edcompatible' 'ed' boolean (default off)
3072 global
3073 Makes the 'g' and 'c' flags of the ":substitute" command to be
3074 toggled each time the flag is given. See |complex-change|. See
3075 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003076 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003077 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078
Bram Moolenaar03413f42016-04-12 21:07:15 +02003079 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003080'emoji' 'emo' boolean (default: on)
3081 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003082 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003083 This excludes "text emoji" characters, which are normally displayed as
3084 single width. Unfortunately there is no good specification for this
3085 and it has been determined on trial-and-error basis. Use the
3086 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003089'encoding' 'enc' string (default for MS-Windows: "utf-8",
3090 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 Sets the character encoding used inside Vim. It applies to text in
3093 the buffers, registers, Strings in expressions, text stored in the
3094 viminfo file, etc. It sets the kind of characters which Vim can work
3095 with. See |encoding-names| for the possible values.
3096
3097 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003098 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003100 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101
Bram Moolenaar865242e2010-07-14 21:12:05 +02003102 This option cannot be set from a |modeline|. It would most likely
3103 corrupt the text.
3104
Bram Moolenaar3df01732017-02-17 22:47:16 +01003105 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3106 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 'encoding', "utf-8" is the natural choice for the environment and
3108 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003109 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 versions, and to avoid changing the encoding of newly created files
3111 without your knowledge (in case 'fileencodings' is empty).
3112
3113 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003114 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 iconv() or as specified with 'charconvert'.
3116
Bram Moolenaar207f0092020-08-30 17:20:20 +02003117 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003118 can use: >
3119 if has("multi_byte_encoding")
3120<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 Normally 'encoding' will be equal to your current locale. This will
3122 be the default if Vim recognizes your environment settings. If
3123 'encoding' is not set to the current locale, 'termencoding' must be
3124 set to convert typed and displayed text. See |encoding-table|.
3125
3126 When you set this option, it fires the |EncodingChanged| autocommand
3127 event so that you can set up fonts if necessary.
3128
3129 When the option is set, the value is converted to lowercase. Thus
3130 you can set it with uppercase values too. Underscores are translated
3131 to '-' signs.
3132 When the encoding is recognized, it is changed to the standard name.
3133 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3134 "iso-8859-2" and "utf8" becomes "utf-8".
3135
3136 Note: "latin1" is also used when the encoding could not be detected.
3137 This only works when editing files in the same encoding! When the
3138 actual character set is not latin1, make sure 'fileencoding' and
3139 'fileencodings' are empty. When conversion is needed, switch to using
3140 utf-8.
3141
3142 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3143 You don't notice this while editing, but it does matter for the
3144 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3145 setting 'encoding' to one of these values instead of utf-8 only has
3146 effect for encoding used for files when 'fileencoding' is empty.
3147
Bram Moolenaar661b1822005-07-28 22:36:45 +00003148 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3149 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003151 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003152'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003154 Indicates that a CTRL-Z character was found at the end of the file
3155 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003157 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003158 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003159 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003160
3161 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3162'endofline' 'eol' boolean (default on)
3163 local to buffer
3164 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003165 is on, or 'fixeol' option is off, no <EOL> will be written for the
3166 last line in the file. This option is automatically set or reset when
3167 starting to edit a new file, depending on whether file has an <EOL>
3168 for the last line in the file. Normally you don't have to set or
3169 reset this option.
3170 When 'binary' is off and 'fixeol' is on the value is not used when
3171 writing the file. When 'binary' is on or 'fixeol' is off it is used
3172 to remember the presence of a <EOL> for the last line in the file, so
3173 that when you write the file the situation from the original file can
3174 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003175 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176
3177 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3178'equalalways' 'ea' boolean (default on)
3179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003181 splitting or closing a window. This also happens the moment the
3182 option is switched on. When off, splitting a window will reduce the
3183 size of the current window and leave the other windows the same. When
3184 closing a window the extra lines are given to the window next to it
3185 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 When mixing vertically and horizontally split windows, a minimal size
3187 is computed and some windows may be larger if there is room. The
3188 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003189 Changing the height and width of a window can be avoided by setting
3190 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003191 If a window size is specified when creating a new window sizes are
3192 currently not equalized (it's complicated, but may be implemented in
3193 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194
3195 *'equalprg'* *'ep'*
3196'equalprg' 'ep' string (default "")
3197 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003199 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003200 or 'indentexpr'. When Vim was compiled without internal formatting,
3201 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003202 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 about including spaces and backslashes.
3204 This option cannot be set from a |modeline| or in the |sandbox|, for
3205 security reasons.
3206
3207 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3208'errorbells' 'eb' boolean (default off)
3209 global
3210 Ring the bell (beep or screen flash) for error messages. This only
3211 makes a difference for error messages, the bell will be used always
3212 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003213 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003214 screen flash or do nothing. See 'belloff' to finetune when to ring the
3215 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216
3217 *'errorfile'* *'ef'*
3218'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3219 others: "errors.err")
3220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 {not available when compiled without the |+quickfix|
3222 feature}
3223 Name of the errorfile for the QuickFix mode (see |:cf|).
3224 When the "-q" command-line argument is used, 'errorfile' is set to the
3225 following argument. See |-q|.
3226 NOT used for the ":make" command. See 'makeef' for that.
3227 Environment variables are expanded |:set_env|.
3228 See |option-backslash| about including spaces and backslashes.
3229 This option cannot be set from a |modeline| or in the |sandbox|, for
3230 security reasons.
3231
3232 *'errorformat'* *'efm'*
3233'errorformat' 'efm' string (default is very long)
3234 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 {not available when compiled without the |+quickfix|
3236 feature}
3237 Scanf-like description of the format for the lines in the error file
3238 (see |errorformat|).
3239
3240 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3241'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 Function keys that start with an <Esc> are recognized in Insert
3244 mode. When this option is off, the cursor and function keys cannot be
3245 used in Insert mode if they start with an <Esc>. The advantage of
3246 this is that the single <Esc> is recognized immediately, instead of
3247 after one second. Instead of resetting this option, you might want to
3248 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3249 when 'esckeys' is off, you can still map anything, but the cursor keys
3250 won't work by default.
3251 NOTE: This option is set to the Vi default value when 'compatible' is
3252 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003253 NOTE: when this option is off then the |modifyOtherKeys| and
3254 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3255 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256
3257 *'eventignore'* *'ei'*
3258'eventignore' 'ei' string (default "")
3259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003261 When set to "all" or when "all" is one of the items, all autocommand
3262 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003263 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 :set ei=WinEnter,WinLeave
3265<
3266 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3267'expandtab' 'et' boolean (default off)
3268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3272 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003273 This option is reset when the 'paste' option is set and restored when
3274 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 NOTE: This option is reset when 'compatible' is set.
3276
3277 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3278'exrc' 'ex' boolean (default off)
3279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003281 directory.
3282
3283 Setting this option is a potential security leak. E.g., consider
3284 unpacking a package or fetching files from github, a .vimrc in there
3285 might be a trojan horse. BETTER NOT SET THIS OPTION!
3286 Instead, define an autocommand in your .vimrc to set options for a
3287 matching directory.
3288
3289 If you do switch this option on you should also consider setting the
3290 'secure' option (see |initialization|).
3291 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 This option cannot be set from a |modeline| or in the |sandbox|, for
3293 security reasons.
3294
3295 *'fileencoding'* *'fenc'* *E213*
3296'fileencoding' 'fenc' string (default: "")
3297 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003299
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003301 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 When 'fileencoding' is empty, the same value as 'encoding' will be
3303 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003304 No error will be given when the value is set, only when it is used,
3305 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003306 Conversion will also be done when 'encoding' and 'fileencoding' are
3307 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3308 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003310 'encoding' is "utf-8" or another Unicode encoding, conversion
3311 is most likely done in a way that the reverse conversion
3312 results in the same text. When 'encoding' is not "utf-8" some
3313 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003314
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 See 'encoding' for the possible values. Additionally, values may be
3316 specified that can be handled by the converter, see
3317 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003318
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 When reading a file 'fileencoding' will be set from 'fileencodings'.
3320 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003321 'fileencoding', use the |++enc| argument. One exception: when
3322 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003323 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003324
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3326 When the option is set, the value is converted to lowercase. Thus
3327 you can set it with uppercase values too. '_' characters are
3328 replaced with '-'. If a name is recognized from the list for
3329 'encoding', it is replaced by the standard name. For example
3330 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003331
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 When this option is set, after starting to edit a file, the 'modified'
3333 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003334
3335 Keep in mind that changing 'fenc' from a modeline happens
3336 AFTER the text has been read, thus it applies to when the file will be
3337 written. If you do set 'fenc' in a modeline, you might want to set
3338 'nomodified' to avoid not being able to ":q".
3339
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 This option can not be changed when 'modifiable' is off.
3341
3342 *'fe'*
3343 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 old short name was 'fe', which is no longer used.
3346
3347 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003348'fileencodings' 'fencs' string (default: "ucs-bom",
3349 "ucs-bom,utf-8,default,latin1" when
3350 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 This is a list of character encodings considered when starting to edit
3353 an existing file. When a file is read, Vim tries to use the first
3354 mentioned character encoding. If an error is detected, the next one
3355 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003356 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 an empty string, which means the value of 'encoding' is used.
3358 WARNING: Conversion can cause loss of information! When
3359 'encoding' is "utf-8" (or one of the other Unicode variants)
3360 conversion is most likely done in a way that the reverse
3361 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003362 "utf-8" some non-ASCII characters may be lost! You can use
3363 the |++bad| argument to specify what is done with characters
3364 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 For an empty file or a file with only ASCII characters most encodings
3366 will work and the first entry of 'fileencodings' will be used (except
3367 "ucs-bom", which requires the BOM to be present). If you prefer
3368 another encoding use an BufReadPost autocommand event to test if your
3369 preferred encoding is to be used. Example: >
3370 au BufReadPost * if search('\S', 'w') == 0 |
3371 \ set fenc=iso-2022-jp | endif
3372< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3373 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003374 When the |++enc| argument is used then the value of 'fileencodings' is
3375 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003376 Note that 'fileencodings' is not used for a new file, the global value
3377 of 'fileencoding' is used instead. You can set it with: >
3378 :setglobal fenc=iso-8859-2
3379< This means that a non-existing file may get a different encoding than
3380 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 The special value "ucs-bom" can be used to check for a Unicode BOM
3382 (Byte Order Mark) at the start of the file. It must not be preceded
3383 by "utf-8" or another Unicode encoding for this to work properly.
3384 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3385 because Vim cannot detect an error, thus the encoding is always
3386 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003387 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003388 environment. On MS-Windows this is the system encoding. Otherwise
3389 this is the default value for 'encoding'. It is useful when
3390 'encoding' is set to "utf-8" and your environment uses a non-latin1
3391 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003392 When 'encoding' is "utf-8" and a file contains an illegal byte
3393 sequence it won't be recognized as UTF-8. You can use the |8g8|
3394 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 WRONG VALUES: WHAT'S WRONG:
3396 latin1,utf-8 "latin1" will always be used
3397 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3398 file
3399 cp1250,latin1 "cp1250" will always be used
3400 If 'fileencodings' is empty, 'fileencoding' is not modified.
3401 See 'fileencoding' for the possible values.
3402 Setting this option does not have an effect until the next time a file
3403 is read.
3404
3405 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003406'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003407 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 This gives the <EOL> of the current buffer, which is used for
3410 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003411 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 unix <NL>
3413 mac <CR>
3414 When "dos" is used, CTRL-Z at the end of a file is ignored.
3415 See |file-formats| and |file-read|.
3416 For the character encoding of the file see 'fileencoding'.
3417 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003418 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 This option is set automatically when starting to edit a file and
3420 'fileformats' is not empty and 'binary' is off.
3421 When this option is set, after starting to edit a file, the 'modified'
3422 option is set, because the file would be different when written.
3423 This option can not be changed when 'modifiable' is off.
3424 For backwards compatibility: When this option is set to "dos",
3425 'textmode' is set, otherwise 'textmode' is reset.
3426
3427 *'fileformats'* *'ffs'*
3428'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003429 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003430 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 Vi Cygwin: "unix,dos",
3432 Vi others: "")
3433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 This gives the end-of-line (<EOL>) formats that will be tried when
3435 starting to edit a new buffer and when reading a file into an existing
3436 buffer:
3437 - When empty, the format defined with 'fileformat' will be used
3438 always. It is not set automatically.
3439 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003440 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 'fileformats' name will be used when a file is read into an existing
3442 buffer, no matter what 'fileformat' for that buffer is set to.
3443 - When more than one name is present, separated by commas, automatic
3444 <EOL> detection will be done when reading a file. When starting to
3445 edit a file, a check is done for the <EOL>:
3446 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3447 'fileformat' is set to "dos".
3448 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003449 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003451 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3452 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003453 This means that "mac" is only chosen when:
3454 "unix" is not present or no <NL> is found in the file, and
3455 "dos" is not present or no <CR><NL> is found in the file.
3456 Except: if "unix" was chosen, but there is a <CR> before
3457 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003458 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 4. If 'fileformat' is still not set, the first name from
3460 'fileformats' is used.
3461 When reading a file into an existing buffer, the same is done, but
3462 this happens like 'fileformat' has been set appropriately for that
3463 file only, the option is not changed.
3464 When 'binary' is set, the value of 'fileformats' is not used.
3465
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003466 When Vim starts up with an empty buffer the first item is used. You
3467 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003468
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3470 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3471 done:
3472 - When 'fileformats' is empty, there is no automatic detection. Dos
3473 format will be used.
3474 - When 'fileformats' is set to one or more names, automatic detection
3475 is done. This is based on the first <NL> in the file: If there is a
3476 <CR> in front of it, Dos format is used, otherwise Unix format is
3477 used.
3478 Also see |file-formats|.
3479 For backwards compatibility: When this option is set to an empty
3480 string or one format (no comma is included), 'textauto' is reset,
3481 otherwise 'textauto' is set.
3482 NOTE: This option is set to the Vi default value when 'compatible' is
3483 set and to the Vim default value when 'compatible' is reset.
3484
Bram Moolenaarbf884932013-04-05 22:26:15 +02003485 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3486'fileignorecase' 'fic' boolean (default on for systems where case in file
3487 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003488 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003489 When set case is ignored when using file names and directories.
3490 See 'wildignorecase' for only ignoring case when doing completion.
3491
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 *'filetype'* *'ft'*
3493'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003494 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 When this option is set, the FileType autocommand event is triggered.
3496 All autocommands that match with the value of this option will be
3497 executed. Thus the value of 'filetype' is used in place of the file
3498 name.
3499 Otherwise this option does not always reflect the current file type.
3500 This option is normally set when the file type is detected. To enable
3501 this use the ":filetype on" command. |:filetype|
3502 Setting this option to a different value is most useful in a modeline,
3503 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003504 Example, for in an IDL file:
3505 /* vim: set filetype=idl : */ ~
3506 |FileType| |filetypes|
3507 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003508 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003509 /* vim: set filetype=c.doxygen : */ ~
3510 This will use the "c" filetype first, then the "doxygen" filetype.
3511 This works both for filetype plugins and for syntax files. More than
3512 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 This option is not copied to another buffer, independent of the 's' or
3514 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003515 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516
3517 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003518'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003519 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003520 Characters to fill the statuslines, vertical separators and special
3521 lines in the window.
3522 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003523 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003525 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003526 stl ' ' statusline of the current window
3527 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003528 vert '|' vertical separators |:vsplit|
3529 fold '-' filling 'foldtext'
3530 foldopen '-' mark the beginning of a fold
3531 foldclose '+' show a closed fold
3532 foldsep '|' open fold middle character
3533 diff '-' deleted lines of the 'diff' option
3534 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003535 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003537 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538
3539 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003540 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3541<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003542 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3543 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003544 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003547 item name highlight group ~
3548 stl StatusLine |hl-StatusLine|
3549 stlnc StatusLineNC |hl-StatusLineNC|
3550 vert VertSplit |hl-VertSplit|
3551 fold Folded |hl-Folded|
3552 diff DiffDelete |hl-DiffDelete|
3553 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003554 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003556 *'findfunc'* *'ffu'* *E1514*
3557'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003558 global or local to buffer |global-local|
3559 {not available when compiled without the |+eval|
3560 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003561 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003562 command. When this option is empty, the internal |file-searching|
3563 mechanism is used.
3564
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003565 The value can be the name of a function, a |lambda| or a |Funcref|.
3566 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003567
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003568 The function is called with two arguments. The first argument is a
3569 |String| and is the |:find| command argument. The second argument is
3570 a |Boolean| and is set to |v:true| when the function is called to get
3571 a List of command-line completion matches for the |:find| command.
3572 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003573
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003574 The function is called only once per |:find| command invocation.
3575 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003576
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003577 If a match is found, the function should return a |List| containing
3578 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003579 should return an empty List.
3580
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003581 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003582 empty List is used as the return value.
3583
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003584 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003585 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003586
3587 This option cannot be set from a |modeline| or in the |sandbox|, for
3588 security reasons.
3589
3590 Examples:
3591>
3592 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003593 func FindFuncGlob(cmdarg, cmdcomplete)
3594 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003595 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003596 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003597 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003598
3599 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003600 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003601 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003602 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003603 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003604 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003605<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003606 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3607'fixendofline' 'fixeol' boolean (default on)
3608 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003609 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003610 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003611 preserve the situation from the original file.
3612 When the 'binary' option is set the value of this option doesn't
3613 matter.
3614 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003615 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003616
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003618'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 {only available when compiled with the |+rightleft|
3621 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003622 This option was for using Farsi, which has been removed. See
3623 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
3625 *'foldclose'* *'fcl'*
3626'foldclose' 'fcl' string (default "")
3627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 {not available when compiled without the |+folding|
3629 feature}
3630 When set to "all", a fold is closed when the cursor isn't in it and
3631 its level is higher than 'foldlevel'. Useful if you want folds to
3632 automatically close when moving out of them.
3633
3634 *'foldcolumn'* *'fdc'*
3635'foldcolumn' 'fdc' number (default 0)
3636 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 {not available when compiled without the |+folding|
3638 feature}
3639 When non-zero, a column with the specified width is shown at the side
3640 of the window which indicates open and closed folds. The maximum
3641 value is 12.
3642 See |folding|.
3643
3644 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3645'foldenable' 'fen' boolean (default on)
3646 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 {not available when compiled without the |+folding|
3648 feature}
3649 When off, all folds are open. This option can be used to quickly
3650 switch between showing all text unfolded and viewing the text with
3651 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003652 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'foldenable' is off.
3654 This option is set by commands that create a new fold or close a fold.
3655 See |folding|.
3656
3657 *'foldexpr'* *'fde'*
3658'foldexpr' 'fde' string (default: "0")
3659 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003661 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003663 for each line to obtain its fold level. The context is set to the
3664 script where 'foldexpr' was set, script-local items can be accessed.
3665 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003666
Bram Moolenaar30b65812012-07-12 22:01:11 +02003667 The expression will be evaluated in the |sandbox| if set from a
3668 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003669 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003670 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003671
3672 It is not allowed to change text or jump to another window while
3673 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674
3675 *'foldignore'* *'fdi'*
3676'foldignore' 'fdi' string (default: "#")
3677 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 {not available when compiled without the |+folding|
3679 feature}
3680 Used only when 'foldmethod' is "indent". Lines starting with
3681 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003682 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 The default "#" works well for C programs. See |fold-indent|.
3684
3685 *'foldlevel'* *'fdl'*
3686'foldlevel' 'fdl' number (default: 0)
3687 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 {not available when compiled without the |+folding|
3689 feature}
3690 Sets the fold level: Folds with a higher level will be closed.
3691 Setting this option to zero will close all folds. Higher numbers will
3692 close fewer folds.
3693 This option is set by commands like |zm|, |zM| and |zR|.
3694 See |fold-foldlevel|.
3695
3696 *'foldlevelstart'* *'fdls'*
3697'foldlevelstart' 'fdls' number (default: -1)
3698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 {not available when compiled without the |+folding|
3700 feature}
3701 Sets 'foldlevel' when starting to edit another buffer in a window.
3702 Useful to always start editing with all folds closed (value zero),
3703 some folds closed (one) or no folds closed (99).
3704 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003705 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 ignores this option and closes all folds.
3707 It is also done before BufReadPre autocommands, to allow an autocmd to
3708 overrule the 'foldlevel' value for specific files.
3709 When the value is negative, it is not used.
3710
3711 *'foldmarker'* *'fmr'* *E536*
3712'foldmarker' 'fmr' string (default: "{{{,}}}")
3713 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 {not available when compiled without the |+folding|
3715 feature}
3716 The start and end marker used when 'foldmethod' is "marker". There
3717 must be one comma, which separates the start and end marker. The
3718 marker is a literal string (a regular expression would be too slow).
3719 See |fold-marker|.
3720
3721 *'foldmethod'* *'fdm'*
3722'foldmethod' 'fdm' string (default: "manual")
3723 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 {not available when compiled without the |+folding|
3725 feature}
3726 The kind of folding used for the current window. Possible values:
3727 |fold-manual| manual Folds are created manually.
3728 |fold-indent| indent Lines with equal indent form a fold.
3729 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3730 |fold-marker| marker Markers are used to specify folds.
3731 |fold-syntax| syntax Syntax highlighting items specify folds.
3732 |fold-diff| diff Fold text that is not changed.
3733
3734 *'foldminlines'* *'fml'*
3735'foldminlines' 'fml' number (default: 1)
3736 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 {not available when compiled without the |+folding|
3738 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003739 Sets the number of screen lines above which a fold can be displayed
3740 closed. Also for manually closed folds. With the default value of
3741 one a fold can only be closed if it takes up two or more screen lines.
3742 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003743 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 "zc" to close a fold, which is displayed open because it's smaller
3745 than 'foldminlines', a following "zc" may close a containing fold.
3746
3747 *'foldnestmax'* *'fdn'*
3748'foldnestmax' 'fdn' number (default: 20)
3749 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 {not available when compiled without the |+folding|
3751 feature}
3752 Sets the maximum nesting of folds for the "indent" and "syntax"
3753 methods. This avoids that too many folds will be created. Using more
3754 than 20 doesn't work, because the internal limit is 20.
3755
3756 *'foldopen'* *'fdo'*
3757'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3758 search,tag,undo")
3759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 {not available when compiled without the |+folding|
3761 feature}
3762 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003763 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003765 NOTE: When the command is part of a mapping this option is not used.
3766 Add the |zv| command to the mapping to get the same effect.
3767 (rationale: the mapping may want to control opening folds itself)
3768
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 item commands ~
3770 all any
3771 block "(", "{", "[[", "[{", etc.
3772 hor horizontal movements: "l", "w", "fx", etc.
3773 insert any command in Insert mode
3774 jump far jumps: "G", "gg", etc.
3775 mark jumping to a mark: "'m", CTRL-O, etc.
3776 percent "%"
3777 quickfix ":cn", ":crew", ":make", etc.
3778 search search for a pattern: "/", "n", "*", "gd", etc.
3779 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003780 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 tag jumping to a tag: ":ta", CTRL-T, etc.
3782 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 When a movement command is used for an operator (e.g., "dl" or "y%")
3784 this option is not used. This means the operator will include the
3785 whole closed fold.
3786 Note that vertical movements are not here, because it would make it
3787 very difficult to move onto a closed fold.
3788 In insert mode the folds containing the cursor will always be open
3789 when text is inserted.
3790 To close folds you can re-apply 'foldlevel' with the |zx| command or
3791 set the 'foldclose' option to "all".
3792
3793 *'foldtext'* *'fdt'*
3794'foldtext' 'fdt' string (default: "foldtext()")
3795 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 {not available when compiled without the |+folding|
3797 feature}
3798 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003799 fold. The context is set to the script where 'foldexpr' was set,
3800 script-local items can be accessed. See |fold-foldtext| for the
3801 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802
Bram Moolenaar30b65812012-07-12 22:01:11 +02003803 The expression will be evaluated in the |sandbox| if set from a
3804 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003805 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003806
3807 It is not allowed to change text or jump to another window while
3808 evaluating 'foldtext' |textlock|.
3809
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003810 *'formatexpr'* *'fex'*
3811'formatexpr' 'fex' string (default "")
3812 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003813 {not available when compiled without the |+eval|
3814 feature}
3815 Expression which is evaluated to format a range of lines for the |gq|
3816 operator or automatic formatting (see 'formatoptions'). When this
3817 option is empty 'formatprg' is used.
3818
3819 The |v:lnum| variable holds the first line to be formatted.
3820 The |v:count| variable holds the number of lines to be formatted.
3821 The |v:char| variable holds the character that is going to be
3822 inserted if the expression is being evaluated due to
3823 automatic formatting. This can be empty. Don't insert
3824 it yet!
3825
3826 Example: >
3827 :set formatexpr=mylang#Format()
3828< This will invoke the mylang#Format() function in the
3829 autoload/mylang.vim file in 'runtimepath'. |autoload|
3830
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003831 The advantage of using a function call without arguments is that it is
3832 faster, see |expr-option-function|.
3833
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003834 The expression is also evaluated when 'textwidth' is set and adding
3835 text beyond that limit. This happens under the same conditions as
3836 when internal formatting is used. Make sure the cursor is kept in the
3837 same spot relative to the text then! The |mode()| function will
3838 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003839
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003840 When the expression evaluates to non-zero Vim will fall back to using
3841 the internal format mechanism.
3842
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003843 If the expression starts with s: or |<SID>|, then it is replaced with
3844 the script ID (|local-function|). Example: >
3845 set formatexpr=s:MyFormatExpr()
3846 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003847< Otherwise, the expression is evaluated in the context of the script
3848 where the option was set, thus script-local items are available.
3849
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003850 The expression will be evaluated in the |sandbox| when set from a
3851 modeline, see |sandbox-option|. That stops the option from working,
3852 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003853 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003854 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003855
Bram Moolenaar86b68352004-12-27 21:59:20 +00003856 *'formatlistpat'* *'flp'*
3857'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3858 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003859 A pattern that is used to recognize a list header. This is used for
3860 the "n" flag in 'formatoptions'.
3861 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003862 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003863 while still checking more characters. There must be a character
3864 following the pattern, when it matches the whole line it is handled
3865 like there is no match.
3866 The default recognizes a number, followed by an optional punctuation
3867 character and white space.
3868
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003869 *'formatoptions'* *'fo'*
3870'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3871 local to buffer
3872 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003873 formatting is to be done.
3874 See |fo-table| for possible values and |gq| for how to format text.
3875 When the 'paste' option is on, no formatting is done (like
3876 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003877 To avoid problems with flags that are added in the future, use the
3878 "+=" and "-=" feature of ":set" |add-option-flags|.
3879 NOTE: This option is set to the Vi default value when 'compatible' is
3880 set and to the Vim default value when 'compatible' is reset.
3881
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 *'formatprg'* *'fp'*
3883'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003884 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003886 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003888 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003889 If the 'formatexpr' option is not empty it will be used instead.
3890 Otherwise, if 'formatprg' option is an empty string, the internal
3891 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003892 Environment variables are expanded |:set_env|. See |option-backslash|
3893 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003894 This option cannot be set from a |modeline| or in the |sandbox|, for
3895 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896
Bram Moolenaard94464e2015-11-02 15:28:18 +01003897 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003898'fsync' 'fs' boolean (default on)
3899 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003900 When on, the library function fsync() will be called after writing a
3901 file. This will flush a file to disk, ensuring that it is safely
3902 written even on filesystems which do metadata-only journaling. This
3903 will force the harddrive to spin up on Linux systems running in laptop
3904 mode, so it may be undesirable in some situations. Be warned that
3905 turning this off increases the chances of data loss after a crash. On
3906 systems without an fsync() implementation, this variable is always
3907 off.
3908 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003909 'fsync' also applies to |writefile()| (unless a flag is used to
3910 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003911 This option cannot be set from a |modeline| or in the |sandbox|, for
3912 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003913
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3915'gdefault' 'gd' boolean (default off)
3916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 When on, the ":substitute" flag 'g' is default on. This means that
3918 all matches in a line are substituted instead of one. When a 'g' flag
3919 is given to a ":substitute" command, this will toggle the substitution
3920 of all or one match. See |complex-change|.
3921
3922 command 'gdefault' on 'gdefault' off ~
3923 :s/// subst. all subst. one
3924 :s///g subst. one subst. all
3925 :s///gg subst. all subst. one
3926
3927 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003928 Setting this option may break plugins that rely on the default
3929 behavior of the 'g' flag. This will also make the 'g' flag have the
3930 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003931 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932
3933 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003934'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 Format to recognize for the ":grep" command output.
3937 This is a scanf-like string that uses the same format as the
3938 'errorformat' option: see |errorformat|.
3939
3940 *'grepprg'* *'gp'*
3941'grepprg' 'gp' string (default "grep -n ",
3942 Unix: "grep -n $* /dev/null",
3943 Win32: "findstr /n" or "grep -n",
3944 VMS: "SEARCH/NUMBERS ")
3945 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003946 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 and '#' characters, which are expanded like when used in a command-
3948 line. The placeholder "$*" is allowed to specify where the arguments
3949 will be included. Environment variables are expanded |:set_env|. See
3950 |option-backslash| about including spaces and backslashes.
3951 When your "grep" accepts the "-H" argument, use this to make ":grep"
3952 also work well with a single file: >
3953 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003954< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003955 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3956 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003957 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 apply equally to 'grepprg'.
3959 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3960 otherwise it's "grep -n".
3961 This option cannot be set from a |modeline| or in the |sandbox|, for
3962 security reasons.
3963
3964 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3965'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3966 ve:ver35-Cursor,
3967 o:hor50-Cursor,
3968 i-ci:ver25-Cursor/lCursor,
3969 r-cr:hor20-Cursor/lCursor,
3970 sm:block-Cursor
3971 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003972 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 "n-v-c:block,o:hor50,i-ci:hor15,
3974 r-cr:hor30,sm:block")
3975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003977 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003979 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003980 height of the cursor can be changed. This can be done by specifying a
3981 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003982 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3983 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003985 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 mode-list and an argument-list:
3987 mode-list:argument-list,mode-list:argument-list,..
3988 The mode-list is a dash separated list of these modes:
3989 n Normal mode
3990 v Visual mode
3991 ve Visual mode with 'selection' "exclusive" (same as 'v',
3992 if not specified)
3993 o Operator-pending mode
3994 i Insert mode
3995 r Replace mode
3996 c Command-line Normal (append) mode
3997 ci Command-line Insert mode
3998 cr Command-line Replace mode
3999 sm showmatch in Insert mode
4000 a all modes
4001 The argument-list is a dash separated list of these arguments:
4002 hor{N} horizontal bar, {N} percent of the character height
4003 ver{N} vertical bar, {N} percent of the character width
4004 block block cursor, fills the whole character
4005 [only one of the above three should be present]
4006 blinkwait{N} *cursor-blinking*
4007 blinkon{N}
4008 blinkoff{N}
4009 blink times for cursor: blinkwait is the delay before
4010 the cursor starts blinking, blinkon is the time that
4011 the cursor is shown and blinkoff is the time that the
4012 cursor is not shown. The times are in msec. When one
4013 of the numbers is zero, there is no blinking. The
4014 default is: "blinkwait700-blinkon400-blinkoff250".
4015 These numbers are used for a missing entry. This
4016 means that blinking is enabled by default. To switch
4017 blinking off you can use "blinkon0". The cursor only
4018 blinks when Vim is waiting for input, not while
4019 executing a command.
4020 To make the cursor blink in an xterm, see
4021 |xterm-blink|.
4022 {group-name}
4023 a highlight group name, that sets the color and font
4024 for the cursor
4025 {group-name}/{group-name}
4026 Two highlight group names, the first is used when
4027 no language mappings are used, the other when they
4028 are. |language-mapping|
4029
4030 Examples of parts:
4031 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4032 block cursor with colors from the "nCursor"
4033 highlight group
4034 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4035 In Insert and Command-line Insert mode, use a
4036 30% vertical bar cursor with colors from the
4037 "iCursor" highlight group. Blink a bit
4038 faster.
4039
4040 The 'a' mode is different. It will set the given argument-list for
4041 all modes. It does not reset anything to defaults. This can be used
4042 to do a common setting for all modes. For example, to switch off
4043 blinking: "a:blinkon0"
4044
4045 Examples of cursor highlighting: >
4046 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4047 :highlight Cursor gui=NONE guifg=bg guibg=fg
4048<
4049 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004050 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051'guifont' 'gfn' string (default "")
4052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 {only available when compiled with GUI enabled}
4054 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004055 In its simplest form the value is just one font name.
4056 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057
4058 *'guifontset'* *'gfs'*
4059 *E250* *E252* *E234* *E597* *E598*
4060'guifontset' 'gfs' string (default "")
4061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 {only available when compiled with GUI enabled and
4063 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004064 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 When not empty, specifies two (or more) fonts to be used. The first
4066 one for normal English, the second one for your special language. See
4067 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004068
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4070'guifontwide' 'gfw' string (default "")
4071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 {only available when compiled with GUI enabled}
4073 When not empty, specifies a comma-separated list of fonts to be used
4074 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004075 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004076
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 *'guiheadroom'* *'ghr'*
4078'guiheadroom' 'ghr' number (default 50)
4079 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004080 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 The number of pixels subtracted from the screen height when fitting
4082 the GUI window on the screen. Set this before the GUI is started,
4083 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004084 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 lines will be left for window decorations and other items on the
4086 screen. Set it to a negative value to allow windows taller than the
4087 screen.
4088
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004089 *'guiligatures'* *'gli'* *E1243*
4090'guiligatures' 'gli' string (default "")
4091 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004092 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004093 List of ASCII characters that, when combined together, can create more
4094 complex shapes. Each character must be a printable ASCII character
4095 with a value in the 32-127 range.
4096 Example: >
4097 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4098< Changing this option updates screen output immediately. Set it to an
4099 empty string to disable ligatures.
4100
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004102'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4103 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004104 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004105 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004108 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 sequence of letters which describes what components and options of the
4110 GUI should be used.
4111 To avoid problems with flags that are added in the future, use the
4112 "+=" and "-=" feature of ":set" |add-option-flags|.
4113
Bram Moolenaar13568252018-03-16 20:46:58 +01004114 Valid characters are as follows:
4115 *'go-!'*
4116 '!' External commands are executed in a terminal window. Without
4117 this flag the MS-Windows GUI will open a console window to
4118 execute the command. The Unix GUI will simulate a dumb
4119 terminal to list the command output.
4120 The terminal window will be positioned at the bottom, and grow
4121 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004122 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 'a' Autoselect: If present, then whenever VISUAL mode is started,
4124 or the Visual area extended, Vim tries to become the owner of
4125 the windowing system's global selection. This means that the
4126 Visually highlighted text is available for pasting into other
4127 applications as well as into Vim itself. When the Visual mode
4128 ends, possibly due to an operation on the text, or when an
4129 application wants to paste the selection, the highlighted text
4130 is automatically yanked into the "* selection register.
4131 Thus the selection is still available for pasting into other
4132 applications after the VISUAL mode has ended.
4133 If not present, then Vim won't become the owner of the
4134 windowing system's global selection unless explicitly told to
4135 by a yank or delete operation for the "* register.
4136 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004137 *'go-P'*
4138 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004139 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004140 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004141 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 applies to the modeless selection.
4143
4144 'guioptions' autoselect Visual autoselect modeless ~
4145 "" - -
4146 "a" yes yes
4147 "A" - yes
4148 "aA" yes yes
4149
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004150 When using a terminal see the 'clipboard' option.
4151
Bram Moolenaar02467872007-05-06 13:22:01 +00004152 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 'c' Use console dialogs instead of popup dialogs for simple
4154 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004155 *'go-d'*
4156 'd' Use dark theme variant if available. Currently only works for
4157 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004158 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004159 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004160 'guitablabel' can be used to change the text in the labels.
4161 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004162 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004163 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004164 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 'f' Foreground: Don't use fork() to detach the GUI from the shell
4166 where it was started. Use this for programs that wait for the
4167 editor to finish (e.g., an e-mail program). Alternatively you
4168 can use "gvim -f" or ":gui -f" to start the GUI in the
4169 foreground. |gui-fork|
4170 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004171 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004172 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4174 corner of the window. It's black&white on non-GTK, because of
4175 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004176 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004178 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004179 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004181 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004183 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004184 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 'g' Grey menu items: Make menu items that are not active grey. If
4186 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004187 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 't' Include tearoff menu items. Currently only works for Win32,
4189 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004190 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004191 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4192 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004193 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004195 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 'R' Right-hand scrollbar is present when there is a vertically
4197 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004198 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004200 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 'L' Left-hand scrollbar is present when there is a vertically
4202 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004203 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4205 the longest visible line, or on the cursor line if the 'h'
4206 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004207 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 'h' Limit horizontal scrollbar size to the length of the cursor
4209 line. Reduces computations. |gui-horiz-scroll|
4210
4211 And yes, you may even have scrollbars on the left AND the right if
4212 you really want to :-). See |gui-scrollbars| for more information.
4213
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004214 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 'v' Use a vertical button layout for dialogs. When not included,
4216 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004217 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004218 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 'p' Use Pointer callbacks for X11 GUI. This is required for some
4220 window managers. If the cursor is not blinking or hollow at
4221 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004222 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004224 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004225 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004226 *'go-k'*
4227 'k' Keep the GUI window size when adding/removing a scrollbar, or
4228 toolbar, tabline, etc. Instead, the behavior is similar to
4229 when the window is maximized and will adjust 'lines' and
4230 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004231 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004232 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004233
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 *'guipty'* *'noguipty'*
4235'guipty' boolean (default on)
4236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 {only available when compiled with GUI enabled}
4238 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4239 I/O to/from shell commands. See |gui-pty|.
4240
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004241 *'guitablabel'* *'gtl'*
4242'guitablabel' 'gtl' string (default empty)
4243 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004244 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004245 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004246 pages line. When empty and when the result is empty Vim will use a
4247 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004248
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004249 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004250 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004251 The expression will be evaluated in the |sandbox| when set from a
4252 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004253 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004254
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004255 Only used when the GUI tab pages line is displayed. 'e' must be
4256 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4257 used.
4258
Bram Moolenaar57657d82006-04-21 22:12:41 +00004259 *'guitabtooltip'* *'gtt'*
4260'guitabtooltip' 'gtt' string (default empty)
4261 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004262 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004263 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004264 pages line. When empty Vim will use a default tooltip.
4265 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004266 You can include a line break. Simplest method is to use |:let|: >
4267 :let &guitabtooltip = "line one\nline two"
4268<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004269
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004271'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 (others) "$VIMRUNTIME/doc/help.txt")
4273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 Name of the main help file. All distributed help files should be
4275 placed together in one directory. Additionally, all "doc" directories
4276 in 'runtimepath' will be used.
4277 Environment variables are expanded |:set_env|. For example:
4278 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004279 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 spaces and backslashes.
4281 This option cannot be set from a |modeline| or in the |sandbox|, for
4282 security reasons.
4283
4284 *'helpheight'* *'hh'*
4285'helpheight' 'hh' number (default 20)
4286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 Minimal initial height of the help window when it is opened with the
4288 ":help" command. The initial height of the help window is half of the
4289 current window, or (when the 'ea' option is on) the same as other
4290 windows. When the height is less than 'helpheight', the height is
4291 set to 'helpheight'. Set to zero to disable.
4292
4293 *'helplang'* *'hlg'*
4294'helplang' 'hlg' string (default: messages language or empty)
4295 global
4296 {only available when compiled with the |+multi_lang|
4297 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004298 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 for which the desired help can be found. The English help will always
4300 be used as a last resort. You can add "en" to prefer English over
4301 another language, but that will only find tags that exist in that
4302 language and not in the English help.
4303 Example: >
4304 :set helplang=de,it
4305< This will first search German, then Italian and finally English help
4306 files.
4307 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4308 try to find the tag in the current language before using this option.
4309 See |help-translated|.
4310
4311 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4312'hidden' 'hid' boolean (default off)
4313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 When off a buffer is unloaded when it is |abandon|ed. When on a
4315 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4316 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004317
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004319 hidden even if the 'hidden' option is off when these three are true:
4320 - the buffer is modified
4321 - 'autowrite' is off or writing is not possible
4322 - the '!' flag was used
4323 Also see |windows.txt|.
4324
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004325 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 This option is set for one command with ":hide {command}" |:hide|.
4327 WARNING: It's easy to forget that you have changes in hidden buffers.
4328 Think twice when using ":q!" or ":qa!".
4329
4330 *'highlight'* *'hl'*
4331'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004332 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4333 d:Directory,e:ErrorMsg,i:IncSearch,
4334 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004335 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004336 N:CursorLineNr,r:Question,s:StatusLine,
4337 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004338 v:Visual,V:VisualNOS,w:WarningMsg,
4339 W:WildMenu,f:Folded,F:FoldColumn,
4340 A:DiffAdd,C:DiffChange,D:DiffDelete,
4341 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004342 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004343 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004344 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004345 [:PmenuKind,]:PmenuKindSel,
4346 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004347 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4348 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004349 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004350 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004351 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004354 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004356 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004358 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4359 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 characters from 'showbreak'
4361 |hl-Directory| d directories in CTRL-D listing and other special
4362 things in listings
4363 |hl-ErrorMsg| e error messages
4364 h (obsolete, ignored)
4365 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004366 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4368 |hl-MoreMsg| m |more-prompt|
4369 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004370 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004371 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004372 |hl-LineNr| n line number for ":number" and ":#" commands, and
4373 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004374 |hl-LineNrAbove| a line number above the cursor for when the
4375 'relativenumber' option is set.
4376 |hl-LineNrBelow| b line number below the cursor for when the
4377 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004378 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4379 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 |hl-Question| r |hit-enter| prompt and yes/no questions
4381 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004382 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4384 |hl-VertSplit| c column used to separate vertically split windows
4385 |hl-Visual| v Visual mode
4386 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4387 Selection" Only X11 Gui's |gui-x11| and
4388 |xterm-clipboard|.
4389 |hl-WarningMsg| w warning messages
4390 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4391 |hl-Folded| f line used for closed folds
4392 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004393 |hl-DiffAdd| A added line in diff mode
4394 |hl-DiffChange| C changed line in diff mode
4395 |hl-DiffDelete| D deleted line in diff mode
4396 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004398 |hl-Conceal| - the placeholders used for concealed characters
4399 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004400 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004401 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004402 |hl-SpellRare| R rare word |spell|
4403 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004404 |hl-Pmenu| + popup menu normal line
4405 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004406 |hl-PmenuKind| [ popup menu "kind" normal line
4407 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004408 |hl-PmenuExtra| { popup menu "extra" normal line
4409 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004410 |hl-PmenuSbar| x popup menu scrollbar
4411 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004412 |hl-PmenuMatch| k popup menu matched text
4413 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414
4415 The display modes are:
4416 r reverse (termcap entry "mr" and "me")
4417 i italic (termcap entry "ZH" and "ZR")
4418 b bold (termcap entry "md" and "me")
4419 s standout (termcap entry "so" and "se")
4420 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004421 c undercurl (termcap entry "Us" and "Ce")
4422 2 double underline (termcap entry "Ds" and "Ce")
4423 d dotted underline (termcap entry "ds" and "Ce")
4424 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004425 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 n no highlighting
4427 - no highlighting
4428 : use a highlight group
4429 The default is used for occasions that are not included.
4430 If you want to change what the display modes do, see |dos-colors|
4431 for an example.
4432 When using the ':' display mode, this must be followed by the name of
4433 a highlight group. A highlight group can be used to define any type
4434 of highlighting, including using color. See |:highlight| on how to
4435 define one. The default uses a different group for each occasion.
4436 See |highlight-default| for the default highlight groups.
4437
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004439'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004442 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004443 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004444 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004445 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 NOTE: This option is set to the Vi default value when 'compatible' is
4447 set and to the Vim default value when 'compatible' is reset.
4448
4449 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4450'hkmap' 'hk' boolean (default off)
4451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 {only available when compiled with the |+rightleft|
4453 feature}
4454 When on, the keyboard is mapped for the Hebrew character set.
4455 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4456 toggle this option. See |rileft.txt|.
4457 NOTE: This option is reset when 'compatible' is set.
4458
4459 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4460'hkmapp' 'hkp' boolean (default off)
4461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 {only available when compiled with the |+rightleft|
4463 feature}
4464 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4465 This is useful if you have a non-Hebrew keyboard.
4466 See |rileft.txt|.
4467 NOTE: This option is reset when 'compatible' is set.
4468
Bram Moolenaar036986f2017-03-16 17:41:02 +01004469 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4470'hlsearch' 'hls' boolean (default off)
4471 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004472 {not available when compiled without the
4473 |+extra_search| feature}
4474 When there is a previous search pattern, highlight all its matches.
4475 The type of highlighting used can be set with the 'l' occasion in the
4476 'highlight' option. This uses the "Search" highlight group by
4477 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004478 are not applied. If the "CurSearch" highlight group is set then the
4479 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004480 See also: 'incsearch' and |:match|.
4481 When you get bored looking at the highlighted matches, you can turn it
4482 off with |:nohlsearch|. This does not change the option value, as
4483 soon as you use a search command, the highlighting comes back.
4484 'redrawtime' specifies the maximum time spent on finding matches.
4485 When the search pattern can match an end-of-line, Vim will try to
4486 highlight all of the matched text. However, this depends on where the
4487 search starts. This will be the first line in the window or the first
4488 line below a closed fold. A match in a previous line which is not
4489 drawn may not continue in a newly drawn line.
4490 You can specify whether the highlight status is restored on startup
4491 with the 'h' flag in 'viminfo' |viminfo-h|.
4492 NOTE: This option is reset when 'compatible' is set.
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 *'icon'* *'noicon'*
4495'icon' boolean (default off, on when title can be restored)
4496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 When on, the icon text of the window will be set to the value of
4498 'iconstring' (if it is not empty), or to the name of the file
4499 currently being edited. Only the last part of the name is used.
4500 Overridden by the 'iconstring' option.
4501 Only works if the terminal supports setting window icons (currently
4502 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4503 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4504 builtin termcap).
4505 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004506 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004508 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509
4510 *'iconstring'*
4511'iconstring' string (default "")
4512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 When this option is not empty, it will be used for the icon text of
4514 the window. This happens only when the 'icon' option is on.
4515 Only works if the terminal supports setting window icon text
4516 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004517 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 When Vim was compiled with HAVE_X11 defined, the original icon will be
4519 restored if possible |X11|.
4520 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004521 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004523 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 {not available when compiled without the |+statusline| feature}
4525
4526 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4527'ignorecase' 'ic' boolean (default off)
4528 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004529 Ignore case in search patterns, |cmdline-completion|, when
4530 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004531 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 Can be overruled by using "\c" or "\C" in the pattern, see
4533 |/ignorecase|.
4534
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004535 *'imactivatefunc'* *'imaf'*
4536'imactivatefunc' 'imaf' string (default "")
4537 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004538 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004539 activate or deactivate the Input Method. The value can be the name of
4540 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4541 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004542 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004543 The expression will be evaluated in the |sandbox| when set from a
4544 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004545
4546 Example: >
4547 function ImActivateFunc(active)
4548 if a:active
4549 ... do something
4550 else
4551 ... do something
4552 endif
4553 " return value is not used
4554 endfunction
4555 set imactivatefunc=ImActivateFunc
4556<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 *'imactivatekey'* *'imak'*
4558'imactivatekey' 'imak' string (default "")
4559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004561 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 Specifies the key that your Input Method in X-Windows uses for
4563 activation. When this is specified correctly, vim can fully control
4564 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4565 You can't use this option to change the activation key, the option
4566 tells Vim what the key is.
4567 Format:
4568 [MODIFIER_FLAG-]KEY_STRING
4569
4570 These characters can be used for MODIFIER_FLAG (case is ignored):
4571 S Shift key
4572 L Lock key
4573 C Control key
4574 1 Mod1 key
4575 2 Mod2 key
4576 3 Mod3 key
4577 4 Mod4 key
4578 5 Mod5 key
4579 Combinations are allowed, for example "S-C-space" or "SC-space" are
4580 both shift+ctrl+space.
4581 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4582
4583 Example: >
4584 :set imactivatekey=S-space
4585< "S-space" means shift+space. This is the activation key for kinput2 +
4586 canna (Japanese), and ami (Korean).
4587
4588 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4589'imcmdline' 'imc' boolean (default off)
4590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 When set the Input Method is always on when starting to edit a command
4592 line, unless entering a search pattern (see 'imsearch' for that).
4593 Setting this option is useful when your input method allows entering
4594 English characters directly, e.g., when it's used to type accented
4595 characters with dead keys.
4596
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004597 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 When set the Input Method is never used. This is useful to disable
4601 the IM when it doesn't work properly.
4602 Currently this option is on by default for SGI/IRIX machines. This
4603 may change in later releases.
4604
4605 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004606'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 Specifies whether :lmap or an Input Method (IM) is to be used in
4609 Insert mode. Valid values:
4610 0 :lmap is off and IM is off
4611 1 :lmap is ON and IM is off
4612 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 To always reset the option to zero when leaving Insert mode with <Esc>
4614 this can be used: >
4615 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4616< This makes :lmap and IM turn off automatically when leaving Insert
4617 mode.
4618 Note that this option changes when using CTRL-^ in Insert mode
4619 |i_CTRL-^|.
4620 The value is set to 1 when setting 'keymap' to a valid keymap name.
4621 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004622 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 methods. Use 'imdisable' to disable XIM then.
4624
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004625 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004626 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004627 |+multi_byte_ime| or |global-ime|.
4628
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004630'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 Specifies whether :lmap or an Input Method (IM) is to be used when
4633 entering a search pattern. Valid values:
4634 -1 the value of 'iminsert' is used, makes it look like
4635 'iminsert' is also used when typing a search pattern
4636 0 :lmap is off and IM is off
4637 1 :lmap is ON and IM is off
4638 2 :lmap is off and IM is ON
4639 Note that this option changes when using CTRL-^ in Command-line mode
4640 |c_CTRL-^|.
4641 The value is set to 1 when it is not -1 and setting the 'keymap'
4642 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004643 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 methods. Use 'imdisable' to disable XIM then.
4645
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004646 *'imstatusfunc'* *'imsf'*
4647'imstatusfunc' 'imsf' string (default "")
4648 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004649 This option specifies a function that is called to obtain the status
4650 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004651 The value can be the name of a function, a |lambda| or a |Funcref|.
4652 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004653 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004654
4655 Example: >
4656 function ImStatusFunc()
4657 let is_active = ...do something
4658 return is_active ? 1 : 0
4659 endfunction
4660 set imstatusfunc=ImStatusFunc
4661<
4662 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004663 The expression will be evaluated in the |sandbox| when set from a
4664 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004665
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004666 *'imstyle'* *'imst'*
4667'imstyle' 'imst' number (default 1)
4668 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004669 {only available when compiled with |+xim| and
4670 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004671 This option specifies the input style of Input Method:
4672 0 use on-the-spot style
4673 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004674 See: |xim-input-style|
4675
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004676 For a long time on-the-spot style had been used in the GTK version of
4677 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004678 |single-repeat|, etc. Therefore over-the-spot style becomes the
4679 default now. This should work fine for most people, however if you
4680 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004681 The expression will be evaluated in the |sandbox| when set from a
4682 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004683
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 *'include'* *'inc'*
4685'include' 'inc' string (default "^\s*#\s*include")
4686 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 {not available when compiled without the
4688 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004689 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 pattern, just like for the "/" command (See |pattern|). The default
4691 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004692 "]I", "[d", etc.
4693 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004694 comes after the matched pattern. But if "\zs" appears in the pattern
4695 then the text matched from "\zs" to the end, or until "\ze" if it
4696 appears, is used as the file name. Use this to include characters
4697 that are not in 'isfname', such as a space. You can then use
4698 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004699 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700
4701 *'includeexpr'* *'inex'*
4702'includeexpr' 'inex' string (default "")
4703 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004705 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004707 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004708 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004710 Note the double backslash: the `:set` command first halves them, then
4711 one remains it the value, where "\." matches a dot literally. For
4712 simple character replacements `tr()` avoids the need for escaping: >
4713 :setlocal includeexpr=tr(v:fname,'.','/')
4714<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004716 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 Also used for |<cfile>|.
4718
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004719 If the expression starts with s: or |<SID>|, then it is replaced with
4720 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004721 setlocal includeexpr=s:MyIncludeExpr()
4722 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004723< Otherwise, the expression is evaluated in the context of the script
4724 where the option was set, thus script-local items are available.
4725
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004726 It is more efficient if the value is just a function call without
4727 arguments, see |expr-option-function|.
4728
Bram Moolenaar30b65812012-07-12 22:01:11 +02004729 The expression will be evaluated in the |sandbox| when set from a
4730 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004731 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004732
4733 It is not allowed to change text or jump to another window while
4734 evaluating 'includeexpr' |textlock|.
4735
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004737'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004738 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004741 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004742 While typing a search command, show where the pattern, as it was typed
4743 so far, matches. The matched string is highlighted. If the pattern
4744 is invalid or not found, nothing is shown. The screen will be updated
4745 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004746 Also applies to the pattern in commands: >
4747 :global
4748 :lvimgrep
4749 :lvimgrepadd
4750 :smagic
4751 :snomagic
4752 :sort
4753 :substitute
4754 :vglobal
4755 :vimgrep
4756 :vimgrepadd
4757< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004758 original position when no match is found and when pressing <Esc>. You
4759 still need to finish the search command with <Enter> to move the
4760 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004761 You can use the CTRL-G and CTRL-T keys to move to the next and
4762 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004763 When compiled with the |+reltime| feature Vim only searches for about
4764 half a second. With a complicated pattern and/or a lot of text the
4765 match may not be found. This is to avoid that Vim hangs while you
4766 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004767 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004768 When 'hlsearch' is on, all matched strings are highlighted too while
4769 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004770 If you don't want to turn 'hlsearch' on, but want to highlight all
4771 matches while searching, you can turn on and off 'hlsearch' with
4772 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004773 augroup vimrc-incsearch-highlight
4774 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004775 autocmd CmdlineEnter /,\? :set hlsearch
4776 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004777 augroup END
4778<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004779 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004780 to the command line. If 'ignorecase' and 'smartcase' are set and the
4781 command line has no uppercase characters, the added character is
4782 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004783 CTRL-R CTRL-W can be used to add the word at the end of the current
4784 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 NOTE: This option is reset when 'compatible' is set.
4786
4787 *'indentexpr'* *'inde'*
4788'indentexpr' 'inde' string (default "")
4789 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004790 {not available when compiled without the |+eval|
4791 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 Expression which is evaluated to obtain the proper indent for a line.
4793 It is used when a new line is created, for the |=| operator and
4794 in Insert mode as specified with the 'indentkeys' option.
4795 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004796 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004797 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 When 'paste' is set this option is not used for indenting.
4799 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004800 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004802
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004803 If the expression starts with s: or |<SID>|, then it is replaced with
4804 the script ID (|local-function|). Example: >
4805 set indentexpr=s:MyIndentExpr()
4806 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004807< Otherwise, the expression is evaluated in the context of the script
4808 where the option was set, thus script-local items are available.
4809
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004810 The advantage of using a function call without arguments is that it is
4811 faster, see |expr-option-function|.
4812
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 The expression must return the number of spaces worth of indent. It
4814 can return "-1" to keep the current indent (this means 'autoindent' is
4815 used for the indent).
4816 Functions useful for computing the indent are |indent()|, |cindent()|
4817 and |lispindent()|.
4818 The evaluation of the expression must not have side effects! It must
4819 not change the text, jump to another window, etc. Afterwards the
4820 cursor position is always restored, thus the cursor may be moved.
4821 Normally this option would be set to call a function: >
4822 :set indentexpr=GetMyIndent()
4823< Error messages will be suppressed, unless the 'debug' option contains
4824 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004825 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004826 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827
Bram Moolenaar30b65812012-07-12 22:01:11 +02004828 The expression will be evaluated in the |sandbox| when set from a
4829 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004830 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004831
4832 It is not allowed to change text or jump to another window while
4833 evaluating 'indentexpr' |textlock|.
4834
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004836'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 A list of keys that, when typed in Insert mode, cause reindenting of
4839 the current line. Only happens if 'indentexpr' isn't empty.
4840 The format is identical to 'cinkeys', see |indentkeys-format|.
4841 See |C-indenting| and |indent-expression|.
4842
4843 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4844'infercase' 'inf' boolean (default off)
4845 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004847 'ignorecase' is also on, the case of the match is adjusted depending
4848 on the typed text. If the typed text contains a lowercase letter
4849 where the match has an upper case letter, the completed part is made
4850 lowercase. If the typed text has no lowercase letters and the match
4851 has a lowercase letter where the typed text has an uppercase letter,
4852 and there is a letter before it, the completed part is made uppercase.
4853 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854
4855 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4856'insertmode' 'im' boolean (default off)
4857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 Makes Vim work in a way that Insert mode is the default mode. Useful
4859 if you want to use Vim as a modeless editor. Used for |evim|.
4860 These Insert mode commands will be useful:
4861 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004862 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 this is a mapping, it is executed as if 'insertmode' was off.
4864 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004866 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4867 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
4869 These items change when 'insertmode' is set:
4870 - when starting to edit of a file, Vim goes to Insert mode.
4871 - <Esc> in Insert mode is a no-op and beeps.
4872 - <Esc> in Normal mode makes Vim go to Insert mode.
4873 - CTRL-L in Insert mode is a command, it is not inserted.
4874 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4875 However, when <Esc> is used inside a mapping, it behaves like
4876 'insertmode' was not set. This was done to be able to use the same
4877 mappings with 'insertmode' set or not set.
4878 When executing commands with |:normal| 'insertmode' is not used.
4879
4880 NOTE: This option is reset when 'compatible' is set.
4881
4882 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004883'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4885 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4886 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4887 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4888 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 The characters specified by this option are included in file names and
4891 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004892 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 Multi-byte characters 256 and above are always included, only the
4894 characters up to 255 are specified with this option.
4895 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004896 Think twice before adding white space to this option. Although a
4897 space may appear inside a file name, the effect will be that Vim
4898 doesn't know where a file name starts or ends when doing completion.
4899 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900
4901 Note that on systems using a backslash as path separator, Vim tries to
4902 do its best to make it work as you would expect. That is a bit
4903 tricky, since Vi originally used the backslash to escape special
4904 characters. Vim will not remove a backslash in front of a normal file
4905 name character on these systems, but it will on Unix and alikes. The
4906 '&' and '^' are not included by default, because these are special for
4907 cmd.exe.
4908
4909 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004910 Each part can be a single character number or a range. A range is two
4911 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 decimal number between 0 and 255 or the ASCII character itself (does
4913 not work for digits). Example:
4914 "_,-,128-140,#-43" (include '_' and '-' and the range
4915 128 to 140 and '#' to 43)
4916 If a part starts with '^', the following character number or range
4917 will be excluded from the option. The option is interpreted from left
4918 to right. Put the excluded character after the range where it is
4919 included. To include '^' itself use it as the last character of the
4920 option or the end of a range. Example:
4921 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4922 If the character is '@', all characters where isalpha() returns TRUE
4923 are included. Normally these are the characters a to z and A to Z,
4924 plus accented characters. To include '@' itself use "@-@". Examples:
4925 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004926 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 "a-z,A-Z,@-@" All letters plus the '@' character.
4928 A comma can be included by using it where a character number is
4929 expected. Example:
4930 "48-57,,,_" Digits, comma and underscore.
4931 A comma can be excluded by prepending a '^'. Example:
4932 " -~,^,,9" All characters from space to '~', excluding
4933 comma, plus <Tab>.
4934 See |option-backslash| about including spaces and backslashes.
4935
4936 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004937'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 "@,48-57,_,128-167,224-235"
4939 otherwise: "@,48-57,_,192-255")
4940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 The characters given by this option are included in identifiers.
4942 Identifiers are used in recognizing environment variables and after a
4943 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004944 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004945 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004947 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4949
4950 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004951'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 "@,48-57,_,128-167,224-235"
4953 otherwise: "@,48-57,_,192-255"
4954 Vi default: "@,48-57,_")
4955 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004957 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004958 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004959 characters above 255 check the "word" character class (any character
4960 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004961 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 For a help file it is set to all non-blank printable characters except
4963 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4964 command).
4965 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004966 This option also influences syntax highlighting, unless the syntax
4967 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 NOTE: This option is set to the Vi default value when 'compatible' is
4969 set and to the Vim default value when 'compatible' is reset.
4970
4971 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02004972'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 "@,~-255"; otherwise: "@,161-255")
4974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 The characters given by this option are displayed directly on the
4976 screen. It is also used for "\p" in a |pattern|. The characters from
4977 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4978 even when they are not included in 'isprint' or excluded. See
4979 'isfname' for a description of the format of this option.
4980
4981 Non-printable characters are displayed with two characters:
4982 0 - 31 "^@" - "^_"
4983 32 - 126 always single characters
4984 127 "^?"
4985 128 - 159 "~@" - "~_"
4986 160 - 254 "| " - "|~"
4987 255 "~?"
4988 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4989 displayed as <xx>, with the hexadecimal value of the byte.
4990 When 'display' contains "uhex" all unprintable characters are
4991 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004992 The SpecialKey highlighting will be used for unprintable characters.
4993 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994
4995 Multi-byte characters 256 and above are always included, only the
4996 characters up to 255 are specified with this option. When a character
4997 is printable but it is not available in the current font, a
4998 replacement character will be shown.
4999 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5000 There is no option to specify these characters.
5001
5002 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5003'joinspaces' 'js' boolean (default on)
5004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 Insert two spaces after a '.', '?' and '!' with a join command.
5006 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5007 Otherwise only one space is inserted.
5008 NOTE: This option is set when 'compatible' is set.
5009
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005010 *'jumpoptions'* *'jop'*
5011'jumpoptions' 'jop' string (default "")
5012 global
5013 List of words that change the behavior of the |jumplist|.
5014 stack Make the jumplist behave like the tagstack.
5015 Relative location of entries in the jumplist is
5016 preserved at the cost of discarding subsequent entries
5017 when navigating backwards in the jumplist and then
5018 jumping to a location. |jumplist-stack|
5019
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 *'key'*
5021'key' string (default "")
5022 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005023 {only available when compiled with the |+cryptv|
5024 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005026 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 Careful: Do not set the key value by hand, someone might see the typed
5028 key. Use the |:X| command. But you can make 'key' empty: >
5029 :set key=
5030< It is not possible to get the value of this option with ":set key" or
5031 "echo &key". This is to avoid showing it to someone who shouldn't
5032 know. It also means you cannot see it yourself once you have set it,
5033 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005034 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5035 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005036 You can use "&key" in an expression to detect whether encryption is
5037 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
5039 *'keymap'* *'kmp'* *E544*
5040'keymap' 'kmp' string (default "")
5041 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 {only available when compiled with the |+keymap|
5043 feature}
5044 Name of a keyboard mapping. See |mbyte-keymap|.
5045 Setting this option to a valid keymap name has the side effect of
5046 setting 'iminsert' to one, so that the keymap becomes effective.
5047 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005048 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049
5050 *'keymodel'* *'km'*
5051'keymodel' 'km' string (default "")
5052 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005053 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 can do. These values can be used:
5055 startsel Using a shifted special key starts selection (either
5056 Select mode or Visual mode, depending on "key" being
5057 present in 'selectmode').
5058 stopsel Using a not-shifted special key stops selection.
5059 Special keys in this context are the cursor keys, <End>, <Home>,
5060 <PageUp> and <PageDown>.
5061 The 'keymodel' option is set by the |:behave| command.
5062
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005063 *'keyprotocol'* *'kpc'*
5064'keyprotocol' 'kpc' string (default: see below)
5065 global
5066 Specifies what keyboard protocol to use depending on the value of
5067 'term'. The supported keyboard protocols names are:
5068 none whatever the terminal uses
5069 mok2 modifyOtherKeys level 2, as supported by xterm
5070 kitty Kitty keyboard protocol, as supported by Kitty
5071
Bram Moolenaara87749e2022-11-30 10:23:17 +00005072 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005073 a pattern that is matched against the 'term' option, a colon and the
5074 protocol name to be used. To illustrate this, the default value would
5075 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005076 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5077 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005078
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005079< This means that when 'term' contains "kitty, "foot", "ghostty" or
5080 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5081 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005082
5083 The first match is used, thus if you want to have "kitty" use the
5084 kitty protocol, but "badkitty" not, then you should match "badkitty"
5085 first and use the "none" value: >
5086 set keyprotocol=badkitty:none,kitty:kitty
5087<
5088 The option is used after 'term' has been changed. First the termcap
5089 entries are set, possibly using the builtin list, see |builtin-terms|.
5090 Then this option is inspected and if there is a match and a protocol
5091 is specified the following happens:
5092 none Nothing, the regular t_TE and t_TI values remain
5093
5094 mok2 The t_TE value is changed to:
5095 CSI >4;m disables modifyOtherKeys
5096 The t_TI value is changed to:
5097 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005098 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005099
5100 kitty The t_TE value is changed to:
5101 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005102 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005103 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005104 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005105 CSI ?u request kitty keyboard protocol state
5106 CSI >c request the termresponse
5107
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005108 If you notice problems, such as characters being displayed that
5109 disappear after `CTRL-L`, you might want to try making this option
5110 empty. Then set the 'term' option to have it take effect: >
5111 set keyprotocol=
5112 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005113<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005114
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 *'keywordprg'* *'kp'*
5116'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005117 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 Program to use for the |K| command. Environment variables are
5120 expanded |:set_env|. ":help" may be used to access the Vim internal
5121 help. (Note that previously setting the global option to the empty
5122 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005123 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005124 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005125 When "man", "man -s" or an Ex command is used, Vim will automatically
5126 translate a count for the "K" command and pass it as the first
5127 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 See |option-backslash| about including spaces and backslashes.
5129 Example: >
5130 :set keywordprg=man\ -s
5131< This option cannot be set from a |modeline| or in the |sandbox|, for
5132 security reasons.
5133
5134 *'langmap'* *'lmap'* *E357* *E358*
5135'langmap' 'lmap' string (default "")
5136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 {only available when compiled with the |+langmap|
5138 feature}
5139 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005140 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005141 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 care of translating these special characters to the original meaning
5143 of the key. This means you don't have to change the keyboard mode to
5144 be able to execute Normal mode commands.
5145 This is the opposite of the 'keymap' option, where characters are
5146 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005147 Also consider setting 'langremap' to off, to prevent 'langmap' from
5148 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005149 This option cannot be set from a |modeline| or in the |sandbox|, for
5150 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005152 Example (for Greek, in UTF-8): *greek* >
5153 :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 +00005154< Example (exchanges meaning of z and y for commands): >
5155 :set langmap=zy,yz,ZY,YZ
5156<
5157 The 'langmap' option is a list of parts, separated with commas. Each
5158 part can be in one of two forms:
5159 1. A list of pairs. Each pair is a "from" character immediately
5160 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005161 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 characters. Example: "abc;ABC"
5163 Example: "aA,fgh;FGH,cCdDeE"
5164 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005165 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
5167 This will allow you to activate vim actions without having to switch
5168 back and forth between the languages. Your language characters will
5169 be understood as normal vim English characters (according to the
5170 langmap mappings) in the following cases:
5171 o Normal/Visual mode (commands, buffer/register names, user mappings)
5172 o Insert/Replace Mode: Register names after CTRL-R
5173 o Insert/Replace Mode: Mappings
5174 Characters entered in Command-line mode will NOT be affected by
5175 this option. Note that this option can be changed at any time
5176 allowing to switch between mappings for different languages/encodings.
5177 Use a mapping to avoid having to type it each time!
5178
5179 *'langmenu'* *'lm'*
5180'langmenu' 'lm' string (default "")
5181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 {only available when compiled with the |+menu| and
5183 |+multi_lang| features}
5184 Language to use for menu translation. Tells which file is loaded
5185 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005186 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187< (without the spaces). For example, to always use the Dutch menus, no
5188 matter what $LANG is set to: >
5189 :set langmenu=nl_NL.ISO_8859-1
5190< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005191 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 If your $LANG is set to a non-English language but you do want to use
5193 the English menus: >
5194 :set langmenu=none
5195< This option must be set before loading menus, switching on filetype
5196 detection or syntax highlighting. Once the menus are defined setting
5197 this option has no effect. But you could do this: >
5198 :source $VIMRUNTIME/delmenu.vim
5199 :set langmenu=de_DE.ISO_8859-1
5200 :source $VIMRUNTIME/menu.vim
5201< Warning: This deletes all menus that you defined yourself!
5202
Bram Moolenaard94464e2015-11-02 15:28:18 +01005203 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005204'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005205 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005206 {only available when compiled with the |+langmap|
5207 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005208 This is just like 'langremap' but with the value inverted. It only
5209 exists for backwards compatibility. When setting 'langremap' then
5210 'langnoremap' is set to the inverted value, and the other way around.
5211
5212 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005213'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005214 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005215 {only available when compiled with the |+langmap|
5216 feature}
5217 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005218 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005219 'langmap' disables some of your mappings, try resetting this option.
5220 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005221 that works for you to avoid mappings to break.
5222
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 *'laststatus'* *'ls'*
5224'laststatus' 'ls' number (default 1)
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 The value of this option influences when the last window will have a
5227 status line:
5228 0: never
5229 1: only if there are at least two windows
5230 2: always
5231 The screen looks nicer with a status line if you have several
5232 windows, but it takes another screen line. |status-line|
5233
5234 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5235'lazyredraw' 'lz' boolean (default off)
5236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 When this option is set, the screen will not be redrawn while
5238 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005239 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005241 This may occasionally cause display errors. It is only meant to be set
5242 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005243 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244
5245 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5246'linebreak' 'lbr' boolean (default off)
5247 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005248 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005250 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 than at the last character that fits on the screen. Unlike
5252 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005253 it only affects the way the file is displayed, not its contents.
5254 If 'breakindent' is set, line is visually indented. Then, the value
5255 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005256 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 Note that <Tab> characters after an <EOL> are mostly not displayed
5258 with the right amount of white space.
5259
5260 *'lines'* *E593*
5261'lines' number (default 24 or terminal height)
5262 global
5263 Number of lines of the Vim window.
5264 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005265 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 When Vim is running in the GUI or in a resizable window, setting this
5267 option will cause the window size to be changed. When you only want
5268 to use the size for the GUI, put the command in your |gvimrc| file.
5269 Vim limits the number of lines to what fits on the screen. You can
5270 use this command to get the tallest window possible: >
5271 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005272< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005273 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 When you set this option and Vim is unable to change the physical
5275 number of lines of the display, the display may be messed up.
5276
5277 *'linespace'* *'lsp'*
5278'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 {only in the GUI}
5281 Number of pixel lines inserted between characters. Useful if the font
5282 uses the full character cell height, making lines touch each other.
5283 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005284 With some fonts there can be too much room between lines (to have
5285 space for ascents and descents). Then it makes sense to set
5286 'linespace' to a negative value. This may cause display problems
5287 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288
5289 *'lisp'* *'nolisp'*
5290'lisp' boolean (default off)
5291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 Lisp mode: When <Enter> is typed in insert mode set the indent for
5293 the next line to Lisp standards (well, sort of). Also happens with
5294 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5295 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5296 better. Also see 'lispwords'.
5297 The '-' character is included in keyword characters. Redefines the
5298 "=" operator to use this same indentation algorithm rather than
5299 calling an external program if 'equalprg' is empty.
5300 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005302 *'lispoptions'* *'lop'*
5303'lispoptions' 'lop' string (default "")
5304 local to buffer
5305 Comma-separated list of items that influence the Lisp indenting when
5306 enabled with the |'lisp'| option. Currently only one item is
5307 supported:
5308 expr:1 use 'indentexpr' for Lisp indenting when it is set
5309 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5310 Note that when using 'indentexpr' the `=` operator indents all the
5311 lines, otherwise the first line is not indented (Vi-compatible).
5312
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 *'lispwords'* *'lw'*
5314'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005315 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005316 Comma-separated list of words that influence the Lisp indenting when
5317 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318
5319 *'list'* *'nolist'*
5320'list' boolean (default off)
5321 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005322 List mode: By default show tabs as CTRL-I is displayed, display $
5323 after end of line. Useful to see the difference between tabs and
5324 spaces and for trailing blanks. Further changed by the 'listchars'
5325 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005326
5327 The cursor is displayed at the start of the space a Tab character
5328 occupies, not at the end as usual in Normal mode. To get this cursor
5329 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005330 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005331<
5332 Note that list mode will also affect formatting (set with 'textwidth'
5333 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 changing the way tabs are displayed.
5335
5336 *'listchars'* *'lcs'*
5337'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005338 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005339 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005340 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005341 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 eol:c Character to show at the end of each line. When
5343 omitted, there is no extra character at the end of the
5344 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005345 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005346 tab:xy[z] Two or three characters to be used to show a tab.
5347 The third character is optional.
5348
5349 tab:xy The 'x' is always used, then 'y' as many times as will
5350 fit. Thus "tab:>-" displays:
5351 >
5352 >-
5353 >--
5354 etc.
5355
5356 tab:xyz The 'z' is always used, then 'x' is prepended, and
5357 then 'y' is used as many times as will fit. Thus
5358 "tab:<->" displays:
5359 >
5360 <>
5361 <->
5362 <-->
5363 etc.
5364
5365 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005366 *lcs-space*
5367 space:c Character to show for a space. When omitted, spaces
5368 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005369 *lcs-multispace*
5370 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005371 One or more characters to use cyclically to show for
5372 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005373 setting, except for single spaces. When omitted, the
5374 "space" setting is used. For example,
5375 `:set listchars=multispace:---+` shows ten consecutive
5376 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005377 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005378 *lcs-lead*
5379 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005380 leading spaces are blank. Overrides the "space" and
5381 "multispace" settings for leading spaces. You can
5382 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005383 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005384< *lcs-leadmultispace*
5385 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005386 Like the |lcs-multispace| value, but for leading
5387 spaces only. Also overrides |lcs-lead| for leading
5388 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005389 `:set listchars=leadmultispace:---+` shows ten
5390 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005391 ---+---+--XXX ~
5392 Where "XXX" denotes the first non-blank characters in
5393 the line.
5394 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005395 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005396 trailing spaces are blank. Overrides the "space" and
5397 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005398 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 extends:c Character to show in the last column, when 'wrap' is
5400 off and the line continues beyond the right of the
5401 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005402 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005403 precedes:c Character to show in the first visible column of the
5404 physical line, when there is text preceding the
5405 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005406 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005407 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005408 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005409 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005410 nbsp:c Character to show for a non-breakable space character
5411 (0xA0 (160 decimal) and U+202F). Left blank when
5412 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005414 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005416 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005418 Each character can be specified as hex: >
5419 set listchars=eol:\\x24
5420 set listchars=eol:\\u21b5
5421 set listchars=eol:\\U000021b5
5422< Note that a double backslash is used. The number of hex characters
5423 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5424
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 Examples: >
5426 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005427 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 :set lcs=extends:>,precedes:<
5429< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005430 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5431 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005432 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433
5434 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5435'loadplugins' 'lpl' boolean (default on)
5436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 When on the plugin scripts are loaded when starting up |load-plugins|.
5438 This option can be reset in your |vimrc| file to disable the loading
5439 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005440 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5441 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442
Bram Moolenaard94464e2015-11-02 15:28:18 +01005443 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005444'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005445 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005446 {only available when compiled with the |+lua/dyn|
5447 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005448 Specifies the name of the Lua shared library. The default is
5449 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005450 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005451 This option cannot be set from a |modeline| or in the |sandbox|, for
5452 security reasons.
5453
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005454 *'macatsui'* *'nomacatsui'*
5455'macatsui' boolean (default on)
5456 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005457 {not supported}
5458 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005459
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 *'magic'* *'nomagic'*
5461'magic' boolean (default on)
5462 global
5463 Changes the special characters that can be used in search patterns.
5464 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005465 WARNING: Switching this option off most likely breaks plugins! That
5466 is because many patterns assume it's on and will fail when it's off.
5467 Only switch it off when working with old Vi scripts. In any other
5468 situation write patterns that work when 'magic' is on. Include "\M"
5469 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005470 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5471 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472
5473 *'makeef'* *'mef'*
5474'makeef' 'mef' string (default: "")
5475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 {not available when compiled without the |+quickfix|
5477 feature}
5478 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5479 and the |:grep| command.
5480 When it is empty, an internally generated temp file will be used.
5481 When "##" is included, it is replaced by a number to make the name
5482 unique. This makes sure that the ":make" command doesn't overwrite an
5483 existing file.
5484 NOT used for the ":cf" command. See 'errorfile' for that.
5485 Environment variables are expanded |:set_env|.
5486 See |option-backslash| about including spaces and backslashes.
5487 This option cannot be set from a |modeline| or in the |sandbox|, for
5488 security reasons.
5489
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005490 *'makeencoding'* *'menc'*
5491'makeencoding' 'menc' string (default "")
5492 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005493 Encoding used for reading the output of external commands. When empty,
5494 encoding is not converted.
5495 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5496 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5497 and `:laddfile`.
5498
5499 This would be mostly useful when you use MS-Windows and set 'encoding'
5500 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5501 'makeencoding' to "char" has the same effect as setting to the system
5502 locale encoding. Example: >
5503 :set encoding=utf-8
5504 :set makeencoding=char " system locale is used
5505<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 *'makeprg'* *'mp'*
5507'makeprg' 'mp' string (default "make", VMS: "MMS")
5508 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005509 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005510 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5511 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005512 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005513 Environment variables are expanded |:set_env|. See |option-backslash|
5514 about including spaces and backslashes.
5515 Note that a '|' must be escaped twice: once for ":set" and once for
5516 the interpretation of a command. When you use a filter called
5517 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 :set makeprg=gmake\ \\\|\ myfilter
5519< The placeholder "$*" can be given (even multiple times) to specify
5520 where the arguments will be included, for example: >
5521 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5522< This option cannot be set from a |modeline| or in the |sandbox|, for
5523 security reasons.
5524
5525 *'matchpairs'* *'mps'*
5526'matchpairs' 'mps' string (default "(:),{:},[:]")
5527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005529 other.
5530 Only character pairs are allowed that are different, thus you cannot
5531 jump between two double quotes.
5532 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005533 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005534 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 :set mps+=<:>
5536
5537< A more exotic example, to jump between the '=' and ';' in an
5538 assignment, useful for languages like C and Java: >
5539 :au FileType c,cpp,java set mps+==:;
5540
5541< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005542 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543
5544 *'matchtime'* *'mat'*
5545'matchtime' 'mat' number (default 5)
5546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 Tenths of a second to show the matching paren, when 'showmatch' is
5548 set. Note that this is not in milliseconds, like other options that
5549 set a time. This is to be compatible with Nvi.
5550
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005551 *'maxcombine'* *'mco'*
5552'maxcombine' 'mco' number (default 2)
5553 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005554 The maximum number of combining characters supported for displaying.
5555 Only used when 'encoding' is "utf-8".
5556 The default is OK for most languages. Hebrew may require 4.
5557 Maximum value is 6.
5558 Even when this option is set to 2 you can still edit text with more
5559 combining characters, you just can't see them. Use |g8| or |ga|.
5560 See |mbyte-combining|.
5561
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 *'maxfuncdepth'* *'mfd'*
5563'maxfuncdepth' 'mfd' number (default 100)
5564 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005565 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005566 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 Maximum depth of function calls for user functions. This normally
5568 catches endless recursion. When using a recursive function with
5569 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5570 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005571 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005572 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005574 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575
5576 *'maxmapdepth'* *'mmd'* *E223*
5577'maxmapdepth' 'mmd' number (default 1000)
5578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 Maximum number of times a mapping is done without resulting in a
5580 character to be used. This normally catches endless mappings, like
5581 ":map x y" with ":map y x". It still does not catch ":map g wg",
5582 because the 'w' is used before the next mapping is done. See also
5583 |key-mapping|.
5584
5585 *'maxmem'* *'mm'*
5586'maxmem' 'mm' number (default between 256 to 5120 (system
5587 dependent) or half the amount of memory
5588 available)
5589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5591 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005592 other memory to be freed.
5593 The maximum usable value is about 2000000. Use this to work without a
5594 limit.
5595 The value is ignored when 'swapfile' is off.
5596 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005598 *'maxmempattern'* *'mmp'*
5599'maxmempattern' 'mmp' number (default 1000)
5600 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005601 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005602 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005603 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005604 When Vim runs into the limit it gives an error message and mostly
5605 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005606 Running into the limit often means that the pattern is very
5607 inefficient or too complex. This may already happen with the pattern
5608 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005609 Might also happen on redraw, when syntax rules try to match a complex
5610 text structure.
5611 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5612 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005613
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 *'maxmemtot'* *'mmt'*
5615'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5616 dependent) or half the amount of memory
5617 available)
5618 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005619 Maximum amount of memory in Kbyte to use for all buffers together.
5620 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005621 without a limit.
5622 On 64 bit machines higher values might work. But hey, do you really
5623 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005624 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005625 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005626 Buffers with 'swapfile' off still count to the total amount of memory
5627 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005628 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629
5630 *'menuitems'* *'mis'*
5631'menuitems' 'mis' number (default 25)
5632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 {not available when compiled without the |+menu|
5634 feature}
5635 Maximum number of items to use in a menu. Used for menus that are
5636 generated from a list of items, e.g., the Buffers menu. Changing this
5637 option has no direct effect, the menu must be refreshed first.
5638
Christian Brabandt51d4d842024-12-06 17:26:25 +01005639 *'messagesopt'* *'mopt'*
5640'messagesopt' 'mopt' string (default "hit-enter,history:500")
5641 global
5642
zeertzjq8cc43da2024-12-07 16:09:08 +01005643 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005644 following items. Items must be separated by a comma.
5645
zeertzjq8cc43da2024-12-07 16:09:08 +01005646 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005647 'cmdheight' size.
5648
zeertzjq8cc43da2024-12-07 16:09:08 +01005649 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5650 {n} milliseconds so that the user has a chance to read
5651 the message. The maximum value of {n} is 10000. Use
5652 0 to disable the wait (but then the user may miss an
5653 important message).
5654 This item is ignored when "hit-enter" is present, but
5655 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005656
5657 history:{n} Determines how many entries are remembered in the
5658 |:messages| history. The maximum value is 10000.
5659 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005660 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005661
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005662 *'mkspellmem'* *'msm'*
5663'mkspellmem' 'msm' string (default "460000,2000,500")
5664 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005665 {not available when compiled without the |+syntax|
5666 feature}
5667 Parameters for |:mkspell|. This tunes when to start compressing the
5668 word tree. Compression can be slow when there are many words, but
5669 it's needed to avoid running out of memory. The amount of memory used
5670 per word depends very much on how similar the words are, that's why
5671 this tuning is complicated.
5672
5673 There are three numbers, separated by commas:
5674 {start},{inc},{added}
5675
5676 For most languages the uncompressed word tree fits in memory. {start}
5677 gives the amount of memory in Kbyte that can be used before any
5678 compression is done. It should be a bit smaller than the amount of
5679 memory that is available to Vim.
5680
5681 When going over the {start} limit the {inc} number specifies the
5682 amount of memory in Kbyte that can be allocated before another
5683 compression is done. A low number means compression is done after
5684 less words are added, which is slow. A high number means more memory
5685 will be allocated.
5686
5687 After doing compression, {added} times 1024 words can be added before
5688 the {inc} limit is ignored and compression is done when any extra
5689 amount of memory is needed. A low number means there is a smaller
5690 chance of hitting the {inc} limit, less memory is used but it's
5691 slower.
5692
5693 The languages for which these numbers are important are Italian and
5694 Hungarian. The default works for when you have about 512 Mbyte. If
5695 you have 1 Gbyte you could use: >
5696 :set mkspellmem=900000,3000,800
5697< If you have less than 512 Mbyte |:mkspell| may fail for some
5698 languages, no matter what you set 'mkspellmem' to.
5699
dkearns8ebdbc92023-10-29 06:26:19 +11005700 This option cannot be set from a |modeline| or in the |sandbox|, for
5701 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005702
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005704'modeline' 'ml' boolean (Vim default: on (off for root),
5705 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005707 If 'modeline' is on 'modelines' gives the number of lines that is
5708 checked for set commands. If 'modeline' is off or 'modelines' is zero
5709 no lines are checked. See |modeline|.
5710
5711 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5712'modelineexpr' 'mle' boolean (default: off)
5713 global
5714 When on allow some options that are an expression to be set in the
5715 modeline. Check the option for whether it is affected by
5716 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005717 This option cannot be set from a |modeline| or in the |sandbox|, for
5718 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005719
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 *'modelines'* *'mls'*
5721'modelines' 'mls' number (default 5)
5722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 If 'modeline' is on 'modelines' gives the number of lines that is
5724 checked for set commands. If 'modeline' is off or 'modelines' is zero
5725 no lines are checked. See |modeline|.
5726 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5727 set and to the Vim default value when 'compatible' is reset.
5728
5729 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005730 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731'modifiable' 'ma' boolean (default on)
5732 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 When off the buffer contents cannot be changed. The 'fileformat' and
5734 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005735 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736
5737 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5738'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005739 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 When on, the buffer is considered to be modified. This option is set
5741 when:
5742 1. A change was made to the text since it was last written. Using the
5743 |undo| command to go back to the original text will reset the
5744 option. But undoing changes that were made before writing the
5745 buffer will set the option again, since the text is different from
5746 when it was written.
5747 2. 'fileformat' or 'fileencoding' is different from its original
5748 value. The original value is set when the buffer is read or
5749 written. A ":set nomodified" command also resets the original
5750 values to the current values and the 'modified' option will be
5751 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005752 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005753 This option is not set when a change is made to the buffer as the
5754 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5755 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5756 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5758 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005759 Note that the text may actually be the same, e.g. 'modified' is set
5760 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
5762 *'more'* *'nomore'*
5763'more' boolean (Vim default: on, Vi default: off)
5764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 When on, listings pause when the whole screen is filled. You will get
5766 the |more-prompt|. When this option is off there are no pauses, the
5767 listing continues until finished.
5768 NOTE: This option is set to the Vi default value when 'compatible' is
5769 set and to the Vim default value when 'compatible' is reset.
5770
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005771 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005772'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005773 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005775 Enable the use of the mouse. Works for most terminals (xterm, Win32
5776 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5777 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5778 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005779 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 v Visual mode
5781 i Insert mode
5782 c Command-line mode
5783 h all previous modes when editing a help file
5784 a all previous modes
5785 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005786 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005788< If your terminal can't overrule the mouse events going to the
5789 application, use: >
5790 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005791< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005792 back to Vim using the mouse events.
5793 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5794 "xterm".
5795
5796 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 modeless selection. This doesn't move the text cursor.
5798
5799 See |mouse-using|. Also see |'clipboard'|.
5800
5801 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005802 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 the mouse buttons can still be used by keeping the shift key pressed.
5804 Also see the 'clipboard' option.
5805
5806 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5807'mousefocus' 'mousef' boolean (default off)
5808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 {only works in the GUI}
5810 The window that the mouse pointer is on is automatically activated.
5811 When changing the window layout or window focus in another way, the
5812 mouse pointer is moved to the window with keyboard focus. Off is the
5813 default because it makes using the pull down menus a little goofy, as
5814 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005815 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005816 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817
5818 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5819'mousehide' 'mh' boolean (default on)
5820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 {only works in the GUI}
5822 When on, the mouse pointer is hidden when characters are typed.
5823 The mouse pointer is restored when the mouse is moved.
5824
5825 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005826'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 Sets the model to use for the mouse. The name mostly specifies what
5829 the right mouse button is used for:
5830 extend Right mouse button extends a selection. This works
5831 like in an xterm.
5832 popup Right mouse button pops up a menu. The shifted left
5833 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005834 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 popup_setpos Like "popup", but the cursor will be moved to the
5836 position where the mouse was clicked, and thus the
5837 selected operation will act upon the clicked object.
5838 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005839 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 course, that right clicking outside a selection will
5841 end Visual mode.
5842 Overview of what button does what for each model:
5843 mouse extend popup(_setpos) ~
5844 left click place cursor place cursor
5845 left drag start selection start selection
5846 shift-left search word extend selection
5847 right click extend selection popup menu (place cursor)
5848 right drag extend selection -
5849 middle click paste paste
5850
5851 In the "popup" model the right mouse button produces a pop-up menu.
5852 You need to define this first, see |popup-menu|.
5853
5854 Note that you can further refine the meaning of buttons with mappings.
5855 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5856 selection (because that's handled in the GUI code directly).
5857
5858 The 'mousemodel' option is set by the |:behave| command.
5859
h_east59858792023-10-25 22:47:05 +09005860 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005861'mousemoveevent' 'mousemev' boolean (default off)
5862 global
5863 {only works in the GUI}
5864 When on, mouse move events are delivered to the input queue and are
5865 available for mapping. The default, off, avoids the mouse movement
5866 overhead except when needed. See |gui-mouse-mapping|.
5867 Warning: Setting this option can make pending mappings to be aborted
5868 when the mouse is moved.
5869 Currently only works in the GUI, may be made to work in a terminal
5870 later.
5871
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005873'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5874 vs:leftright,vd:lrsizing,m:no,
5875 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 {only available when compiled with the |+mouseshape|
5878 feature}
5879 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005880 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 like used for 'guicursor'. Each part consist of a mode/location-list
5882 and an argument-list:
5883 mode-list:shape,mode-list:shape,..
5884 The mode-list is a dash separated list of these modes/locations:
5885 In a normal window: ~
5886 n Normal mode
5887 v Visual mode
5888 ve Visual mode with 'selection' "exclusive" (same as 'v',
5889 if not specified)
5890 o Operator-pending mode
5891 i Insert mode
5892 r Replace mode
5893
5894 Others: ~
5895 c appending to the command-line
5896 ci inserting in the command-line
5897 cr replacing in the command-line
5898 m at the 'Hit ENTER' or 'More' prompts
5899 ml idem, but cursor in the last line
5900 e any mode, pointer below last window
5901 s any mode, pointer on a status line
5902 sd any mode, while dragging a status line
5903 vs any mode, pointer on a vertical separator line
5904 vd any mode, while dragging a vertical separator line
5905 a everywhere
5906
5907 The shape is one of the following:
5908 avail name looks like ~
5909 w x arrow Normal mouse pointer
5910 w x blank no pointer at all (use with care!)
5911 w x beam I-beam
5912 w x updown up-down sizing arrows
5913 w x leftright left-right sizing arrows
5914 w x busy The system's usual busy pointer
5915 w x no The system's usual 'no input' pointer
5916 x udsizing indicates up-down resizing
5917 x lrsizing indicates left-right resizing
5918 x crosshair like a big thin +
5919 x hand1 black hand
5920 x hand2 white hand
5921 x pencil what you write with
5922 x question big ?
5923 x rightup-arrow arrow pointing right-up
5924 w x up-arrow arrow pointing up
5925 x <number> any X11 pointer number (see X11/cursorfont.h)
5926
5927 The "avail" column contains a 'w' if the shape is available for Win32,
5928 x for X11.
5929 Any modes not specified or shapes not available use the normal mouse
5930 pointer.
5931
5932 Example: >
5933 :set mouseshape=s:udsizing,m:no
5934< will make the mouse turn to a sizing arrow over the status lines and
5935 indicate no input when the hit-enter prompt is displayed (since
5936 clicking the mouse has no effect in this state.)
5937
5938 *'mousetime'* *'mouset'*
5939'mousetime' 'mouset' number (default 500)
5940 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005941 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 time in msec between two mouse clicks for the second click to be
5943 recognized as a multi click.
5944
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01005945
laburnumT3f7855a2023-12-05 18:37:03 +01005946 *'mzquantum'* *'mzq'*
5947'mzquantum' 'mzq' number (default 100)
5948 global
5949 {not available when compiled without the |+mzscheme|
5950 feature}
5951 The number of milliseconds between polls for MzScheme threads.
5952 Negative or zero value means no thread scheduling.
5953 NOTE: This option is set to the Vim default value when 'compatible'
5954 is reset.
5955
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005956 *'mzschemedll'*
5957'mzschemedll' string (default depends on the build)
5958 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005959 {only available when compiled with the |+mzscheme/dyn|
5960 feature}
5961 Specifies the name of the MzScheme shared library. The default is
5962 DYNAMIC_MZSCH_DLL which was specified at compile time.
5963 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005964 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005965 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005966 This option cannot be set from a |modeline| or in the |sandbox|, for
5967 security reasons.
5968
5969 *'mzschemegcdll'*
5970'mzschemegcdll' string (default depends on the build)
5971 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005972 {only available when compiled with the |+mzscheme/dyn|
5973 feature}
5974 Specifies the name of the MzScheme GC shared library. The default is
5975 DYNAMIC_MZGC_DLL which was specified at compile time.
5976 The value can be equal to 'mzschemedll' if it includes the GC code.
5977 Environment variables are expanded |:set_env|.
5978 This option cannot be set from a |modeline| or in the |sandbox|, for
5979 security reasons.
5980
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005982'nrformats' 'nf' string (default "bin,octal,hex",
5983 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 This defines what bases Vim will consider for numbers when using the
5986 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5987 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005988 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005990 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005991 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005993 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 considered to be hexadecimal. Example: Using CTRL-X on
5995 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005996 bin If included, numbers starting with "0b" or "0B" will be
5997 considered to be binary. Example: Using CTRL-X on
5998 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005999 unsigned If included, numbers are recognized as unsigned. Thus a
6000 leading dash or negative sign won't be considered as part of
6001 the number. Examples:
6002 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6003 (without "unsigned" it would become "9-2021").
6004 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6005 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006006 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6007 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006008 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006009 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006010 dash immediately preceded by a non-whitespace character (i.e.,
6011 not a tab or a " "), the negative sign won't be considered as
6012 part of the number. For example:
6013 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6014 (without "blank" it would become "Carbon-13").
6015 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006016 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006017 set, it would result in "Carbon -7").
6018 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006019 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006020 included, "unsigned" will take precedence.
6021
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 Numbers which simply begin with a digit in the range 1-9 are always
6023 considered decimal. This also happens for numbers that are not
6024 recognized as octal or hex.
6025
6026 *'number'* *'nu'* *'nonumber'* *'nonu'*
6027'number' 'nu' boolean (default off)
6028 local to window
6029 Print the line number in front of each line. When the 'n' option is
6030 excluded from 'cpoptions' a wrapped line will not use the column of
6031 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006032 The 'numberwidth' option can be used to set the room used for the line
6033 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034 When a long, wrapped line doesn't start with the first character, '-'
6035 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006036 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6037 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006038 *number_relativenumber*
6039 The 'relativenumber' option changes the displayed number to be
6040 relative to the cursor. Together with 'number' there are these
6041 four combinations (cursor in line 3):
6042
Bram Moolenaar3848e002016-03-19 18:42:29 +01006043 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006044 'nornu' 'nornu' 'rnu' 'rnu'
6045
6046 |apple | 1 apple | 2 apple | 2 apple
6047 |pear | 2 pear | 1 pear | 1 pear
6048 |nobody | 3 nobody | 0 nobody |3 nobody
6049 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006051 *'numberwidth'* *'nuw'*
6052'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6053 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006054 {only available when compiled with the |+linebreak|
6055 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006056 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006057 when the 'number' or 'relativenumber' option is set or printing lines
6058 with a line number. Since one space is always between the number and
6059 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006060 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006061 fit the highest line number in the buffer respectively the number of
6062 rows in the window, depending on whether 'number' or 'relativenumber'
6063 is set. Thus with the Vim default of 4 there is room for a line number
6064 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006065 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006066 NOTE: This option is set to the Vi default value when 'compatible' is
6067 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006068
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006069 *'omnifunc'* *'ofu'*
6070'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006071 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006072 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006073 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006074 This option specifies a function to be used for Insert mode omni
6075 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006076 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006077 invoked and what it should return. The value can be the name of a
6078 function, a |lambda| or a |Funcref|. See |option-value-function| for
6079 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006080 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006081 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006082 This option cannot be set from a |modeline| or in the |sandbox|, for
6083 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006084
Bram Moolenaar02467872007-05-06 13:22:01 +00006085 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006086'opendevice' 'odev' boolean (default off)
6087 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006088 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006089 Enable reading and writing from devices. This may get Vim stuck on a
6090 device that can be opened but doesn't actually do the I/O. Therefore
6091 it is off by default.
6092 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6093 result in editing a device.
6094
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006095 *'operatorfunc'* *'opfunc'*
6096'operatorfunc' 'opfunc' string (default: empty)
6097 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006098 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006099 See |:map-operator| for more info and an example. The value can be
6100 the name of a function, a |lambda| or a |Funcref|. See
6101 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006102
6103 This option cannot be set from a |modeline| or in the |sandbox|, for
6104 security reasons.
6105
Bram Moolenaar251e1912011-06-19 05:09:16 +02006106 *'osfiletype'* *'oft'*
6107'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006109 This option was supported on RISC OS, which has been removed.
6110
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006111 *'packpath'* *'pp'*
6112'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006113 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006114 This option cannot be set from a |modeline| or in the |sandbox|, for
6115 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006116
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006118'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 global
6120 Specifies the nroff macros that separate paragraphs. These are pairs
6121 of two letters (see |object-motions|).
6122
6123 *'paste'* *'nopaste'*
6124'paste' boolean (default off)
6125 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 Put Vim in Paste mode. This is useful if you want to cut or copy
6127 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 unexpected effects.
6129 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006130 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 knows about pasting and will mostly do the right thing without 'paste'
6132 being set. The same is true for a terminal where Vim handles the
6133 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006134 This option is reset when starting the GUI. Thus if you set it in
6135 your .vimrc it will work in a terminal, but not in the GUI. Setting
6136 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6137 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 When the 'paste' option is switched on (also when it was already on):
6139 - mapping in Insert mode and Command-line mode is disabled
6140 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006142 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006143 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 - 'revins' is reset
6145 - 'ruler' is reset
6146 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006147 - 'smarttab' is reset
6148 - 'softtabstop' is set to 0
6149 - 'textwidth' is set to 0
6150 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006151 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006154 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006155 - 'indentexpr'
6156 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006157 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 NOTE: When you start editing another file while the 'paste' option is
6159 on, settings from the modelines or autocommands may change the
6160 settings again, causing trouble when pasting text. You might want to
6161 set the 'paste' option again.
6162 When the 'paste' option is reset the mentioned options are restored to
6163 the value before the moment 'paste' was switched from off to on.
6164 Resetting 'paste' before ever setting it does not have any effect.
6165 Since mapping doesn't work while 'paste' is active, you need to use
6166 the 'pastetoggle' option to toggle the 'paste' option with some key.
6167
6168 *'pastetoggle'* *'pt'*
6169'pastetoggle' 'pt' string (default "")
6170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 When non-empty, specifies the key sequence that toggles the 'paste'
6172 option. This is like specifying a mapping: >
6173 :map {keys} :set invpaste<CR>
6174< Where {keys} is the value of 'pastetoggle'.
6175 The difference is that it will work even when 'paste' is set.
6176 'pastetoggle' works in Insert mode and Normal mode, but not in
6177 Command-line mode.
6178 Mappings are checked first, thus overrule 'pastetoggle'. However,
6179 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6180 this: >
6181 :map <F10> :set paste<CR>
6182 :map <F11> :set nopaste<CR>
6183 :imap <F10> <C-O>:set paste<CR>
6184 :imap <F11> <nop>
6185 :set pastetoggle=<F11>
6186< This will make <F10> start paste mode and <F11> stop paste mode.
6187 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6188 mode everything is inserted literally, except the 'pastetoggle' key
6189 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006190 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191
6192 *'pex'* *'patchexpr'*
6193'patchexpr' 'pex' string (default "")
6194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 {not available when compiled without the |+diff|
6196 feature}
6197 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006198 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006199 This option cannot be set from a |modeline| or in the |sandbox|, for
6200 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201
Bram Moolenaardbc28022014-07-26 13:40:44 +02006202 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203'patchmode' 'pm' string (default "")
6204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 When non-empty the oldest version of a file is kept. This can be used
6206 to keep the original version of a file if you are changing files in a
6207 source distribution. Only the first time that a file is written a
6208 copy of the original file will be kept. The name of the copy is the
6209 name of the original file with the string in the 'patchmode' option
6210 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006211 ".orig" or ".org". 'backupdir' must not be empty for this to work
6212 (Detail: The backup file is renamed to the patchmode file after the
6213 new file has been successfully written, that's why it must be possible
6214 to write a backup file). If there was no file to be backed up, an
6215 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 When the 'backupskip' pattern matches, a patchmode file is not made.
6217 Using 'patchmode' for compressed files appends the extension at the
6218 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6219 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006220 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006222 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 other systems: ".,,")
6225 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006227 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6228 provided that the file being searched for has a relative path (not
6229 starting with "/", "./" or "../"). The directories in the 'path'
6230 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 - Use commas to separate directory names: >
6232 :set path=.,/usr/local/include,/usr/include
6233< - Spaces can also be used to separate directory names (for backwards
6234 compatibility with version 3.0). To have a space in a directory
6235 name, precede it with an extra backslash, and escape the space: >
6236 :set path=.,/dir/with\\\ space
6237< - To include a comma in a directory name precede it with an extra
6238 backslash: >
6239 :set path=.,/dir/with\\,comma
6240< - To search relative to the directory of the current file, use: >
6241 :set path=.
6242< - To search in the current directory use an empty string between two
6243 commas: >
6244 :set path=,,
6245< - A directory name may end in a ':' or '/'.
6246 - Environment variables are expanded |:set_env|.
6247 - When using |netrw.vim| URLs can be used. For example, adding
6248 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006249 - Search upwards and downwards in a directory tree using "*", "**" and
6250 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 - Careful with '\' characters, type two to get one in the option: >
6252 :set path=.,c:\\include
6253< Or just use '/' instead: >
6254 :set path=.,c:/include
6255< Don't forget "." or files won't even be found in the same directory as
6256 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006257 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 it is something like 256 or 1024 characters.
6259 You can check if all the include files are found, using the value of
6260 'path', see |:checkpath|.
6261 The use of |:set+=| and |:set-=| is preferred when adding or removing
6262 directories from the list. This avoids problems when a future version
6263 uses another default. To remove the current directory use: >
6264 :set path-=
6265< To add the current directory use: >
6266 :set path+=
6267< To use an environment variable, you probably need to replace the
6268 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006269 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006270 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271< Replace the ';' with a ':' or whatever separator is used. Note that
6272 this doesn't work when $INCL contains a comma or white space.
6273
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006274 *'perldll'*
6275'perldll' string (default depends on the build)
6276 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006277 {only available when compiled with the |+perl/dyn|
6278 feature}
6279 Specifies the name of the Perl shared library. The default is
6280 DYNAMIC_PERL_DLL, which was specified at compile time.
6281 Environment variables are expanded |:set_env|.
6282 This option cannot be set from a |modeline| or in the |sandbox|, for
6283 security reasons.
6284
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6286'preserveindent' 'pi' boolean (default off)
6287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 When changing the indent of the current line, preserve as much of the
6289 indent structure as possible. Normally the indent is replaced by a
6290 series of tabs followed by spaces as required (unless |'expandtab'| is
6291 enabled, in which case only spaces are used). Enabling this option
6292 means the indent will preserve as many existing characters as possible
6293 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006294 'expandtab' does not apply to the preserved white space, a Tab remains
6295 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 NOTE: When using ">>" multiple times the resulting indent is a mix of
6297 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006298 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 Also see 'copyindent'.
6300 Use |:retab| to clean up white space.
6301
6302 *'previewheight'* *'pvh'*
6303'previewheight' 'pvh' number (default 12)
6304 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006305 {not available when compiled without the |+quickfix|
6306 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006308 commands. Used for |CTRL-W_}| when no count is given. Not used when
6309 'previewpopup' is set.
6310
6311 *'previewpopup'* *'pvp'*
6312'previewpopup' 'pvp' string (default empty)
6313 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006314 {not available when compiled without the |+textprop|
6315 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006316 When not empty a popup window is used for commands that would open a
6317 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006318 Not used for the insert completion info, add "popup" to
6319 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320
6321 *'previewwindow'* *'nopreviewwindow'*
6322 *'pvw'* *'nopvw'* *E590*
6323'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006324 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006325 {not available when compiled without the |+quickfix|
6326 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006327 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 set. It's normally not set directly, but by using one of the commands
6329 |:ptag|, |:pedit|, etc.
6330
6331 *'printdevice'* *'pdev'*
6332'printdevice' 'pdev' string (default empty)
6333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 {only available when compiled with the |+printer|
6335 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006336 The name of the printer to be used for |:hardcopy|.
6337 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006338 This option cannot be set from a |modeline| or in the |sandbox|, for
6339 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340
Bram Moolenaar8299df92004-07-10 09:47:34 +00006341 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006342'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 {only available when compiled with the |+printer|
6345 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006346 Sets the character encoding used when printing.
6347 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348
6349 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006350'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 {only available when compiled with the |+printer|
6353 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006354 Expression used to print the PostScript produced with |:hardcopy|.
6355 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006356 This option cannot be set from a |modeline| or in the |sandbox|, for
6357 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358
Bram Moolenaar8299df92004-07-10 09:47:34 +00006359 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360'printfont' 'pfn' string (default "courier")
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 font that will be used for |:hardcopy|.
6365 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366
6367 *'printheader'* *'pheader'*
6368'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 {only available when compiled with the |+printer|
6371 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006372 The format of the header produced in |:hardcopy| output.
6373 See |pheader-option|.
6374
6375 *'printmbcharset'* *'pmbcs'*
6376'printmbcharset' 'pmbcs' string (default "")
6377 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006378 {only available when compiled with the |+printer|
6379 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006380 The CJK character set to be used for CJK output from |:hardcopy|.
6381 See |pmbcs-option|.
6382
6383 *'printmbfont'* *'pmbfn'*
6384'printmbfont' 'pmbfn' string (default "")
6385 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006386 {only available when compiled with the |+printer|
6387 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006388 List of font names to be used for CJK output from |:hardcopy|.
6389 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390
6391 *'printoptions'* *'popt'*
6392'printoptions' 'popt' string (default "")
6393 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006395 List of items that control the format of the output of |:hardcopy|.
6396 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006398 *'prompt'* *'noprompt'*
6399'prompt' boolean (default on)
6400 global
6401 When on a ":" prompt is used in Ex mode.
6402
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006403 *'pumheight'* *'ph'*
6404'pumheight' 'ph' number (default 0)
6405 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006406 Determines the maximum number of items to show in the popup menu for
6407 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006408 |ins-completion-menu|.
6409
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006410 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006411'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006412 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006413 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006414 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006415
Bram Moolenaard94464e2015-11-02 15:28:18 +01006416 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006417'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006418 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006419 {only available when compiled with the |+python/dyn|
6420 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006421 Specifies the name of the Python 2.x shared library. The default is
6422 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006423 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006424 This option cannot be set from a |modeline| or in the |sandbox|, for
6425 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006426
Bram Moolenaar94073162018-01-31 21:49:05 +01006427 *'pythonhome'*
6428'pythonhome' string (default "")
6429 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006430 {only available when compiled with the |+python/dyn|
6431 feature}
6432 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6433 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6434 which was specified at compile time, will be used for the Python 2.x
6435 home directory.
6436 Environment variables are expanded |:set_env|.
6437 This option cannot be set from a |modeline| or in the |sandbox|, for
6438 security reasons.
6439
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006440 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006441'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006442 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006443 {only available when compiled with the |+python3/dyn|
6444 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006445 Specifies the name of the Python 3 shared library. The default is
6446 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006447 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006448 This option cannot be set from a |modeline| or in the |sandbox|, for
6449 security reasons.
6450
Bram Moolenaar94073162018-01-31 21:49:05 +01006451 *'pythonthreehome'*
6452'pythonthreehome' string (default "")
6453 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006454 {only available when compiled with the |+python3/dyn|
6455 feature}
6456 Specifies the name of the Python 3 home directory. When
6457 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6458 PYTHON3_HOME, which was specified at compile time, will be used for
6459 the Python 3 home directory.
6460 Environment variables are expanded |:set_env|.
6461 This option cannot be set from a |modeline| or in the |sandbox|, for
6462 security reasons.
6463
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006464 *'pyxversion'* *'pyx'*
6465'pyxversion' 'pyx' number (default depends on the build)
6466 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006467 {only available when compiled with the |+python| or
6468 the |+python3| feature}
6469 Specifies the python version used for pyx* functions and commands
6470 |python_x|. The default value is as follows:
6471
6472 Compiled with Default ~
6473 |+python| and |+python3| 0
6474 only |+python| 2
6475 only |+python3| 3
6476
6477 Available values are 0, 2 and 3.
6478 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6479 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6480 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6481 to 2 if Python 2 is available.
6482 See also: |has-pythonx|
6483
6484 If Vim is compiled with only |+python| or |+python3| setting
6485 'pyxversion' has no effect. The pyx* functions and commands are
6486 always the same as the compiled version.
6487
6488 This option cannot be set from a |modeline| or in the |sandbox|, for
6489 security reasons.
6490
Bram Moolenaar858ba062020-05-31 23:11:59 +02006491 *'quickfixtextfunc'* *'qftf'*
6492'quickfixtextfunc' 'qftf' string (default "")
6493 global
6494 {only available when compiled with the |+quickfix|
6495 feature}
6496 This option specifies a function to be used to get the text to display
6497 in the quickfix and location list windows. This can be used to
6498 customize the information displayed in the quickfix or location window
6499 for each entry in the corresponding quickfix or location list. See
6500 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006501 function and an example. The value can be the name of a function, a
6502 |lambda| or a |Funcref|. See |option-value-function| for more
6503 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006504
6505 This option cannot be set from a |modeline| or in the |sandbox|, for
6506 security reasons.
6507
Bram Moolenaar677ee682005-01-27 14:41:15 +00006508 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006509'quoteescape' 'qe' string (default "\")
6510 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006511 The characters that are used to escape quotes in a string. Used for
6512 objects like a', a" and a` |a'|.
6513 When one of the characters in this option is found inside a string,
6514 the following character will be skipped. The default value makes the
6515 text "foo\"bar\\" considered to be one string.
6516
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6518'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006519 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 If on, writes fail unless you use a '!'. Protects you from
6521 accidentally overwriting a file. Default on when Vim is started
6522 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006523 When using ":w!" the 'readonly' option is reset for the current
6524 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006525 When using the ":view" command the 'readonly' option is set for the
6526 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006527 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006529 *'redrawtime'* *'rdt'*
6530'redrawtime' 'rdt' number (default 2000)
6531 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006532 {only available when compiled with the |+reltime|
6533 feature}
6534 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006535 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006536 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006537 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006538 matches will be highlighted.
6539 For syntax highlighting the time applies per window. When over the
6540 limit syntax highlighting is disabled until |CTRL-L| is used.
6541 This is used to avoid that Vim hangs when using a very complicated
6542 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006543
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006544 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006545'regexpengine' 're' number (default 0)
6546 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006547 This selects the default regexp engine. |two-engines|
6548 The possible values are:
6549 0 automatic selection
6550 1 old engine
6551 2 NFA engine
6552 Note that when using the NFA engine and the pattern contains something
6553 that is not supported the pattern will not match. This is only useful
6554 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006555 Using automatic selection enables Vim to switch the engine, if the
6556 default engine becomes too costly. E.g., when the NFA engine uses too
6557 many states. This should prevent Vim from hanging on a combination of
6558 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006559
Bram Moolenaar64486672010-05-16 15:46:46 +02006560 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6561'relativenumber' 'rnu' boolean (default off)
6562 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006563 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006564 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006565 precede some vertical motion commands (e.g. j k + -) with, without
6566 having to calculate it yourself. Especially useful in combination with
6567 other commands (e.g. y d c < > gq gw =).
6568 When the 'n' option is excluded from 'cpoptions' a wrapped
6569 line will not use the column of line numbers (this is the default when
6570 'compatible' isn't set).
6571 The 'numberwidth' option can be used to set the room used for the line
6572 number.
6573 When a long, wrapped line doesn't start with the first character, '-'
6574 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006575 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6576 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006577
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006578 The number in front of the cursor line also depends on the value of
6579 'number', see |number_relativenumber| for all combinations of the two
6580 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006581
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 *'remap'* *'noremap'*
6583'remap' boolean (default on)
6584 global
6585 Allows for mappings to work recursively. If you do not want this for
6586 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006587 NOTE: To avoid portability problems with Vim scripts, always keep
6588 this option at the default "on". Only switch it off when working with
6589 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590
zeertzjqd086b8f2024-02-25 15:42:52 +08006591 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006592'renderoptions' 'rop' string (default: empty)
6593 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006594 {only available when compiled with GUI and DIRECTX on
6595 MS-Windows}
6596 Select a text renderer and set its options. The options depend on the
6597 renderer.
6598
6599 Syntax: >
6600 set rop=type:{renderer}(,{name}:{value})*
6601<
6602 Currently, only one optional renderer is available.
6603
6604 render behavior ~
6605 directx Vim will draw text using DirectX (DirectWrite). It makes
6606 drawn glyphs more beautiful than default GDI.
6607 It requires 'encoding' is "utf-8", and only works on
6608 MS-Windows Vista or newer version.
6609
6610 Options:
6611 name meaning type value ~
6612 gamma gamma float 1.0 - 2.2 (maybe)
6613 contrast enhancedContrast float (unknown)
6614 level clearTypeLevel float (unknown)
6615 geom pixelGeometry int 0 - 2 (see below)
6616 renmode renderingMode int 0 - 6 (see below)
6617 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006618 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006619
Bram Moolenaar92467d32017-12-05 13:22:16 +01006620 See this URL for detail (except for scrlines):
6621 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006622
6623 For geom: structure of a device pixel.
6624 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6625 1 - DWRITE_PIXEL_GEOMETRY_RGB
6626 2 - DWRITE_PIXEL_GEOMETRY_BGR
6627
6628 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006629 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006630
6631 For renmode: method of rendering glyphs.
6632 0 - DWRITE_RENDERING_MODE_DEFAULT
6633 1 - DWRITE_RENDERING_MODE_ALIASED
6634 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6635 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6636 4 - DWRITE_RENDERING_MODE_NATURAL
6637 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6638 6 - DWRITE_RENDERING_MODE_OUTLINE
6639
6640 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006641 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006642
6643 For taamode: antialiasing mode used for drawing text.
6644 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6645 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6646 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6647 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6648
6649 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006650 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6651
Bram Moolenaara338adc2018-01-31 20:51:47 +01006652 For scrlines:
6653 This was used for optimizing scrolling behavior, however this
6654 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006655
6656 Example: >
6657 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006658 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006659 set rop=type:directx
6660<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006661 If select a raster font (Courier, Terminal or FixedSys which
6662 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006663 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006664
6665 NOTE: It is known that some fonts and options combination
6666 causes trouble on drawing glyphs.
6667
Bram Moolenaar92467d32017-12-05 13:22:16 +01006668 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006669 special made fonts (True-Type fonts which includes only
6670 bitmap glyphs).
6671 - 'taamode:3' will not work with some vector fonts.
6672
6673 NOTE: With this option, you can display colored emoji
6674 (emoticon) in Windows 8.1 or later. To display colored emoji,
6675 there are some conditions which you should notice.
6676
6677 - If your font includes non-colored emoji already, it will
6678 be used.
6679 - If your font doesn't have emoji, the system chooses an
6680 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6681 will be used.
6682 - When this alternative font didn't have fixed width glyph,
6683 emoji might be rendered beyond the bounding box of drawing
6684 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006685
6686 Other render types are currently not supported.
6687
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 *'report'*
6689'report' number (default 2)
6690 global
6691 Threshold for reporting number of lines changed. When the number of
6692 changed lines is more than 'report' a message will be given for most
6693 ":" commands. If you want it always, set 'report' to 0.
6694 For the ":substitute" command the number of substitutions is used
6695 instead of the number of lines.
6696
6697 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6698'restorescreen' 'rs' boolean (default on)
6699 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006700 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 When set, the screen contents is restored when exiting Vim. This also
6702 happens when executing external commands.
6703
6704 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6705 options in your .vimrc. To disable restoring:
6706 set t_ti= t_te=
6707 To enable restoring (for an xterm):
6708 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6709 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6710
6711 *'revins'* *'ri'* *'norevins'* *'nori'*
6712'revins' 'ri' boolean (default off)
6713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 {only available when compiled with the |+rightleft|
6715 feature}
6716 Inserting characters in Insert mode will work backwards. See "typing
6717 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6718 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006719 NOTE: This option is reset when 'compatible' is set.
6720 This option is reset when 'paste' is set and restored when 'paste' is
6721 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722
6723 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6724'rightleft' 'rl' boolean (default off)
6725 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 {only available when compiled with the |+rightleft|
6727 feature}
6728 When on, display orientation becomes right-to-left, i.e., characters
6729 that are stored in the file appear from the right to the left.
6730 Using this option, it is possible to edit files for languages that
6731 are written from the right to the left such as Hebrew and Arabic.
6732 This option is per window, so it is possible to edit mixed files
6733 simultaneously, or to view the same file in both ways (this is
6734 useful whenever you have a mixed text file with both right-to-left
6735 and left-to-right strings so that both sets are displayed properly
6736 in different windows). Also see |rileft.txt|.
6737
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006738 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739'rightleftcmd' 'rlc' string (default "search")
6740 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 {only available when compiled with the |+rightleft|
6742 feature}
6743 Each word in this option enables the command line editing to work in
6744 right-to-left mode for a group of commands:
6745
6746 search "/" and "?" commands
6747
6748 This is useful for languages such as Hebrew, Arabic and Farsi.
6749 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6750
Bram Moolenaard94464e2015-11-02 15:28:18 +01006751 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006752'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006753 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006754 {only available when compiled with the |+ruby/dyn|
6755 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006756 Specifies the name of the Ruby shared library. The default is
6757 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006758 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006759 This option cannot be set from a |modeline| or in the |sandbox|, for
6760 security reasons.
6761
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006763'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 text in the file is shown on the far right:
6768 Top first line is visible
6769 Bot last line is visible
6770 All first and last line are visible
6771 45% relative position in the file
6772 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006773 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006774 ruler is shown there. Otherwise it is shown in the last line of the
6775 screen. If the statusline is given by 'statusline' (i.e. not empty),
6776 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006778 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 the text column (byte number) and the screen column are shown,
6780 separated with a dash.
6781 For an empty line "0-1" is shown.
6782 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006783 This option is reset when 'paste' is set and restored when 'paste' is
6784 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 If you don't want to see the ruler all the time but want to know where
6786 you are, use "g CTRL-G" |g_CTRL-G|.
6787 NOTE: This option is reset when 'compatible' is set.
6788
6789 *'rulerformat'* *'ruf'*
6790'rulerformat' 'ruf' string (default empty)
6791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 {not available when compiled without the |+statusline|
6793 feature}
6794 When this option is not empty, it determines the content of the ruler
6795 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006796 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006797 This option cannot be set in a modeline when 'modelineexpr' is off.
6798
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 The default ruler width is 17 characters. To make the ruler 15
6800 characters wide, put "%15(" at the start and "%)" at the end.
6801 Example: >
6802 :set rulerformat=%15(%c%V\ %p%%%)
6803<
6804 *'runtimepath'* *'rtp'* *vimfiles*
6805'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006806 Unix: "$HOME/.vim or
6807 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 $VIM/vimfiles,
6809 $VIMRUNTIME,
6810 $VIM/vimfiles/after,
6811 $HOME/.vim/after"
6812 Amiga: "home:vimfiles,
6813 $VIM/vimfiles,
6814 $VIMRUNTIME,
6815 $VIM/vimfiles/after,
6816 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006817 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 $VIM/vimfiles,
6819 $VIMRUNTIME,
6820 $VIM/vimfiles/after,
6821 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006822 Haiku: "$BE_USER_SETTINGS/vim,
6823 $VIM/vimfiles,
6824 $VIMRUNTIME,
6825 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006826 $BE_USER_SETTINGS/vim/after"
6827 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 $VIM/vimfiles,
6829 $VIMRUNTIME,
6830 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006831 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 This is a list of directories which will be searched for runtime
6834 files:
6835 filetype.vim filetypes by file name |new-filetype|
6836 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006837 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 colors/ color scheme files |:colorscheme|
6839 compiler/ compiler files |:compiler|
6840 doc/ documentation |write-local-help|
6841 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006842 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 indent/ indent scripts |indent-expression|
6844 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006845 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006847 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 plugin/ plugin scripts |write-plugin|
6849 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006850 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 syntax/ syntax files |mysyntaxfile|
6852 tutor/ files for vimtutor |tutor|
6853
6854 And any other file searched for with the |:runtime| command.
6855
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006856 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6857
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 The defaults for most systems are setup to search five locations:
6859 1. In your home directory, for your personal preferences.
6860 2. In a system-wide Vim directory, for preferences from the system
6861 administrator.
6862 3. In $VIMRUNTIME, for files distributed with Vim.
6863 *after-directory*
6864 4. In the "after" directory in the system-wide Vim directory. This is
6865 for the system administrator to overrule or add to the distributed
6866 defaults (rarely needed)
6867 5. In the "after" directory in your home directory. This is for
6868 personal preferences to overrule or add to the distributed defaults
6869 or system-wide settings (rarely needed).
6870
Bram Moolenaard0796902016-09-16 20:02:31 +02006871 More entries are added when using |packages|. If it gets very long
6872 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6873 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006874
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6876 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006877 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 wildcards.
6879 See |:runtime|.
6880 Example: >
6881 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6882< This will use the directory "~/vimruntime" first (containing your
6883 personal Vim runtime files), then "/mygroup/vim" (shared between a
6884 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6885 files).
6886 You probably should always include $VIMRUNTIME somewhere, to use the
6887 distributed runtime files. You can put a directory before $VIMRUNTIME
6888 to find files which replace a distributed runtime files. You can put
6889 a directory after $VIMRUNTIME to find files which add to distributed
6890 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006891 When Vim is started with |--clean| the home directory entries are not
6892 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 This option cannot be set from a |modeline| or in the |sandbox|, for
6894 security reasons.
6895
6896 *'scroll'* *'scr'*
6897'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006898 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6900 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006901 changes. This may happen when enabling the |status-line| or
6902 'tabline' option after setting the 'scroll' option.
6903 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006904 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006905 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906
6907 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6908'scrollbind' 'scb' boolean (default off)
6909 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006910 See also |scroll-binding|. When this option is set, scrolling the
6911 current window also scrolls other scrollbind windows (windows that
6912 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 differences between two versions of a file, see 'diff'.
6914 See |'scrollopt'| for options that determine how this option should be
6915 interpreted.
6916 This option is mostly reset when splitting a window to edit another
6917 file. This means that ":split | edit file" results in two windows
6918 with scroll-binding, but ":split file" does not.
6919
Bram Moolenaarae20f342019-11-05 21:09:23 +01006920 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6921'scrollfocus' 'scf' boolean (default off)
6922 global
6923 {only for MS-Windows GUI}
6924 When using the scroll wheel and this option is set, the window under
6925 the mouse pointer is scrolled. With this option off the current
6926 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006927 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006928
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 *'scrolljump'* *'sj'*
6930'scrolljump' 'sj' number (default 1)
6931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 Minimal number of lines to scroll when the cursor gets off the
6933 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6934 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006935 When set to a negative number from -1 to -100 this is used as the
6936 percentage of the window height. Thus -50 scrolls half the window
6937 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 NOTE: This option is set to 1 when 'compatible' is set.
6939
6940 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006941'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006942 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 Minimal number of screen lines to keep above and below the cursor.
6944 This will make some context visible around where you are working. If
6945 you set it to a very large value (999) the cursor line will always be
6946 in the middle of the window (except at the start or end of the file or
6947 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006948 After using the local value, go back the global value with one of
6949 these two: >
6950 setlocal scrolloff<
6951 setlocal scrolloff=-1
6952< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 NOTE: This option is set to 0 when 'compatible' is set.
6954
6955 *'scrollopt'* *'sbo'*
6956'scrollopt' 'sbo' string (default "ver,jump")
6957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006959 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6960 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 The following words are available:
6962 ver Bind vertical scrolling for 'scrollbind' windows
6963 hor Bind horizontal scrolling for 'scrollbind' windows
6964 jump Applies to the offset between two windows for vertical
6965 scrolling. This offset is the difference in the first
6966 displayed line of the bound windows. When moving
6967 around in a window, another 'scrollbind' window may
6968 reach a position before the start or after the end of
6969 the buffer. The offset is not changed though, when
6970 moving back the 'scrollbind' window will try to scroll
6971 to the desired position when possible.
6972 When now making that window the current one, two
6973 things can be done with the relative offset:
6974 1. When "jump" is not included, the relative offset is
6975 adjusted for the scroll position in the new current
6976 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006977 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 2. When "jump" is included, the other windows are
6979 scrolled to keep the same relative offset. When
6980 going back to the other window, it still uses the
6981 same relative offset.
6982 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006983 When 'diff' mode is active there always is vertical scroll binding,
6984 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985
6986 *'sections'* *'sect'*
6987'sections' 'sect' string (default "SHNHH HUnhsh")
6988 global
6989 Specifies the nroff macros that separate sections. These are pairs of
6990 two letters (See |object-motions|). The default makes a section start
6991 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6992
6993 *'secure'* *'nosecure'* *E523*
6994'secure' boolean (default off)
6995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 When on, ":autocmd", shell and write commands are not allowed in
6997 ".vimrc" and ".exrc" in the current directory and map commands are
6998 displayed. Switch it off only if you know that you will not run into
6999 problems, or when the 'exrc' option is off. On Unix this option is
7000 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007001 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 'secure' at the end of your ~/.vimrc then.
7003 This option cannot be set from a |modeline| or in the |sandbox|, for
7004 security reasons.
7005
7006 *'selection'* *'sel'*
7007'selection' 'sel' string (default "inclusive")
7008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 This option defines the behavior of the selection. It is only used
7010 in Visual and Select mode.
7011 Possible values:
7012 value past line inclusive ~
7013 old no yes
7014 inclusive yes yes
7015 exclusive yes no
7016 "past line" means that the cursor is allowed to be positioned one
7017 character past the line.
7018 "inclusive" means that the last character of the selection is included
7019 in an operation. For example, when "x" is used to delete the
7020 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007021 When "old" is used and 'virtualedit' allows the cursor to move past
7022 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007023 When "exclusive" is used, cursor position in visual mode will be
7024 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 Note that when "exclusive" is used and selecting from the end
7026 backwards, you cannot include the last character of a line, when
7027 starting in Normal mode and 'virtualedit' empty.
7028
7029 The 'selection' option is set by the |:behave| command.
7030
7031 *'selectmode'* *'slm'*
7032'selectmode' 'slm' string (default "")
7033 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007034 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 Select mode instead of Visual mode, when a selection is started.
7036 Possible values:
7037 mouse when using the mouse
7038 key when using shifted special keys
7039 cmd when using "v", "V" or CTRL-V
7040 See |Select-mode|.
7041 The 'selectmode' option is set by the |:behave| command.
7042
7043 *'sessionoptions'* *'ssop'*
7044'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007045 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007047 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 feature}
7049 Changes the effect of the |:mksession| command. It is a comma
7050 separated list of words. Each word enables saving and restoring
7051 something:
7052 word save and restore ~
7053 blank empty windows
7054 buffers hidden and unloaded buffers, not just those in windows
7055 curdir the current directory
7056 folds manually created folds, opened/closed folds and local
7057 fold options
7058 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007059 and contain at least one lowercase letter. Only
7060 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 help the help window
7062 localoptions options and mappings local to a window or buffer (not
7063 global values for local options)
7064 options all options and mappings (also global values for local
7065 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007066 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 resize size of the Vim window: 'lines' and 'columns'
7068 sesdir the directory in which the session file is located
7069 will become the current directory (useful with
7070 projects accessed over a network from different
7071 systems)
7072 slash backslashes in file names replaced with forward
7073 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007074 tabpages all tab pages; without this only the current tab page
7075 is restored, so that you can make a session for each
7076 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007077 terminal include terminal windows where the command can be
7078 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 unix with Unix end-of-line format (single <NL>), even when
7080 on Windows or DOS
7081 winpos position of the whole Vim window
7082 winsize window sizes
7083
7084 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007085 When neither "curdir" nor "sesdir" is included, file names are stored
7086 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007087 If you leave out "options" many things won't work well after restoring
7088 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 "slash" and "unix" are useful on Windows when sharing session files
7090 with Unix. The Unix version of Vim cannot source dos format scripts,
7091 but the Windows version of Vim can source unix format scripts.
7092
7093 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007094'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 global
7096 Name of the shell to use for ! and :! commands. When changing the
7097 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7098 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007099 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 See |option-backslash| about including spaces and backslashes.
7101 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007102
Bram Moolenaara2baa732022-02-04 16:09:54 +00007103 In |restricted-mode| shell commands will not be possible. This mode
7104 is used if the value of $SHELL ends in "false" or "nologin".
7105
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007106 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007107 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7109< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007110 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007112 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007114 Example with escaped space (Vim will do this when initializing the
7115 option from $SHELL): >
7116 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007117< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007118 backslashes are consumed by `:set`.
7119
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 Under MS-Windows, when the executable ends in ".com" it must be
7121 included. Thus setting the shell to "command.com" or "4dos.com"
7122 works, but "command" and "4dos" do not work for all commands (e.g.,
7123 filtering).
7124 For unknown reasons, when using "4dos.com" the current directory is
7125 changed to "C:\". To avoid this set 'shell' like this: >
7126 :set shell=command.com\ /c\ 4dos
7127< This option cannot be set from a |modeline| or in the |sandbox|, for
7128 security reasons.
7129
7130 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007131'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007132 Win32, when 'shell' contains "powershell":
7133 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007134 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007137 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7138 For MS-Windows, the default is set according to the value of 'shell',
7139 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007140 On Unix it can have more than one flag. Each white space separated
7141 part is passed as an argument to the shell command.
7142 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007143 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 This option cannot be set from a |modeline| or in the |sandbox|, for
7145 security reasons.
7146
7147 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007148'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7149 "2>&1| tee", or
7150 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 {not available when compiled without the |+quickfix|
7153 feature}
7154 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007155 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 including spaces and backslashes.
7157 The name of the temporary file can be represented by "%s" if necessary
7158 (the file name is appended automatically if no %s appears in the value
7159 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007160 For the Amiga the default is ">". For MS-Windows using powershell the
7161 default is "2>&1 | Out-File -Encoding default", otherwise the default
7162 is ">%s 2>&1". The output is directly saved in a file and not echoed
7163 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007164 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 in a file and echoed to the screen. If the 'shell' option is "csh" or
7166 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007167 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007168 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7169 means that stderr is also included. Before using the 'shell' option a
7170 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007171 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7172 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 The initialization of this option is done after reading the ".vimrc"
7174 and the other initializations, so that when the 'shell' option is set
7175 there, the 'shellpipe' option changes automatically, unless it was
7176 explicitly set before.
7177 When 'shellpipe' is set to an empty string, no redirection of the
7178 ":make" output will be done. This is useful if you use a 'makeprg'
7179 that writes to 'makeef' by itself. If you want no piping, but do
7180 want to include the 'makeef', set 'shellpipe' to a single space.
7181 Don't forget to precede the space with a backslash: ":set sp=\ ".
7182 In the future pipes may be used for filtering and this option will
7183 become obsolete (at least for Unix).
7184 This option cannot be set from a |modeline| or in the |sandbox|, for
7185 security reasons.
7186
7187 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007188'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 Quoting character(s), put around the command passed to the shell, for
7191 the "!" and ":!" commands. The redirection is kept outside of the
7192 quoting. See 'shellxquote' to include the redirection. It's
7193 probably not useful to set both options.
7194 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007195 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007196 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 This option cannot be set from a |modeline| or in the |sandbox|, for
7198 security reasons.
7199
7200 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007201'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7202 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 String to be used to put the output of a filter command in a temporary
7205 file. See also |:!|. See |option-backslash| about including spaces
7206 and backslashes.
7207 The name of the temporary file can be represented by "%s" if necessary
7208 (the file name is appended automatically if no %s appears in the value
7209 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007210 The default is ">". For Unix, if the 'shell' option is "csh" or
7211 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007212 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007213 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7214 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007215 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7216 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007217 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7218 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 The initialization of this option is done after reading the ".vimrc"
7220 and the other initializations, so that when the 'shell' option is set
7221 there, the 'shellredir' option changes automatically unless it was
7222 explicitly set before.
7223 In the future pipes may be used for filtering and this option will
7224 become obsolete (at least for Unix).
7225 This option cannot be set from a |modeline| or in the |sandbox|, for
7226 security reasons.
7227
7228 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7229'shellslash' 'ssl' boolean (default off)
7230 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007231 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007233 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007234 powershell.exe. Backward slashes can still be typed, but they are
7235 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 Note that setting or resetting this option has no effect for some
7237 existing file names, thus this option needs to be set before opening
7238 any file for best results. This might change in the future.
7239 'shellslash' only works when a backslash can be used as a path
7240 separator. To test if this is so use: >
7241 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007242< Also see 'completeslash'.
7243
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007244 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7245'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7246 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007247 When on, use temp files for shell commands. When off use a pipe.
7248 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007249 Currently a pipe is only supported on Unix and MS-Windows 2K and
7250 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007251 :if has("filterpipe")
7252< The advantage of using a pipe is that nobody can read the temp file
7253 and the 'shell' command does not need to support redirection.
7254 The advantage of using a temp file is that the file type and encoding
7255 can be detected.
7256 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7257 |FilterWritePost| autocommands event are not triggered when
7258 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007259 The `system()` function does not respect this option and always uses
7260 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007261 NOTE: This option is set to the Vim default value when 'compatible'
7262 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007263
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 *'shelltype'* *'st'*
7265'shelltype' 'st' number (default 0)
7266 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007267 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 On the Amiga this option influences the way how the commands work
7269 which use a shell.
7270 0 and 1: always use the shell
7271 2 and 3: use the shell only to filter lines
7272 4 and 5: use shell only for ':sh' command
7273 When not using the shell, the command is executed directly.
7274
7275 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7276 1 and 3: use "shell cmd" to start external commands
7277
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007278 *'shellxescape'* *'sxe'*
7279'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007280 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007281 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007282 When 'shellxquote' is set to "(" then the characters listed in this
7283 option will be escaped with a '^' character. This makes it possible
7284 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007285 This option cannot be set from a |modeline| or in the |sandbox|, for
7286 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007287
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 *'shellxquote'* *'sxq'*
7289'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007290 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007291 for Win32, when 'shell' is
7292 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007293 for Win32, when 'shell' contains "sh"
7294 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 for Unix, when using system(): "\"")
7296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 Quoting character(s), put around the command passed to the shell, for
7298 the "!" and ":!" commands. Includes the redirection. See
7299 'shellquote' to exclude the redirection. It's probably not useful
7300 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007301 When the value is '(' then ')' is appended. When the value is '"('
7302 then ')"' is appended.
7303 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007304 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007305 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7306 pwsh.exe which automatically strips off the first and last quote on a
7307 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7308 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007309 'shell', to reduce the need to set this option by the user. See
7310 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 This option cannot be set from a |modeline| or in the |sandbox|, for
7312 security reasons.
7313
7314 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7315'shiftround' 'sr' boolean (default off)
7316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 Round indent to multiple of 'shiftwidth'. Applies to > and <
7318 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7319 a multiple of 'shiftwidth' (this is Vi compatible).
7320 NOTE: This option is reset when 'compatible' is set.
7321
7322 *'shiftwidth'* *'sw'*
7323'shiftwidth' 'sw' number (default 8)
7324 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007325 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007327 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007328 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
7330 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007331'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7332 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007333 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007335 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 It is a list of flags:
7337 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007338 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7339 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7340 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7341 m use "[+]" instead of "[Modified]" *shm-m*
7342 n use "[New]" instead of "[New File]" *shm-n*
7343 r use "[RO]" instead of "[readonly]" *shm-r*
7344 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007346 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7347 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007348 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007349 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007351 o overwrite message for writing a file with subsequent *shm-o*
7352 message for reading a file (useful for ":wn" or when
7353 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007354 O message for reading a file overwrites any previous *shm-O*
7355 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007356 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7357 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007358 the search count do not show "W" before the count message
7359 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007360 t truncate file message at the start if it is too long *shm-t*
7361 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007362 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007363 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007364 long to fit on the command line; "..." will appear in the
7365 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007366 W don't give "written" or "[w]" when writing a file *shm-W*
7367 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007368 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007369 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007370 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007371 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007372 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7373 match", "Pattern not found", "Back at original", etc.
7374 C don't give messages while scanning for ins-completion *shm-C*
7375 items, for instance "scanning tags"
7376 q use "recording" instead of "recording @a" *shm-q*
7377 F don't give the file info when editing a file, like *shm-F*
7378 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007379 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007380 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007381 "[1/5]". When the "S" flag is not present (e.g. search count
7382 is shown), the "search hit BOTTOM, continuing at TOP" and
7383 "search hit TOP, continuing at BOTTOM" messages are only
7384 indicated by a "W" (Mnemonic: Wrapped) letter before the
7385 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386
7387 This gives you the opportunity to avoid that a change between buffers
7388 requires you to hit <Enter>, but still gives as useful a message as
7389 possible for the space available. To get the whole message that you
7390 would have got with 'shm' empty, use ":file!"
7391 Useful values:
7392 shm= No abbreviation of message.
7393 shm=a Abbreviation, but no loss of information.
7394 shm=at Abbreviation, and truncate message when necessary.
7395
7396 NOTE: This option is set to the Vi default value when 'compatible' is
7397 set and to the Vim default value when 'compatible' is reset.
7398
7399 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7400'shortname' 'sn' boolean (default off)
7401 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 Filenames are assumed to be 8 characters plus one extension of 3
7403 characters. Multiple dots in file names are not allowed. When this
7404 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007405 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007407 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408
7409 *'showbreak'* *'sbr'* *E595*
7410'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007411 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007412 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 feature}
7414 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007415 values are "> " or "+++ ": >
7416 :set showbreak=>\
7417< Note the backslash to escape the trailing space. It's easier like
7418 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007419 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007420< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 comma (in a future version the comma might be used to separate the
7422 part that is shown at the end and at the start of a line).
7423 The characters are highlighted according to the '@' flag in
7424 'highlight'.
7425 Note that tabs after the showbreak will be displayed differently.
7426 If you want the 'showbreak' to appear in between line numbers, add the
7427 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007428 A window-local value overrules a global value. If the global value is
7429 set and you want no value in the current window use NONE: >
7430 :setlocal showbreak=NONE
7431<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007433'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7434 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007436 Show (partial) command in the last line of the screen. Set this
7437 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 In Visual mode the size of the selected area is shown:
7439 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007440 If the number of bytes is different it is also displayed: "2-6"
7441 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007443 - When selecting a block, the size in screen characters:
7444 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007445 This information can be displayed in an alternative location using the
7446 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 NOTE: This option is set to the Vi default value when 'compatible' is
7448 set and to the Vim default value when 'compatible' is reset.
7449
Luuk van Baalba936f62022-12-15 13:15:39 +00007450 *'showcmdloc'* *'sloc'*
7451'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007452 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007453 This option can be used to display the (partially) entered command in
7454 another location. Possible values are:
7455 last Last line of the screen (default).
7456 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007457 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007458 Setting this option to "statusline" or "tabline" means that these will
7459 be redrawn whenever the command changes, which can be on every key
7460 pressed.
7461 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7462 place the text. Without a custom 'statusline' or 'tabline' it will be
7463 displayed in a convenient location.
7464
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7466'showfulltag' 'sft' boolean (default off)
7467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 When completing a word in insert mode (see |ins-completion|) from the
7469 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 matched a C function, you can see a template for what arguments are
7472 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007473 Note that this doesn't work well together with having "longest" in
7474 'completeopt', because the completion from the search pattern may not
7475 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476
7477 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7478'showmatch' 'sm' boolean (default off)
7479 global
7480 When a bracket is inserted, briefly jump to the matching one. The
7481 jump is only done if the match can be seen on the screen. The time to
7482 show the match can be set with 'matchtime'.
7483 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007484 seen or not).
7485 This option is reset when 'paste' is set and restored when 'paste' is
7486 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 When the 'm' flag is not included in 'cpoptions', typing a character
7488 will immediately move the cursor back to where it belongs.
7489 See the "sm" field in 'guicursor' for setting the cursor shape and
7490 blinking when showing the match.
7491 The 'matchpairs' option can be used to specify the characters to show
7492 matches for. 'rightleft' and 'revins' are used to look for opposite
7493 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007494 Also see the matchparen plugin for highlighting the match when moving
7495 around |pi_paren.txt|.
7496 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497
7498 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7499'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7500 global
7501 If in Insert, Replace or Visual mode put a message on the last line.
7502 Use the 'M' flag in 'highlight' to set the type of highlighting for
7503 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007504 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 doesn't mean XIM is really active, especially when 'imactivatekey' is
7506 not set.
7507 NOTE: This option is set to the Vi default value when 'compatible' is
7508 set and to the Vim default value when 'compatible' is reset.
7509
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007510 *'showtabline'* *'stal'*
7511'showtabline' 'stal' number (default 1)
7512 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007513 The value of this option specifies when the line with tab page labels
7514 will be displayed:
7515 0: never
7516 1: only if there are at least two tab pages
7517 2: always
7518 This is both for the GUI and non-GUI implementation of the tab pages
7519 line.
7520 See |tab-page| for more information about tab pages.
7521
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 *'sidescroll'* *'ss'*
7523'sidescroll' 'ss' number (default 0)
7524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 The minimal number of columns to scroll horizontally. Used only when
7526 the 'wrap' option is off and the cursor is moved off of the screen.
7527 When it is zero the cursor will be put in the middle of the screen.
7528 When using a slow terminal set it to a large number or 0. When using
7529 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7530 commands.
7531
7532 *'sidescrolloff'* *'siso'*
7533'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007534 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007536 right of the cursor if 'nowrap' is set. Setting this option to a
7537 value greater than 0 while having |'sidescroll'| also at a non-zero
7538 value makes some context visible in the line you are scrolling in
7539 horizontally (except at beginning of the line). Setting this option
7540 to a large value (like 999) has the effect of keeping the cursor
7541 horizontally centered in the window, as long as one does not come too
7542 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007543 After using the local value, go back the global value with one of
7544 these two: >
7545 setlocal sidescrolloff<
7546 setlocal sidescrolloff=-1
7547< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548
7549 Example: Try this together with 'sidescroll' and 'listchars' as
7550 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007551 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552
7553 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7554 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007555<
7556 *'signcolumn'* *'scl'*
7557'signcolumn' 'scl' string (default "auto")
7558 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007559 {not available when compiled without the |+signs|
7560 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007561 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007562 "auto" only when there is a sign to display
7563 "no" never
7564 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007565 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007566 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7569'smartcase' 'scs' boolean (default off)
7570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 Override the 'ignorecase' option if the search pattern contains upper
7572 case characters. Only used when the search pattern is typed and
7573 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007574 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7576 recalling the search pattern from history and hitting <Enter>.
7577 NOTE: This option is reset when 'compatible' is set.
7578
7579 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7580'smartindent' 'si' boolean (default off)
7581 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 Do smart autoindenting when starting a new line. Works for C-like
7583 programs, but can also be used for other languages. 'cindent' does
7584 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007585 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007586 setting 'si' has no effect. 'indentexpr' is a more advanced
7587 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 Normally 'autoindent' should also be on when using 'smartindent'.
7589 An indent is automatically inserted:
7590 - After a line ending in '{'.
7591 - After a line starting with a keyword from 'cinwords'.
7592 - Before a line starting with '}' (only with the "O" command).
7593 When typing '}' as the first character in a new line, that line is
7594 given the same indent as the matching '{'.
7595 When typing '#' as the first character in a new line, the indent for
7596 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007597 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7599 When using the ">>" command, lines starting with '#' are not shifted
7600 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007601 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007602 This option is reset when 'paste' is set and restored when 'paste' is
7603 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604
7605 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7606'smarttab' 'sta' boolean (default off)
7607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007609 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7610 <BS> will delete a 'shiftwidth' worth of space at the start of the
7611 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007612 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007613 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7614 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007615 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007617 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007618 This option is reset when 'paste' is set and restored when 'paste' is
7619 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 NOTE: This option is reset when 'compatible' is set.
7621
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007622 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7623'smoothscroll' 'sms' boolean (default off)
7624 local to window
7625 Scrolling works with screen lines. When 'wrap' is set and the first
7626 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007627 above the window. "<<<" is displayed at the start of the first line,
7628 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007629 You may also want to add "lastline" to the 'display' option to show as
7630 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007631 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007632
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 *'softtabstop'* *'sts'*
7634'softtabstop' 'sts' number (default 0)
7635 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 Number of spaces that a <Tab> counts for while performing editing
7637 operations, like inserting a <Tab> or using <BS>. It "feels" like
7638 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7639 used. This is useful to keep the 'ts' setting at its standard value
7640 of 8, while being able to edit like it is set to 'sts'. However,
7641 commands like "x" still work on the actual characters.
7642 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007643 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007644 'softtabstop' is set to 0 when the 'paste' option is set and restored
7645 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7647 spaces is minimized by using <Tab>s.
7648 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7649 set.
7650 NOTE: This option is set to 0 when 'compatible' is set.
7651
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007652 If Vim is compiled with the |+vartabs| feature then the value of
7653 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7654 anything other than an empty string.
7655
Bram Moolenaar217ad922005-03-20 22:37:15 +00007656 *'spell'* *'nospell'*
7657'spell' boolean (default off)
7658 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007659 {not available when compiled without the |+syntax|
7660 feature}
7661 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007662 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007663
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007664 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007665'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007666 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007667 {not available when compiled without the |+syntax|
7668 feature}
7669 Pattern to locate the end of a sentence. The following word will be
7670 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007671 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007672 When this check is not wanted make this option empty.
7673 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007674 Be careful with special characters, see |option-backslash| about
7675 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007676 To set this option automatically depending on the language, see
7677 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007678
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007679 *'spellfile'* *'spf'*
7680'spellfile' 'spf' string (default empty)
7681 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007682 {not available when compiled without the |+syntax|
7683 feature}
7684 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007685 commands. It must end in ".{encoding}.add". You need to include the
7686 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007687 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007688 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007689 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007690 |zg| and |zw| commands can be used to access each. This allows using
7691 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007692 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007693 you: Using the first directory in 'runtimepath' that is writable. If
7694 there is no "spell" directory yet it will be created. For the file
7695 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007696 ignoring the region.
7697 The resulting ".spl" file will be used for spell checking, it does not
7698 have to appear in 'spelllang'.
7699 Normally one file is used for all regions, but you can add the region
7700 name if you want to. However, it will then only be used when
7701 'spellfile' is set to it, for entries in 'spelllang' only files
7702 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007703 This option cannot be set from a |modeline| or in the |sandbox|, for
7704 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007705
Bram Moolenaar217ad922005-03-20 22:37:15 +00007706 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007707'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007708 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007709 {not available when compiled without the |+syntax|
7710 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007711 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007712 on spellchecking will be done for these languages. Example: >
7713 set spelllang=en_us,nl,medical
7714< This means US English, Dutch and medical words are recognized. Words
7715 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007716 The word list name must consist of alphanumeric characters, a dash or
7717 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007718 recommended to separate the two letter language name from a
7719 specification. Thus "en-rare" is used for rare English words.
7720 A region name must come last and have the form "_xx", where "xx" is
7721 the two-letter, lower case region name. You can use more than one
7722 region by listing them: "en_us,en_ca" supports both US and Canadian
7723 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007724 Britain. (Note: currently en_au and en_nz dictionaries are older than
7725 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007726 If the name "cjk" is included East Asian characters are excluded from
7727 spell checking. This is useful when editing text that also has Asian
7728 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007729 Note that the "medical" dictionary does not exist, it is just an
7730 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007731 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007732 As a special case the name of a .spl file can be given as-is. The
7733 first "_xx" in the name is removed and used as the region name
7734 (_xx is an underscore, two letters and followed by a non-letter).
7735 This is mainly for testing purposes. You must make sure the correct
7736 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007737 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007738 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7739 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007740 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007741
Bram Moolenaar98692072006-02-04 00:57:42 +00007742 If the |spellfile.vim| plugin is active and you use a language name
7743 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7744 will ask you if you want to download the file.
7745
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007746 After this option has been set successfully, Vim will source the files
7747 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007748 up to the first character that is not an ASCII letter or number and
7749 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007750
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007751 *'spelloptions'* *'spo'*
7752'spelloptions' 'spo' string (default "")
7753 local to buffer
7754 {not available when compiled without the |+syntax|
7755 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007756 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007757 camel When a word is CamelCased, assume "Cased" is a
7758 separate word: every upper-case character in a word
7759 that comes after a lower case character indicates the
7760 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007761
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007762 *'spellsuggest'* *'sps'*
7763'spellsuggest' 'sps' string (default "best")
7764 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007765 {not available when compiled without the |+syntax|
7766 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007767 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007768 the |spellsuggest()| function. This is a comma-separated list of
7769 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007770
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007771 best Internal method that works best for English. Finds
7772 changes like "fast" and uses a bit of sound-a-like
7773 scoring to improve the ordering.
7774
7775 double Internal method that uses two methods and mixes the
7776 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007777 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007778 word. That only works when the language specifies
7779 sound folding. Can be slow and doesn't always give
7780 better results.
7781
7782 fast Internal method that only checks for simple changes:
7783 character inserts/deletes/swaps. Works well for
7784 simple typing mistakes.
7785
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007786 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007787 Not used for |spellsuggest()|. The number of
7788 suggestions is never more than the value of 'lines'
7789 minus two.
7790
Bram Moolenaar585ee072022-01-29 11:22:17 +00007791 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007792 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007793 methods. When omitted the limit is 5000. When
7794 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007795 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007796
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007797 file:{filename} Read file {filename}, which must have two columns,
7798 separated by a slash. The first column contains the
7799 bad word, the second column the suggested good word.
7800 Example:
7801 theribal/terrible ~
7802 Use this for common mistakes that do not appear at the
7803 top of the suggestion list with the internal methods.
7804 Lines without a slash are ignored, use this for
7805 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007806 The word in the second column must be correct,
7807 otherwise it will not be used. Add the word to an
7808 ".add" file if it is currently flagged as a spelling
7809 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007810 The file is used for all languages.
7811
7812 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007813 trouble with spaces. Best is to call a function
7814 without arguments, see |expr-option-function|.
7815 |v:val| holds the badly spelled word. The expression
7816 must evaluate to a List of Lists, each with a
7817 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007818 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007819 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007820 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007821 internal methods use. A lower score is better.
7822 This may invoke |spellsuggest()| if you temporarily
7823 set 'spellsuggest' to exclude the "expr:" part.
7824 Errors are silently ignored, unless you set the
7825 'verbose' option to a non-zero value.
7826
7827 Only one of "best", "double" or "fast" may be used. The others may
7828 appear several times in any order. Example: >
7829 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7830<
7831 This option cannot be set from a |modeline| or in the |sandbox|, for
7832 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007833
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7835'splitbelow' 'sb' boolean (default off)
7836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 When on, splitting a window will put the new window below the current
7838 one. |:split|
7839
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007840 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007841'splitkeep' 'spk' string (default "cursor")
7842 global
7843 The value of this option determines the scroll behavior when opening,
7844 closing or resizing horizontal splits.
7845
7846 Possible values are:
7847 cursor Keep the same relative cursor position.
7848 screen Keep the text on the same screen line.
7849 topline Keep the topline the same.
7850
7851 For the "screen" and "topline" values, the cursor position will be
7852 changed when necessary. In this case, the jumplist will be populated
7853 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007854 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007855
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7857'splitright' 'spr' boolean (default off)
7858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 When on, splitting a window will put the new window right of the
7860 current one. |:vsplit|
7861
7862 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7863'startofline' 'sol' boolean (default on)
7864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007866 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007867 (if possible). This applies to the commands:
7868 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007869 - "d", "<<", "==" and ">>" with a linewise operator
7870 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007871 - "%" with a count
7872 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7873 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 In case of buffer changing commands the cursor is placed at the column
7875 where it was the last time the buffer was edited.
7876 NOTE: This option is set when 'compatible' is set.
7877
Bram Moolenaar00654022011-02-25 14:42:19 +01007878 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007880 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 {not available when compiled without the |+statusline|
7882 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007883 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 Also see |status-line|.
7885
7886 The option consists of printf style '%' items interspersed with
7887 normal text. Each status line item is of the form:
7888 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007889 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007890 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007892 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007893 When the option starts with "%!" then it is used as an expression,
7894 evaluated and the result is used as the option value. Example: >
7895 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007896< The *g:statusline_winid* variable will be set to the |window-ID| of the
7897 window that the status line belongs to.
7898 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007899 Note that the "%!" expression is evaluated in the context of the
7900 current window and buffer, while %{} items are evaluated in the
7901 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007902
7903 When there is error while evaluating the option then it will be made
7904 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007905 When the result contains unprintable characters the result is
7906 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007907
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 Note that the only effect of 'ruler' when this option is set (and
7909 'laststatus' is 2) is controlling the output of |CTRL-G|.
7910
7911 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007912 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007914 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 minwid Minimum width of the item, padding as set by '-' & '0'.
7916 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007917 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 on the left for text items. Numeric items will be
7919 shifted down to maxwid-2 digits followed by '>'number
7920 where number is the amount of missing digits, much like
7921 an exponential notation.
7922 item A one letter code as described below.
7923
7924 Following is a description of the possible statusline items. The
7925 second character in "item" is the type:
7926 N for number
7927 S for string
7928 F for flags as described below
7929 - not applicable
7930
7931 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007932 f S Path to the file in the buffer, as typed or relative to current
7933 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 F S Full path to the file in the buffer.
7935 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007936 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007938 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007940 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007942 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007944 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007946 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7948 being used: "<keymap>"
7949 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007950 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 B N As above, in hexadecimal.
7952 o N Byte number in file of byte under cursor, first byte is 1.
7953 Mnemonic: Offset from start of file (with one added)
7954 {not available when compiled without |+byte_offset| feature}
7955 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007956 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 l N Line number.
7958 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007959 c N Column number (byte index).
7960 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007961 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 p N Percentage through file in lines as in |CTRL-G|.
7963 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007964 percentage described for 'ruler'. Always 3 in length, unless
7965 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007966 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007967 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007969 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007970 Note that there is no '%' before the closing '}'. The
7971 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007972 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007973 {% - This is almost same as { except the result of the expression is
7974 re-evaluated as a statusline format string. Thus if the
7975 return value of expr contains % items they will get expanded.
7976 The expression can contain the } character, the end of
7977 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007978 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007979 func! Stl_filename() abort
7980 return "%t"
7981 endfunc
7982< `stl=%{Stl_filename()}` results in `"%t"`
7983 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007984 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 ( - Start of item group. Can be used for setting the width and
7986 alignment of a section. Must be followed by %) somewhere.
7987 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007988 T N For 'tabline': start of tab page N label. Use %T after the last
7989 label. This information is used for mouse clicks.
7990 X N For 'tabline': start of close tab N label. Use %X after the
7991 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7992 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 < - Where to truncate line if too long. Default is at the start.
7994 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007995 = - Separation point between alignment sections. Each section will
7996 be separated by an equal number of spaces. With one %= what
7997 comes after it will be right-aligned. With two %= there is a
7998 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008000 # - Set highlight group. The name must follow and then a # again.
8001 Thus use %#HLname# for highlight group HLname. The same
8002 highlighting is used, also for the statusline of non-current
8003 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008005 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008006 The difference between User{N} and StatusLine will be applied to
8007 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 The number N must be between 1 and 9. See |hl-User1..9|
8009
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008010 When displaying a flag, Vim removes the leading comma, if any, when
8011 that flag comes right after plaintext. This will make a nice display
8012 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013
Bram Moolenaar582fd852005-03-28 20:58:01 +00008014 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 not set) and a minwid is not set for the group, the whole group will
8016 become empty. This will make a group like the following disappear
8017 completely from the statusline when none of the flags are set. >
8018 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008019< Beware that an expression is evaluated each and every time the status
8020 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008021 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008022 While evaluating %{} the current buffer and current window will be set
8023 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008024 currently being drawn. The expression will evaluate in this context.
8025 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8026 real current buffer and "g:actual_curwin" to the |window-ID| of the
8027 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008028
Bram Moolenaar30b65812012-07-12 22:01:11 +02008029 The 'statusline' option will be evaluated in the |sandbox| if set from
8030 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008031 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008032
8033 It is not allowed to change text or jump to another window while
8034 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035
8036 If the statusline is not updated when you want it (e.g., after setting
8037 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008038 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008040 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 Otherwise the result is taken as flag text and applied to the rules
8042 described above.
8043
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008044 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008046 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047
8048 Examples:
8049 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008050 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051< Similar, but add ASCII value of char under the cursor (like "ga") >
8052 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8053< Display byte count and byte value, modified flag in red. >
8054 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8055 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8056< Display a ,GZ flag if a compressed file is loaded >
8057 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8058< In the |:autocmd|'s: >
8059 :let b:gzflag = 1
8060< And: >
8061 :unlet b:gzflag
8062< And define this function: >
8063 :function VarExists(var, val)
8064 : if exists(a:var) | return a:val | else | return '' | endif
8065 :endfunction
8066<
8067 *'suffixes'* *'su'*
8068'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 Files with these suffixes get a lower priority when multiple files
8071 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008072 suffixes. Spaces after the comma are ignored. A dot is also seen as
8073 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 separator, precede it with a backslash (see |option-backslash| about
8075 including spaces and backslashes).
8076 See 'wildignore' for completely ignoring files.
8077 The use of |:set+=| and |:set-=| is preferred when adding or removing
8078 suffixes from the list. This avoids problems when a future version
8079 uses another default.
8080
8081 *'suffixesadd'* *'sua'*
8082'suffixesadd' 'sua' string (default "")
8083 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008084 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 file for the "gf", "[I", etc. commands. Example: >
8086 :set suffixesadd=.java
8087<
8088 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8089'swapfile' 'swf' boolean (default on)
8090 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008091 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 swapfile is not wanted for a specific buffer. For example, with
8093 confidential information that even root must not be able to access.
8094 Careful: All text will be in memory:
8095 - Don't use this for big files.
8096 - Recovery will be impossible!
8097 A swapfile will only be present when |'updatecount'| is non-zero and
8098 'swapfile' is set.
8099 When 'swapfile' is reset, the swap file for the current buffer is
8100 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8101 non-zero, a swap file is immediately created.
8102 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008103 If you want to open a new buffer without creating a swap file for it,
8104 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008105 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106
8107 This option is used together with 'bufhidden' and 'buftype' to
8108 specify special kinds of buffers. See |special-buffers|.
8109
8110 *'swapsync'* *'sws'*
8111'swapsync' 'sws' string (default "fsync")
8112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008114 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 When this option is empty parts of the swap file may be in memory and
8116 not written to disk. When the system crashes you may lose more work.
8117 On Unix the system does a sync now and then without Vim asking for it,
8118 so the disadvantage of setting this option off is small. On some
8119 systems the swap file will not be written at all. For a unix system
8120 setting it to "sync" will use the sync() call instead of the default
8121 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008122 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123
8124 *'switchbuf'* *'swb'*
8125'switchbuf' 'swb' string (default "")
8126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008128 This option is checked, when
8129 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008130 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008131 - jumping to a tag using the |:stag| command.
8132 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8133 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8134 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008135 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008136 useopen If included, jump to the first open window in the
8137 current tab page that contains the specified buffer
8138 (if there is one). Otherwise: Do not examine other
8139 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008140 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008141 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008143 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008144 Otherwise: do not split, use current window (when used
8145 in the quickfix window: the previously used window or
8146 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008147 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008148 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008149 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008150 uselast If included, jump to the previously used window when
8151 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008152 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8153 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008155 *'synmaxcol'* *'smc'*
8156'synmaxcol' 'smc' number (default 3000)
8157 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008158 {not available when compiled without the |+syntax|
8159 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008160 Maximum column in which to search for syntax items. In long lines the
8161 text after this column is not highlighted and following lines may not
8162 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008163 This helps to avoid very slow redrawing for an XML file that is one
8164 long line.
8165 Set to zero to remove the limit.
8166
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 *'syntax'* *'syn'*
8168'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008169 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 {not available when compiled without the |+syntax|
8171 feature}
8172 When this option is set, the syntax with this name is loaded, unless
8173 syntax highlighting has been switched off with ":syntax off".
8174 Otherwise this option does not always reflect the current syntax (the
8175 b:current_syntax variable does).
8176 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008177 not automatically recognized. Example, in an IDL file:
8178 /* vim: set syntax=idl : */ ~
8179 When a dot appears in the value then this separates two filetype
8180 names. Example:
8181 /* vim: set syntax=c.doxygen : */ ~
8182 This will use the "c" syntax first, then the "doxygen" syntax.
8183 Note that the second one must be prepared to be loaded as an addition,
8184 otherwise it will be skipped. More than one dot may appear.
8185 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 :set syntax=OFF
8187< To switch syntax highlighting on according to the current value of the
8188 'filetype' option: >
8189 :set syntax=ON
8190< What actually happens when setting the 'syntax' option is that the
8191 Syntax autocommand event is triggered with the value as argument.
8192 This option is not copied to another buffer, independent of the 's' or
8193 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008194 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195
LemonBoy5247b0b2024-07-12 19:30:58 +02008196 *'tabclose'* *'tcl'*
8197'tabclose' 'tcl' string (default "")
8198 global
8199 This option controls the behavior when closing tab pages (e.g., using
8200 |:tabclose|). When empty Vim goes to the next (right) tab page.
8201
8202 Possible values (comma-separated list):
8203 left If included, go to the previous tab page instead of
8204 the next one.
8205 uselast If included, go to the previously used tab page if
8206 possible. This option takes precedence over the
8207 others.
8208
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008209 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008210'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008211 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008212 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008213 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008214 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008215
8216 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008217 option and only when there is no GUI tab line. When 'e' is in
8218 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008219 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008220
8221 The value is evaluated like with 'statusline'. You can use
8222 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008223 the text to be displayed. Use "%1T" for the first label, "%2T" for
8224 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008225
Bram Moolenaare12bab32019-01-08 22:02:56 +01008226 When changing something that is used in 'tabline' that does not
8227 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008228 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008229
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008230 Keep in mind that only one of the tab pages is the current one, others
8231 are invisible and you can't jump to their windows.
8232
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008233 *'tabpagemax'* *'tpm'*
8234'tabpagemax' 'tpm' number (default 10)
8235 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008236 Maximum number of tab pages to be opened by the |-p| command line
8237 argument or the ":tab all" command. |tabpage|
8238
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008239 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240'tabstop' 'ts' number (default 8)
8241 local to buffer
8242 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008243 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244
8245 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008246 appear wrong in many places, e.g., when printing it.
8247 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008249 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8251 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008252 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008254 This is the recommended way, the file will look the same with other
8255 tools and when listing it in a terminal.
8256 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8257 'expandtab'. This way you will always insert spaces. The
8258 formatting will never be messed up when 'tabstop' is changed (leave
8259 it at 8 just in case). The file will be a bit larger.
8260 You do need to check if no Tabs exist in the file. You can get rid
8261 of them by first setting 'expandtab' and using `%retab!`, making
8262 sure the value of 'tabstop' is set correctly.
8263 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 'expandtab'. This way you will always insert spaces. The
8265 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008266 You do need to check if no Tabs exist in the file, just like in the
8267 item just above.
8268 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008269 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008270 works when using Vim to edit the file, other tools assume a tabstop
8271 is worth 8 spaces.
8272 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 'noexpandtab'. This should then work (for initial indents only)
8274 for any tabstop setting that people use. It might be nice to have
8275 tabs after the first non-blank inserted as spaces if you do this
8276 though. Otherwise aligned comments will be wrong when 'tabstop' is
8277 changed.
8278
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008279 If Vim is compiled with the |+vartabs| feature then the value of
8280 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8281 than an empty string.
8282
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8284'tagbsearch' 'tbs' boolean (default on)
8285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008287 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 searching makes searching for a tag a LOT faster, but a linear search
8289 will find more tags if the tags file wasn't properly sorted.
8290 Vim normally assumes that your tags files are sorted, or indicate that
8291 they are not sorted. Only when this is not the case does the
8292 'tagbsearch' option need to be switched off.
8293
8294 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008295 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 certain files, or retry all files with a linear search. When
8297 'tagbsearch' is off, only a linear search is done.
8298
8299 Linear searching is done anyway, for one file, when Vim finds a line
8300 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008301 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302< [The whitespace before and after the '0' must be a single <Tab>]
8303
8304 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008305 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 instead of a normal tag name, a retry is done with a linear search.
8307 Tags in unsorted tags files, and matches with different case will only
8308 be found in the retry.
8309
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008310 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008311 linear search can be avoided when case is ignored. Use a value of '2'
8312 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8313 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008314 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8315 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8316 used for this as well. Note that case must be folded to uppercase for
8317 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008318
8319 By default, tag searches are case-sensitive. Case is ignored when
8320 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8321 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008322 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8323 'tagcase' is "smart", and the pattern contains only lowercase
8324 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325
8326 When 'tagbsearch' is off, tags searching is slower when a full match
8327 exists, but faster when no full match exists. Tags in unsorted tags
8328 files may only be found with 'tagbsearch' off.
8329 When the tags file is not sorted, or sorted in a wrong way (not on
8330 ASCII byte value), 'tagbsearch' should be off, or the line given above
8331 must be included in the tags file.
8332 This option doesn't affect commands that find all matching tags (e.g.,
8333 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008335 *'tagcase'* *'tc'*
8336'tagcase' 'tc' string (default "followic")
8337 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008338 This option specifies how case is handled when searching the tags
8339 file:
8340 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008341 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008342 ignore Ignore case
8343 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008344 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008345 NOTE: This option is set to the Vi default value when 'compatible' is
8346 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008347
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008348 *'tagfunc'* *'tfu'*
8349'tagfunc' 'tfu' string (default: empty)
8350 local to buffer
8351 {not available when compiled without the |+eval|
8352 feature}
8353 This option specifies a function to be used to perform tag searches.
8354 The function gets the tag pattern and should return a List of matching
8355 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008356 function and an example. The value can be the name of a function, a
8357 |lambda| or a |Funcref|. See |option-value-function| for more
8358 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008359 This option cannot be set from a |modeline| or in the |sandbox|, for
8360 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008361
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 *'taglength'* *'tl'*
8363'taglength' 'tl' number (default 0)
8364 global
8365 If non-zero, tags are significant up to this number of characters.
8366
8367 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8368'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8369 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008370 If on and using a tags file in another directory, file names in that
8371 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 NOTE: This option is set to the Vi default value when 'compatible' is
8373 set and to the Vim default value when 'compatible' is reset.
8374
8375 *'tags'* *'tag'* *E433*
8376'tags' 'tag' string (default "./tags,tags", when compiled with
8377 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8378 global or local to buffer |global-local|
8379 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008380 include a space or comma in a file name, precede it with backslashes
8381 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 When a file name starts with "./", the '.' is replaced with the path
8383 of the current file. But only when the 'd' flag is not included in
8384 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8385 |tags-option|.
8386 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008387 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8388 find all files named "tags" below "/lib". The filename itself cannot
8389 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008390 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008391 The |tagfiles()| function can be used to get a list of the file names
8392 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8394 files are also supported. They are automatically recognized. The
8395 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8396 differences are ignored (MS-Windows). |emacs-tags|
8397 The use of |:set+=| and |:set-=| is preferred when adding or removing
8398 file names from the list. This avoids problems when a future version
8399 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400
8401 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8402'tagstack' 'tgst' boolean (default on)
8403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 When on, the |tagstack| is used normally. When off, a ":tag" or
8405 ":tselect" command with an argument will not push the tag onto the
8406 tagstack. A following ":tag" without an argument, a ":pop" command or
8407 any other command that uses the tagstack will use the unmodified
8408 tagstack, but does change the pointer to the active entry.
8409 Resetting this option is useful when using a ":tag" command in a
8410 mapping which should not change the tagstack.
8411
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008412 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008413'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008414 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008415 {only available when compiled with the |+tcl/dyn|
8416 feature}
8417 Specifies the name of the Tcl shared library. The default is
8418 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008419 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008420 This option cannot be set from a |modeline| or in the |sandbox|, for
8421 security reasons.
8422
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 *'term'* *E529* *E530* *E531*
8424'term' string (default is $TERM, if that fails:
8425 in the GUI: "builtin_gui"
8426 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008427 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 on Unix: "ansi"
8430 on VMS: "ansi"
8431 on Win 32: "win32")
8432 global
8433 Name of the terminal. Used for choosing the terminal control
8434 characters. Environment variables are expanded |:set_env|.
8435 For example: >
8436 :set term=$TERM
8437< See |termcap|.
8438
8439 *'termbidi'* *'tbidi'*
8440 *'notermbidi'* *'notbidi'*
8441'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 {only available when compiled with the |+arabic|
8444 feature}
8445 The terminal is in charge of Bi-directionality of text (as specified
8446 by Unicode). The terminal is also expected to do the required shaping
8447 that some languages (such as Arabic) require.
8448 Setting this option implies that 'rightleft' will not be set when
8449 'arabic' is set and the value of 'arabicshape' will be ignored.
8450 Note that setting 'termbidi' has the immediate effect that
8451 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8452 This option is reset when the GUI is started.
8453 For further details see |arabic.txt|.
8454
8455 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008456'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 Encoding used for the terminal. This specifies what character
8459 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008460 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008461 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008462 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008463 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8465 Any attempts to set a different value will be rejected, and an error
8466 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008467 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 because the Win32 system always passes Unicode characters.
8469 When empty, the same encoding is used as for the 'encoding' option.
8470 This is the normal value.
8471 Not all combinations for 'termencoding' and 'encoding' are valid. See
8472 |encoding-table|.
8473 The value for this option must be supported by internal conversions or
8474 iconv(). When this is not possible no conversion will be done and you
8475 will probably experience problems with non-ASCII characters.
8476 Example: You are working with the locale set to euc-jp (Japanese) and
8477 want to edit a UTF-8 file: >
8478 :let &termencoding = &encoding
8479 :set encoding=utf-8
8480< You need to do this when your system has no locale support for UTF-8.
8481
Bram Moolenaar938ae282023-02-20 20:44:55 +00008482 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008483'termguicolors' 'tgc' boolean (default off)
8484 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008485 {not available when compiled without the
8486 |+termguicolors| feature}
8487 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008488 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008489
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008490 Requires a ISO-8613-3 compatible terminal. If setting this option
8491 does not work (produces a colorless UI) reading |xterm-true-color|
8492 might help.
8493
8494 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8495 is required. Use this check to find out: >
8496 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008497< This requires Vim to be built with the |+vtp| feature.
8498
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008499 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008500
8501 When using Vim with Windows Terminal, the background of Windows
8502 Terminal is normally filled with the Vim background color. Setting
8503 'termguicolors' and the guibg of the Normal highlight group to NONE
8504 will make the background transparent: >
8505 :hi Normal guibg=NONE
8506<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008507 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008508
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008509 *'termwinkey'* *'twk'*
8510'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008511 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008512 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008513 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008514 The key can be specified as a single character, a |key-notation| (e.g.
8515 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8516 :set twk=X
8517 :set twk=^I
8518 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008519< The string must be one key stroke but can be multiple bytes.
8520 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008521 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008522 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008523
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008524 *'termwinscroll'* *'twsl'*
8525'termwinscroll' 'twsl' number (default 10000)
8526 local to buffer
8527 {not available when compiled without the
8528 |+terminal| feature}
8529 Number of scrollback lines to keep. When going over this limit the
8530 first 10% of the scrollback lines are deleted. This is just to reduce
8531 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008532 Also used as a limit for text sent to the terminal in one write,
8533 multiplied by the number of columns times 3 (average number of bytes
8534 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008535
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008536 *'termwinsize'* *'tws'*
8537'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008538 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008539 Size used when opening the |terminal| window. Format:
8540 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008541 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008542 - When set with a "x" (e.g., "24x80") the terminal size is not
8543 adjusted to the window size. If the window is smaller only the
8544 top-left part is displayed.
8545 - When set with a "*" (e.g., "10*50") the terminal size follows the
8546 window size, but will not be smaller than the specified rows and/or
8547 columns.
8548 - When rows is zero then use the height of the window.
8549 - When columns is zero then use the width of the window.
8550 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008551 - Can be overruled in the |term_start()| options with "term_rows" and
8552 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008553
8554 Examples:
8555 "30x0" uses 30 rows and the current window width.
8556 "20*0" uses at least 20 rows and the current window width.
8557 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008558 Note that the command running in the terminal window may still change
8559 the size of the terminal. In that case the Vim window will be
8560 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008561
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008562 *'termwintype'* *'twt'*
8563'termwintype' 'twt' string (default "")
8564 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008565 {only available when compiled with the |terminal|
8566 feature on MS-Windows}
8567 Specify the virtual console (pty) used when opening the terminal
8568 window.
8569
8570 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008571 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008572 "winpty" use winpty, fail if not supported
8573 "conpty" use |ConPTY|, fail if not supported
8574
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008575 |ConPTY| support depends on the platform. Windows 10 October 2018
8576 Update is the first version that supports ConPTY, however it is still
8577 considered unstable. ConPTY might become stable in the next release
8578 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008579 supported then you cannot open a terminal window.
8580
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 *'terse'* *'noterse'*
8582'terse' boolean (default off)
8583 global
8584 When set: Add 's' flag to 'shortmess' option (this makes the message
8585 for a search that hits the start or end of the file not being
8586 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8587 shortens a lot of messages}
8588
8589 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8590'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 This option is obsolete. Use 'fileformats'.
8593 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8594 set to the default value for the current system. When 'textauto' is
8595 reset, 'fileformats' is made empty.
8596 NOTE: This option is set to the Vi default value when 'compatible' is
8597 set and to the Vim default value when 'compatible' is reset.
8598
8599 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008600'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 others: default off)
8602 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 This option is obsolete. Use 'fileformat'.
8604 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8605 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8606 "unix".
8607
8608 *'textwidth'* *'tw'*
8609'textwidth' 'tw' number (default 0)
8610 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 Maximum width of text that is being inserted. A longer line will be
8612 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008613 this.
8614 'textwidth' is set to 0 when the 'paste' option is set and restored
8615 when 'paste' is reset.
8616 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008618 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 NOTE: This option is set to 0 when 'compatible' is set.
8620
8621 *'thesaurus'* *'tsr'*
8622'thesaurus' 'tsr' string (default "")
8623 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008625 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8626 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008627
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008628 This option is not used if 'thesaurusfunc' is set, either for the
8629 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008630
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008631 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008633 name. See |option-backslash| about using backslashes. The use of
8634 |:set+=| and |:set-=| is preferred when adding or removing directories
8635 from the list. This avoids problems when a future version uses
8636 another default. Backticks cannot be used in this option for security
8637 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008639 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008640'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008641 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008642 {not available when compiled without the |+eval|
8643 feature}
8644 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008645 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008646 The value can be the name of a function, a |lambda| or a |Funcref|.
8647 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008648
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008649 This option cannot be set from a |modeline| or in the |sandbox|, for
8650 security reasons.
8651
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8653'tildeop' 'top' boolean (default off)
8654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 When on: The tilde command "~" behaves like an operator.
8656 NOTE: This option is reset when 'compatible' is set.
8657
8658 *'timeout'* *'to'* *'notimeout'* *'noto'*
8659'timeout' 'to' boolean (default on)
8660 global
laburnumT3f7855a2023-12-05 18:37:03 +01008661
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008663'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 These two options together determine the behavior when part of a
8666 mapped key sequence or keyboard code has been received:
8667
8668 'timeout' 'ttimeout' action ~
8669 off off do not time out
8670 on on or off time out on :mappings and key codes
8671 off on time out on key codes
8672
8673 If both options are off, Vim will wait until either the complete
8674 mapping or key sequence has been received, or it is clear that there
8675 is no mapping or key sequence for the received characters. For
8676 example: if you have mapped "vl" and Vim has received 'v', the next
8677 character is needed to see if the 'v' is followed by an 'l'.
8678 When one of the options is on, Vim will wait for about 1 second for
8679 the next character to arrive. After that the already received
8680 characters are interpreted as single characters. The waiting time can
8681 be changed with the 'timeoutlen' option.
8682 On slow terminals or very busy systems timing out may cause
8683 malfunctioning cursor keys. If both options are off, Vim waits
8684 forever after an entered <Esc> if there are key codes that start
8685 with <Esc>. You will have to type <Esc> twice. If you do not have
8686 problems with key codes, but would like to have :mapped key
8687 sequences not timing out in 1 second, set the 'ttimeout' option and
8688 reset the 'timeout' option.
8689
8690 NOTE: 'ttimeout' is reset when 'compatible' is set.
8691
8692 *'timeoutlen'* *'tm'*
8693'timeoutlen' 'tm' number (default 1000)
8694 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008695
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008697'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 The time in milliseconds that is waited for a key code or mapped key
8700 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8701 when part of a command has been typed.
8702 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8703 different timeout value for key codes is desired set 'ttimeoutlen' to
8704 a non-negative number.
8705
8706 ttimeoutlen mapping delay key code delay ~
8707 < 0 'timeoutlen' 'timeoutlen'
8708 >= 0 'timeoutlen' 'ttimeoutlen'
8709
8710 The timeout only happens when the 'timeout' and 'ttimeout' options
8711 tell so. A useful setting would be >
8712 :set timeout timeoutlen=3000 ttimeoutlen=100
8713< (time out on mapping after three seconds, time out on key codes after
8714 a tenth of a second).
8715
8716 *'title'* *'notitle'*
8717'title' boolean (default off, on when title can be restored)
8718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 When on, the title of the window will be set to the value of
8720 'titlestring' (if it is not empty), or to:
8721 filename [+=-] (path) - VIM
8722 Where:
8723 filename the name of the file being edited
8724 - indicates the file cannot be modified, 'ma' off
8725 + indicates the file was modified
8726 = indicates the file is read-only
8727 =+ indicates the file is read-only and modified
8728 (path) is the path of the file being edited
8729 - VIM the server name |v:servername| or "VIM"
8730 Only works if the terminal supports setting window titles
8731 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008732 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8734 *X11*
8735 When Vim was compiled with HAVE_X11 defined, the original title will
8736 be restored if possible. The output of ":version" will include "+X11"
8737 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8738 works for the icon name |'icon'|.
8739 But: When Vim was started with the |-X| argument, restoring the title
8740 will not work (except in the GUI).
8741 If the title cannot be restored, it is set to the value of 'titleold'.
8742 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008743 When using an xterm from a remote machine you can use this command: >
8744
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008746 ssh -X machine_name xterm &
8747<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 then the WINDOWID environment variable should be inherited and the
8749 title of the window should change back to what it should be after
8750 exiting Vim.
8751
8752 *'titlelen'*
8753'titlelen' number (default 85)
8754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008756 title. When the title is longer, only the end of the path name is
8757 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 Using a percentage makes this adapt to the width of the window. But
8759 it won't work perfectly, because the actual number of characters
8760 available also depends on the font used and other things in the title
8761 bar. When 'titlelen' is zero the full path is used. Otherwise,
8762 values from 1 to 30000 percent can be used.
8763 'titlelen' is also used for the 'titlestring' option.
8764
8765 *'titleold'*
8766'titleold' string (default "Thanks for flying Vim")
8767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 This option will be used for the window title when exiting Vim if the
8769 original title cannot be restored. Only happens if 'title' is on or
8770 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008771 This option cannot be set from a |modeline| or in the |sandbox|, for
8772 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 *'titlestring'*
8774'titlestring' string (default "")
8775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 When this option is not empty, it will be used for the title of the
8777 window. This happens only when the 'title' option is on.
8778 Only works if the terminal supports setting window titles (currently
8779 Amiga console, Win32 console, all GUI versions and terminals with a
8780 non-empty 't_ts' option).
8781 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008782 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008783
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008785 expanded according to the rules used for 'statusline'. If it contains
8786 an invalid '%' format, the value is used as-is and no error or warning
8787 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008788 This option cannot be set in a modeline when 'modelineexpr' is off.
8789
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008791 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8793< The value of 'titlelen' is used to align items in the middle or right
8794 of the available space.
8795 Some people prefer to have the file name first: >
8796 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8797< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008798 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 separating space only when needed.
8800 NOTE: Use of special characters in 'titlestring' may cause the display
8801 to be garbled (e.g., when it contains a CR or NL character).
8802 {not available when compiled without the |+statusline| feature}
8803
8804 *'toolbar'* *'tb'*
8805'toolbar' 'tb' string (default "icons,tooltips")
8806 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008807 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008808 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 possible values are:
8810 icons Toolbar buttons are shown with icons.
8811 text Toolbar buttons shown with text.
8812 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008813 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 tooltips Tooltips are active for toolbar buttons.
8815 Tooltips refer to the popup help text which appears after the mouse
8816 cursor is placed over a toolbar button for a brief moment.
8817
8818 If you want the toolbar to be shown with icons as well as text, do the
8819 following: >
8820 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008821< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 will show icons if both are requested.
8823
8824 If none of the strings specified in 'toolbar' are valid or if
8825 'toolbar' is empty, this option is ignored. If you want to disable
8826 the toolbar, you need to set the 'guioptions' option. For example: >
8827 :set guioptions-=T
8828< Also see |gui-toolbar|.
8829
8830 *'toolbariconsize'* *'tbis'*
8831'toolbariconsize' 'tbis' string (default "small")
8832 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008833 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008835 tiny Use tiny icons.
8836 small Use small icons (default).
8837 medium Use medium-sized icons.
8838 large Use large icons.
8839 huge Use even larger icons.
8840 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008842 the current theme. Common dimensions are giant=48x48, huge=32x32,
8843 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844
8845 If 'toolbariconsize' is empty, the global default size as determined
8846 by user preferences or the current theme is used.
8847
8848 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8849'ttybuiltin' 'tbi' boolean (default on)
8850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 When on, the builtin termcaps are searched before the external ones.
8852 When off the builtin termcaps are searched after the external ones.
8853 When this option is changed, you should set the 'term' option next for
8854 the change to take effect, for example: >
8855 :set notbi term=$TERM
8856< See also |termcap|.
8857 Rationale: The default for this option is "on", because the builtin
8858 termcap entries are generally better (many systems contain faulty
8859 xterm entries...).
8860
8861 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008862'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 Indicates a fast terminal connection. More characters will be sent to
8865 the screen for redrawing, instead of using insert/delete line
8866 commands. Improves smoothness of redrawing when there are multiple
8867 windows and the terminal does not support a scrolling region.
8868 Also enables the extra writing of characters at the end of each screen
8869 line for lines that wrap. This helps when using copy/paste with the
8870 mouse in an xterm and other terminals.
8871
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008872 The default used to be set only for some terminal names, but these
8873 days nearly all terminals are fast, therefore the default is now "on".
8874 If you have a slow connection you may want to set this option off,
8875 e.g. depending on the host name: >
8876 if hostname() =~ 'faraway'
8877 set nottyfast
8878 endif
8879<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 *'ttymouse'* *'ttym'*
8881'ttymouse' 'ttym' string (default depends on 'term')
8882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008883 {only in Unix and VMS, doesn't work in the GUI; not
8884 available when compiled without |+mouse|}
8885 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008886 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 *xterm-mouse*
8888 xterm xterm-like mouse handling. The mouse generates
8889 "<Esc>[Mscr", where "scr" is three bytes:
8890 "s" = button state
8891 "c" = column plus 33
8892 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008893 This only works up to 223 columns! See "dec",
8894 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008895 xterm2 Works like "xterm", but with the xterm reporting the
8896 mouse position while the mouse is dragged. This works
8897 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008898 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899 work. See below for how Vim detects this
8900 automatically.
8901 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008902 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008904 for the row and column. No other mouse events are
8905 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 *dec-mouse*
8907 dec DEC terminal mouse handling. The mouse generates a
8908 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008909 This is also available for an Xterm, if it was
8910 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 *jsbterm-mouse*
8912 jsbterm JSB term mouse handling.
8913 *pterm-mouse*
8914 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008915 *urxvt-mouse*
8916 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008917 The mouse works only if the terminal supports this
8918 encoding style, but it does not have 223 columns limit
8919 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008920 *sgr-mouse*
8921 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008922 mouse reporting. The mouse works even in columns
8923 beyond 223. This option is backward compatible with
8924 "xterm2" because it can also decode "xterm2" style
8925 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926
8927 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008928 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8929 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8931 recognized, if enabled at compile time. DEC terminal mouse codes
8932 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008933 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8934 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008936 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8937 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8938 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008939 If the terminfo/termcap entry "XM" exists and the first number is
8940 "1006" then 'ttymouse' will be set to "sgr". This works for many
8941 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008942 Additionally, if vim is compiled with the |+termresponse| feature and
8943 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008944 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008946 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8947 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8948 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008949 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8950 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 :set t_RV=
8952<
8953 *'ttyscroll'* *'tsl'*
8954'ttyscroll' 'tsl' number (default 999)
8955 global
8956 Maximum number of lines to scroll the screen. If there are more lines
8957 to scroll the window is redrawn. For terminals where scrolling is
8958 very slow and redrawing is not slow this can be set to a small number,
8959 e.g., 3, to speed up displaying.
8960
8961 *'ttytype'* *'tty'*
8962'ttytype' 'tty' string (default from $TERM)
8963 global
8964 Alias for 'term', see above.
8965
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008966 *'undodir'* *'udir'*
8967'undodir' 'udir' string (default ".")
8968 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008969 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008970 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008971 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008972 "." means using the directory of the file. The undo file name for
8973 "file.txt" is ".file.txt.un~".
8974 For other directories the file name is the full path of the edited
8975 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008976 When writing: The first directory that exists is used. "." always
8977 works, no directories after "." will be used for writing.
8978 When reading all entries are tried to find an undo file. The first
8979 undo file that exists is used. When it cannot be read an error is
8980 given, no further entry is used.
8981 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008982 This option cannot be set from a |modeline| or in the |sandbox|, for
8983 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008984
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008985 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008986'undofile' 'udf' boolean (default off)
8987 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008988 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008989 When on, Vim automatically saves undo history to an undo file when
8990 writing a buffer to a file, and restores undo history from the same
8991 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008992 The directory where the undo file is stored is specified by 'undodir'.
8993 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008994 The undo file is not read when 'undoreload' causes the buffer from
8995 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008996 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008997 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008998
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009000'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009001 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009003 is kept in memory, higher numbers will cause more memory to be used.
9004 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9006 itself: >
9007 set ul=0
9008< But you can also get Vi compatibility by including the 'u' flag in
9009 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009010 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009011 Set to -1 for no undo at all. You might want to do this only for the
9012 current buffer: >
9013 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009015
9016 The local value is set to -123456 when the global value is to be used.
9017
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009018 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009020 *'undoreload'* *'ur'*
9021'undoreload' 'ur' number (default 10000)
9022 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009023 Save the whole buffer for undo when reloading it. This applies to the
9024 ":e!" command and reloading for when the buffer changed outside of
9025 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009026 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009027 of lines is smaller than the value of this option.
9028 Set this option to zero to disable undo for a reload.
9029
9030 When saving undo for a reload, any undo file is not read.
9031
9032 Note that this causes the whole buffer to be stored in memory. Set
9033 this option to a lower value if you run out of memory.
9034
Bram Moolenaar071d4272004-06-13 20:20:40 +00009035 *'updatecount'* *'uc'*
9036'updatecount' 'uc' number (default: 200)
9037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038 After typing this many characters the swap file will be written to
9039 disk. When zero, no swap file will be created at all (see chapter on
9040 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9041 Vim with the "-n" option, see |startup|. When editing in readonly
9042 mode this option will be initialized to 10000.
9043 The swapfile can be disabled per buffer with |'swapfile'|.
9044 When 'updatecount' is set from zero to non-zero, swap files are
9045 created for all buffers that have 'swapfile' set. When 'updatecount'
9046 is set to zero, existing swap files are not deleted.
9047 Also see |'swapsync'|.
9048 This option has no meaning in buffers where |'buftype'| is "nofile"
9049 or "nowrite".
9050
9051 *'updatetime'* *'ut'*
9052'updatetime' 'ut' number (default 4000)
9053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 If this many milliseconds nothing is typed the swap file will be
9055 written to disk (see |crash-recovery|). Also used for the
9056 |CursorHold| autocommand event.
9057
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009058 *'varsofttabstop'* *'vsts'*
9059'varsofttabstop' 'vsts' string (default "")
9060 local to buffer
9061 {only available when compiled with the |+vartabs|
9062 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009063 A list of the number of spaces that a <Tab> counts for while editing,
9064 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9065 width <Tab>s are being inserted, while in fact a mixture of spaces
9066 and <Tab>s is used. Tab widths are separated with commas, with the
9067 final value applying to all subsequent tabs.
9068
9069 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009070 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009071 to use the following: >
9072 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009073< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9074 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009075
9076 Note that the value of |'softtabstop'| will be ignored while
9077 'varsofttabstop' is set.
9078
9079 *'vartabstop'* *'vts'*
9080'vartabstop' 'vts' string (default "")
9081 local to buffer
9082 {only available when compiled with the |+vartabs|
9083 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009084 A list of the number of spaces that a <Tab> in the file counts for,
9085 separated by commas. Each value corresponds to one tab, with the
9086 final value applying to all subsequent tabs. For example: >
9087 :set vartabstop=4,20,10,8
9088< This will make the first tab 4 spaces wide, the second 20 spaces,
9089 the third 10 spaces, and all following tabs 8 spaces.
9090
9091 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9092 is set.
9093
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 *'verbose'* *'vbs'*
9095'verbose' 'vbs' number (default 0)
9096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 When bigger than zero, Vim will give messages about what it is doing.
9098 Currently, these messages are given:
9099 >= 1 When the viminfo file is read or written.
9100 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009101 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009102 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 >= 8 Files for which a group of autocommands is executed.
9104 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009105 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106 >= 12 Every executed function.
9107 >= 13 When an exception is thrown, caught, finished, or discarded.
9108 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009109 >= 15 Every executed Ex command from a script (truncated at 200
9110 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009111 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112
9113 This option can also be set with the "-V" argument. See |-V|.
9114 This option is also set by the |:verbose| command.
9115
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009116 When the 'verbosefile' option is set then the verbose messages are not
9117 displayed.
9118
9119 *'verbosefile'* *'vfile'*
9120'verbosefile' 'vfile' string (default empty)
9121 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009122 When not empty all messages are written in a file with this name.
9123 When the file exists messages are appended.
9124 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009125 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009126 Setting 'verbosefile' to a new value is like making it empty first.
9127 The difference with |:redir| is that verbose messages are not
9128 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009129 This option cannot be set from a |modeline| or in the |sandbox|, for
9130 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009131
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009133'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009134 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009135 for Unix: "$HOME/.vim/view" or
9136 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009137 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009139 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 feature}
9141 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009142 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 This option cannot be set from a |modeline| or in the |sandbox|, for
9144 security reasons.
9145
9146 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009147'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009149 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009151 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009152 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153 word save and restore ~
9154 cursor cursor position in file and in window
9155 folds manually created folds, opened/closed folds and local
9156 fold options
9157 options options and mappings local to a window or buffer (not
9158 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009159 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 slash backslashes in file names replaced with forward
9161 slashes
9162 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009163 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009164 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009166 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009168 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169
9170 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009171'viminfo' 'vi' string (Vi default: "", Vim default for
9172 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009173 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9174 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009176 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 feature}
9178 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009179 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9180 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009181 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009182 consisting of a single character identifying the particular parameter,
9183 followed by a number or string which specifies the value of that
9184 parameter. If a particular character is left out, then the default
9185 value is used for that parameter. The following is a list of the
9186 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009188 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 ! When included, save and restore global variables that start
9190 with an uppercase letter, and don't contain a lowercase
9191 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009192 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009193 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009194 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 " Maximum number of lines saved for each register. Old name of
9196 the '<' item, with the disadvantage that you need to put a
9197 backslash before the ", otherwise it will be recognized as the
9198 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009199 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009200 % When included, save and restore the buffer list. If Vim is
9201 started with a file name argument, the buffer list is not
9202 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009203 buffer list is restored from the viminfo file. Quickfix
9204 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9205 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009206 When followed by a number, the number specifies the maximum
9207 number of buffers that are stored. Without a number all
9208 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009209 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210 ' Maximum number of previously edited files for which the marks
9211 are remembered. This parameter must always be included when
9212 'viminfo' is non-empty.
9213 Including this item also means that the |jumplist| and the
9214 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009215 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009217 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009218 patterns are also saved. When not included, the value of
9219 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009220 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009222 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009223 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 < Maximum number of lines saved for each register. If zero then
9225 registers are not saved. When not included, all lines are
9226 saved. '"' is the old name for this item.
9227 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009228 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009230 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009231 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 c When included, convert the text in the viminfo file from the
9233 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009234 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009235 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009236 f Whether file marks need to be stored. If zero, file marks ('0
9237 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009238 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009240 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 h Disable the effect of 'hlsearch' when loading the viminfo
9242 file. When not included, it depends on whether ":nohlsearch"
9243 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009244 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009246 the 'n'. Must be at the end of the option! If the
9247 'viminfofile' option is set, that file name overrides the one
9248 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009249 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009250 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 r Removable media. The argument is a string (up to the next
9252 ','). This parameter can be given several times. Each
9253 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009254 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9256 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9257 ignored. Maximum length of each 'r' argument is 50
9258 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009259 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009260 s Maximum size of an item in Kbyte. If zero then registers are
9261 not saved. Currently only applies to registers. The default
9262 "s10" will exclude registers with more than 10 Kbyte of text.
9263 Also see the '<' item above: line count limit.
9264
9265 Example: >
9266 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9267<
9268 '50 Marks will be remembered for the last 50 files you
9269 edited.
9270 <1000 Contents of registers (up to 1000 lines each) will be
9271 remembered.
9272 s100 Registers with more than 100 Kbyte text are skipped.
9273 :0 Command-line history will not be saved.
9274 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9275 no / Since '/' is not specified, the default will be used,
9276 that is, save all of the search history, and also the
9277 previous search and substitute patterns.
9278 no % The buffer list will not be saved nor read back.
9279 no h 'hlsearch' highlighting will be restored.
9280
9281 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9282 load the contents of the file, this is not done automatically.
9283
9284 This option cannot be set from a |modeline| or in the |sandbox|, for
9285 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009286 NOTE: This option is set to the Vim default value when 'compatible'
9287 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009288
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009289 *'viminfofile'* *'vif'*
9290'viminfofile' 'vif' string (default: "")
9291 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009292 {not available when compiled without the |+viminfo|
9293 feature}
9294 When non-empty, overrides the file name used for viminfo.
9295 When equal to "NONE" no viminfo file will be read or written.
9296 This option can be set with the |-i| command line flag. The |--clean|
9297 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009298 This option cannot be set from a |modeline| or in the |sandbox|, for
9299 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009300
Bram Moolenaar071d4272004-06-13 20:20:40 +00009301 *'virtualedit'* *'ve'*
9302'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009303 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009304 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 block Allow virtual editing in Visual block mode.
9306 insert Allow virtual editing in Insert mode.
9307 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009308 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009309 none When used as the local value, do not allow virtual
9310 editing even when the global value is set. When used
9311 as the global value, "none" is the same as "".
9312 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009313
Bram Moolenaar071d4272004-06-13 20:20:40 +00009314 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009315 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 of the line. Useful for selecting a rectangle in Visual mode and
9317 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009318 "onemore" is not the same, it will only allow moving the cursor just
9319 after the last character of the line. This makes some commands more
9320 consistent. Previously the cursor was always past the end of the line
9321 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009322 break some plugins or Vim scripts. For example because |l| can move
9323 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009324 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009325 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009326 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009327 It doesn't make sense to combine "all" with "onemore", but you will
9328 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009329 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009330 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331
9332 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9333'visualbell' 'vb' boolean (default off)
9334 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009335 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009337 use: >
9338 :set vb t_vb=
9339< If you want a short flash, you can use this on many terminals: >
9340 :set vb t_vb=[?5h$<100>[?5l
9341< Here $<100> specifies the time, you can use a smaller or bigger value
9342 to get a shorter or longer flash.
9343
9344 Note: Vim will limit the bell to once per half a second. This avoids
9345 having to wait for the flashing to finish when there are lots of
9346 bells, e.g. on key repeat. This also happens without 'visualbell'
9347 set.
9348
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9350 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9351 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009352
9353 Note: When the GUI starts, 't_vb' is reset to its default value. You
9354 might want to set it again in your |gvimrc|.
9355
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356 Does not work on the Amiga, you always get a screen flash.
9357 Also see 'errorbells'.
9358
9359 *'warn'* *'nowarn'*
9360'warn' boolean (default on)
9361 global
9362 Give a warning message when a shell command is used while the buffer
9363 has been changed.
9364
9365 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9366'weirdinvert' 'wiv' boolean (default off)
9367 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009368 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369 It is provided for backwards compatibility with version 4.x.
9370 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9371 vice versa. Has no effect when the GUI is running.
9372
9373 *'whichwrap'* *'ww'*
9374'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376 Allow specified keys that move the cursor left/right to move to the
9377 previous/next line when the cursor is on the first/last character in
9378 the line. Concatenate characters to allow this for these keys:
9379 char key mode ~
9380 b <BS> Normal and Visual
9381 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009382 h "h" Normal and Visual (not recommended)
9383 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009384 < <Left> Normal and Visual
9385 > <Right> Normal and Visual
9386 ~ "~" Normal
9387 [ <Left> Insert and Replace
9388 ] <Right> Insert and Replace
9389 For example: >
9390 :set ww=<,>,[,]
9391< allows wrap only when cursor keys are used.
9392 When the movement keys are used in combination with a delete or change
9393 operator, the <EOL> also counts for a character. This makes "3h"
9394 different from "3dh" when the cursor crosses the end of a line. This
9395 is also true for "x" and "X", because they do the same as "dl" and
9396 "dh". If you use this, you may also want to use the mapping
9397 ":map <BS> X" to make backspace delete the character in front of the
9398 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009399 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009400 line (not an empty line) then it will not move to the next line. This
9401 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402 NOTE: This option is set to the Vi default value when 'compatible' is
9403 set and to the Vim default value when 'compatible' is reset.
9404
9405 *'wildchar'* *'wc'*
9406'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009408 Character you have to type to start wildcard expansion in the
9409 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009410 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009411 The character is not recognized when used inside a macro. See
9412 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009413 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009414 <Esc> can be used, but hitting it twice in a row will still exit
9415 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009416 Although 'wc' is a number option, it can be specified as a number, a
9417 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9418 preceded with a caret (e.g. `^F` is CTRL-F): >
9419 :set wc=27
9420 :set wc=X
9421 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009422 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009423< NOTE: This option is set to the Vi default value when 'compatible' is
9424 set and to the Vim default value when 'compatible' is reset.
9425
9426 *'wildcharm'* *'wcm'*
9427'wildcharm' 'wcm' number (default: none (0))
9428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009429 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009430 recognized when used inside a macro. You can find "spare" command-line
9431 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009432 you'll never actually type 'wildcharm', just use it in mappings that
9433 automatically invoke completion mode, e.g.: >
9434 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009435 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436< Then after typing :ss you can use CTRL-P & CTRL-N.
9437
9438 *'wildignore'* *'wig'*
9439'wildignore' 'wig' string (default "")
9440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009441 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009442 patterns is ignored when expanding |wildcards|, completing file or
9443 directory names, and influences the result of |expand()|, |glob()| and
9444 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009445 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9446 Also see 'suffixes'.
9447 Example: >
9448 :set wildignore=*.o,*.obj
9449< The use of |:set+=| and |:set-=| is preferred when adding or removing
9450 a pattern from the list. This avoids problems when a future version
9451 uses another default.
9452
h_east596a9f22023-11-21 21:24:23 +09009453 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009454'wildignorecase' 'wic' boolean (default off)
9455 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009456 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009457 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009458 Does not apply when the shell is used to expand wildcards, which
9459 happens when there are special characters.
9460
Bram Moolenaar071d4272004-06-13 20:20:40 +00009461 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009462'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009464 When 'wildmenu' is on, command-line completion operates in an enhanced
9465 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009466 the possible matches are shown.
9467 When 'wildoptions' contains "pum", then the completion matches are
9468 shown in a popup menu. Otherwise they are displayed just above the
9469 command line, with the first match highlighted (overwriting the status
9470 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009471 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009472 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9473 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9474 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009475 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009476 If there are more matches than can fit in the line, a ">" is shown on
9477 the right and/or a "<" is shown on the left. The status line scrolls
9478 as needed.
9479 The "wildmenu" mode is abandoned when a key is hit that is not used
9480 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009481 While the "wildmenu" is active, the following keys have special
9482 meanings:
9483 CTRL-P - go to the previous entry
9484 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009485 <CR> - in menu completion, when the cursor is just after a
9486 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009487 CTRL-E - end completion, go back to what was there before
9488 selecting a match.
9489 CTRL-Y - accept the currently selected match and stop
9490 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009491
9492 When not using the popup menu for command line completion, the
9493 following keys have special meanings:
9494 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009495 <Up> - in filename/menu name completion: move up into
9496 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009497 <Down> - in filename/menu name completion: move into a
9498 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009499
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009500 When using the popup menu for command line completion, the following
9501 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009502 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009503 <PageUp> - select a match several entries back
9504 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009505 <Left> - in filename/menu name completion: move up into
9506 parent directory or parent menu.
9507 <Right> - in filename/menu name completion: move into a
9508 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009509
Bram Moolenaar071d4272004-06-13 20:20:40 +00009510 This makes the menus accessible from the console |console-menus|.
9511
9512 If you prefer the <Left> and <Right> keys to move the cursor instead
9513 of selecting a different match, use this: >
9514 :cnoremap <Left> <Space><BS><Left>
9515 :cnoremap <Right> <Space><BS><Right>
9516<
9517 The "WildMenu" highlighting is used for displaying the current match
9518 |hl-WildMenu|.
9519
9520 *'wildmode'* *'wim'*
9521'wildmode' 'wim' string (Vim default: "full")
9522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009524 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009525 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 first part specifies the behavior for the first use of 'wildchar',
9527 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009528
9529 Each part consists of a colon separated list consisting of the
9530 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009531 "" Complete only the first match.
9532 "full" Complete the next full match. After the last match,
9533 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009534 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009535 "longest" Complete till longest common string. If this doesn't
9536 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009537 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009538 "lastused" When completing buffer names and more than one buffer
9539 matches, sort buffers by time last used (other than
9540 the current buffer).
9541 When there is only a single match, it is fully completed in all cases.
9542
9543 Examples of useful colon-separated values:
9544 "longest:full" Like "longest", but also start 'wildmenu' if it is
9545 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009546 "list:full" When more than one match, list all matches and
9547 complete first match.
9548 "list:longest" When more than one match, list all matches and
9549 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009550 "list:lastused" When more than one buffer matches, list all matches
9551 and sort buffers by time last used (other than the
9552 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009553
9554 Examples: >
9555 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009556< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 :set wildmode=longest,full
9558< Complete longest common string, then each full match >
9559 :set wildmode=list:full
9560< List all matches and complete each full match >
9561 :set wildmode=list,full
9562< List all matches without completing, then each full match >
9563 :set wildmode=longest,list
9564< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009565 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009566
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009567 *'wildoptions'* *'wop'*
9568'wildoptions' 'wop' string (default "")
9569 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009570 A list of words that change how |cmdline-completion| is done.
9571 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009572 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009573 this value is specified, wildcard expansion will not
9574 be used for completion. The matches will be sorted by
9575 the "best match" rather than alphabetically sorted.
9576 This will find more matches than the wildcard
9577 expansion. Currently fuzzy matching based completion
9578 is not supported for file and directory names and
9579 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009580 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009581 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009582 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009583 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009584 is displayed per line. Often used tag kinds are:
9585 d #define
9586 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009587
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 *'winaltkeys'* *'wak'*
9589'winaltkeys' 'wak' string (default "menu")
9590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591 {only used in Win32, Motif, GTK and Photon GUI}
9592 Some GUI versions allow the access to menu entries by using the ALT
9593 key in combination with a character that appears underlined in the
9594 menu. This conflicts with the use of the ALT key for mappings and
9595 entering special characters. This option tells what to do:
9596 no Don't use ALT keys for menus. ALT key combinations can be
9597 mapped, but there is no automatic handling. This can then be
9598 done with the |:simalt| command.
9599 yes ALT key handling is done by the windowing system. ALT key
9600 combinations cannot be mapped.
9601 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009602 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009603 keys can be mapped.
9604 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9605 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009606 This option is not used for <F10>; on Win32 and with GTK <F10> will
9607 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009608
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009609 *'wincolor'* *'wcr'*
9610'wincolor' 'wcr' string (default empty)
9611 local to window
9612 Highlight group name to use for this window instead of the Normal
9613 color |hl-Normal|.
9614
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009615 *'window'* *'wi'*
9616'window' 'wi' number (default screen height - 1)
9617 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009618 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9619 window and the value is smaller than 'lines' minus one. The screen
9620 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009621 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9622 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009623 When resizing the Vim window, and the value is smaller than 1 or more
9624 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009625 Note: Do not confuse this with the height of the Vim window, use
9626 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009627
Colin Kennedy21570352024-03-03 16:16:47 +01009628 *'winfixbuf'*
9629'winfixbuf' 'wfb' boolean (default off)
9630 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009631 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009632 For example, attempting to change the buffer with |:edit| will fail.
9633 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009634 also skip any window with 'winfixbuf' enabled. However if an Ex
9635 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009636
laburnumT3f7855a2023-12-05 18:37:03 +01009637 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9638'winfixheight' 'wfh' boolean (default off)
9639 local to window |local-noglobal|
9640 Keep the window height when windows are opened or closed and
9641 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9642 |preview-window| and |quickfix-window|.
9643 The height may be changed anyway when running out of room.
9644
9645 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9646'winfixwidth' 'wfw' boolean (default off)
9647 local to window |local-noglobal|
9648 Keep the window width when windows are opened or closed and
9649 'equalalways' is set. Also for |CTRL-W_=|.
9650 The width may be changed anyway when running out of room.
9651
Bram Moolenaar071d4272004-06-13 20:20:40 +00009652 *'winheight'* *'wh'* *E591*
9653'winheight' 'wh' number (default 1)
9654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009655 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009656 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009657 focus goes to a window that is smaller, its size is increased, at the
9658 cost of the height of other windows.
9659 Set 'winheight' to a small number for normal editing.
9660 Set it to 999 to make the current window fill most of the screen.
9661 Other windows will be only 'winminheight' high. This has the drawback
9662 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9663 to create only two windows, set the option after startup is done,
9664 using the |VimEnter| event: >
9665 au VimEnter * set winheight=999
9666< Minimum value is 1.
9667 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009668 height of the current window.
9669 'winheight' applies to the current window. Use 'winminheight' to set
9670 the minimal height for other windows.
9671
Bram Moolenaar071d4272004-06-13 20:20:40 +00009672 *'winminheight'* *'wmh'*
9673'winminheight' 'wmh' number (default 1)
9674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009675 The minimal height of a window, when it's not the current window.
9676 This is a hard minimum, windows will never become smaller.
9677 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9678 status bar) if necessary. They will return to at least one line when
9679 they become active (since the cursor has to have somewhere to go.)
9680 Use 'winheight' to set the minimal height of the current window.
9681 This option is only checked when making a window smaller. Don't use a
9682 large number, it will cause errors when opening more than a few
9683 windows. A value of 0 to 3 is reasonable.
9684
9685 *'winminwidth'* *'wmw'*
9686'winminwidth' 'wmw' number (default 1)
9687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009688 The minimal width of a window, when it's not the current window.
9689 This is a hard minimum, windows will never become smaller.
9690 When set to zero, windows may be "squashed" to zero columns (i.e. just
9691 a vertical separator) if necessary. They will return to at least one
9692 line when they become active (since the cursor has to have somewhere
9693 to go.)
9694 Use 'winwidth' to set the minimal width of the current window.
9695 This option is only checked when making a window smaller. Don't use a
9696 large number, it will cause errors when opening more than a few
9697 windows. A value of 0 to 12 is reasonable.
9698
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009699 *'winptydll'*
9700'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9701 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009702 {only available when compiled with the |terminal|
9703 feature on MS-Windows}
9704 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009705 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009706 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009707 a fallback.
9708 Environment variables are expanded |:set_env|.
9709 This option cannot be set from a |modeline| or in the |sandbox|, for
9710 security reasons.
9711
Bram Moolenaar071d4272004-06-13 20:20:40 +00009712 *'winwidth'* *'wiw'* *E592*
9713'winwidth' 'wiw' number (default 20)
9714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009715 Minimal number of columns for the current window. This is not a hard
9716 minimum, Vim will use fewer columns if there is not enough room. If
9717 the current window is smaller, its size is increased, at the cost of
9718 the width of other windows. Set it to 999 to make the current window
9719 always fill the screen. Set it to a small number for normal editing.
9720 The width is not adjusted after one of the commands to change the
9721 width of the current window.
9722 'winwidth' applies to the current window. Use 'winminwidth' to set
9723 the minimal width for other windows.
9724
9725 *'wrap'* *'nowrap'*
9726'wrap' boolean (default on)
9727 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009728 This option changes how text is displayed. It doesn't change the text
9729 in the buffer, see 'textwidth' for that.
9730 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009731 displaying continues on the next line. When off lines will not wrap
9732 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009733 moved to a part that is not shown, the screen will scroll
9734 horizontally.
9735 The line will be broken in the middle of a word if necessary. See
9736 'linebreak' to get the break at a word boundary.
9737 To make scrolling horizontally a bit more useful, try this: >
9738 :set sidescroll=5
9739 :set listchars+=precedes:<,extends:>
9740< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009741 This option can't be set from a |modeline| when the 'diff' option is
9742 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009743
9744 *'wrapmargin'* *'wm'*
9745'wrapmargin' 'wm' number (default 0)
9746 local to buffer
9747 Number of characters from the right window border where wrapping
9748 starts. When typing text beyond this limit, an <EOL> will be inserted
9749 and inserting continues on the next line.
9750 Options that add a margin, such as 'number' and 'foldcolumn', cause
9751 the text width to be further reduced. This is Vi compatible.
9752 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009753 This option is set to 0 when 'paste' is set and restored when 'paste'
9754 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009755 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009756
9757 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9758'wrapscan' 'ws' boolean (default on) *E384* *E385*
9759 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009760 Searches wrap around the end of the file. Also applies to |]s| and
9761 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009762
9763 *'write'* *'nowrite'*
9764'write' boolean (default on)
9765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009766 Allows writing files. When not set, writing a file is not allowed.
9767 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009768 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009769 argument. Filtering text is still possible, even though this requires
9770 writing a temporary file.
9771
9772 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9773'writeany' 'wa' boolean (default off)
9774 global
9775 Allows writing to any file with no need for "!" override.
9776
9777 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9778'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9779 otherwise)
9780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009781 Make a backup before overwriting a file. The backup is removed after
9782 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009783 also on.
9784 WARNING: Switching this option off means that when Vim fails to write
9785 your buffer correctly and then, for whatever reason, Vim exits, you
9786 lose both the original file and what you were writing. Only reset
9787 this option if your file system is almost full and it makes the write
9788 fail (and make sure not to exit Vim until the write was successful).
9789 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009790 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009791 Depending on 'backupcopy' the backup is a new file or the original
9792 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009793 NOTE: This option is set to the default value when 'compatible' is
9794 set.
9795
9796 *'writedelay'* *'wd'*
9797'writedelay' 'wd' number (default 0)
9798 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009799 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009800 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009801 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009802
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009803 *'xtermcodes'* *'noxtermcodes'*
9804'xtermcodes' boolean (default on)
9805 global
9806 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009807 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009808 key codes and number of colors from the terminal. This takes care of
9809 various configuration options of the terminal that cannot be obtained
9810 from the termlib/terminfo entry, see |xterm-codes|.
9811 A side effect may be that t_Co changes and Vim will redraw the
9812 display.
9813
9814
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009815 vim:tw=78:ts=8:noet:ft=help:norl: