blob: 22ea4219771b413165512b1df21de81595717eaa [file] [log] [blame]
Hirohito Higashi195fcc92025-02-01 10:26:58 +01001*options.txt* For Vim version 9.1. Last change: 2025 Feb 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
215 :set tags=tags\\,file results in "tags,file"
216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
Millyd9af78b2024-09-26 15:54:43 +0200399 Command global value local value condition ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display local value is set
404 :set option? display - local value is not set
405 :setlocal option? - display
406:setglobal option? display -
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408
409Global options with a local value *global-local*
410
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000411Options are global when you mostly use one value for all buffers and windows.
412For some global options it's useful to sometimes have a different local value.
413You can set the local value with ":setlocal". That buffer or window will then
414use the local value, while other buffers and windows continue using the global
415value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416
417For example, you have two windows, both on C source code. They use the global
418'makeprg' option. If you do this in one of the two windows: >
419 :set makeprg=gmake
420then the other window will switch to the same value. There is no need to set
421the 'makeprg' option in the other C source window too.
422However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000423another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000424files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 :setlocal makeprg=perlmake
426You can switch back to using the global value by making the local value empty: >
427 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428This only works for a string option. For a number or boolean option you need
429to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100431Note that for non-boolean and non-number options using "<" copies the global
432value to the local value, it doesn't switch back to using the global value
433(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000434 :set path<
435This will make the local value of 'path' empty, so that the global value is
436used. Thus it does the same as: >
437 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000438Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439":setlocal" on a global option might work differently then.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441 *option-value-function*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
1720 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1721'cindent' 'cin' boolean (default off)
1722 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001723 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 that trigger reindenting in insert mode and 'cinoptions' to set your
1725 preferred indent style.
1726 If 'indentexpr' is not empty, it overrules 'cindent'.
1727 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1728 the "=" operator indents using this algorithm rather than calling an
1729 external program.
1730 See |C-indenting|.
1731 When you don't like the way 'cindent' works, try the 'smartindent'
1732 option or 'indentexpr'.
1733 This option is not used when 'paste' is set.
1734 NOTE: This option is reset when 'compatible' is set.
1735
1736 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001737'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 A list of keys that, when typed in Insert mode, cause reindenting of
1740 the current line. Only used if 'cindent' is on and 'indentexpr' is
1741 empty.
1742 For the format of this option see |cinkeys-format|.
1743 See |C-indenting|.
1744
1745 *'cinoptions'* *'cino'*
1746'cinoptions' 'cino' string (default "")
1747 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1749 program. See |cinoptions-values| for the values of this option, and
1750 |C-indenting| for info on C indenting in general.
1751
laburnumT3f7855a2023-12-05 18:37:03 +01001752 *'cinscopedecls'* *'cinsd'*
1753'cinscopedecls' 'cinsd' string (default "public,protected,private")
1754 local to buffer
1755 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1756 Useful e.g. for working with the Qt framework that defines additional
1757 scope declarations "signals", "public slots" and "private slots": >
1758 set cinscopedecls+=signals,public\ slots,private\ slots
1759<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *'cinwords'* *'cinw'*
1761'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 These keywords start an extra indent in the next line when
1764 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1765 an appropriate place (inside {}).
1766 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1767 matter, include the keyword both the uppercase and lowercase:
1768 "if,If,IF".
1769
laburnumT3f7855a2023-12-05 18:37:03 +01001770 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1772 for X-windows, "" otherwise)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 {only in GUI versions or when the |+xterm_clipboard|
1775 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001776 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001778 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001779 prepend, e.g.: >
1780 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001781< When using the GUI see |'go-A'|.
1782 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001784 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 unnamed When included, Vim will use the clipboard register '*'
1786 for all yank, delete, change and put operations which
1787 would normally go to the unnamed register. When a
1788 register is explicitly specified, it will always be
1789 used regardless of whether "unnamed" is in 'clipboard'
1790 or not. The clipboard register can always be
1791 explicitly accessed using the "* notation. Also see
1792 |gui-clipboard|.
1793
Bram Moolenaar30b65812012-07-12 22:01:11 +02001794 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001795 unnamedplus A variant of the "unnamed" flag which uses the
1796 clipboard register '+' (|quoteplus|) instead of
1797 register '*' for all yank, delete, change and put
1798 operations which would normally go to the unnamed
1799 register. When "unnamed" is also included to the
1800 option, yank operations (but not delete, change or
1801 put) will additionally copy the text into register
1802 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001803 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001804 Availability can be checked with: >
1805 if has('unnamedplus')
1806<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 autoselect Works like the 'a' flag in 'guioptions': If present,
1809 then whenever Visual mode is started, or the Visual
1810 area extended, Vim tries to become the owner of the
1811 windowing system's global selection or put the
1812 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001813 register "*. See |'go-a'| and |quotestar| for details.
1814 When the GUI is active, the 'a' flag in 'guioptions'
1815 is used, when the GUI is not active, this "autoselect"
1816 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 Also applies to the modeless selection.
1818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-autoselectplus*
1820 autoselectplus Like "autoselect" but using the + register instead of
1821 the * register. Compare to the 'P' flag in
1822 'guioptions'.
1823
1824 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 autoselectml Like "autoselect", but for the modeless selection
1826 only. Compare to the 'A' flag in 'guioptions'.
1827
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001828 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001829 html When the clipboard contains HTML, use this when
1830 pasting. When putting text on the clipboard, mark it
1831 as HTML. This works to copy rendered HTML from
1832 Firefox, paste it as raw HTML in Vim, select the HTML
1833 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001834 You probably want to add this only temporarily,
1835 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001837
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001838 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 exclude:{pattern}
1840 Defines a pattern that is matched against the name of
1841 the terminal 'term'. If there is a match, no
1842 connection will be made to the X server. This is
1843 useful in this situation:
1844 - Running Vim in a console.
1845 - $DISPLAY is set to start applications on another
1846 display.
1847 - You do not want to connect to the X server in the
1848 console, but do want this in a terminal emulator.
1849 To never connect to the X server use: >
1850 exclude:.*
1851< This has the same effect as using the |-X| argument.
1852 Note that when there is no connection to the X server
1853 the window title won't be restored and the clipboard
1854 cannot be accessed.
1855 The value of 'magic' is ignored, {pattern} is
1856 interpreted as if 'magic' was on.
1857 The rest of the option value will be used for
1858 {pattern}, this must be the last entry.
1859
1860 *'cmdheight'* *'ch'*
1861'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001862 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001863 Number of screen lines to use for the command-line. A larger value
1864 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001865 The value of this option is stored with the tab page, so that each tab
1866 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867
1868 *'cmdwinheight'* *'cwh'*
1869'cmdwinheight' 'cwh' number (default 7)
1870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 Number of screen lines to use for the command-line window. |cmdwin|
1872
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001873 *'colorcolumn'* *'cc'*
1874'colorcolumn' 'cc' string (default "")
1875 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001876 {not available when compiled without the |+syntax|
1877 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001878 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001879 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1880 text. Will make screen redrawing slower.
1881 The screen column can be an absolute number, or a number preceded with
1882 '+' or '-', which is added to or subtracted from 'textwidth'. >
1883
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001884 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001885 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1886 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1887<
1888 When 'textwidth' is zero then the items with '-' and '+' are not used.
1889 A maximum of 256 columns are highlighted.
1890
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *'columns'* *'co'* *E594*
1892'columns' 'co' number (default 80 or terminal width)
1893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001895 initialization and does not have to be set by hand. Also see
1896 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 When Vim is running in the GUI or in a resizable window, setting this
1898 option will cause the window size to be changed. When you only want
1899 to use the size for the GUI, put the command in your |gvimrc| file.
1900 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001901 number of columns of the display, the display may be messed up. For
1902 the GUI it is always possible and Vim limits the number of columns to
1903 what fits on the screen. You can use this command to get the widest
1904 window possible: >
1905 :set columns=9999
1906< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907
1908 *'comments'* *'com'* *E524* *E525*
1909'comments' 'com' string (default
1910 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1911 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001912 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 |format-comments|. See |option-backslash| about using backslashes to
1914 insert a space.
1915
1916 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001917'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 {not available when compiled without the |+folding|
1920 feature}
1921 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001922 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001923 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001924 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
1926 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001928 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 This option has the effect of making Vim either more Vi-compatible, or
1931 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 other options are also changed as a side effect.
1935 NOTE: Setting or resetting this option can have a lot of unexpected
1936 effects: Mappings are interpreted in another way, undo behaves
1937 differently, etc. If you set this option in your vimrc file, you
1938 should probably put it at the very start.
1939
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 By default this option is on and the Vi defaults are used for the
1941 options. This default was chosen for those people who want to use Vim
1942 just like Vi, and don't even (want to) know about the 'compatible'
1943 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001944 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001945 this option is switched off, and all options that have not been
1946 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001947 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001948 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001949 happen for the system-wide vimrc or gvimrc file, nor for a file given
1950 with the |-u| argument). Also see |compatible-default| and
1951 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 You can also set this option with the "-C" argument, and reset it with
1953 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 When this option is set, numerous other options are set to make Vim as
1957 Vi-compatible as possible. When this option is unset, various options
1958 are set to make Vim more useful. The table below lists all the
1959 options affected.
1960 The {?} column indicates when the options are affected:
1961 + Means that the option is set to the value given in {set value} when
1962 'compatible' is set.
1963 & Means that the option is set to the value given in {set value} when
1964 'compatible' is set AND is set to its Vim default value when
1965 'compatible' is unset.
1966 - Means the option is NOT changed when setting 'compatible' but IS
1967 set to its Vim default when 'compatible' is unset.
1968 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
Bram Moolenaar036986f2017-03-16 17:41:02 +01001970 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971
1972 'allowrevins' + off no CTRL-_ command
1973 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001974 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001975 'arabicshape' + on correct character shapes
1976 'backspace' + "" normal backspace
1977 'backup' + off no backup file
1978 'backupcopy' & Unix: "yes" backup file is a copy
1979 else: "auto" copy or rename backup file
1980 'balloonexpr' + "" text to show in evaluation balloon
1981 'breakindent' + off don't indent when wrapping lines
1982 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001983 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cindent' + off no C code indentation
1985 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1986 'copyindent' + off don't copy indent structure
1987 'cpoptions' & (all flags) Vi-compatible flags
1988 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001989 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001991 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'cscopeverbose' + off see |cscopeverbose|
1993 'delcombine' + off unicode: delete whole char combination
1994 'digraph' + off no digraphs
1995 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001996 this also disables |modifyOtherKeys|
1997 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001998 'expandtab' + off tabs not expanded to spaces
1999 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002000 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002001 'formatexpr' + "" use 'formatprg' for auto-formatting
2002 'formatoptions' & "vt" Vi compatible formatting
2003 'gdefault' + off no default 'g' flag for ":s"
2004 'history' & 0 no commandline history
2005 'hkmap' + off no Hebrew keyboard mapping
2006 'hkmapp' + off no phonetic Hebrew keyboard mapping
2007 'hlsearch' + off no highlighting of search matches
2008 'incsearch' + off no incremental searching
2009 'indentexpr' + "" no indenting by expression
2010 'insertmode' + off do not start in Insert mode
2011 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002013 'joinspaces' + on insert 2 spaces after period
2014 'modeline' & off no modelines
2015 'more' & off no pauses in listings
2016 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2017 'numberwidth' & 8 min number of columns for line number
2018 'preserveindent'+ off don't preserve current indent structure
2019 when changing it
2020 'revins' + off no reverse insert
2021 'ruler' + off no ruler
2022 'scrolljump' + 1 no jump scroll
2023 'scrolloff' + 0 no scroll offset
2024 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2025 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002026 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002027 'showcmd' & off command characters not shown
2028 'showmode' & off current mode not shown
2029 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2030 'smartcase' + off no automatic ignore case switch
2031 'smartindent' + off no smart indentation
2032 'smarttab' + off no smart tab size
2033 'softtabstop' + 0 tabs are always 'tabstop' positions
2034 'startofline' + on goto startofline with some commands
2035 'tagcase' & "followic" 'ignorecase' when searching tags file
2036 'tagrelative' & off tag file names are not relative
2037 'termguicolors' + off don't use highlight-(guifg|guibg)
2038 'textauto' & off no automatic textmode detection
2039 'textwidth' + 0 no automatic line wrap
2040 'tildeop' + off tilde is not an operator
2041 'ttimeout' + off no terminal timeout
2042 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'virtualedit' + "" cursor can only be placed on characters
2045 'whichwrap' & "" left-right movements don't wrap
2046 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002048 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
2050 *'complete'* *'cpt'* *E535*
2051'complete' 'cpt' string (default: ".,w,b,u,t,i")
2052 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 This option specifies how keyword completion |ins-completion| works
2054 when CTRL-P or CTRL-N are used. It is also used for whole-line
2055 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002056 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002057 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 w scan buffers from other windows
2059 b scan other loaded buffers that are in the buffer list
2060 u scan the unloaded buffers that are in the buffer list
2061 U scan the buffers that are not in the buffer list
2062 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002063 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 k{dict} scan the file {dict}. Several "k" flags can be given,
2065 patterns are valid too. For example: >
2066 :set cpt=k/usr/dict/*,k~/spanish
2067< s scan the files given with the 'thesaurus' option
2068 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2069 are valid too.
2070 i scan current and included files
2071 d scan current and included files for defined name or macro
2072 |i_CTRL-X_CTRL-D|
2073 ] tag completion
2074 t same as "]"
2075
2076 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2077 not executed, this may lead to unexpected completions from some files
2078 (gzipped files for example). Unloaded buffers are not scanned for
2079 whole-line completion.
2080
2081 The default is ".,w,b,u,t,i", which means to scan:
2082 1. the current buffer
2083 2. buffers in other windows
2084 3. other loaded buffers
2085 4. unloaded buffers
2086 5. tags
2087 6. included files
2088
2089 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002090 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2091 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002093 *'completefunc'* *'cfu'*
2094'completefunc' 'cfu' string (default: empty)
2095 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002096 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002097 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002098 This option specifies a function to be used for Insert mode completion
2099 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002100 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002101 invoked and what it should return. The value can be the name of a
2102 function, a |lambda| or a |Funcref|. See |option-value-function| for
2103 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002104 This option cannot be set from a |modeline| or in the |sandbox|, for
2105 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002106
glepnir6a89c942024-10-01 20:32:12 +02002107 *'completeitemalign'* *'cia'*
2108'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2109 global
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
glepnirf400a0c2025-01-23 19:55:14 +01002167 nosort Disable sorting of completion candidates based on fuzzy
2168 scores when "fuzzy" is enabled. Candidates will appear
2169 in their original order.
2170
glepniredd4ac32025-01-29 18:53:51 +01002171 preinsert
2172 Preinsert the portion of the first candidate word that is
2173 not part of the current completion leader and using the
2174 |hl-ComplMatchIns| highlight group. Does not work when
2175 "fuzzy" is also included.
2176
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002177 *'completepopup'* *'cpp'*
2178'completepopup' 'cpp' string (default empty)
2179 global
2180 {not available when compiled without the |+textprop|
2181 or |+quickfix| feature}
2182 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002183 properties of the info popup when it is created. If an info popup
2184 window already exists it is closed, so that the option value is
2185 applied when it is created again.
2186 You can also use |popup_findinfo()| and then set properties for an
2187 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002188
laburnumT3f7855a2023-12-05 18:37:03 +01002189 *'completeslash'* *'csl'*
2190'completeslash' 'csl' string (default: "")
2191 local to buffer
2192 {only for MS-Windows}
2193 When this option is set it overrules 'shellslash' for completion:
2194 - When this option is set to "slash", a forward slash is used for path
2195 completion in insert mode. This is useful when editing HTML tag, or
2196 Makefile with 'noshellslash' on MS-Windows.
2197 - When this option is set to "backslash", backslash is used. This is
2198 useful when editing a batch file with 'shellslash' set on MS-Windows.
2199 - When this option is empty, same character is used as for
2200 'shellslash'.
2201 For Insert mode completion the buffer-local value is used. For
2202 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002203
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002204 *'concealcursor'* *'cocu'*
2205'concealcursor' 'cocu' string (default: "")
2206 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002207 {not available when compiled without the |+conceal|
2208 feature}
2209 Sets the modes in which text in the cursor line can also be concealed.
2210 When the current mode is listed then concealing happens just like in
2211 other lines.
2212 n Normal mode
2213 v Visual mode
2214 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002215 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002216
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002217 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002218 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002219 are moving around text is concealed, but when starting to insert text
2220 or selecting a Visual area the concealed text is displayed, so that
2221 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002222 Keep in mind that the cursor position is not always where it's
2223 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002224
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002225 *'conceallevel'* *'cole'*
2226'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002227 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002228 {not available when compiled without the |+conceal|
2229 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002230 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2231 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002232
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002233 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002234 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002235 1 Each block of concealed text is replaced with one
2236 character. If the syntax item does not have a custom
2237 replacement character defined (see |:syn-cchar|) the
2238 character defined in 'listchars' is used (default is a
2239 space).
2240 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002241 2 Concealed text is completely hidden unless it has a
2242 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002243 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002244 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002245
Bram Moolenaara7781e02010-07-19 20:13:22 +02002246 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002247 edit and copy the text. This can be changed with the 'concealcursor'
2248 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002249
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2251'confirm' 'cf' boolean (default off)
2252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 When 'confirm' is on, certain operations that would normally
2254 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2255 instead raise a |dialog| asking if you wish to save the current
2256 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2257 If 'confirm' is off you can still activate confirmation for one
2258 command only (this is most useful in mappings) with the |:confirm|
2259 command.
2260 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2261
2262 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2263'conskey' 'consk' boolean (default off)
2264 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002265 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266
2267 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2268'copyindent' 'ci' boolean (default off)
2269 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 Copy the structure of the existing lines indent when autoindenting a
2271 new line. Normally the new indent is reconstructed by a series of
2272 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2273 in which case only spaces are used). Enabling this option makes the
2274 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002275 existing line. 'expandtab' has no effect on these characters, a Tab
2276 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002278 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 Also see 'preserveindent'.
2280
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002281 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002282'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2283 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002284 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002287 this indicates Vi-compatible behavior. This is used for things where
2288 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 'cpoptions' stands for "compatible-options".
2290 Commas can be added for readability.
2291 To avoid problems with flags that are added in the future, use the
2292 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002293
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 NOTE: This option is set to the Vi default value when 'compatible' is
2295 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002296
2297 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2298 is saved, 'cpoptions' is set to the Vim default, and the saved value
2299 is restored at the end of the script. Changes to the value of
2300 'cpoptions' will be applied to the saved value, but keep in mind that
2301 removing a flag that is not present when 'cpoptions' is changed has no
2302 effect. In the |.vimrc| file the value is not restored, thus using
2303 `vim9script` in the |.vimrc| file results in using the Vim default.
2304
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305 NOTE: This option is set to the POSIX default value at startup when
2306 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002307 variable exists |posix|. This means Vim tries to behave like the
2308 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309
2310 contains behavior ~
2311 *cpo-a*
2312 a When included, a ":read" command with a file name
2313 argument will set the alternate file name for the
2314 current window.
2315 *cpo-A*
2316 A When included, a ":write" command with a file name
2317 argument will set the alternate file name for the
2318 current window.
2319 *cpo-b*
2320 b "\|" in a ":map" command is recognized as the end of
2321 the map command. The '\' is included in the mapping,
2322 the text after the '|' is interpreted as the next
2323 command. Use a CTRL-V instead of a backslash to
2324 include the '|' in the mapping. Applies to all
2325 mapping, abbreviation, menu and autocmd commands.
2326 See also |map_bar|.
2327 *cpo-B*
2328 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002329 abbreviations, user commands and the "to" part of the
2330 menu commands. Remove this flag to be able to use a
2331 backslash like a CTRL-V. For example, the command
2332 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 'B' included: "\^[" (^[ is a real <Esc>)
2334 'B' excluded: "<Esc>" (5 characters)
2335 ('<' excluded in both cases)
2336 *cpo-c*
2337 c Searching continues at the end of any match at the
2338 cursor position, but not further than the start of the
2339 next line. When not present searching continues
2340 one character from the cursor position. With 'c'
2341 "abababababab" only gets three matches when repeating
2342 "/abab", without 'c' there are five matches.
2343 *cpo-C*
2344 C Do not concatenate sourced lines that start with a
2345 backslash. See |line-continuation|.
2346 *cpo-d*
2347 d Using "./" in the 'tags' option doesn't mean to use
2348 the tags file relative to the current file, but the
2349 tags file in the current directory.
2350 *cpo-D*
2351 D Can't use CTRL-K to enter a digraph after Normal mode
2352 commands with a character argument, like |r|, |f| and
2353 |t|.
2354 *cpo-e*
2355 e When executing a register with ":@r", always add a
2356 <CR> to the last line, also when the register is not
2357 linewise. If this flag is not present, the register
2358 is not linewise and the last line does not end in a
2359 <CR>, then the last line is put on the command-line
2360 and can be edited before hitting <CR>.
2361 *cpo-E*
2362 E It is an error when using "y", "d", "c", "g~", "gu" or
2363 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002364 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 This makes "y0" fail in the first column.
2366 *cpo-f*
2367 f When included, a ":read" command with a file name
2368 argument will set the file name for the current buffer,
2369 if the current buffer doesn't have a file name yet.
2370 *cpo-F*
2371 F When included, a ":write" command with a file name
2372 argument will set the file name for the current
2373 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002374 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 *cpo-g*
2376 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002377 *cpo-H*
2378 H When using "I" on a line with only blanks, insert
2379 before the last blank. Without this flag insert after
2380 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 *cpo-i*
2382 i When included, interrupting the reading of a file will
2383 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002384 *cpo-I*
2385 I When moving the cursor up or down just after inserting
2386 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *cpo-j*
2388 j When joining lines, only add two spaces after a '.',
2389 not after '!' or '?'. Also see 'joinspaces'.
2390 *cpo-J*
2391 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002392 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 white space.
2394 *cpo-k*
2395 k Disable the recognition of raw key codes in
2396 mappings, abbreviations, and the "to" part of menu
2397 commands. For example, if <Key> sends ^[OA (where ^[
2398 is <Esc>), the command ":map X ^[OA" results in X
2399 being mapped to:
2400 'k' included: "^[OA" (3 characters)
2401 'k' excluded: "<Key>" (one key code)
2402 Also see the '<' flag below.
2403 *cpo-K*
2404 K Don't wait for a key code to complete when it is
2405 halfway a mapping. This breaks mapping <F1><F1> when
2406 only part of the second <F1> has been read. It
2407 enables cancelling the mapping by typing <F1><Esc>.
2408 *cpo-l*
2409 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002410 literally, only "\]", "\^", "\-" and "\\" are special.
2411 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2413 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002414 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *cpo-L*
2416 L When the 'list' option is set, 'wrapmargin',
2417 'textwidth', 'softtabstop' and Virtual Replace mode
2418 (see |gR|) count a <Tab> as two characters, instead of
2419 the normal behavior of a <Tab>.
2420 *cpo-m*
2421 m When included, a showmatch will always wait half a
2422 second. When not included, a showmatch will wait half
2423 a second or until a character is typed. |'showmatch'|
2424 *cpo-M*
2425 M When excluded, "%" matching will take backslashes into
2426 account. Thus in "( \( )" and "\( ( \)" the outer
2427 parenthesis match. When included "%" ignores
2428 backslashes, which is Vi compatible.
2429 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002430 n When included, the column used for 'number' and
2431 'relativenumber' will also be used for text of wrapped
2432 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 *cpo-o*
2434 o Line offset to search command is not remembered for
2435 next search.
2436 *cpo-O*
2437 O Don't complain if a file is being overwritten, even
2438 when it didn't exist when editing it. This is a
2439 protection against a file unexpectedly created by
2440 someone else. Vi didn't complain about this.
2441 *cpo-p*
2442 p Vi compatible Lisp indenting. When not present, a
2443 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002444 *cpo-P*
2445 P When included, a ":write" command that appends to a
2446 file will set the file name for the current buffer, if
2447 the current buffer doesn't have a file name yet and
2448 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002449 *cpo-q*
2450 q When joining multiple lines leave the cursor at the
2451 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 *cpo-r*
2453 r Redo ("." command) uses "/" to repeat a search
2454 command, instead of the actually used search string.
2455 *cpo-R*
2456 R Remove marks from filtered lines. Without this flag
2457 marks are kept like |:keepmarks| was used.
2458 *cpo-s*
2459 s Set buffer options when entering the buffer for the
2460 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002461 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 set when the buffer is created.
2463 *cpo-S*
2464 S Set buffer options always when entering a buffer
2465 (except 'readonly', 'fileformat', 'filetype' and
2466 'syntax'). This is the (most) Vi compatible setting.
2467 The options are set to the values in the current
2468 buffer. When you change an option and go to another
2469 buffer, the value is copied. Effectively makes the
2470 buffer options global to all buffers.
2471
2472 's' 'S' copy buffer options
2473 no no when buffer created
2474 yes no when buffer first entered (default)
2475 X yes each time when buffer entered (vi comp.)
2476 *cpo-t*
2477 t Search pattern for the tag command is remembered for
2478 "n" command. Otherwise Vim only puts the pattern in
2479 the history for search pattern, but doesn't change the
2480 last used search pattern.
2481 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002482 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 *cpo-v*
2484 v Backspaced characters remain visible on the screen in
2485 Insert mode. Without this flag the characters are
2486 erased from the screen right away. With this flag the
2487 screen newly typed text overwrites backspaced
2488 characters.
2489 *cpo-w*
2490 w When using "cw" on a blank character, only change one
2491 character and not all blanks until the start of the
2492 next word.
2493 *cpo-W*
2494 W Don't overwrite a readonly file. When omitted, ":w!"
2495 overwrites a readonly file, if possible.
2496 *cpo-x*
2497 x <Esc> on the command-line executes the command-line.
2498 The default in Vim is to abandon the command-line,
2499 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002500 *cpo-X*
2501 X When using a count with "R" the replaced text is
2502 deleted only once. Also when repeating "R" with "."
2503 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002505 y A yank command can be redone with ".". Think twice if
2506 you really want to use this, it may break some
2507 plugins, since most people expect "." to only repeat a
2508 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002509 *cpo-Z*
2510 Z When using "w!" while the 'readonly' option is set,
2511 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002512 *cpo-z*
2513 z Special casing the "cw" and "d" command (see |cw| and
2514 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 *cpo-!*
2516 ! When redoing a filter command, use the last used
2517 external command, whatever it was. Otherwise the last
2518 used -filter- command is used.
2519 *cpo-$*
2520 $ When making a change to one line, don't redisplay the
2521 line, but put a '$' at the end of the changed text.
2522 The changed text will be overwritten when you type the
2523 new text. The line is redisplayed if you type any
2524 command that moves the cursor from the insertion
2525 point.
2526 *cpo-%*
2527 % Vi-compatible matching is done for the "%" command.
2528 Does not recognize "#if", "#endif", etc.
2529 Does not recognize "/*" and "*/".
2530 Parens inside single and double quotes are also
2531 counted, causing a string that contains a paren to
2532 disturb the matching. For example, in a line like
2533 "if (strcmp("foo(", s))" the first paren does not
2534 match the last one. When this flag is not included,
2535 parens inside single and double quotes are treated
2536 specially. When matching a paren outside of quotes,
2537 everything inside quotes is ignored. When matching a
2538 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002540 This flag is also used for other features, such as
2541 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002542 *cpo--*
2543 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002544 it would go above the first line or below the last
2545 line. Without it the cursor moves to the first or
2546 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002547 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002548 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002549 *cpo-+*
2550 + When included, a ":write file" command will reset the
2551 'modified' flag of the buffer, even though the buffer
2552 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002553 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 * Use ":*" in the same way as ":@". When not included,
2555 ":*" is an alias for ":'<,'>", select the Visual area.
2556 *cpo-<*
2557 < Disable the recognition of special key codes in |<>|
2558 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002559 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 ":map X <Tab>" results in X being mapped to:
2561 '<' included: "<Tab>" (5 characters)
2562 '<' excluded: "^I" (^I is a real <Tab>)
2563 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002564 *cpo->*
2565 > When appending to a register, put a line break before
2566 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002567 *cpo-;*
2568 ; When using |,| or |;| to repeat the last |t| search
2569 and the cursor is right in front of the searched
2570 character, the cursor won't move. When not included,
2571 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002572 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002573
2574 POSIX flags. These are not included in the Vi default value, except
2575 when $VIM_POSIX was set on startup. |posix|
2576
2577 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002578 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002579 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002580 *cpo-&*
2581 & When ":preserve" was used keep the swap file when
2582 exiting normally while this buffer is still loaded.
2583 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002584 *cpo-\*
2585 \ Backslash in a [] range in a search pattern is taken
2586 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002587 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2588 '\' excluded: "/[ \-]" finds <Space> and '-'
2589 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002590 *cpo-/*
2591 / When "%" is used as the replacement string in a |:s|
2592 command, use the previous replacement string. |:s%|
2593 *cpo-{*
2594 { The |{| and |}| commands also stop at a "{" character
2595 at the start of a line.
2596 *cpo-.*
2597 . The ":chdir" and ":cd" commands fail if the current
2598 buffer is modified, unless ! is used. Vim doesn't
2599 need this, since it remembers the full path of an
2600 opened file.
2601 *cpo-bar*
2602 | The value of the $LINES and $COLUMNS environment
2603 variables overrule the terminal size values obtained
2604 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002605
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002606 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002607'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002608 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002609 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002610 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002611 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002612 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002613 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002614 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002615 blowfish Blowfish method. Medium strong encryption but it has
2616 an implementation flaw. Requires Vim 7.3 or later,
2617 files can NOT be read by Vim 7.2 and older. This adds
2618 a "seed" to the file, every time you write the file
2619 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002620 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002621 *blowfish2*
2622 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002623 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002624 and older. This adds a "seed" to the file, every time
2625 you write the file the encrypted bytes will be
2626 different. The whole undo file is encrypted, not just
2627 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002628 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002629 *E1197* *E1198* *E1199* *E1200* *E1201*
2630 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2631 Code. Medium strong till strong encryption.
2632 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002633 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002634 It adds a seed and a message authentication code (MAC)
2635 to the file. This needs at least a Vim 8.2.3022 to
2636 read the encrypted file.
2637 Encryption of swap files is not supported, therefore
2638 no swap file will be used when xchacha20 encryption is
2639 enabled.
2640 Encryption of undo files is not yet supported,
2641 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002642 CAREFUL: Files written with this method might have to
2643 be read back with the same version of Vim if the
2644 binary format changes later.
2645 Obsolete, please do no longer use.
2646 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2647 stores the key derivation parameters together with the
2648 encrypted file. Should work better in case the
2649 parameters in the libsodium library ever change.
2650 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002651 might have to be read back with the same version of
2652 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002653
Christian Brabandtaae58342023-04-23 17:50:22 +01002654 You should use "blowfish2", also to re-encrypt older files. The
2655 "xchacha20" method provides better encryption, but it does not work
2656 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002657
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002658 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002659 to the detected method of the file being read. Thus if you write it
2660 without changing 'cryptmethod' the same method will be used.
2661 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002662 explicitly write it, you don't get a warning unless there are other
2663 modifications. Also see |:X|.
2664
2665 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002666 the value "blowfish2". When setting the local value to an empty
2667 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002668
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002669 When a new encryption method is added in a later version of Vim, and
2670 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002671 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002672
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 *'cscopepathcomp'* *'cspc'*
2674'cscopepathcomp' 'cspc' number (default 0)
2675 global
2676 {not available when compiled without the |+cscope|
2677 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 Determines how many components of the path to show in a list of tags.
2679 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002680 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681
2682 *'cscopeprg'* *'csprg'*
2683'cscopeprg' 'csprg' string (default "cscope")
2684 global
2685 {not available when compiled without the |+cscope|
2686 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 Specifies the command to execute cscope. See |cscopeprg|.
2688 This option cannot be set from a |modeline| or in the |sandbox|, for
2689 security reasons.
2690
2691 *'cscopequickfix'* *'csqf'*
2692'cscopequickfix' 'csqf' string (default "")
2693 global
2694 {not available when compiled without the |+cscope|
2695 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 Specifies whether to use quickfix window to show cscope results.
2697 See |cscopequickfix|.
2698
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002699 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002700'cscoperelative' 'csre' boolean (default off)
2701 global
2702 {not available when compiled without the |+cscope|
2703 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002704 In the absence of a prefix (-P) for cscope. setting this option enables
2705 to use the basename of cscope.out path as the prefix.
2706 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002707 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002708
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2710'cscopetag' 'cst' boolean (default off)
2711 global
2712 {not available when compiled without the |+cscope|
2713 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 Use cscope for tag commands. See |cscope-options|.
2715 NOTE: This option is reset when 'compatible' is set.
2716
2717 *'cscopetagorder'* *'csto'*
2718'cscopetagorder' 'csto' number (default 0)
2719 global
2720 {not available when compiled without the |+cscope|
2721 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 Determines the order in which ":cstag" performs a search. See
2723 |cscopetagorder|.
2724 NOTE: This option is set to 0 when 'compatible' is set.
2725
2726 *'cscopeverbose'* *'csverb'*
2727 *'nocscopeverbose'* *'nocsverb'*
2728'cscopeverbose' 'csverb' boolean (default off)
2729 global
2730 {not available when compiled without the |+cscope|
2731 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 Give messages when adding a cscope database. See |cscopeverbose|.
2733 NOTE: This option is reset when 'compatible' is set.
2734
Bram Moolenaar860cae12010-06-05 23:22:07 +02002735 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2736'cursorbind' 'crb' boolean (default off)
2737 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002738 When this option is set, as the cursor in the current
2739 window moves other cursorbound windows (windows that also have
2740 this option set) move their cursors to the corresponding line and
2741 column. This option is useful for viewing the
2742 differences between two versions of a file (see 'diff'); in diff mode,
2743 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002744 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002745
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002746 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2747'cursorcolumn' 'cuc' boolean (default off)
2748 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002749 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002750 feature}
2751 Highlight the screen column of the cursor with CursorColumn
2752 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2753 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002754 If you only want the highlighting in the current window you can use
2755 these autocommands: >
2756 au WinLeave * set nocursorline nocursorcolumn
2757 au WinEnter * set cursorline cursorcolumn
2758<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002759
2760 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2761'cursorline' 'cul' boolean (default off)
2762 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002763 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002764 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002765 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2766 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002767 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002768 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002769
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002770 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002771'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002772 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002773 {not available when compiled without the |+syntax|
2774 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002775 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002776 Valid values:
2777 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002778 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002779 "screenline" Highlight only the screen line of the cursor with
2780 CursorLine |hl-CursorLine|.
2781 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002782 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002783
2784 Special value:
2785 "both" Alias for the values "line,number".
2786
2787 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002788
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 *'debug'*
2790'debug' string (default "")
2791 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002792 These values can be used:
2793 msg Error messages that would otherwise be omitted will be given
2794 anyway.
2795 throw Error messages that would otherwise be omitted will be given
2796 anyway and also throw an exception and set |v:errmsg|.
2797 beep A message will be given when otherwise only a beep would be
2798 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002799 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002800 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2801 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
2803 *'define'* *'def'*
2804'define' 'def' string (default "^\s*#\s*define")
2805 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002806 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 pattern, just like for the "/" command. This option is used for the
2808 commands like "[i" and "[d" |include-search|. The 'isident' option is
2809 used to recognize the defined name after the match:
2810 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2811 See |option-backslash| about inserting backslashes to include a space
2812 or backslash.
2813 The default value is for C programs. For C++ this value would be
2814 useful, to include const type declarations: >
2815 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002816< You can also use "\ze" just before the name and continue the pattern
2817 to check what is following. E.g. for Javascript, if a function is
2818 defined with "func_name = function(args)": >
2819 ^\s*\ze\i\+\s*=\s*function(
2820< If the function is defined with "func_name : function() {...": >
2821 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002823 To avoid that use `:let` with a single quote string: >
2824 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002825<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826
2827 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2828'delcombine' 'deco' boolean (default off)
2829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 If editing Unicode and this option is set, backspace and Normal mode
2831 "x" delete each combining character on its own. When it is off (the
2832 default) the character along with its combining characters are
2833 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002834 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835
2836 This is useful for Arabic, Hebrew and many other languages where one
2837 may have combining characters overtop of base characters, and want
2838 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002839 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
2841 *'dictionary'* *'dict'*
2842'dictionary' 'dict' string (default "")
2843 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 List of file names, separated by commas, that are used to lookup words
2845 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2846 contain a list of words. This can be one word per line, or several
2847 words per line, separated by non-keyword characters (white space is
2848 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002849
2850 When this option is empty or an entry "spell" is present, and spell
2851 checking is enabled, words in the word lists for the currently active
2852 'spelllang' are used. See |spell|.
2853
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002854 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 after a comma are ignored, otherwise spaces are included in the file
2856 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002857 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 Where to find a list of words?
2859 - On FreeBSD, there is the file "/usr/share/dict/words".
2860 - In the Simtel archive, look in the "msdos/linguist" directory.
2861 - In "miscfiles" of the GNU collection.
2862 The use of |:set+=| and |:set-=| is preferred when adding or removing
2863 directories from the list. This avoids problems when a future version
2864 uses another default.
2865 Backticks cannot be used in this option for security reasons.
2866
2867 *'diff'* *'nodiff'*
2868'diff' boolean (default off)
2869 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 {not available when compiled without the |+diff|
2871 feature}
2872 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002873 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874
2875 *'dex'* *'diffexpr'*
2876'diffexpr' 'dex' string (default "")
2877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 {not available when compiled without the |+diff|
2879 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002880 Expression which is evaluated to obtain a diff file (either ed-style
2881 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 This option cannot be set from a |modeline| or in the |sandbox|, for
2883 security reasons.
2884
2885 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002886'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 {not available when compiled without the |+diff|
2889 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 All are optional. Items must be separated by a comma.
2892
Jonathon7c7a4e62025-01-12 09:58:00 +01002893 algorithm:{text} Use the specified diff algorithm with the
2894 internal diff engine. Currently supported
2895 algorithms are:
2896 myers the default algorithm
2897 minimal spend extra time to generate the
2898 smallest possible diff
2899 patience patience diff algorithm
2900 histogram histogram diff algorithm
2901
2902 closeoff When a window is closed where 'diff' is set
2903 and there is only one window remaining in the
2904 same tab page with 'diff' set, execute
2905 `:diffoff` in that window. This undoes a
2906 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907
2908 context:{n} Use a context of {n} lines between a change
2909 and a fold that contains unchanged lines.
2910 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002911 When using zero the context is actually one,
2912 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002913 for a deleted line. Set it to a very large
2914 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 See |fold-diff|.
2916
Jonathon7c7a4e62025-01-12 09:58:00 +01002917 filler Show filler lines, to keep the text
2918 synchronized with a window that has inserted
2919 lines at the same position. Mostly useful
2920 when windows are side-by-side and 'scrollbind'
2921 is set.
2922
2923 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2924 starting diff mode. Without this 2 is used.
2925
2926 followwrap Follow the 'wrap' option and leave as it is.
2927
2928 horizontal Start diff mode with horizontal splits (unless
2929 explicitly specified otherwise).
2930
2931 hiddenoff Do not use diff mode for a buffer when it
2932 becomes hidden.
2933
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002934 iblank Ignore changes where lines are all blank. Adds
2935 the "-B" flag to the "diff" command if
2936 'diffexpr' is empty. Check the documentation
2937 of the "diff" command for what this does
2938 exactly.
2939 NOTE: the diff windows will get out of sync,
2940 because no differences between blank lines are
2941 taken into account.
2942
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 icase Ignore changes in case of text. "a" and "A"
2944 are considered the same. Adds the "-i" flag
2945 to the "diff" command if 'diffexpr' is empty.
2946
Jonathon7c7a4e62025-01-12 09:58:00 +01002947 indent-heuristic
2948 Use the indent heuristic for the internal
2949 diff library.
2950
2951 internal Use the internal diff library. This is
2952 ignored when 'diffexpr' is set. *E960*
2953 When running out of memory when writing a
2954 buffer this item will be ignored for diffs
2955 involving that buffer. Set the 'verbose'
2956 option to see when this happens.
2957
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 iwhite Ignore changes in amount of white space. Adds
2959 the "-b" flag to the "diff" command if
2960 'diffexpr' is empty. Check the documentation
2961 of the "diff" command for what this does
2962 exactly. It should ignore adding trailing
2963 white space, but not leading white space.
2964
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002965 iwhiteall Ignore all white space changes. Adds
2966 the "-w" flag to the "diff" command if
2967 'diffexpr' is empty. Check the documentation
2968 of the "diff" command for what this does
2969 exactly.
2970
2971 iwhiteeol Ignore white space changes at end of line.
2972 Adds the "-Z" flag to the "diff" command if
2973 'diffexpr' is empty. Check the documentation
2974 of the "diff" command for what this does
2975 exactly.
2976
Jonathon7c7a4e62025-01-12 09:58:00 +01002977 linematch:{n} Align and mark changes between the most
2978 similar lines between the buffers. When the
2979 total number of lines in the diff hunk exceeds
2980 {n}, the lines will not be aligned because for
2981 very large diff hunks there will be a
2982 noticeable lag. A reasonable setting is
2983 "linematch:60", as this will enable alignment
2984 for a 2 buffer diff hunk of 30 lines each,
2985 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002986
2987 vertical Start diff mode with vertical splits (unless
2988 explicitly specified otherwise).
2989
Bram Moolenaare828b762018-09-10 17:51:58 +02002990 Examples: >
2991 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002993 :set diffopt=internal,filler,foldcolumn:3
2994 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995<
2996 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2997'digraph' 'dg' boolean (default off)
2998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 {not available when compiled without the |+digraphs|
3000 feature}
3001 Enable the entering of digraphs in Insert mode with {char1} <BS>
3002 {char2}. See |digraphs|.
3003 NOTE: This option is reset when 'compatible' is set.
3004
3005 *'directory'* *'dir'*
3006'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003007 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 for Unix: ".,~/tmp,/var/tmp,/tmp")
3009 global
3010 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003011 Recommended value: ".,~/vimswap//" - this will put the swap file next
3012 to the edited file if possible, and in your personal swap directory
3013 otherwise. Make sure "~/vimswap//" is only readable for you.
3014
3015 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 - The swap file will be created in the first directory where this is
3017 possible.
3018 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003019 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 - A directory "." means to put the swap file in the same directory as
3021 the edited file. On Unix, a dot is prepended to the file name, so
3022 it doesn't show in a directory listing. On MS-Windows the "hidden"
3023 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003024 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3025 the swap file relative to where the edited file is. The leading "."
3026 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003027 - For Unix and Win32, if a directory ends in two path separators "//",
3028 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003029 with all path separators replaced by percent '%' signs (including
3030 the colon following the drive letter on Win32). This will ensure
3031 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003032 On Win32, it is also possible to end with "\\". However, When a
3033 separating comma is following, you must use "//", since "\\" will
3034 include the comma in the file name. Therefore it is recommended to
3035 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 - Spaces after the comma are ignored, other spaces are considered part
3037 of the directory name. To have a space at the start of a directory
3038 name, precede it with a backslash.
3039 - To include a comma in a directory name precede it with a backslash.
3040 - A directory name may end in an ':' or '/'.
3041 - Environment variables are expanded |:set_env|.
3042 - Careful with '\' characters, type one before a space, type two to
3043 get one in the option (see |option-backslash|), for example: >
3044 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3045< - For backwards compatibility with Vim version 3.0 a '>' at the start
3046 of the option is removed.
3047 Using "." first in the list is recommended. This means that editing
3048 the same file twice will result in a warning. Using "/tmp" on Unix is
3049 discouraged: When the system crashes you lose the swap file.
3050 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003051 choice than "/tmp". But others on the computer may be able to see the
3052 files, and it can contain a lot of files, your swap files get lost in
3053 the crowd. That is why a "tmp" directory in your home directory is
3054 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 The use of |:set+=| and |:set-=| is preferred when adding or removing
3056 directories from the list. This avoids problems when a future version
3057 uses another default.
3058 This option cannot be set from a |modeline| or in the |sandbox|, for
3059 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060
3061 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003062'display' 'dy' string (default "", set to "truncate" in
3063 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003065 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 flags:
3067 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003068 in a window will be displayed. "@@@" is put in the
3069 last columns of the last screen line to indicate the
3070 rest of the line is not displayed.
3071 truncate Like "lastline", but "@@@" is displayed in the first
3072 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 uhex Show unprintable characters hexadecimal as <xx>
3074 instead of using ^C and ~C.
3075
Bram Moolenaard0796902016-09-16 20:02:31 +02003076 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003077 doesn't fit is replaced with "@" lines.
3078
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003079 The "@" character can be changed by setting the "lastline" item in
3080 'fillchars'. The character is highlighted with |hl-NonText|.
3081
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 *'eadirection'* *'ead'*
3083'eadirection' 'ead' string (default "both")
3084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 Tells when the 'equalalways' option applies:
3086 ver vertically, width of windows is not affected
3087 hor horizontally, height of windows is not affected
3088 both width and height of windows is affected
3089
3090 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3091'edcompatible' 'ed' boolean (default off)
3092 global
3093 Makes the 'g' and 'c' flags of the ":substitute" command to be
3094 toggled each time the flag is given. See |complex-change|. See
3095 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003096 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003097 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098
Bram Moolenaar03413f42016-04-12 21:07:15 +02003099 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003100'emoji' 'emo' boolean (default: on)
3101 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003102 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003103 This excludes "text emoji" characters, which are normally displayed as
3104 single width. Unfortunately there is no good specification for this
3105 and it has been determined on trial-and-error basis. Use the
3106 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003109'encoding' 'enc' string (default for MS-Windows: "utf-8",
3110 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 Sets the character encoding used inside Vim. It applies to text in
3113 the buffers, registers, Strings in expressions, text stored in the
3114 viminfo file, etc. It sets the kind of characters which Vim can work
3115 with. See |encoding-names| for the possible values.
3116
3117 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003118 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003120 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121
Bram Moolenaar865242e2010-07-14 21:12:05 +02003122 This option cannot be set from a |modeline|. It would most likely
3123 corrupt the text.
3124
Bram Moolenaar3df01732017-02-17 22:47:16 +01003125 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3126 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 'encoding', "utf-8" is the natural choice for the environment and
3128 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003129 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 versions, and to avoid changing the encoding of newly created files
3131 without your knowledge (in case 'fileencodings' is empty).
3132
3133 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003134 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 iconv() or as specified with 'charconvert'.
3136
Bram Moolenaar207f0092020-08-30 17:20:20 +02003137 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003138 can use: >
3139 if has("multi_byte_encoding")
3140<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 Normally 'encoding' will be equal to your current locale. This will
3142 be the default if Vim recognizes your environment settings. If
3143 'encoding' is not set to the current locale, 'termencoding' must be
3144 set to convert typed and displayed text. See |encoding-table|.
3145
3146 When you set this option, it fires the |EncodingChanged| autocommand
3147 event so that you can set up fonts if necessary.
3148
3149 When the option is set, the value is converted to lowercase. Thus
3150 you can set it with uppercase values too. Underscores are translated
3151 to '-' signs.
3152 When the encoding is recognized, it is changed to the standard name.
3153 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3154 "iso-8859-2" and "utf8" becomes "utf-8".
3155
3156 Note: "latin1" is also used when the encoding could not be detected.
3157 This only works when editing files in the same encoding! When the
3158 actual character set is not latin1, make sure 'fileencoding' and
3159 'fileencodings' are empty. When conversion is needed, switch to using
3160 utf-8.
3161
3162 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3163 You don't notice this while editing, but it does matter for the
3164 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3165 setting 'encoding' to one of these values instead of utf-8 only has
3166 effect for encoding used for files when 'fileencoding' is empty.
3167
Bram Moolenaar661b1822005-07-28 22:36:45 +00003168 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3169 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003171 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003172'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003174 Indicates that a CTRL-Z character was found at the end of the file
3175 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003177 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003178 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003179 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003180
3181 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3182'endofline' 'eol' boolean (default on)
3183 local to buffer
3184 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003185 is on, or 'fixeol' option is off, no <EOL> will be written for the
3186 last line in the file. This option is automatically set or reset when
3187 starting to edit a new file, depending on whether file has an <EOL>
3188 for the last line in the file. Normally you don't have to set or
3189 reset this option.
3190 When 'binary' is off and 'fixeol' is on the value is not used when
3191 writing the file. When 'binary' is on or 'fixeol' is off it is used
3192 to remember the presence of a <EOL> for the last line in the file, so
3193 that when you write the file the situation from the original file can
3194 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003195 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196
3197 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3198'equalalways' 'ea' boolean (default on)
3199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003201 splitting or closing a window. This also happens the moment the
3202 option is switched on. When off, splitting a window will reduce the
3203 size of the current window and leave the other windows the same. When
3204 closing a window the extra lines are given to the window next to it
3205 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 When mixing vertically and horizontally split windows, a minimal size
3207 is computed and some windows may be larger if there is room. The
3208 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003209 Changing the height and width of a window can be avoided by setting
3210 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003211 If a window size is specified when creating a new window sizes are
3212 currently not equalized (it's complicated, but may be implemented in
3213 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214
3215 *'equalprg'* *'ep'*
3216'equalprg' 'ep' string (default "")
3217 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003219 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003220 or 'indentexpr'. When Vim was compiled without internal formatting,
3221 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003222 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 about including spaces and backslashes.
3224 This option cannot be set from a |modeline| or in the |sandbox|, for
3225 security reasons.
3226
3227 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3228'errorbells' 'eb' boolean (default off)
3229 global
3230 Ring the bell (beep or screen flash) for error messages. This only
3231 makes a difference for error messages, the bell will be used always
3232 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003233 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003234 screen flash or do nothing. See 'belloff' to finetune when to ring the
3235 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 *'errorfile'* *'ef'*
3238'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3239 others: "errors.err")
3240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 {not available when compiled without the |+quickfix|
3242 feature}
3243 Name of the errorfile for the QuickFix mode (see |:cf|).
3244 When the "-q" command-line argument is used, 'errorfile' is set to the
3245 following argument. See |-q|.
3246 NOT used for the ":make" command. See 'makeef' for that.
3247 Environment variables are expanded |:set_env|.
3248 See |option-backslash| about including spaces and backslashes.
3249 This option cannot be set from a |modeline| or in the |sandbox|, for
3250 security reasons.
3251
3252 *'errorformat'* *'efm'*
3253'errorformat' 'efm' string (default is very long)
3254 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 {not available when compiled without the |+quickfix|
3256 feature}
3257 Scanf-like description of the format for the lines in the error file
3258 (see |errorformat|).
3259
3260 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3261'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 Function keys that start with an <Esc> are recognized in Insert
3264 mode. When this option is off, the cursor and function keys cannot be
3265 used in Insert mode if they start with an <Esc>. The advantage of
3266 this is that the single <Esc> is recognized immediately, instead of
3267 after one second. Instead of resetting this option, you might want to
3268 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3269 when 'esckeys' is off, you can still map anything, but the cursor keys
3270 won't work by default.
3271 NOTE: This option is set to the Vi default value when 'compatible' is
3272 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003273 NOTE: when this option is off then the |modifyOtherKeys| and
3274 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3275 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276
3277 *'eventignore'* *'ei'*
3278'eventignore' 'ei' string (default "")
3279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003281 When set to "all" or when "all" is one of the items, all autocommand
3282 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003283 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 :set ei=WinEnter,WinLeave
3285<
3286 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3287'expandtab' 'et' boolean (default off)
3288 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3292 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003293 This option is reset when the 'paste' option is set and restored when
3294 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 NOTE: This option is reset when 'compatible' is set.
3296
3297 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3298'exrc' 'ex' boolean (default off)
3299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003301 directory.
3302
3303 Setting this option is a potential security leak. E.g., consider
3304 unpacking a package or fetching files from github, a .vimrc in there
3305 might be a trojan horse. BETTER NOT SET THIS OPTION!
3306 Instead, define an autocommand in your .vimrc to set options for a
3307 matching directory.
3308
3309 If you do switch this option on you should also consider setting the
3310 'secure' option (see |initialization|).
3311 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 This option cannot be set from a |modeline| or in the |sandbox|, for
3313 security reasons.
3314
3315 *'fileencoding'* *'fenc'* *E213*
3316'fileencoding' 'fenc' string (default: "")
3317 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003321 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 When 'fileencoding' is empty, the same value as 'encoding' will be
3323 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003324 No error will be given when the value is set, only when it is used,
3325 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003326 Conversion will also be done when 'encoding' and 'fileencoding' are
3327 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3328 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003330 'encoding' is "utf-8" or another Unicode encoding, conversion
3331 is most likely done in a way that the reverse conversion
3332 results in the same text. When 'encoding' is not "utf-8" some
3333 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003334
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 See 'encoding' for the possible values. Additionally, values may be
3336 specified that can be handled by the converter, see
3337 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 When reading a file 'fileencoding' will be set from 'fileencodings'.
3340 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003341 'fileencoding', use the |++enc| argument. One exception: when
3342 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003343 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003344
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3346 When the option is set, the value is converted to lowercase. Thus
3347 you can set it with uppercase values too. '_' characters are
3348 replaced with '-'. If a name is recognized from the list for
3349 'encoding', it is replaced by the standard name. For example
3350 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 When this option is set, after starting to edit a file, the 'modified'
3353 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003354
3355 Keep in mind that changing 'fenc' from a modeline happens
3356 AFTER the text has been read, thus it applies to when the file will be
3357 written. If you do set 'fenc' in a modeline, you might want to set
3358 'nomodified' to avoid not being able to ":q".
3359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 This option can not be changed when 'modifiable' is off.
3361
3362 *'fe'*
3363 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003364 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 old short name was 'fe', which is no longer used.
3366
3367 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003368'fileencodings' 'fencs' string (default: "ucs-bom",
3369 "ucs-bom,utf-8,default,latin1" when
3370 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 This is a list of character encodings considered when starting to edit
3373 an existing file. When a file is read, Vim tries to use the first
3374 mentioned character encoding. If an error is detected, the next one
3375 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003376 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 an empty string, which means the value of 'encoding' is used.
3378 WARNING: Conversion can cause loss of information! When
3379 'encoding' is "utf-8" (or one of the other Unicode variants)
3380 conversion is most likely done in a way that the reverse
3381 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003382 "utf-8" some non-ASCII characters may be lost! You can use
3383 the |++bad| argument to specify what is done with characters
3384 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 For an empty file or a file with only ASCII characters most encodings
3386 will work and the first entry of 'fileencodings' will be used (except
3387 "ucs-bom", which requires the BOM to be present). If you prefer
3388 another encoding use an BufReadPost autocommand event to test if your
3389 preferred encoding is to be used. Example: >
3390 au BufReadPost * if search('\S', 'w') == 0 |
3391 \ set fenc=iso-2022-jp | endif
3392< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3393 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003394 When the |++enc| argument is used then the value of 'fileencodings' is
3395 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003396 Note that 'fileencodings' is not used for a new file, the global value
3397 of 'fileencoding' is used instead. You can set it with: >
3398 :setglobal fenc=iso-8859-2
3399< This means that a non-existing file may get a different encoding than
3400 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 The special value "ucs-bom" can be used to check for a Unicode BOM
3402 (Byte Order Mark) at the start of the file. It must not be preceded
3403 by "utf-8" or another Unicode encoding for this to work properly.
3404 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3405 because Vim cannot detect an error, thus the encoding is always
3406 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003407 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003408 environment. On MS-Windows this is the system encoding. Otherwise
3409 this is the default value for 'encoding'. It is useful when
3410 'encoding' is set to "utf-8" and your environment uses a non-latin1
3411 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003412 When 'encoding' is "utf-8" and a file contains an illegal byte
3413 sequence it won't be recognized as UTF-8. You can use the |8g8|
3414 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 WRONG VALUES: WHAT'S WRONG:
3416 latin1,utf-8 "latin1" will always be used
3417 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3418 file
3419 cp1250,latin1 "cp1250" will always be used
3420 If 'fileencodings' is empty, 'fileencoding' is not modified.
3421 See 'fileencoding' for the possible values.
3422 Setting this option does not have an effect until the next time a file
3423 is read.
3424
3425 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003426'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003427 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 This gives the <EOL> of the current buffer, which is used for
3430 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003431 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 unix <NL>
3433 mac <CR>
3434 When "dos" is used, CTRL-Z at the end of a file is ignored.
3435 See |file-formats| and |file-read|.
3436 For the character encoding of the file see 'fileencoding'.
3437 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003438 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 This option is set automatically when starting to edit a file and
3440 'fileformats' is not empty and 'binary' is off.
3441 When this option is set, after starting to edit a file, the 'modified'
3442 option is set, because the file would be different when written.
3443 This option can not be changed when 'modifiable' is off.
3444 For backwards compatibility: When this option is set to "dos",
3445 'textmode' is set, otherwise 'textmode' is reset.
3446
3447 *'fileformats'* *'ffs'*
3448'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003449 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003450 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 Vi Cygwin: "unix,dos",
3452 Vi others: "")
3453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 This gives the end-of-line (<EOL>) formats that will be tried when
3455 starting to edit a new buffer and when reading a file into an existing
3456 buffer:
3457 - When empty, the format defined with 'fileformat' will be used
3458 always. It is not set automatically.
3459 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003460 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 'fileformats' name will be used when a file is read into an existing
3462 buffer, no matter what 'fileformat' for that buffer is set to.
3463 - When more than one name is present, separated by commas, automatic
3464 <EOL> detection will be done when reading a file. When starting to
3465 edit a file, a check is done for the <EOL>:
3466 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3467 'fileformat' is set to "dos".
3468 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003469 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003471 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3472 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003473 This means that "mac" is only chosen when:
3474 "unix" is not present or no <NL> is found in the file, and
3475 "dos" is not present or no <CR><NL> is found in the file.
3476 Except: if "unix" was chosen, but there is a <CR> before
3477 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003478 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 4. If 'fileformat' is still not set, the first name from
3480 'fileformats' is used.
3481 When reading a file into an existing buffer, the same is done, but
3482 this happens like 'fileformat' has been set appropriately for that
3483 file only, the option is not changed.
3484 When 'binary' is set, the value of 'fileformats' is not used.
3485
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003486 When Vim starts up with an empty buffer the first item is used. You
3487 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003488
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3490 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3491 done:
3492 - When 'fileformats' is empty, there is no automatic detection. Dos
3493 format will be used.
3494 - When 'fileformats' is set to one or more names, automatic detection
3495 is done. This is based on the first <NL> in the file: If there is a
3496 <CR> in front of it, Dos format is used, otherwise Unix format is
3497 used.
3498 Also see |file-formats|.
3499 For backwards compatibility: When this option is set to an empty
3500 string or one format (no comma is included), 'textauto' is reset,
3501 otherwise 'textauto' is set.
3502 NOTE: This option is set to the Vi default value when 'compatible' is
3503 set and to the Vim default value when 'compatible' is reset.
3504
Bram Moolenaarbf884932013-04-05 22:26:15 +02003505 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3506'fileignorecase' 'fic' boolean (default on for systems where case in file
3507 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003508 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003509 When set case is ignored when using file names and directories.
3510 See 'wildignorecase' for only ignoring case when doing completion.
3511
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 *'filetype'* *'ft'*
3513'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003514 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 When this option is set, the FileType autocommand event is triggered.
3516 All autocommands that match with the value of this option will be
3517 executed. Thus the value of 'filetype' is used in place of the file
3518 name.
3519 Otherwise this option does not always reflect the current file type.
3520 This option is normally set when the file type is detected. To enable
3521 this use the ":filetype on" command. |:filetype|
3522 Setting this option to a different value is most useful in a modeline,
3523 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003524 Example, for in an IDL file:
3525 /* vim: set filetype=idl : */ ~
3526 |FileType| |filetypes|
3527 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003528 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003529 /* vim: set filetype=c.doxygen : */ ~
3530 This will use the "c" filetype first, then the "doxygen" filetype.
3531 This works both for filetype plugins and for syntax files. More than
3532 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 This option is not copied to another buffer, independent of the 's' or
3534 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003535 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536
3537 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003538'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003539 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003540 Characters to fill the statuslines, vertical separators and special
3541 lines in the window.
3542 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003543 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003545 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003546 stl ' ' statusline of the current window
3547 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003548 vert '|' vertical separators |:vsplit|
3549 fold '-' filling 'foldtext'
3550 foldopen '-' mark the beginning of a fold
3551 foldclose '+' show a closed fold
3552 foldsep '|' open fold middle character
3553 diff '-' deleted lines of the 'diff' option
3554 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003555 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003557 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003560 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3561<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003562 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3563 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003564 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003565
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003567 item name highlight group ~
3568 stl StatusLine |hl-StatusLine|
3569 stlnc StatusLineNC |hl-StatusLineNC|
3570 vert VertSplit |hl-VertSplit|
3571 fold Folded |hl-Folded|
3572 diff DiffDelete |hl-DiffDelete|
3573 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003574 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003576 *'findfunc'* *'ffu'* *E1514*
3577'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003578 global or local to buffer |global-local|
3579 {not available when compiled without the |+eval|
3580 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003581 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003582 command. When this option is empty, the internal |file-searching|
3583 mechanism is used.
3584
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003585 The value can be the name of a function, a |lambda| or a |Funcref|.
3586 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003587
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003588 The function is called with two arguments. The first argument is a
3589 |String| and is the |:find| command argument. The second argument is
3590 a |Boolean| and is set to |v:true| when the function is called to get
3591 a List of command-line completion matches for the |:find| command.
3592 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003593
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003594 The function is called only once per |:find| command invocation.
3595 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003596
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003597 If a match is found, the function should return a |List| containing
3598 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003599 should return an empty List.
3600
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003601 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003602 empty List is used as the return value.
3603
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003604 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003605 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003606
3607 This option cannot be set from a |modeline| or in the |sandbox|, for
3608 security reasons.
3609
3610 Examples:
3611>
3612 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003613 func FindFuncGlob(cmdarg, cmdcomplete)
3614 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003615 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003616 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003617 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003618
3619 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003620 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003621 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003622 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003623 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003624 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003625<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003626 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3627'fixendofline' 'fixeol' boolean (default on)
3628 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003629 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003630 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003631 preserve the situation from the original file.
3632 When the 'binary' option is set the value of this option doesn't
3633 matter.
3634 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003635 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003636
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003638'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 {only available when compiled with the |+rightleft|
3641 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003642 This option was for using Farsi, which has been removed. See
3643 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644
3645 *'foldclose'* *'fcl'*
3646'foldclose' 'fcl' string (default "")
3647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {not available when compiled without the |+folding|
3649 feature}
3650 When set to "all", a fold is closed when the cursor isn't in it and
3651 its level is higher than 'foldlevel'. Useful if you want folds to
3652 automatically close when moving out of them.
3653
3654 *'foldcolumn'* *'fdc'*
3655'foldcolumn' 'fdc' number (default 0)
3656 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 {not available when compiled without the |+folding|
3658 feature}
3659 When non-zero, a column with the specified width is shown at the side
3660 of the window which indicates open and closed folds. The maximum
3661 value is 12.
3662 See |folding|.
3663
3664 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3665'foldenable' 'fen' boolean (default on)
3666 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 {not available when compiled without the |+folding|
3668 feature}
3669 When off, all folds are open. This option can be used to quickly
3670 switch between showing all text unfolded and viewing the text with
3671 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003672 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 'foldenable' is off.
3674 This option is set by commands that create a new fold or close a fold.
3675 See |folding|.
3676
3677 *'foldexpr'* *'fde'*
3678'foldexpr' 'fde' string (default: "0")
3679 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003681 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003683 for each line to obtain its fold level. The context is set to the
3684 script where 'foldexpr' was set, script-local items can be accessed.
3685 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003686
Bram Moolenaar30b65812012-07-12 22:01:11 +02003687 The expression will be evaluated in the |sandbox| if set from a
3688 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003689 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003690 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003691
3692 It is not allowed to change text or jump to another window while
3693 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694
3695 *'foldignore'* *'fdi'*
3696'foldignore' 'fdi' string (default: "#")
3697 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {not available when compiled without the |+folding|
3699 feature}
3700 Used only when 'foldmethod' is "indent". Lines starting with
3701 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003702 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 The default "#" works well for C programs. See |fold-indent|.
3704
3705 *'foldlevel'* *'fdl'*
3706'foldlevel' 'fdl' number (default: 0)
3707 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 {not available when compiled without the |+folding|
3709 feature}
3710 Sets the fold level: Folds with a higher level will be closed.
3711 Setting this option to zero will close all folds. Higher numbers will
3712 close fewer folds.
3713 This option is set by commands like |zm|, |zM| and |zR|.
3714 See |fold-foldlevel|.
3715
3716 *'foldlevelstart'* *'fdls'*
3717'foldlevelstart' 'fdls' number (default: -1)
3718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 {not available when compiled without the |+folding|
3720 feature}
3721 Sets 'foldlevel' when starting to edit another buffer in a window.
3722 Useful to always start editing with all folds closed (value zero),
3723 some folds closed (one) or no folds closed (99).
3724 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003725 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 ignores this option and closes all folds.
3727 It is also done before BufReadPre autocommands, to allow an autocmd to
3728 overrule the 'foldlevel' value for specific files.
3729 When the value is negative, it is not used.
3730
3731 *'foldmarker'* *'fmr'* *E536*
3732'foldmarker' 'fmr' string (default: "{{{,}}}")
3733 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 {not available when compiled without the |+folding|
3735 feature}
3736 The start and end marker used when 'foldmethod' is "marker". There
3737 must be one comma, which separates the start and end marker. The
3738 marker is a literal string (a regular expression would be too slow).
3739 See |fold-marker|.
3740
3741 *'foldmethod'* *'fdm'*
3742'foldmethod' 'fdm' string (default: "manual")
3743 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 {not available when compiled without the |+folding|
3745 feature}
3746 The kind of folding used for the current window. Possible values:
3747 |fold-manual| manual Folds are created manually.
3748 |fold-indent| indent Lines with equal indent form a fold.
3749 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3750 |fold-marker| marker Markers are used to specify folds.
3751 |fold-syntax| syntax Syntax highlighting items specify folds.
3752 |fold-diff| diff Fold text that is not changed.
3753
3754 *'foldminlines'* *'fml'*
3755'foldminlines' 'fml' number (default: 1)
3756 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 {not available when compiled without the |+folding|
3758 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003759 Sets the number of screen lines above which a fold can be displayed
3760 closed. Also for manually closed folds. With the default value of
3761 one a fold can only be closed if it takes up two or more screen lines.
3762 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003763 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 "zc" to close a fold, which is displayed open because it's smaller
3765 than 'foldminlines', a following "zc" may close a containing fold.
3766
3767 *'foldnestmax'* *'fdn'*
3768'foldnestmax' 'fdn' number (default: 20)
3769 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 {not available when compiled without the |+folding|
3771 feature}
3772 Sets the maximum nesting of folds for the "indent" and "syntax"
3773 methods. This avoids that too many folds will be created. Using more
3774 than 20 doesn't work, because the internal limit is 20.
3775
3776 *'foldopen'* *'fdo'*
3777'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3778 search,tag,undo")
3779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 {not available when compiled without the |+folding|
3781 feature}
3782 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003783 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003785 NOTE: When the command is part of a mapping this option is not used.
3786 Add the |zv| command to the mapping to get the same effect.
3787 (rationale: the mapping may want to control opening folds itself)
3788
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 item commands ~
3790 all any
3791 block "(", "{", "[[", "[{", etc.
3792 hor horizontal movements: "l", "w", "fx", etc.
3793 insert any command in Insert mode
3794 jump far jumps: "G", "gg", etc.
3795 mark jumping to a mark: "'m", CTRL-O, etc.
3796 percent "%"
3797 quickfix ":cn", ":crew", ":make", etc.
3798 search search for a pattern: "/", "n", "*", "gd", etc.
3799 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003800 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 tag jumping to a tag: ":ta", CTRL-T, etc.
3802 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 When a movement command is used for an operator (e.g., "dl" or "y%")
3804 this option is not used. This means the operator will include the
3805 whole closed fold.
3806 Note that vertical movements are not here, because it would make it
3807 very difficult to move onto a closed fold.
3808 In insert mode the folds containing the cursor will always be open
3809 when text is inserted.
3810 To close folds you can re-apply 'foldlevel' with the |zx| command or
3811 set the 'foldclose' option to "all".
3812
3813 *'foldtext'* *'fdt'*
3814'foldtext' 'fdt' string (default: "foldtext()")
3815 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {not available when compiled without the |+folding|
3817 feature}
3818 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003819 fold. The context is set to the script where 'foldexpr' was set,
3820 script-local items can be accessed. See |fold-foldtext| for the
3821 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822
Bram Moolenaar30b65812012-07-12 22:01:11 +02003823 The expression will be evaluated in the |sandbox| if set from a
3824 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003825 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003826
3827 It is not allowed to change text or jump to another window while
3828 evaluating 'foldtext' |textlock|.
3829
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003830 *'formatexpr'* *'fex'*
3831'formatexpr' 'fex' string (default "")
3832 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003833 {not available when compiled without the |+eval|
3834 feature}
3835 Expression which is evaluated to format a range of lines for the |gq|
3836 operator or automatic formatting (see 'formatoptions'). When this
3837 option is empty 'formatprg' is used.
3838
3839 The |v:lnum| variable holds the first line to be formatted.
3840 The |v:count| variable holds the number of lines to be formatted.
3841 The |v:char| variable holds the character that is going to be
3842 inserted if the expression is being evaluated due to
3843 automatic formatting. This can be empty. Don't insert
3844 it yet!
3845
3846 Example: >
3847 :set formatexpr=mylang#Format()
3848< This will invoke the mylang#Format() function in the
3849 autoload/mylang.vim file in 'runtimepath'. |autoload|
3850
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003851 The advantage of using a function call without arguments is that it is
3852 faster, see |expr-option-function|.
3853
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003854 The expression is also evaluated when 'textwidth' is set and adding
3855 text beyond that limit. This happens under the same conditions as
3856 when internal formatting is used. Make sure the cursor is kept in the
3857 same spot relative to the text then! The |mode()| function will
3858 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003859
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003860 When the expression evaluates to non-zero Vim will fall back to using
3861 the internal format mechanism.
3862
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003863 If the expression starts with s: or |<SID>|, then it is replaced with
3864 the script ID (|local-function|). Example: >
3865 set formatexpr=s:MyFormatExpr()
3866 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003867< Otherwise, the expression is evaluated in the context of the script
3868 where the option was set, thus script-local items are available.
3869
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003870 The expression will be evaluated in the |sandbox| when set from a
3871 modeline, see |sandbox-option|. That stops the option from working,
3872 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003873 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003874 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003875
Bram Moolenaar86b68352004-12-27 21:59:20 +00003876 *'formatlistpat'* *'flp'*
3877'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3878 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003879 A pattern that is used to recognize a list header. This is used for
3880 the "n" flag in 'formatoptions'.
3881 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003882 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003883 while still checking more characters. There must be a character
3884 following the pattern, when it matches the whole line it is handled
3885 like there is no match.
3886 The default recognizes a number, followed by an optional punctuation
3887 character and white space.
3888
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003889 *'formatoptions'* *'fo'*
3890'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3891 local to buffer
3892 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003893 formatting is to be done.
3894 See |fo-table| for possible values and |gq| for how to format text.
3895 When the 'paste' option is on, no formatting is done (like
3896 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003897 To avoid problems with flags that are added in the future, use the
3898 "+=" and "-=" feature of ":set" |add-option-flags|.
3899 NOTE: This option is set to the Vi default value when 'compatible' is
3900 set and to the Vim default value when 'compatible' is reset.
3901
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 *'formatprg'* *'fp'*
3903'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003906 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003908 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003909 If the 'formatexpr' option is not empty it will be used instead.
3910 Otherwise, if 'formatprg' option is an empty string, the internal
3911 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003912 Environment variables are expanded |:set_env|. See |option-backslash|
3913 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003914 This option cannot be set from a |modeline| or in the |sandbox|, for
3915 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916
Bram Moolenaard94464e2015-11-02 15:28:18 +01003917 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003918'fsync' 'fs' boolean (default on)
3919 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003920 When on, the library function fsync() will be called after writing a
3921 file. This will flush a file to disk, ensuring that it is safely
3922 written even on filesystems which do metadata-only journaling. This
3923 will force the harddrive to spin up on Linux systems running in laptop
3924 mode, so it may be undesirable in some situations. Be warned that
3925 turning this off increases the chances of data loss after a crash. On
3926 systems without an fsync() implementation, this variable is always
3927 off.
3928 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003929 'fsync' also applies to |writefile()| (unless a flag is used to
3930 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003931 This option cannot be set from a |modeline| or in the |sandbox|, for
3932 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003933
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3935'gdefault' 'gd' boolean (default off)
3936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 When on, the ":substitute" flag 'g' is default on. This means that
3938 all matches in a line are substituted instead of one. When a 'g' flag
3939 is given to a ":substitute" command, this will toggle the substitution
3940 of all or one match. See |complex-change|.
3941
3942 command 'gdefault' on 'gdefault' off ~
3943 :s/// subst. all subst. one
3944 :s///g subst. one subst. all
3945 :s///gg subst. all subst. one
3946
3947 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003948 Setting this option may break plugins that rely on the default
3949 behavior of the 'g' flag. This will also make the 'g' flag have the
3950 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003951 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952
3953 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003954'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 Format to recognize for the ":grep" command output.
3957 This is a scanf-like string that uses the same format as the
3958 'errorformat' option: see |errorformat|.
3959
3960 *'grepprg'* *'gp'*
3961'grepprg' 'gp' string (default "grep -n ",
3962 Unix: "grep -n $* /dev/null",
3963 Win32: "findstr /n" or "grep -n",
3964 VMS: "SEARCH/NUMBERS ")
3965 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003966 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 and '#' characters, which are expanded like when used in a command-
3968 line. The placeholder "$*" is allowed to specify where the arguments
3969 will be included. Environment variables are expanded |:set_env|. See
3970 |option-backslash| about including spaces and backslashes.
3971 When your "grep" accepts the "-H" argument, use this to make ":grep"
3972 also work well with a single file: >
3973 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003974< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003975 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3976 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003977 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 apply equally to 'grepprg'.
3979 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3980 otherwise it's "grep -n".
3981 This option cannot be set from a |modeline| or in the |sandbox|, for
3982 security reasons.
3983
3984 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3985'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3986 ve:ver35-Cursor,
3987 o:hor50-Cursor,
3988 i-ci:ver25-Cursor/lCursor,
3989 r-cr:hor20-Cursor/lCursor,
3990 sm:block-Cursor
3991 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003992 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 "n-v-c:block,o:hor50,i-ci:hor15,
3994 r-cr:hor30,sm:block")
3995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003997 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003999 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004000 height of the cursor can be changed. This can be done by specifying a
4001 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004002 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4003 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004005 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 mode-list and an argument-list:
4007 mode-list:argument-list,mode-list:argument-list,..
4008 The mode-list is a dash separated list of these modes:
4009 n Normal mode
4010 v Visual mode
4011 ve Visual mode with 'selection' "exclusive" (same as 'v',
4012 if not specified)
4013 o Operator-pending mode
4014 i Insert mode
4015 r Replace mode
4016 c Command-line Normal (append) mode
4017 ci Command-line Insert mode
4018 cr Command-line Replace mode
4019 sm showmatch in Insert mode
4020 a all modes
4021 The argument-list is a dash separated list of these arguments:
4022 hor{N} horizontal bar, {N} percent of the character height
4023 ver{N} vertical bar, {N} percent of the character width
4024 block block cursor, fills the whole character
4025 [only one of the above three should be present]
4026 blinkwait{N} *cursor-blinking*
4027 blinkon{N}
4028 blinkoff{N}
4029 blink times for cursor: blinkwait is the delay before
4030 the cursor starts blinking, blinkon is the time that
4031 the cursor is shown and blinkoff is the time that the
4032 cursor is not shown. The times are in msec. When one
4033 of the numbers is zero, there is no blinking. The
4034 default is: "blinkwait700-blinkon400-blinkoff250".
4035 These numbers are used for a missing entry. This
4036 means that blinking is enabled by default. To switch
4037 blinking off you can use "blinkon0". The cursor only
4038 blinks when Vim is waiting for input, not while
4039 executing a command.
4040 To make the cursor blink in an xterm, see
4041 |xterm-blink|.
4042 {group-name}
4043 a highlight group name, that sets the color and font
4044 for the cursor
4045 {group-name}/{group-name}
4046 Two highlight group names, the first is used when
4047 no language mappings are used, the other when they
4048 are. |language-mapping|
4049
4050 Examples of parts:
4051 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4052 block cursor with colors from the "nCursor"
4053 highlight group
4054 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4055 In Insert and Command-line Insert mode, use a
4056 30% vertical bar cursor with colors from the
4057 "iCursor" highlight group. Blink a bit
4058 faster.
4059
4060 The 'a' mode is different. It will set the given argument-list for
4061 all modes. It does not reset anything to defaults. This can be used
4062 to do a common setting for all modes. For example, to switch off
4063 blinking: "a:blinkon0"
4064
4065 Examples of cursor highlighting: >
4066 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4067 :highlight Cursor gui=NONE guifg=bg guibg=fg
4068<
4069 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004070 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071'guifont' 'gfn' string (default "")
4072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 {only available when compiled with GUI enabled}
4074 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004075 In its simplest form the value is just one font name.
4076 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077
4078 *'guifontset'* *'gfs'*
4079 *E250* *E252* *E234* *E597* *E598*
4080'guifontset' 'gfs' string (default "")
4081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 {only available when compiled with GUI enabled and
4083 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004084 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 When not empty, specifies two (or more) fonts to be used. The first
4086 one for normal English, the second one for your special language. See
4087 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004088
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4090'guifontwide' 'gfw' string (default "")
4091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 {only available when compiled with GUI enabled}
4093 When not empty, specifies a comma-separated list of fonts to be used
4094 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004095 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004096
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 *'guiheadroom'* *'ghr'*
4098'guiheadroom' 'ghr' number (default 50)
4099 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004100 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 The number of pixels subtracted from the screen height when fitting
4102 the GUI window on the screen. Set this before the GUI is started,
4103 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004104 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 lines will be left for window decorations and other items on the
4106 screen. Set it to a negative value to allow windows taller than the
4107 screen.
4108
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004109 *'guiligatures'* *'gli'* *E1243*
4110'guiligatures' 'gli' string (default "")
4111 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004112 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004113 List of ASCII characters that, when combined together, can create more
4114 complex shapes. Each character must be a printable ASCII character
4115 with a value in the 32-127 range.
4116 Example: >
4117 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4118< Changing this option updates screen output immediately. Set it to an
4119 empty string to disable ligatures.
4120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004122'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4123 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004124 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004125 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004128 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 sequence of letters which describes what components and options of the
4130 GUI should be used.
4131 To avoid problems with flags that are added in the future, use the
4132 "+=" and "-=" feature of ":set" |add-option-flags|.
4133
Bram Moolenaar13568252018-03-16 20:46:58 +01004134 Valid characters are as follows:
4135 *'go-!'*
4136 '!' External commands are executed in a terminal window. Without
4137 this flag the MS-Windows GUI will open a console window to
4138 execute the command. The Unix GUI will simulate a dumb
4139 terminal to list the command output.
4140 The terminal window will be positioned at the bottom, and grow
4141 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004142 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 'a' Autoselect: If present, then whenever VISUAL mode is started,
4144 or the Visual area extended, Vim tries to become the owner of
4145 the windowing system's global selection. This means that the
4146 Visually highlighted text is available for pasting into other
4147 applications as well as into Vim itself. When the Visual mode
4148 ends, possibly due to an operation on the text, or when an
4149 application wants to paste the selection, the highlighted text
4150 is automatically yanked into the "* selection register.
4151 Thus the selection is still available for pasting into other
4152 applications after the VISUAL mode has ended.
4153 If not present, then Vim won't become the owner of the
4154 windowing system's global selection unless explicitly told to
4155 by a yank or delete operation for the "* register.
4156 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004157 *'go-P'*
4158 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004159 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004160 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 applies to the modeless selection.
4163
4164 'guioptions' autoselect Visual autoselect modeless ~
4165 "" - -
4166 "a" yes yes
4167 "A" - yes
4168 "aA" yes yes
4169
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004170 When using a terminal see the 'clipboard' option.
4171
Bram Moolenaar02467872007-05-06 13:22:01 +00004172 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 'c' Use console dialogs instead of popup dialogs for simple
4174 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004175 *'go-d'*
4176 'd' Use dark theme variant if available. Currently only works for
4177 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004178 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004179 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004180 'guitablabel' can be used to change the text in the labels.
4181 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004182 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004183 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004184 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 'f' Foreground: Don't use fork() to detach the GUI from the shell
4186 where it was started. Use this for programs that wait for the
4187 editor to finish (e.g., an e-mail program). Alternatively you
4188 can use "gvim -f" or ":gui -f" to start the GUI in the
4189 foreground. |gui-fork|
4190 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004191 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004192 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4194 corner of the window. It's black&white on non-GTK, because of
4195 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004196 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004198 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004199 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004201 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004203 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004204 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 'g' Grey menu items: Make menu items that are not active grey. If
4206 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004207 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 't' Include tearoff menu items. Currently only works for Win32,
4209 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004210 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004211 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4212 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004213 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004215 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 'R' Right-hand scrollbar is present when there is a vertically
4217 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004218 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004220 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 'L' Left-hand scrollbar is present when there is a vertically
4222 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004223 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4225 the longest visible line, or on the cursor line if the 'h'
4226 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004227 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 'h' Limit horizontal scrollbar size to the length of the cursor
4229 line. Reduces computations. |gui-horiz-scroll|
4230
4231 And yes, you may even have scrollbars on the left AND the right if
4232 you really want to :-). See |gui-scrollbars| for more information.
4233
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004234 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 'v' Use a vertical button layout for dialogs. When not included,
4236 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004237 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004238 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 'p' Use Pointer callbacks for X11 GUI. This is required for some
4240 window managers. If the cursor is not blinking or hollow at
4241 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004242 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004244 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004245 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004246 *'go-k'*
4247 'k' Keep the GUI window size when adding/removing a scrollbar, or
4248 toolbar, tabline, etc. Instead, the behavior is similar to
4249 when the window is maximized and will adjust 'lines' and
4250 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004251 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004252 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004253
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 *'guipty'* *'noguipty'*
4255'guipty' boolean (default on)
4256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 {only available when compiled with GUI enabled}
4258 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4259 I/O to/from shell commands. See |gui-pty|.
4260
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004261 *'guitablabel'* *'gtl'*
4262'guitablabel' 'gtl' string (default empty)
4263 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004264 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004265 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004266 pages line. When empty and when the result is empty Vim will use a
4267 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004268
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004269 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004270 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004271 The expression will be evaluated in the |sandbox| when set from a
4272 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004273 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004274
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004275 Only used when the GUI tab pages line is displayed. 'e' must be
4276 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4277 used.
4278
Bram Moolenaar57657d82006-04-21 22:12:41 +00004279 *'guitabtooltip'* *'gtt'*
4280'guitabtooltip' 'gtt' string (default empty)
4281 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004282 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004283 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004284 pages line. When empty Vim will use a default tooltip.
4285 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004286 You can include a line break. Simplest method is to use |:let|: >
4287 :let &guitabtooltip = "line one\nline two"
4288<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004289
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004291'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 (others) "$VIMRUNTIME/doc/help.txt")
4293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 Name of the main help file. All distributed help files should be
4295 placed together in one directory. Additionally, all "doc" directories
4296 in 'runtimepath' will be used.
4297 Environment variables are expanded |:set_env|. For example:
4298 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004299 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 spaces and backslashes.
4301 This option cannot be set from a |modeline| or in the |sandbox|, for
4302 security reasons.
4303
4304 *'helpheight'* *'hh'*
4305'helpheight' 'hh' number (default 20)
4306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 Minimal initial height of the help window when it is opened with the
4308 ":help" command. The initial height of the help window is half of the
4309 current window, or (when the 'ea' option is on) the same as other
4310 windows. When the height is less than 'helpheight', the height is
4311 set to 'helpheight'. Set to zero to disable.
4312
4313 *'helplang'* *'hlg'*
4314'helplang' 'hlg' string (default: messages language or empty)
4315 global
4316 {only available when compiled with the |+multi_lang|
4317 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004318 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 for which the desired help can be found. The English help will always
4320 be used as a last resort. You can add "en" to prefer English over
4321 another language, but that will only find tags that exist in that
4322 language and not in the English help.
4323 Example: >
4324 :set helplang=de,it
4325< This will first search German, then Italian and finally English help
4326 files.
4327 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4328 try to find the tag in the current language before using this option.
4329 See |help-translated|.
4330
4331 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4332'hidden' 'hid' boolean (default off)
4333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 When off a buffer is unloaded when it is |abandon|ed. When on a
4335 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4336 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004337
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004339 hidden even if the 'hidden' option is off when these three are true:
4340 - the buffer is modified
4341 - 'autowrite' is off or writing is not possible
4342 - the '!' flag was used
4343 Also see |windows.txt|.
4344
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004345 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 This option is set for one command with ":hide {command}" |:hide|.
4347 WARNING: It's easy to forget that you have changes in hidden buffers.
4348 Think twice when using ":q!" or ":qa!".
4349
4350 *'highlight'* *'hl'*
4351'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004352 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4353 d:Directory,e:ErrorMsg,i:IncSearch,
4354 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004355 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004356 N:CursorLineNr,r:Question,s:StatusLine,
4357 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004358 v:Visual,V:VisualNOS,w:WarningMsg,
4359 W:WildMenu,f:Folded,F:FoldColumn,
4360 A:DiffAdd,C:DiffChange,D:DiffDelete,
4361 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004362 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004363 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004364 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004365 [:PmenuKind,]:PmenuKindSel,
4366 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004367 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4368 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004369 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004370 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004371 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004374 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004376 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004378 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4379 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 characters from 'showbreak'
4381 |hl-Directory| d directories in CTRL-D listing and other special
4382 things in listings
4383 |hl-ErrorMsg| e error messages
4384 h (obsolete, ignored)
4385 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004386 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4388 |hl-MoreMsg| m |more-prompt|
4389 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004390 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004391 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004392 |hl-LineNr| n line number for ":number" and ":#" commands, and
4393 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004394 |hl-LineNrAbove| a line number above the cursor for when the
4395 'relativenumber' option is set.
4396 |hl-LineNrBelow| b line number below the cursor for when the
4397 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004398 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4399 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 |hl-Question| r |hit-enter| prompt and yes/no questions
4401 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004402 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4404 |hl-VertSplit| c column used to separate vertically split windows
4405 |hl-Visual| v Visual mode
4406 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4407 Selection" Only X11 Gui's |gui-x11| and
4408 |xterm-clipboard|.
4409 |hl-WarningMsg| w warning messages
4410 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4411 |hl-Folded| f line used for closed folds
4412 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004413 |hl-DiffAdd| A added line in diff mode
4414 |hl-DiffChange| C changed line in diff mode
4415 |hl-DiffDelete| D deleted line in diff mode
4416 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004418 |hl-Conceal| - the placeholders used for concealed characters
4419 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004420 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004421 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004422 |hl-SpellRare| R rare word |spell|
4423 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004424 |hl-Pmenu| + popup menu normal line
4425 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004426 |hl-PmenuKind| [ popup menu "kind" normal line
4427 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004428 |hl-PmenuExtra| { popup menu "extra" normal line
4429 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004430 |hl-PmenuSbar| x popup menu scrollbar
4431 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004432 |hl-PmenuMatch| k popup menu matched text
4433 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434
4435 The display modes are:
4436 r reverse (termcap entry "mr" and "me")
4437 i italic (termcap entry "ZH" and "ZR")
4438 b bold (termcap entry "md" and "me")
4439 s standout (termcap entry "so" and "se")
4440 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004441 c undercurl (termcap entry "Us" and "Ce")
4442 2 double underline (termcap entry "Ds" and "Ce")
4443 d dotted underline (termcap entry "ds" and "Ce")
4444 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004445 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 n no highlighting
4447 - no highlighting
4448 : use a highlight group
4449 The default is used for occasions that are not included.
4450 If you want to change what the display modes do, see |dos-colors|
4451 for an example.
4452 When using the ':' display mode, this must be followed by the name of
4453 a highlight group. A highlight group can be used to define any type
4454 of highlighting, including using color. See |:highlight| on how to
4455 define one. The default uses a different group for each occasion.
4456 See |highlight-default| for the default highlight groups.
4457
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004459'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004462 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004463 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004464 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004465 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 NOTE: This option is set to the Vi default value when 'compatible' is
4467 set and to the Vim default value when 'compatible' is reset.
4468
4469 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4470'hkmap' 'hk' boolean (default off)
4471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 {only available when compiled with the |+rightleft|
4473 feature}
4474 When on, the keyboard is mapped for the Hebrew character set.
4475 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4476 toggle this option. See |rileft.txt|.
4477 NOTE: This option is reset when 'compatible' is set.
4478
4479 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4480'hkmapp' 'hkp' boolean (default off)
4481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 {only available when compiled with the |+rightleft|
4483 feature}
4484 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4485 This is useful if you have a non-Hebrew keyboard.
4486 See |rileft.txt|.
4487 NOTE: This option is reset when 'compatible' is set.
4488
Bram Moolenaar036986f2017-03-16 17:41:02 +01004489 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4490'hlsearch' 'hls' boolean (default off)
4491 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004492 {not available when compiled without the
4493 |+extra_search| feature}
4494 When there is a previous search pattern, highlight all its matches.
4495 The type of highlighting used can be set with the 'l' occasion in the
4496 'highlight' option. This uses the "Search" highlight group by
4497 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004498 are not applied. If the "CurSearch" highlight group is set then the
4499 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004500 See also: 'incsearch' and |:match|.
4501 When you get bored looking at the highlighted matches, you can turn it
4502 off with |:nohlsearch|. This does not change the option value, as
4503 soon as you use a search command, the highlighting comes back.
4504 'redrawtime' specifies the maximum time spent on finding matches.
4505 When the search pattern can match an end-of-line, Vim will try to
4506 highlight all of the matched text. However, this depends on where the
4507 search starts. This will be the first line in the window or the first
4508 line below a closed fold. A match in a previous line which is not
4509 drawn may not continue in a newly drawn line.
4510 You can specify whether the highlight status is restored on startup
4511 with the 'h' flag in 'viminfo' |viminfo-h|.
4512 NOTE: This option is reset when 'compatible' is set.
4513
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 *'icon'* *'noicon'*
4515'icon' boolean (default off, on when title can be restored)
4516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 When on, the icon text of the window will be set to the value of
4518 'iconstring' (if it is not empty), or to the name of the file
4519 currently being edited. Only the last part of the name is used.
4520 Overridden by the 'iconstring' option.
4521 Only works if the terminal supports setting window icons (currently
4522 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4523 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4524 builtin termcap).
4525 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004526 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004528 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529
4530 *'iconstring'*
4531'iconstring' string (default "")
4532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 When this option is not empty, it will be used for the icon text of
4534 the window. This happens only when the 'icon' option is on.
4535 Only works if the terminal supports setting window icon text
4536 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004537 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 When Vim was compiled with HAVE_X11 defined, the original icon will be
4539 restored if possible |X11|.
4540 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004541 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004543 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 {not available when compiled without the |+statusline| feature}
4545
4546 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4547'ignorecase' 'ic' boolean (default off)
4548 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004549 Ignore case in search patterns, |cmdline-completion|, when
4550 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004551 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 Can be overruled by using "\c" or "\C" in the pattern, see
4553 |/ignorecase|.
4554
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004555 *'imactivatefunc'* *'imaf'*
4556'imactivatefunc' 'imaf' string (default "")
4557 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004558 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004559 activate or deactivate the Input Method. The value can be the name of
4560 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4561 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004562 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004563 The expression will be evaluated in the |sandbox| when set from a
4564 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004565
4566 Example: >
4567 function ImActivateFunc(active)
4568 if a:active
4569 ... do something
4570 else
4571 ... do something
4572 endif
4573 " return value is not used
4574 endfunction
4575 set imactivatefunc=ImActivateFunc
4576<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 *'imactivatekey'* *'imak'*
4578'imactivatekey' 'imak' string (default "")
4579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004581 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 Specifies the key that your Input Method in X-Windows uses for
4583 activation. When this is specified correctly, vim can fully control
4584 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4585 You can't use this option to change the activation key, the option
4586 tells Vim what the key is.
4587 Format:
4588 [MODIFIER_FLAG-]KEY_STRING
4589
4590 These characters can be used for MODIFIER_FLAG (case is ignored):
4591 S Shift key
4592 L Lock key
4593 C Control key
4594 1 Mod1 key
4595 2 Mod2 key
4596 3 Mod3 key
4597 4 Mod4 key
4598 5 Mod5 key
4599 Combinations are allowed, for example "S-C-space" or "SC-space" are
4600 both shift+ctrl+space.
4601 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4602
4603 Example: >
4604 :set imactivatekey=S-space
4605< "S-space" means shift+space. This is the activation key for kinput2 +
4606 canna (Japanese), and ami (Korean).
4607
4608 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4609'imcmdline' 'imc' boolean (default off)
4610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 When set the Input Method is always on when starting to edit a command
4612 line, unless entering a search pattern (see 'imsearch' for that).
4613 Setting this option is useful when your input method allows entering
4614 English characters directly, e.g., when it's used to type accented
4615 characters with dead keys.
4616
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004617 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 When set the Input Method is never used. This is useful to disable
4621 the IM when it doesn't work properly.
4622 Currently this option is on by default for SGI/IRIX machines. This
4623 may change in later releases.
4624
4625 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004626'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 Specifies whether :lmap or an Input Method (IM) is to be used in
4629 Insert mode. Valid values:
4630 0 :lmap is off and IM is off
4631 1 :lmap is ON and IM is off
4632 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 To always reset the option to zero when leaving Insert mode with <Esc>
4634 this can be used: >
4635 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4636< This makes :lmap and IM turn off automatically when leaving Insert
4637 mode.
4638 Note that this option changes when using CTRL-^ in Insert mode
4639 |i_CTRL-^|.
4640 The value is set to 1 when setting 'keymap' to a valid keymap name.
4641 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004642 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 methods. Use 'imdisable' to disable XIM then.
4644
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004645 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004646 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004647 |+multi_byte_ime| or |global-ime|.
4648
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004650'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 Specifies whether :lmap or an Input Method (IM) is to be used when
4653 entering a search pattern. Valid values:
4654 -1 the value of 'iminsert' is used, makes it look like
4655 'iminsert' is also used when typing a search pattern
4656 0 :lmap is off and IM is off
4657 1 :lmap is ON and IM is off
4658 2 :lmap is off and IM is ON
4659 Note that this option changes when using CTRL-^ in Command-line mode
4660 |c_CTRL-^|.
4661 The value is set to 1 when it is not -1 and setting the 'keymap'
4662 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004663 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 methods. Use 'imdisable' to disable XIM then.
4665
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004666 *'imstatusfunc'* *'imsf'*
4667'imstatusfunc' 'imsf' string (default "")
4668 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004669 This option specifies a function that is called to obtain the status
4670 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004671 The value can be the name of a function, a |lambda| or a |Funcref|.
4672 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004673 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004674
4675 Example: >
4676 function ImStatusFunc()
4677 let is_active = ...do something
4678 return is_active ? 1 : 0
4679 endfunction
4680 set imstatusfunc=ImStatusFunc
4681<
4682 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004683 The expression will be evaluated in the |sandbox| when set from a
4684 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004685
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004686 *'imstyle'* *'imst'*
4687'imstyle' 'imst' number (default 1)
4688 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004689 {only available when compiled with |+xim| and
4690 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004691 This option specifies the input style of Input Method:
4692 0 use on-the-spot style
4693 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004694 See: |xim-input-style|
4695
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004696 For a long time on-the-spot style had been used in the GTK version of
4697 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004698 |single-repeat|, etc. Therefore over-the-spot style becomes the
4699 default now. This should work fine for most people, however if you
4700 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004701 The expression will be evaluated in the |sandbox| when set from a
4702 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004703
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 *'include'* *'inc'*
4705'include' 'inc' string (default "^\s*#\s*include")
4706 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 {not available when compiled without the
4708 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004709 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 pattern, just like for the "/" command (See |pattern|). The default
4711 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004712 "]I", "[d", etc.
4713 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004714 comes after the matched pattern. But if "\zs" appears in the pattern
4715 then the text matched from "\zs" to the end, or until "\ze" if it
4716 appears, is used as the file name. Use this to include characters
4717 that are not in 'isfname', such as a space. You can then use
4718 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004719 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720
4721 *'includeexpr'* *'inex'*
4722'includeexpr' 'inex' string (default "")
4723 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004725 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004727 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004728 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004730 Note the double backslash: the `:set` command first halves them, then
4731 one remains it the value, where "\." matches a dot literally. For
4732 simple character replacements `tr()` avoids the need for escaping: >
4733 :setlocal includeexpr=tr(v:fname,'.','/')
4734<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 Also used for |<cfile>|.
4738
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004739 If the expression starts with s: or |<SID>|, then it is replaced with
4740 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004741 setlocal includeexpr=s:MyIncludeExpr()
4742 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004743< Otherwise, the expression is evaluated in the context of the script
4744 where the option was set, thus script-local items are available.
4745
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004746 It is more efficient if the value is just a function call without
4747 arguments, see |expr-option-function|.
4748
Bram Moolenaar30b65812012-07-12 22:01:11 +02004749 The expression will be evaluated in the |sandbox| when set from a
4750 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004751 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004752
4753 It is not allowed to change text or jump to another window while
4754 evaluating 'includeexpr' |textlock|.
4755
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004757'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004758 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004761 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004762 While typing a search command, show where the pattern, as it was typed
4763 so far, matches. The matched string is highlighted. If the pattern
4764 is invalid or not found, nothing is shown. The screen will be updated
4765 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004766 Also applies to the pattern in commands: >
4767 :global
4768 :lvimgrep
4769 :lvimgrepadd
4770 :smagic
4771 :snomagic
4772 :sort
4773 :substitute
4774 :vglobal
4775 :vimgrep
4776 :vimgrepadd
4777< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004778 original position when no match is found and when pressing <Esc>. You
4779 still need to finish the search command with <Enter> to move the
4780 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004781 You can use the CTRL-G and CTRL-T keys to move to the next and
4782 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004783 When compiled with the |+reltime| feature Vim only searches for about
4784 half a second. With a complicated pattern and/or a lot of text the
4785 match may not be found. This is to avoid that Vim hangs while you
4786 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004787 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004788 When 'hlsearch' is on, all matched strings are highlighted too while
4789 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004790 If you don't want to turn 'hlsearch' on, but want to highlight all
4791 matches while searching, you can turn on and off 'hlsearch' with
4792 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004793 augroup vimrc-incsearch-highlight
4794 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004795 autocmd CmdlineEnter /,\? :set hlsearch
4796 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004797 augroup END
4798<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004799 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004800 to the command line. If 'ignorecase' and 'smartcase' are set and the
4801 command line has no uppercase characters, the added character is
4802 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004803 CTRL-R CTRL-W can be used to add the word at the end of the current
4804 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 NOTE: This option is reset when 'compatible' is set.
4806
4807 *'indentexpr'* *'inde'*
4808'indentexpr' 'inde' string (default "")
4809 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004810 {not available when compiled without the |+eval|
4811 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 Expression which is evaluated to obtain the proper indent for a line.
4813 It is used when a new line is created, for the |=| operator and
4814 in Insert mode as specified with the 'indentkeys' option.
4815 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004816 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004817 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 When 'paste' is set this option is not used for indenting.
4819 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004820 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004822
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004823 If the expression starts with s: or |<SID>|, then it is replaced with
4824 the script ID (|local-function|). Example: >
4825 set indentexpr=s:MyIndentExpr()
4826 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004827< Otherwise, the expression is evaluated in the context of the script
4828 where the option was set, thus script-local items are available.
4829
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004830 The advantage of using a function call without arguments is that it is
4831 faster, see |expr-option-function|.
4832
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 The expression must return the number of spaces worth of indent. It
4834 can return "-1" to keep the current indent (this means 'autoindent' is
4835 used for the indent).
4836 Functions useful for computing the indent are |indent()|, |cindent()|
4837 and |lispindent()|.
4838 The evaluation of the expression must not have side effects! It must
4839 not change the text, jump to another window, etc. Afterwards the
4840 cursor position is always restored, thus the cursor may be moved.
4841 Normally this option would be set to call a function: >
4842 :set indentexpr=GetMyIndent()
4843< Error messages will be suppressed, unless the 'debug' option contains
4844 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004845 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004846 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
Bram Moolenaar30b65812012-07-12 22:01:11 +02004848 The expression will be evaluated in the |sandbox| when set from a
4849 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004850 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004851
4852 It is not allowed to change text or jump to another window while
4853 evaluating 'indentexpr' |textlock|.
4854
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004856'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 A list of keys that, when typed in Insert mode, cause reindenting of
4859 the current line. Only happens if 'indentexpr' isn't empty.
4860 The format is identical to 'cinkeys', see |indentkeys-format|.
4861 See |C-indenting| and |indent-expression|.
4862
4863 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4864'infercase' 'inf' boolean (default off)
4865 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004867 'ignorecase' is also on, the case of the match is adjusted depending
4868 on the typed text. If the typed text contains a lowercase letter
4869 where the match has an upper case letter, the completed part is made
4870 lowercase. If the typed text has no lowercase letters and the match
4871 has a lowercase letter where the typed text has an uppercase letter,
4872 and there is a letter before it, the completed part is made uppercase.
4873 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874
4875 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4876'insertmode' 'im' boolean (default off)
4877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 Makes Vim work in a way that Insert mode is the default mode. Useful
4879 if you want to use Vim as a modeless editor. Used for |evim|.
4880 These Insert mode commands will be useful:
4881 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004882 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 this is a mapping, it is executed as if 'insertmode' was off.
4884 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004886 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4887 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888
4889 These items change when 'insertmode' is set:
4890 - when starting to edit of a file, Vim goes to Insert mode.
4891 - <Esc> in Insert mode is a no-op and beeps.
4892 - <Esc> in Normal mode makes Vim go to Insert mode.
4893 - CTRL-L in Insert mode is a command, it is not inserted.
4894 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4895 However, when <Esc> is used inside a mapping, it behaves like
4896 'insertmode' was not set. This was done to be able to use the same
4897 mappings with 'insertmode' set or not set.
4898 When executing commands with |:normal| 'insertmode' is not used.
4899
4900 NOTE: This option is reset when 'compatible' is set.
4901
4902 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004903'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4905 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4906 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4907 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4908 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 The characters specified by this option are included in file names and
4911 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004912 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 Multi-byte characters 256 and above are always included, only the
4914 characters up to 255 are specified with this option.
4915 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004916 Think twice before adding white space to this option. Although a
4917 space may appear inside a file name, the effect will be that Vim
4918 doesn't know where a file name starts or ends when doing completion.
4919 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
4921 Note that on systems using a backslash as path separator, Vim tries to
4922 do its best to make it work as you would expect. That is a bit
4923 tricky, since Vi originally used the backslash to escape special
4924 characters. Vim will not remove a backslash in front of a normal file
4925 name character on these systems, but it will on Unix and alikes. The
4926 '&' and '^' are not included by default, because these are special for
4927 cmd.exe.
4928
4929 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004930 Each part can be a single character number or a range. A range is two
4931 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 decimal number between 0 and 255 or the ASCII character itself (does
4933 not work for digits). Example:
4934 "_,-,128-140,#-43" (include '_' and '-' and the range
4935 128 to 140 and '#' to 43)
4936 If a part starts with '^', the following character number or range
4937 will be excluded from the option. The option is interpreted from left
4938 to right. Put the excluded character after the range where it is
4939 included. To include '^' itself use it as the last character of the
4940 option or the end of a range. Example:
4941 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4942 If the character is '@', all characters where isalpha() returns TRUE
4943 are included. Normally these are the characters a to z and A to Z,
4944 plus accented characters. To include '@' itself use "@-@". Examples:
4945 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004946 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 "a-z,A-Z,@-@" All letters plus the '@' character.
4948 A comma can be included by using it where a character number is
4949 expected. Example:
4950 "48-57,,,_" Digits, comma and underscore.
4951 A comma can be excluded by prepending a '^'. Example:
4952 " -~,^,,9" All characters from space to '~', excluding
4953 comma, plus <Tab>.
4954 See |option-backslash| about including spaces and backslashes.
4955
4956 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004957'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 "@,48-57,_,128-167,224-235"
4959 otherwise: "@,48-57,_,192-255")
4960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 The characters given by this option are included in identifiers.
4962 Identifiers are used in recognizing environment variables and after a
4963 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004964 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004965 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004967 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4969
4970 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004971'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 "@,48-57,_,128-167,224-235"
4973 otherwise: "@,48-57,_,192-255"
4974 Vi default: "@,48-57,_")
4975 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004977 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004978 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004979 characters above 255 check the "word" character class (any character
4980 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004981 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 For a help file it is set to all non-blank printable characters except
4983 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4984 command).
4985 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004986 This option also influences syntax highlighting, unless the syntax
4987 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 NOTE: This option is set to the Vi default value when 'compatible' is
4989 set and to the Vim default value when 'compatible' is reset.
4990
4991 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02004992'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 "@,~-255"; otherwise: "@,161-255")
4994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 The characters given by this option are displayed directly on the
4996 screen. It is also used for "\p" in a |pattern|. The characters from
4997 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4998 even when they are not included in 'isprint' or excluded. See
4999 'isfname' for a description of the format of this option.
5000
5001 Non-printable characters are displayed with two characters:
5002 0 - 31 "^@" - "^_"
5003 32 - 126 always single characters
5004 127 "^?"
5005 128 - 159 "~@" - "~_"
5006 160 - 254 "| " - "|~"
5007 255 "~?"
5008 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5009 displayed as <xx>, with the hexadecimal value of the byte.
5010 When 'display' contains "uhex" all unprintable characters are
5011 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005012 The SpecialKey highlighting will be used for unprintable characters.
5013 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014
5015 Multi-byte characters 256 and above are always included, only the
5016 characters up to 255 are specified with this option. When a character
5017 is printable but it is not available in the current font, a
5018 replacement character will be shown.
5019 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5020 There is no option to specify these characters.
5021
5022 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5023'joinspaces' 'js' boolean (default on)
5024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 Insert two spaces after a '.', '?' and '!' with a join command.
5026 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5027 Otherwise only one space is inserted.
5028 NOTE: This option is set when 'compatible' is set.
5029
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005030 *'jumpoptions'* *'jop'*
5031'jumpoptions' 'jop' string (default "")
5032 global
5033 List of words that change the behavior of the |jumplist|.
5034 stack Make the jumplist behave like the tagstack.
5035 Relative location of entries in the jumplist is
5036 preserved at the cost of discarding subsequent entries
5037 when navigating backwards in the jumplist and then
5038 jumping to a location. |jumplist-stack|
5039
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 *'key'*
5041'key' string (default "")
5042 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005043 {only available when compiled with the |+cryptv|
5044 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005046 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 Careful: Do not set the key value by hand, someone might see the typed
5048 key. Use the |:X| command. But you can make 'key' empty: >
5049 :set key=
5050< It is not possible to get the value of this option with ":set key" or
5051 "echo &key". This is to avoid showing it to someone who shouldn't
5052 know. It also means you cannot see it yourself once you have set it,
5053 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005054 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5055 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005056 You can use "&key" in an expression to detect whether encryption is
5057 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058
5059 *'keymap'* *'kmp'* *E544*
5060'keymap' 'kmp' string (default "")
5061 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 {only available when compiled with the |+keymap|
5063 feature}
5064 Name of a keyboard mapping. See |mbyte-keymap|.
5065 Setting this option to a valid keymap name has the side effect of
5066 setting 'iminsert' to one, so that the keymap becomes effective.
5067 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005068 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069
5070 *'keymodel'* *'km'*
5071'keymodel' 'km' string (default "")
5072 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005073 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 can do. These values can be used:
5075 startsel Using a shifted special key starts selection (either
5076 Select mode or Visual mode, depending on "key" being
5077 present in 'selectmode').
5078 stopsel Using a not-shifted special key stops selection.
5079 Special keys in this context are the cursor keys, <End>, <Home>,
5080 <PageUp> and <PageDown>.
5081 The 'keymodel' option is set by the |:behave| command.
5082
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005083 *'keyprotocol'* *'kpc'*
5084'keyprotocol' 'kpc' string (default: see below)
5085 global
5086 Specifies what keyboard protocol to use depending on the value of
5087 'term'. The supported keyboard protocols names are:
5088 none whatever the terminal uses
5089 mok2 modifyOtherKeys level 2, as supported by xterm
5090 kitty Kitty keyboard protocol, as supported by Kitty
5091
Bram Moolenaara87749e2022-11-30 10:23:17 +00005092 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005093 a pattern that is matched against the 'term' option, a colon and the
5094 protocol name to be used. To illustrate this, the default value would
5095 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005096 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5097 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005098
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005099< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005100 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5101 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005102
5103 The first match is used, thus if you want to have "kitty" use the
5104 kitty protocol, but "badkitty" not, then you should match "badkitty"
5105 first and use the "none" value: >
5106 set keyprotocol=badkitty:none,kitty:kitty
5107<
5108 The option is used after 'term' has been changed. First the termcap
5109 entries are set, possibly using the builtin list, see |builtin-terms|.
5110 Then this option is inspected and if there is a match and a protocol
5111 is specified the following happens:
5112 none Nothing, the regular t_TE and t_TI values remain
5113
5114 mok2 The t_TE value is changed to:
5115 CSI >4;m disables modifyOtherKeys
5116 The t_TI value is changed to:
5117 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005118 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005119
5120 kitty The t_TE value is changed to:
5121 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005122 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005123 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005124 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005125 CSI ?u request kitty keyboard protocol state
5126 CSI >c request the termresponse
5127
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005128 If you notice problems, such as characters being displayed that
5129 disappear after `CTRL-L`, you might want to try making this option
5130 empty. Then set the 'term' option to have it take effect: >
5131 set keyprotocol=
5132 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005133<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005134
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 *'keywordprg'* *'kp'*
5136'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005137 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 Program to use for the |K| command. Environment variables are
5140 expanded |:set_env|. ":help" may be used to access the Vim internal
5141 help. (Note that previously setting the global option to the empty
5142 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005143 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005144 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005145 When "man", "man -s" or an Ex command is used, Vim will automatically
5146 translate a count for the "K" command and pass it as the first
5147 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 See |option-backslash| about including spaces and backslashes.
5149 Example: >
5150 :set keywordprg=man\ -s
5151< This option cannot be set from a |modeline| or in the |sandbox|, for
5152 security reasons.
5153
5154 *'langmap'* *'lmap'* *E357* *E358*
5155'langmap' 'lmap' string (default "")
5156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 {only available when compiled with the |+langmap|
5158 feature}
5159 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005160 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005161 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 care of translating these special characters to the original meaning
5163 of the key. This means you don't have to change the keyboard mode to
5164 be able to execute Normal mode commands.
5165 This is the opposite of the 'keymap' option, where characters are
5166 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005167 Also consider setting 'langremap' to off, to prevent 'langmap' from
5168 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005169 This option cannot be set from a |modeline| or in the |sandbox|, for
5170 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005172 Example (for Greek, in UTF-8): *greek* >
5173 :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 +00005174< Example (exchanges meaning of z and y for commands): >
5175 :set langmap=zy,yz,ZY,YZ
5176<
5177 The 'langmap' option is a list of parts, separated with commas. Each
5178 part can be in one of two forms:
5179 1. A list of pairs. Each pair is a "from" character immediately
5180 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005181 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 characters. Example: "abc;ABC"
5183 Example: "aA,fgh;FGH,cCdDeE"
5184 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005185 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186
5187 This will allow you to activate vim actions without having to switch
5188 back and forth between the languages. Your language characters will
5189 be understood as normal vim English characters (according to the
5190 langmap mappings) in the following cases:
5191 o Normal/Visual mode (commands, buffer/register names, user mappings)
5192 o Insert/Replace Mode: Register names after CTRL-R
5193 o Insert/Replace Mode: Mappings
5194 Characters entered in Command-line mode will NOT be affected by
5195 this option. Note that this option can be changed at any time
5196 allowing to switch between mappings for different languages/encodings.
5197 Use a mapping to avoid having to type it each time!
5198
5199 *'langmenu'* *'lm'*
5200'langmenu' 'lm' string (default "")
5201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 {only available when compiled with the |+menu| and
5203 |+multi_lang| features}
5204 Language to use for menu translation. Tells which file is loaded
5205 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005206 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207< (without the spaces). For example, to always use the Dutch menus, no
5208 matter what $LANG is set to: >
5209 :set langmenu=nl_NL.ISO_8859-1
5210< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005211 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 If your $LANG is set to a non-English language but you do want to use
5213 the English menus: >
5214 :set langmenu=none
5215< This option must be set before loading menus, switching on filetype
5216 detection or syntax highlighting. Once the menus are defined setting
5217 this option has no effect. But you could do this: >
5218 :source $VIMRUNTIME/delmenu.vim
5219 :set langmenu=de_DE.ISO_8859-1
5220 :source $VIMRUNTIME/menu.vim
5221< Warning: This deletes all menus that you defined yourself!
5222
Bram Moolenaard94464e2015-11-02 15:28:18 +01005223 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005224'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005225 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005226 {only available when compiled with the |+langmap|
5227 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005228 This is just like 'langremap' but with the value inverted. It only
5229 exists for backwards compatibility. When setting 'langremap' then
5230 'langnoremap' is set to the inverted value, and the other way around.
5231
5232 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005233'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005234 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005235 {only available when compiled with the |+langmap|
5236 feature}
5237 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005238 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005239 'langmap' disables some of your mappings, try resetting this option.
5240 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005241 that works for you to avoid mappings to break.
5242
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 *'laststatus'* *'ls'*
5244'laststatus' 'ls' number (default 1)
5245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 The value of this option influences when the last window will have a
5247 status line:
5248 0: never
5249 1: only if there are at least two windows
5250 2: always
5251 The screen looks nicer with a status line if you have several
5252 windows, but it takes another screen line. |status-line|
5253
5254 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5255'lazyredraw' 'lz' boolean (default off)
5256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 When this option is set, the screen will not be redrawn while
5258 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005259 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005261 This may occasionally cause display errors. It is only meant to be set
5262 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005263 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
5265 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5266'linebreak' 'lbr' boolean (default off)
5267 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005268 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005270 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 than at the last character that fits on the screen. Unlike
5272 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005273 it only affects the way the file is displayed, not its contents.
5274 If 'breakindent' is set, line is visually indented. Then, the value
5275 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005276 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 Note that <Tab> characters after an <EOL> are mostly not displayed
5278 with the right amount of white space.
5279
5280 *'lines'* *E593*
5281'lines' number (default 24 or terminal height)
5282 global
5283 Number of lines of the Vim window.
5284 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005285 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 When Vim is running in the GUI or in a resizable window, setting this
5287 option will cause the window size to be changed. When you only want
5288 to use the size for the GUI, put the command in your |gvimrc| file.
5289 Vim limits the number of lines to what fits on the screen. You can
5290 use this command to get the tallest window possible: >
5291 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005292< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005293 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 When you set this option and Vim is unable to change the physical
5295 number of lines of the display, the display may be messed up.
5296
5297 *'linespace'* *'lsp'*
5298'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 {only in the GUI}
5301 Number of pixel lines inserted between characters. Useful if the font
5302 uses the full character cell height, making lines touch each other.
5303 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005304 With some fonts there can be too much room between lines (to have
5305 space for ascents and descents). Then it makes sense to set
5306 'linespace' to a negative value. This may cause display problems
5307 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
5309 *'lisp'* *'nolisp'*
5310'lisp' boolean (default off)
5311 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 Lisp mode: When <Enter> is typed in insert mode set the indent for
5313 the next line to Lisp standards (well, sort of). Also happens with
5314 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5315 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5316 better. Also see 'lispwords'.
5317 The '-' character is included in keyword characters. Redefines the
5318 "=" operator to use this same indentation algorithm rather than
5319 calling an external program if 'equalprg' is empty.
5320 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005322 *'lispoptions'* *'lop'*
5323'lispoptions' 'lop' string (default "")
5324 local to buffer
5325 Comma-separated list of items that influence the Lisp indenting when
5326 enabled with the |'lisp'| option. Currently only one item is
5327 supported:
5328 expr:1 use 'indentexpr' for Lisp indenting when it is set
5329 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5330 Note that when using 'indentexpr' the `=` operator indents all the
5331 lines, otherwise the first line is not indented (Vi-compatible).
5332
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 *'lispwords'* *'lw'*
5334'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005335 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005336 Comma-separated list of words that influence the Lisp indenting when
5337 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
5339 *'list'* *'nolist'*
5340'list' boolean (default off)
5341 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005342 List mode: By default show tabs as CTRL-I is displayed, display $
5343 after end of line. Useful to see the difference between tabs and
5344 spaces and for trailing blanks. Further changed by the 'listchars'
5345 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005346
5347 The cursor is displayed at the start of the space a Tab character
5348 occupies, not at the end as usual in Normal mode. To get this cursor
5349 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005350 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005351<
5352 Note that list mode will also affect formatting (set with 'textwidth'
5353 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 changing the way tabs are displayed.
5355
5356 *'listchars'* *'lcs'*
5357'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005358 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005359 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005360 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005361 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 eol:c Character to show at the end of each line. When
5363 omitted, there is no extra character at the end of the
5364 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005365 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005366 tab:xy[z] Two or three characters to be used to show a tab.
5367 The third character is optional.
5368
5369 tab:xy The 'x' is always used, then 'y' as many times as will
5370 fit. Thus "tab:>-" displays:
5371 >
5372 >-
5373 >--
5374 etc.
5375
5376 tab:xyz The 'z' is always used, then 'x' is prepended, and
5377 then 'y' is used as many times as will fit. Thus
5378 "tab:<->" displays:
5379 >
5380 <>
5381 <->
5382 <-->
5383 etc.
5384
5385 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005386 *lcs-space*
5387 space:c Character to show for a space. When omitted, spaces
5388 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005389 *lcs-multispace*
5390 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005391 One or more characters to use cyclically to show for
5392 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005393 setting, except for single spaces. When omitted, the
5394 "space" setting is used. For example,
5395 `:set listchars=multispace:---+` shows ten consecutive
5396 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005397 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005398 *lcs-lead*
5399 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005400 leading spaces are blank. Overrides the "space" and
5401 "multispace" settings for leading spaces. You can
5402 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005403 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005404< *lcs-leadmultispace*
5405 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005406 Like the |lcs-multispace| value, but for leading
5407 spaces only. Also overrides |lcs-lead| for leading
5408 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005409 `:set listchars=leadmultispace:---+` shows ten
5410 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005411 ---+---+--XXX ~
5412 Where "XXX" denotes the first non-blank characters in
5413 the line.
5414 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005415 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005416 trailing spaces are blank. Overrides the "space" and
5417 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005418 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 extends:c Character to show in the last column, when 'wrap' is
5420 off and the line continues beyond the right of the
5421 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005422 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005423 precedes:c Character to show in the first visible column of the
5424 physical line, when there is text preceding the
5425 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005426 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005427 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005428 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005429 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005430 nbsp:c Character to show for a non-breakable space character
5431 (0xA0 (160 decimal) and U+202F). Left blank when
5432 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005434 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005436 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005438 Each character can be specified as hex: >
5439 set listchars=eol:\\x24
5440 set listchars=eol:\\u21b5
5441 set listchars=eol:\\U000021b5
5442< Note that a double backslash is used. The number of hex characters
5443 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5444
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 Examples: >
5446 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005447 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 :set lcs=extends:>,precedes:<
5449< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005450 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5451 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005452 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
5454 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5455'loadplugins' 'lpl' boolean (default on)
5456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 When on the plugin scripts are loaded when starting up |load-plugins|.
5458 This option can be reset in your |vimrc| file to disable the loading
5459 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005460 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5461 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462
Bram Moolenaard94464e2015-11-02 15:28:18 +01005463 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005464'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005465 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005466 {only available when compiled with the |+lua/dyn|
5467 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005468 Specifies the name of the Lua shared library. The default is
5469 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005470 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005471 This option cannot be set from a |modeline| or in the |sandbox|, for
5472 security reasons.
5473
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005474 *'macatsui'* *'nomacatsui'*
5475'macatsui' boolean (default on)
5476 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005477 {not supported}
5478 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005479
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 *'magic'* *'nomagic'*
5481'magic' boolean (default on)
5482 global
5483 Changes the special characters that can be used in search patterns.
5484 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005485 WARNING: Switching this option off most likely breaks plugins! That
5486 is because many patterns assume it's on and will fail when it's off.
5487 Only switch it off when working with old Vi scripts. In any other
5488 situation write patterns that work when 'magic' is on. Include "\M"
5489 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005490 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5491 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492
5493 *'makeef'* *'mef'*
5494'makeef' 'mef' string (default: "")
5495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 {not available when compiled without the |+quickfix|
5497 feature}
5498 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5499 and the |:grep| command.
5500 When it is empty, an internally generated temp file will be used.
5501 When "##" is included, it is replaced by a number to make the name
5502 unique. This makes sure that the ":make" command doesn't overwrite an
5503 existing file.
5504 NOT used for the ":cf" command. See 'errorfile' for that.
5505 Environment variables are expanded |:set_env|.
5506 See |option-backslash| about including spaces and backslashes.
5507 This option cannot be set from a |modeline| or in the |sandbox|, for
5508 security reasons.
5509
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005510 *'makeencoding'* *'menc'*
5511'makeencoding' 'menc' string (default "")
5512 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005513 Encoding used for reading the output of external commands. When empty,
5514 encoding is not converted.
5515 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5516 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5517 and `:laddfile`.
5518
5519 This would be mostly useful when you use MS-Windows and set 'encoding'
5520 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5521 'makeencoding' to "char" has the same effect as setting to the system
5522 locale encoding. Example: >
5523 :set encoding=utf-8
5524 :set makeencoding=char " system locale is used
5525<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 *'makeprg'* *'mp'*
5527'makeprg' 'mp' string (default "make", VMS: "MMS")
5528 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005529 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005530 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5531 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005532 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005533 Environment variables are expanded |:set_env|. See |option-backslash|
5534 about including spaces and backslashes.
5535 Note that a '|' must be escaped twice: once for ":set" and once for
5536 the interpretation of a command. When you use a filter called
5537 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 :set makeprg=gmake\ \\\|\ myfilter
5539< The placeholder "$*" can be given (even multiple times) to specify
5540 where the arguments will be included, for example: >
5541 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5542< This option cannot be set from a |modeline| or in the |sandbox|, for
5543 security reasons.
5544
5545 *'matchpairs'* *'mps'*
5546'matchpairs' 'mps' string (default "(:),{:},[:]")
5547 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005549 other.
5550 Only character pairs are allowed that are different, thus you cannot
5551 jump between two double quotes.
5552 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005553 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005554 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 :set mps+=<:>
5556
5557< A more exotic example, to jump between the '=' and ';' in an
5558 assignment, useful for languages like C and Java: >
5559 :au FileType c,cpp,java set mps+==:;
5560
5561< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005562 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563
5564 *'matchtime'* *'mat'*
5565'matchtime' 'mat' number (default 5)
5566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 Tenths of a second to show the matching paren, when 'showmatch' is
5568 set. Note that this is not in milliseconds, like other options that
5569 set a time. This is to be compatible with Nvi.
5570
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005571 *'maxcombine'* *'mco'*
5572'maxcombine' 'mco' number (default 2)
5573 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005574 The maximum number of combining characters supported for displaying.
5575 Only used when 'encoding' is "utf-8".
5576 The default is OK for most languages. Hebrew may require 4.
5577 Maximum value is 6.
5578 Even when this option is set to 2 you can still edit text with more
5579 combining characters, you just can't see them. Use |g8| or |ga|.
5580 See |mbyte-combining|.
5581
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 *'maxfuncdepth'* *'mfd'*
5583'maxfuncdepth' 'mfd' number (default 100)
5584 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005585 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005586 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 Maximum depth of function calls for user functions. This normally
5588 catches endless recursion. When using a recursive function with
5589 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5590 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005591 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005592 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005594 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595
5596 *'maxmapdepth'* *'mmd'* *E223*
5597'maxmapdepth' 'mmd' number (default 1000)
5598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 Maximum number of times a mapping is done without resulting in a
5600 character to be used. This normally catches endless mappings, like
5601 ":map x y" with ":map y x". It still does not catch ":map g wg",
5602 because the 'w' is used before the next mapping is done. See also
5603 |key-mapping|.
5604
5605 *'maxmem'* *'mm'*
5606'maxmem' 'mm' number (default between 256 to 5120 (system
5607 dependent) or half the amount of memory
5608 available)
5609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5611 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005612 other memory to be freed.
5613 The maximum usable value is about 2000000. Use this to work without a
5614 limit.
5615 The value is ignored when 'swapfile' is off.
5616 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005618 *'maxmempattern'* *'mmp'*
5619'maxmempattern' 'mmp' number (default 1000)
5620 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005621 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005622 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005623 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005624 When Vim runs into the limit it gives an error message and mostly
5625 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005626 Running into the limit often means that the pattern is very
5627 inefficient or too complex. This may already happen with the pattern
5628 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005629 Might also happen on redraw, when syntax rules try to match a complex
5630 text structure.
5631 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5632 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005633
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 *'maxmemtot'* *'mmt'*
5635'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5636 dependent) or half the amount of memory
5637 available)
5638 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005639 Maximum amount of memory in Kbyte to use for all buffers together.
5640 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005641 without a limit.
5642 On 64 bit machines higher values might work. But hey, do you really
5643 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005644 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005645 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005646 Buffers with 'swapfile' off still count to the total amount of memory
5647 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005648 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
5650 *'menuitems'* *'mis'*
5651'menuitems' 'mis' number (default 25)
5652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 {not available when compiled without the |+menu|
5654 feature}
5655 Maximum number of items to use in a menu. Used for menus that are
5656 generated from a list of items, e.g., the Buffers menu. Changing this
5657 option has no direct effect, the menu must be refreshed first.
5658
Christian Brabandt51d4d842024-12-06 17:26:25 +01005659 *'messagesopt'* *'mopt'*
5660'messagesopt' 'mopt' string (default "hit-enter,history:500")
5661 global
5662
zeertzjq8cc43da2024-12-07 16:09:08 +01005663 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005664 following items. Items must be separated by a comma.
5665
zeertzjq8cc43da2024-12-07 16:09:08 +01005666 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005667 'cmdheight' size.
5668
zeertzjq8cc43da2024-12-07 16:09:08 +01005669 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5670 {n} milliseconds so that the user has a chance to read
5671 the message. The maximum value of {n} is 10000. Use
5672 0 to disable the wait (but then the user may miss an
5673 important message).
5674 This item is ignored when "hit-enter" is present, but
5675 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005676
5677 history:{n} Determines how many entries are remembered in the
5678 |:messages| history. The maximum value is 10000.
5679 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005680 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005681
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005682 *'mkspellmem'* *'msm'*
5683'mkspellmem' 'msm' string (default "460000,2000,500")
5684 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005685 {not available when compiled without the |+syntax|
5686 feature}
5687 Parameters for |:mkspell|. This tunes when to start compressing the
5688 word tree. Compression can be slow when there are many words, but
5689 it's needed to avoid running out of memory. The amount of memory used
5690 per word depends very much on how similar the words are, that's why
5691 this tuning is complicated.
5692
5693 There are three numbers, separated by commas:
5694 {start},{inc},{added}
5695
5696 For most languages the uncompressed word tree fits in memory. {start}
5697 gives the amount of memory in Kbyte that can be used before any
5698 compression is done. It should be a bit smaller than the amount of
5699 memory that is available to Vim.
5700
5701 When going over the {start} limit the {inc} number specifies the
5702 amount of memory in Kbyte that can be allocated before another
5703 compression is done. A low number means compression is done after
5704 less words are added, which is slow. A high number means more memory
5705 will be allocated.
5706
5707 After doing compression, {added} times 1024 words can be added before
5708 the {inc} limit is ignored and compression is done when any extra
5709 amount of memory is needed. A low number means there is a smaller
5710 chance of hitting the {inc} limit, less memory is used but it's
5711 slower.
5712
5713 The languages for which these numbers are important are Italian and
5714 Hungarian. The default works for when you have about 512 Mbyte. If
5715 you have 1 Gbyte you could use: >
5716 :set mkspellmem=900000,3000,800
5717< If you have less than 512 Mbyte |:mkspell| may fail for some
5718 languages, no matter what you set 'mkspellmem' to.
5719
dkearns8ebdbc92023-10-29 06:26:19 +11005720 This option cannot be set from a |modeline| or in the |sandbox|, for
5721 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005722
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005724'modeline' 'ml' boolean (Vim default: on (off for root),
5725 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005727 If 'modeline' is on 'modelines' gives the number of lines that is
5728 checked for set commands. If 'modeline' is off or 'modelines' is zero
5729 no lines are checked. See |modeline|.
5730
5731 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5732'modelineexpr' 'mle' boolean (default: off)
5733 global
5734 When on allow some options that are an expression to be set in the
5735 modeline. Check the option for whether it is affected by
5736 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005737 This option cannot be set from a |modeline| or in the |sandbox|, for
5738 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005739
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 *'modelines'* *'mls'*
5741'modelines' 'mls' number (default 5)
5742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 If 'modeline' is on 'modelines' gives the number of lines that is
5744 checked for set commands. If 'modeline' is off or 'modelines' is zero
5745 no lines are checked. See |modeline|.
5746 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5747 set and to the Vim default value when 'compatible' is reset.
5748
5749 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005750 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751'modifiable' 'ma' boolean (default on)
5752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 When off the buffer contents cannot be changed. The 'fileformat' and
5754 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005755 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756
5757 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5758'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005759 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 When on, the buffer is considered to be modified. This option is set
5761 when:
5762 1. A change was made to the text since it was last written. Using the
5763 |undo| command to go back to the original text will reset the
5764 option. But undoing changes that were made before writing the
5765 buffer will set the option again, since the text is different from
5766 when it was written.
5767 2. 'fileformat' or 'fileencoding' is different from its original
5768 value. The original value is set when the buffer is read or
5769 written. A ":set nomodified" command also resets the original
5770 values to the current values and the 'modified' option will be
5771 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005772 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005773 This option is not set when a change is made to the buffer as the
5774 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5775 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5776 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5778 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005779 Note that the text may actually be the same, e.g. 'modified' is set
5780 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781
5782 *'more'* *'nomore'*
5783'more' boolean (Vim default: on, Vi default: off)
5784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 When on, listings pause when the whole screen is filled. You will get
5786 the |more-prompt|. When this option is off there are no pauses, the
5787 listing continues until finished.
5788 NOTE: This option is set to the Vi default value when 'compatible' is
5789 set and to the Vim default value when 'compatible' is reset.
5790
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005791 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005792'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005793 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005795 Enable the use of the mouse. Works for most terminals (xterm, Win32
5796 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5797 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5798 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005799 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 v Visual mode
5801 i Insert mode
5802 c Command-line mode
5803 h all previous modes when editing a help file
5804 a all previous modes
5805 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005806 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005808< If your terminal can't overrule the mouse events going to the
5809 application, use: >
5810 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005811< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005812 back to Vim using the mouse events.
5813 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5814 "xterm".
5815
5816 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 modeless selection. This doesn't move the text cursor.
5818
5819 See |mouse-using|. Also see |'clipboard'|.
5820
5821 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 the mouse buttons can still be used by keeping the shift key pressed.
5824 Also see the 'clipboard' option.
5825
5826 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5827'mousefocus' 'mousef' boolean (default off)
5828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 {only works in the GUI}
5830 The window that the mouse pointer is on is automatically activated.
5831 When changing the window layout or window focus in another way, the
5832 mouse pointer is moved to the window with keyboard focus. Off is the
5833 default because it makes using the pull down menus a little goofy, as
5834 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005835 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005836 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837
5838 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5839'mousehide' 'mh' boolean (default on)
5840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 {only works in the GUI}
5842 When on, the mouse pointer is hidden when characters are typed.
5843 The mouse pointer is restored when the mouse is moved.
5844
5845 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005846'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 Sets the model to use for the mouse. The name mostly specifies what
5849 the right mouse button is used for:
5850 extend Right mouse button extends a selection. This works
5851 like in an xterm.
5852 popup Right mouse button pops up a menu. The shifted left
5853 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005854 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 popup_setpos Like "popup", but the cursor will be moved to the
5856 position where the mouse was clicked, and thus the
5857 selected operation will act upon the clicked object.
5858 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005859 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 course, that right clicking outside a selection will
5861 end Visual mode.
5862 Overview of what button does what for each model:
5863 mouse extend popup(_setpos) ~
5864 left click place cursor place cursor
5865 left drag start selection start selection
5866 shift-left search word extend selection
5867 right click extend selection popup menu (place cursor)
5868 right drag extend selection -
5869 middle click paste paste
5870
5871 In the "popup" model the right mouse button produces a pop-up menu.
5872 You need to define this first, see |popup-menu|.
5873
5874 Note that you can further refine the meaning of buttons with mappings.
5875 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5876 selection (because that's handled in the GUI code directly).
5877
5878 The 'mousemodel' option is set by the |:behave| command.
5879
h_east59858792023-10-25 22:47:05 +09005880 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005881'mousemoveevent' 'mousemev' boolean (default off)
5882 global
5883 {only works in the GUI}
5884 When on, mouse move events are delivered to the input queue and are
5885 available for mapping. The default, off, avoids the mouse movement
5886 overhead except when needed. See |gui-mouse-mapping|.
5887 Warning: Setting this option can make pending mappings to be aborted
5888 when the mouse is moved.
5889 Currently only works in the GUI, may be made to work in a terminal
5890 later.
5891
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005893'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5894 vs:leftright,vd:lrsizing,m:no,
5895 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 {only available when compiled with the |+mouseshape|
5898 feature}
5899 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005900 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 like used for 'guicursor'. Each part consist of a mode/location-list
5902 and an argument-list:
5903 mode-list:shape,mode-list:shape,..
5904 The mode-list is a dash separated list of these modes/locations:
5905 In a normal window: ~
5906 n Normal mode
5907 v Visual mode
5908 ve Visual mode with 'selection' "exclusive" (same as 'v',
5909 if not specified)
5910 o Operator-pending mode
5911 i Insert mode
5912 r Replace mode
5913
5914 Others: ~
5915 c appending to the command-line
5916 ci inserting in the command-line
5917 cr replacing in the command-line
5918 m at the 'Hit ENTER' or 'More' prompts
5919 ml idem, but cursor in the last line
5920 e any mode, pointer below last window
5921 s any mode, pointer on a status line
5922 sd any mode, while dragging a status line
5923 vs any mode, pointer on a vertical separator line
5924 vd any mode, while dragging a vertical separator line
5925 a everywhere
5926
5927 The shape is one of the following:
5928 avail name looks like ~
5929 w x arrow Normal mouse pointer
5930 w x blank no pointer at all (use with care!)
5931 w x beam I-beam
5932 w x updown up-down sizing arrows
5933 w x leftright left-right sizing arrows
5934 w x busy The system's usual busy pointer
5935 w x no The system's usual 'no input' pointer
5936 x udsizing indicates up-down resizing
5937 x lrsizing indicates left-right resizing
5938 x crosshair like a big thin +
5939 x hand1 black hand
5940 x hand2 white hand
5941 x pencil what you write with
5942 x question big ?
5943 x rightup-arrow arrow pointing right-up
5944 w x up-arrow arrow pointing up
5945 x <number> any X11 pointer number (see X11/cursorfont.h)
5946
5947 The "avail" column contains a 'w' if the shape is available for Win32,
5948 x for X11.
5949 Any modes not specified or shapes not available use the normal mouse
5950 pointer.
5951
5952 Example: >
5953 :set mouseshape=s:udsizing,m:no
5954< will make the mouse turn to a sizing arrow over the status lines and
5955 indicate no input when the hit-enter prompt is displayed (since
5956 clicking the mouse has no effect in this state.)
5957
5958 *'mousetime'* *'mouset'*
5959'mousetime' 'mouset' number (default 500)
5960 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005961 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 time in msec between two mouse clicks for the second click to be
5963 recognized as a multi click.
5964
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01005965
laburnumT3f7855a2023-12-05 18:37:03 +01005966 *'mzquantum'* *'mzq'*
5967'mzquantum' 'mzq' number (default 100)
5968 global
5969 {not available when compiled without the |+mzscheme|
5970 feature}
5971 The number of milliseconds between polls for MzScheme threads.
5972 Negative or zero value means no thread scheduling.
5973 NOTE: This option is set to the Vim default value when 'compatible'
5974 is reset.
5975
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005976 *'mzschemedll'*
5977'mzschemedll' string (default depends on the build)
5978 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005979 {only available when compiled with the |+mzscheme/dyn|
5980 feature}
5981 Specifies the name of the MzScheme shared library. The default is
5982 DYNAMIC_MZSCH_DLL which was specified at compile time.
5983 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005984 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005985 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005986 This option cannot be set from a |modeline| or in the |sandbox|, for
5987 security reasons.
5988
5989 *'mzschemegcdll'*
5990'mzschemegcdll' string (default depends on the build)
5991 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005992 {only available when compiled with the |+mzscheme/dyn|
5993 feature}
5994 Specifies the name of the MzScheme GC shared library. The default is
5995 DYNAMIC_MZGC_DLL which was specified at compile time.
5996 The value can be equal to 'mzschemedll' if it includes the GC code.
5997 Environment variables are expanded |:set_env|.
5998 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 security reasons.
6000
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006002'nrformats' 'nf' string (default "bin,octal,hex",
6003 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 This defines what bases Vim will consider for numbers when using the
6006 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6007 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006008 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006010 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006011 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006013 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 considered to be hexadecimal. Example: Using CTRL-X on
6015 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006016 bin If included, numbers starting with "0b" or "0B" will be
6017 considered to be binary. Example: Using CTRL-X on
6018 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006019 unsigned If included, numbers are recognized as unsigned. Thus a
6020 leading dash or negative sign won't be considered as part of
6021 the number. Examples:
6022 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6023 (without "unsigned" it would become "9-2021").
6024 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6025 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006026 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6027 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006028 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006029 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006030 dash immediately preceded by a non-whitespace character (i.e.,
6031 not a tab or a " "), the negative sign won't be considered as
6032 part of the number. For example:
6033 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6034 (without "blank" it would become "Carbon-13").
6035 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006036 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006037 set, it would result in "Carbon -7").
6038 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006039 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006040 included, "unsigned" will take precedence.
6041
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 Numbers which simply begin with a digit in the range 1-9 are always
6043 considered decimal. This also happens for numbers that are not
6044 recognized as octal or hex.
6045
6046 *'number'* *'nu'* *'nonumber'* *'nonu'*
6047'number' 'nu' boolean (default off)
6048 local to window
6049 Print the line number in front of each line. When the 'n' option is
6050 excluded from 'cpoptions' a wrapped line will not use the column of
6051 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006052 The 'numberwidth' option can be used to set the room used for the line
6053 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 When a long, wrapped line doesn't start with the first character, '-'
6055 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006056 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6057 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006058 *number_relativenumber*
6059 The 'relativenumber' option changes the displayed number to be
6060 relative to the cursor. Together with 'number' there are these
6061 four combinations (cursor in line 3):
6062
Bram Moolenaar3848e002016-03-19 18:42:29 +01006063 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006064 'nornu' 'nornu' 'rnu' 'rnu'
6065
6066 |apple | 1 apple | 2 apple | 2 apple
6067 |pear | 2 pear | 1 pear | 1 pear
6068 |nobody | 3 nobody | 0 nobody |3 nobody
6069 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006071 *'numberwidth'* *'nuw'*
6072'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6073 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006074 {only available when compiled with the |+linebreak|
6075 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006076 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006077 when the 'number' or 'relativenumber' option is set or printing lines
6078 with a line number. Since one space is always between the number and
6079 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006080 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006081 fit the highest line number in the buffer respectively the number of
6082 rows in the window, depending on whether 'number' or 'relativenumber'
6083 is set. Thus with the Vim default of 4 there is room for a line number
6084 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006085 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006086 NOTE: This option is set to the Vi default value when 'compatible' is
6087 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006088
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006089 *'omnifunc'* *'ofu'*
6090'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006091 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006092 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006093 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006094 This option specifies a function to be used for Insert mode omni
6095 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006096 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006097 invoked and what it should return. The value can be the name of a
6098 function, a |lambda| or a |Funcref|. See |option-value-function| for
6099 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006100 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006101 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006102 This option cannot be set from a |modeline| or in the |sandbox|, for
6103 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006104
Bram Moolenaar02467872007-05-06 13:22:01 +00006105 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006106'opendevice' 'odev' boolean (default off)
6107 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006108 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006109 Enable reading and writing from devices. This may get Vim stuck on a
6110 device that can be opened but doesn't actually do the I/O. Therefore
6111 it is off by default.
6112 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6113 result in editing a device.
6114
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006115 *'operatorfunc'* *'opfunc'*
6116'operatorfunc' 'opfunc' string (default: empty)
6117 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006118 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006119 See |:map-operator| for more info and an example. The value can be
6120 the name of a function, a |lambda| or a |Funcref|. See
6121 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006122
6123 This option cannot be set from a |modeline| or in the |sandbox|, for
6124 security reasons.
6125
Bram Moolenaar251e1912011-06-19 05:09:16 +02006126 *'osfiletype'* *'oft'*
6127'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006129 This option was supported on RISC OS, which has been removed.
6130
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006131 *'packpath'* *'pp'*
6132'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006133 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006134 This option cannot be set from a |modeline| or in the |sandbox|, for
6135 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006136
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006138'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 global
6140 Specifies the nroff macros that separate paragraphs. These are pairs
6141 of two letters (see |object-motions|).
6142
6143 *'paste'* *'nopaste'*
6144'paste' boolean (default off)
6145 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006146 Put Vim in Paste mode. This is useful if you want to cut or copy
6147 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 unexpected effects.
6149 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006150 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 knows about pasting and will mostly do the right thing without 'paste'
6152 being set. The same is true for a terminal where Vim handles the
6153 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006154 This option is reset when starting the GUI. Thus if you set it in
6155 your .vimrc it will work in a terminal, but not in the GUI. Setting
6156 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6157 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 When the 'paste' option is switched on (also when it was already on):
6159 - mapping in Insert mode and Command-line mode is disabled
6160 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006162 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006163 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 - 'revins' is reset
6165 - 'ruler' is reset
6166 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006167 - 'smarttab' is reset
6168 - 'softtabstop' is set to 0
6169 - 'textwidth' is set to 0
6170 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006171 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006174 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006175 - 'indentexpr'
6176 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006177 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 NOTE: When you start editing another file while the 'paste' option is
6179 on, settings from the modelines or autocommands may change the
6180 settings again, causing trouble when pasting text. You might want to
6181 set the 'paste' option again.
6182 When the 'paste' option is reset the mentioned options are restored to
6183 the value before the moment 'paste' was switched from off to on.
6184 Resetting 'paste' before ever setting it does not have any effect.
6185 Since mapping doesn't work while 'paste' is active, you need to use
6186 the 'pastetoggle' option to toggle the 'paste' option with some key.
6187
6188 *'pastetoggle'* *'pt'*
6189'pastetoggle' 'pt' string (default "")
6190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 When non-empty, specifies the key sequence that toggles the 'paste'
6192 option. This is like specifying a mapping: >
6193 :map {keys} :set invpaste<CR>
6194< Where {keys} is the value of 'pastetoggle'.
6195 The difference is that it will work even when 'paste' is set.
6196 'pastetoggle' works in Insert mode and Normal mode, but not in
6197 Command-line mode.
6198 Mappings are checked first, thus overrule 'pastetoggle'. However,
6199 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6200 this: >
6201 :map <F10> :set paste<CR>
6202 :map <F11> :set nopaste<CR>
6203 :imap <F10> <C-O>:set paste<CR>
6204 :imap <F11> <nop>
6205 :set pastetoggle=<F11>
6206< This will make <F10> start paste mode and <F11> stop paste mode.
6207 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6208 mode everything is inserted literally, except the 'pastetoggle' key
6209 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006210 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211
6212 *'pex'* *'patchexpr'*
6213'patchexpr' 'pex' string (default "")
6214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 {not available when compiled without the |+diff|
6216 feature}
6217 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006218 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006219 This option cannot be set from a |modeline| or in the |sandbox|, for
6220 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221
Bram Moolenaardbc28022014-07-26 13:40:44 +02006222 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223'patchmode' 'pm' string (default "")
6224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 When non-empty the oldest version of a file is kept. This can be used
6226 to keep the original version of a file if you are changing files in a
6227 source distribution. Only the first time that a file is written a
6228 copy of the original file will be kept. The name of the copy is the
6229 name of the original file with the string in the 'patchmode' option
6230 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006231 ".orig" or ".org". 'backupdir' must not be empty for this to work
6232 (Detail: The backup file is renamed to the patchmode file after the
6233 new file has been successfully written, that's why it must be possible
6234 to write a backup file). If there was no file to be backed up, an
6235 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 When the 'backupskip' pattern matches, a patchmode file is not made.
6237 Using 'patchmode' for compressed files appends the extension at the
6238 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6239 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006240 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006242 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 other systems: ".,,")
6245 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006247 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6248 provided that the file being searched for has a relative path (not
6249 starting with "/", "./" or "../"). The directories in the 'path'
6250 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 - Use commas to separate directory names: >
6252 :set path=.,/usr/local/include,/usr/include
6253< - Spaces can also be used to separate directory names (for backwards
6254 compatibility with version 3.0). To have a space in a directory
6255 name, precede it with an extra backslash, and escape the space: >
6256 :set path=.,/dir/with\\\ space
6257< - To include a comma in a directory name precede it with an extra
6258 backslash: >
6259 :set path=.,/dir/with\\,comma
6260< - To search relative to the directory of the current file, use: >
6261 :set path=.
6262< - To search in the current directory use an empty string between two
6263 commas: >
6264 :set path=,,
6265< - A directory name may end in a ':' or '/'.
6266 - Environment variables are expanded |:set_env|.
6267 - When using |netrw.vim| URLs can be used. For example, adding
6268 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006269 - Search upwards and downwards in a directory tree using "*", "**" and
6270 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 - Careful with '\' characters, type two to get one in the option: >
6272 :set path=.,c:\\include
6273< Or just use '/' instead: >
6274 :set path=.,c:/include
6275< Don't forget "." or files won't even be found in the same directory as
6276 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006277 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 it is something like 256 or 1024 characters.
6279 You can check if all the include files are found, using the value of
6280 'path', see |:checkpath|.
6281 The use of |:set+=| and |:set-=| is preferred when adding or removing
6282 directories from the list. This avoids problems when a future version
6283 uses another default. To remove the current directory use: >
6284 :set path-=
6285< To add the current directory use: >
6286 :set path+=
6287< To use an environment variable, you probably need to replace the
6288 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006289 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006290 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291< Replace the ';' with a ':' or whatever separator is used. Note that
6292 this doesn't work when $INCL contains a comma or white space.
6293
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006294 *'perldll'*
6295'perldll' string (default depends on the build)
6296 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006297 {only available when compiled with the |+perl/dyn|
6298 feature}
6299 Specifies the name of the Perl shared library. The default is
6300 DYNAMIC_PERL_DLL, which was specified at compile time.
6301 Environment variables are expanded |:set_env|.
6302 This option cannot be set from a |modeline| or in the |sandbox|, for
6303 security reasons.
6304
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6306'preserveindent' 'pi' boolean (default off)
6307 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 When changing the indent of the current line, preserve as much of the
6309 indent structure as possible. Normally the indent is replaced by a
6310 series of tabs followed by spaces as required (unless |'expandtab'| is
6311 enabled, in which case only spaces are used). Enabling this option
6312 means the indent will preserve as many existing characters as possible
6313 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006314 'expandtab' does not apply to the preserved white space, a Tab remains
6315 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 NOTE: When using ">>" multiple times the resulting indent is a mix of
6317 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006318 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 Also see 'copyindent'.
6320 Use |:retab| to clean up white space.
6321
6322 *'previewheight'* *'pvh'*
6323'previewheight' 'pvh' number (default 12)
6324 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006325 {not available when compiled without the |+quickfix|
6326 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006328 commands. Used for |CTRL-W_}| when no count is given. Not used when
6329 'previewpopup' is set.
6330
6331 *'previewpopup'* *'pvp'*
6332'previewpopup' 'pvp' string (default empty)
6333 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006334 {not available when compiled without the |+textprop|
6335 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006336 When not empty a popup window is used for commands that would open a
6337 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006338 Not used for the insert completion info, add "popup" to
6339 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340
6341 *'previewwindow'* *'nopreviewwindow'*
6342 *'pvw'* *'nopvw'* *E590*
6343'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006344 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006345 {not available when compiled without the |+quickfix|
6346 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006347 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 set. It's normally not set directly, but by using one of the commands
6349 |:ptag|, |:pedit|, etc.
6350
6351 *'printdevice'* *'pdev'*
6352'printdevice' 'pdev' string (default empty)
6353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 {only available when compiled with the |+printer|
6355 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006356 The name of the printer to be used for |:hardcopy|.
6357 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006358 This option cannot be set from a |modeline| or in the |sandbox|, for
6359 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360
Bram Moolenaar8299df92004-07-10 09:47:34 +00006361 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006362'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 {only available when compiled with the |+printer|
6365 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006366 Sets the character encoding used when printing.
6367 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368
6369 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006370'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 {only available when compiled with the |+printer|
6373 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006374 Expression used to print the PostScript produced with |:hardcopy|.
6375 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006376 This option cannot be set from a |modeline| or in the |sandbox|, for
6377 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378
Bram Moolenaar8299df92004-07-10 09:47:34 +00006379 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380'printfont' 'pfn' string (default "courier")
6381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 {only available when compiled with the |+printer|
6383 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006384 The name of the font that will be used for |:hardcopy|.
6385 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386
6387 *'printheader'* *'pheader'*
6388'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 {only available when compiled with the |+printer|
6391 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006392 The format of the header produced in |:hardcopy| output.
6393 See |pheader-option|.
6394
6395 *'printmbcharset'* *'pmbcs'*
6396'printmbcharset' 'pmbcs' string (default "")
6397 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006398 {only available when compiled with the |+printer|
6399 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006400 The CJK character set to be used for CJK output from |:hardcopy|.
6401 See |pmbcs-option|.
6402
6403 *'printmbfont'* *'pmbfn'*
6404'printmbfont' 'pmbfn' string (default "")
6405 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006406 {only available when compiled with the |+printer|
6407 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006408 List of font names to be used for CJK output from |:hardcopy|.
6409 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410
6411 *'printoptions'* *'popt'*
6412'printoptions' 'popt' string (default "")
6413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006415 List of items that control the format of the output of |:hardcopy|.
6416 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006418 *'prompt'* *'noprompt'*
6419'prompt' boolean (default on)
6420 global
6421 When on a ":" prompt is used in Ex mode.
6422
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006423 *'pumheight'* *'ph'*
6424'pumheight' 'ph' number (default 0)
6425 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006426 Determines the maximum number of items to show in the popup menu for
6427 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006428 |ins-completion-menu|.
6429
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006430 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006431'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006432 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006433 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006434 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006435
Bram Moolenaard94464e2015-11-02 15:28:18 +01006436 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006437'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006438 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006439 {only available when compiled with the |+python/dyn|
6440 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006441 Specifies the name of the Python 2.x shared library. The default is
6442 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006443 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006444 This option cannot be set from a |modeline| or in the |sandbox|, for
6445 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006446
Bram Moolenaar94073162018-01-31 21:49:05 +01006447 *'pythonhome'*
6448'pythonhome' string (default "")
6449 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006450 {only available when compiled with the |+python/dyn|
6451 feature}
6452 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6453 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6454 which was specified at compile time, will be used for the Python 2.x
6455 home directory.
6456 Environment variables are expanded |:set_env|.
6457 This option cannot be set from a |modeline| or in the |sandbox|, for
6458 security reasons.
6459
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006460 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006461'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006462 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006463 {only available when compiled with the |+python3/dyn|
6464 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006465 Specifies the name of the Python 3 shared library. The default is
6466 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006467 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006468 This option cannot be set from a |modeline| or in the |sandbox|, for
6469 security reasons.
6470
Bram Moolenaar94073162018-01-31 21:49:05 +01006471 *'pythonthreehome'*
6472'pythonthreehome' string (default "")
6473 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006474 {only available when compiled with the |+python3/dyn|
6475 feature}
6476 Specifies the name of the Python 3 home directory. When
6477 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6478 PYTHON3_HOME, which was specified at compile time, will be used for
6479 the Python 3 home directory.
6480 Environment variables are expanded |:set_env|.
6481 This option cannot be set from a |modeline| or in the |sandbox|, for
6482 security reasons.
6483
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006484 *'pyxversion'* *'pyx'*
6485'pyxversion' 'pyx' number (default depends on the build)
6486 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006487 {only available when compiled with the |+python| or
6488 the |+python3| feature}
6489 Specifies the python version used for pyx* functions and commands
6490 |python_x|. The default value is as follows:
6491
6492 Compiled with Default ~
6493 |+python| and |+python3| 0
6494 only |+python| 2
6495 only |+python3| 3
6496
6497 Available values are 0, 2 and 3.
6498 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6499 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6500 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6501 to 2 if Python 2 is available.
6502 See also: |has-pythonx|
6503
6504 If Vim is compiled with only |+python| or |+python3| setting
6505 'pyxversion' has no effect. The pyx* functions and commands are
6506 always the same as the compiled version.
6507
6508 This option cannot be set from a |modeline| or in the |sandbox|, for
6509 security reasons.
6510
Bram Moolenaar858ba062020-05-31 23:11:59 +02006511 *'quickfixtextfunc'* *'qftf'*
6512'quickfixtextfunc' 'qftf' string (default "")
6513 global
6514 {only available when compiled with the |+quickfix|
6515 feature}
6516 This option specifies a function to be used to get the text to display
6517 in the quickfix and location list windows. This can be used to
6518 customize the information displayed in the quickfix or location window
6519 for each entry in the corresponding quickfix or location list. See
6520 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006521 function and an example. The value can be the name of a function, a
6522 |lambda| or a |Funcref|. See |option-value-function| for more
6523 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006524
6525 This option cannot be set from a |modeline| or in the |sandbox|, for
6526 security reasons.
6527
Bram Moolenaar677ee682005-01-27 14:41:15 +00006528 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006529'quoteescape' 'qe' string (default "\")
6530 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006531 The characters that are used to escape quotes in a string. Used for
6532 objects like a', a" and a` |a'|.
6533 When one of the characters in this option is found inside a string,
6534 the following character will be skipped. The default value makes the
6535 text "foo\"bar\\" considered to be one string.
6536
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6538'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006539 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 If on, writes fail unless you use a '!'. Protects you from
6541 accidentally overwriting a file. Default on when Vim is started
6542 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006543 When using ":w!" the 'readonly' option is reset for the current
6544 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006545 When using the ":view" command the 'readonly' option is set for the
6546 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006547 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006549 *'redrawtime'* *'rdt'*
6550'redrawtime' 'rdt' number (default 2000)
6551 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006552 {only available when compiled with the |+reltime|
6553 feature}
6554 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006555 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006556 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006557 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006558 matches will be highlighted.
6559 For syntax highlighting the time applies per window. When over the
6560 limit syntax highlighting is disabled until |CTRL-L| is used.
6561 This is used to avoid that Vim hangs when using a very complicated
6562 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006563
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006564 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006565'regexpengine' 're' number (default 0)
6566 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006567 This selects the default regexp engine. |two-engines|
6568 The possible values are:
6569 0 automatic selection
6570 1 old engine
6571 2 NFA engine
6572 Note that when using the NFA engine and the pattern contains something
6573 that is not supported the pattern will not match. This is only useful
6574 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006575 Using automatic selection enables Vim to switch the engine, if the
6576 default engine becomes too costly. E.g., when the NFA engine uses too
6577 many states. This should prevent Vim from hanging on a combination of
6578 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006579
Bram Moolenaar64486672010-05-16 15:46:46 +02006580 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6581'relativenumber' 'rnu' boolean (default off)
6582 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006583 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006584 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006585 precede some vertical motion commands (e.g. j k + -) with, without
6586 having to calculate it yourself. Especially useful in combination with
6587 other commands (e.g. y d c < > gq gw =).
6588 When the 'n' option is excluded from 'cpoptions' a wrapped
6589 line will not use the column of line numbers (this is the default when
6590 'compatible' isn't set).
6591 The 'numberwidth' option can be used to set the room used for the line
6592 number.
6593 When a long, wrapped line doesn't start with the first character, '-'
6594 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006595 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6596 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006597
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006598 The number in front of the cursor line also depends on the value of
6599 'number', see |number_relativenumber| for all combinations of the two
6600 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006601
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 *'remap'* *'noremap'*
6603'remap' boolean (default on)
6604 global
6605 Allows for mappings to work recursively. If you do not want this for
6606 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006607 NOTE: To avoid portability problems with Vim scripts, always keep
6608 this option at the default "on". Only switch it off when working with
6609 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610
zeertzjqd086b8f2024-02-25 15:42:52 +08006611 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006612'renderoptions' 'rop' string (default: empty)
6613 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006614 {only available when compiled with GUI and DIRECTX on
6615 MS-Windows}
6616 Select a text renderer and set its options. The options depend on the
6617 renderer.
6618
6619 Syntax: >
6620 set rop=type:{renderer}(,{name}:{value})*
6621<
6622 Currently, only one optional renderer is available.
6623
6624 render behavior ~
6625 directx Vim will draw text using DirectX (DirectWrite). It makes
6626 drawn glyphs more beautiful than default GDI.
6627 It requires 'encoding' is "utf-8", and only works on
6628 MS-Windows Vista or newer version.
6629
6630 Options:
6631 name meaning type value ~
6632 gamma gamma float 1.0 - 2.2 (maybe)
6633 contrast enhancedContrast float (unknown)
6634 level clearTypeLevel float (unknown)
6635 geom pixelGeometry int 0 - 2 (see below)
6636 renmode renderingMode int 0 - 6 (see below)
6637 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006638 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006639
Bram Moolenaar92467d32017-12-05 13:22:16 +01006640 See this URL for detail (except for scrlines):
6641 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006642
6643 For geom: structure of a device pixel.
6644 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6645 1 - DWRITE_PIXEL_GEOMETRY_RGB
6646 2 - DWRITE_PIXEL_GEOMETRY_BGR
6647
6648 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006649 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006650
6651 For renmode: method of rendering glyphs.
6652 0 - DWRITE_RENDERING_MODE_DEFAULT
6653 1 - DWRITE_RENDERING_MODE_ALIASED
6654 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6655 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6656 4 - DWRITE_RENDERING_MODE_NATURAL
6657 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6658 6 - DWRITE_RENDERING_MODE_OUTLINE
6659
6660 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006661 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006662
6663 For taamode: antialiasing mode used for drawing text.
6664 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6665 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6666 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6667 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6668
6669 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006670 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6671
Bram Moolenaara338adc2018-01-31 20:51:47 +01006672 For scrlines:
6673 This was used for optimizing scrolling behavior, however this
6674 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006675
6676 Example: >
6677 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006678 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006679 set rop=type:directx
6680<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006681 If select a raster font (Courier, Terminal or FixedSys which
6682 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006683 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006684
6685 NOTE: It is known that some fonts and options combination
6686 causes trouble on drawing glyphs.
6687
Bram Moolenaar92467d32017-12-05 13:22:16 +01006688 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006689 special made fonts (True-Type fonts which includes only
6690 bitmap glyphs).
6691 - 'taamode:3' will not work with some vector fonts.
6692
6693 NOTE: With this option, you can display colored emoji
6694 (emoticon) in Windows 8.1 or later. To display colored emoji,
6695 there are some conditions which you should notice.
6696
6697 - If your font includes non-colored emoji already, it will
6698 be used.
6699 - If your font doesn't have emoji, the system chooses an
6700 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6701 will be used.
6702 - When this alternative font didn't have fixed width glyph,
6703 emoji might be rendered beyond the bounding box of drawing
6704 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006705
6706 Other render types are currently not supported.
6707
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 *'report'*
6709'report' number (default 2)
6710 global
6711 Threshold for reporting number of lines changed. When the number of
6712 changed lines is more than 'report' a message will be given for most
6713 ":" commands. If you want it always, set 'report' to 0.
6714 For the ":substitute" command the number of substitutions is used
6715 instead of the number of lines.
6716
6717 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6718'restorescreen' 'rs' boolean (default on)
6719 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006720 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 When set, the screen contents is restored when exiting Vim. This also
6722 happens when executing external commands.
6723
6724 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6725 options in your .vimrc. To disable restoring:
6726 set t_ti= t_te=
6727 To enable restoring (for an xterm):
6728 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6729 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6730
6731 *'revins'* *'ri'* *'norevins'* *'nori'*
6732'revins' 'ri' boolean (default off)
6733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 {only available when compiled with the |+rightleft|
6735 feature}
6736 Inserting characters in Insert mode will work backwards. See "typing
6737 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6738 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006739 NOTE: This option is reset when 'compatible' is set.
6740 This option is reset when 'paste' is set and restored when 'paste' is
6741 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742
6743 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6744'rightleft' 'rl' boolean (default off)
6745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 {only available when compiled with the |+rightleft|
6747 feature}
6748 When on, display orientation becomes right-to-left, i.e., characters
6749 that are stored in the file appear from the right to the left.
6750 Using this option, it is possible to edit files for languages that
6751 are written from the right to the left such as Hebrew and Arabic.
6752 This option is per window, so it is possible to edit mixed files
6753 simultaneously, or to view the same file in both ways (this is
6754 useful whenever you have a mixed text file with both right-to-left
6755 and left-to-right strings so that both sets are displayed properly
6756 in different windows). Also see |rileft.txt|.
6757
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006758 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759'rightleftcmd' 'rlc' string (default "search")
6760 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 {only available when compiled with the |+rightleft|
6762 feature}
6763 Each word in this option enables the command line editing to work in
6764 right-to-left mode for a group of commands:
6765
6766 search "/" and "?" commands
6767
6768 This is useful for languages such as Hebrew, Arabic and Farsi.
6769 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6770
Bram Moolenaard94464e2015-11-02 15:28:18 +01006771 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006772'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006773 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006774 {only available when compiled with the |+ruby/dyn|
6775 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006776 Specifies the name of the Ruby shared library. The default is
6777 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006778 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006779 This option cannot be set from a |modeline| or in the |sandbox|, for
6780 security reasons.
6781
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006783'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006786 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 text in the file is shown on the far right:
6788 Top first line is visible
6789 Bot last line is visible
6790 All first and last line are visible
6791 45% relative position in the file
6792 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006794 ruler is shown there. Otherwise it is shown in the last line of the
6795 screen. If the statusline is given by 'statusline' (i.e. not empty),
6796 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006798 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 the text column (byte number) and the screen column are shown,
6800 separated with a dash.
6801 For an empty line "0-1" is shown.
6802 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006803 This option is reset when 'paste' is set and restored when 'paste' is
6804 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 If you don't want to see the ruler all the time but want to know where
6806 you are, use "g CTRL-G" |g_CTRL-G|.
6807 NOTE: This option is reset when 'compatible' is set.
6808
6809 *'rulerformat'* *'ruf'*
6810'rulerformat' 'ruf' string (default empty)
6811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 {not available when compiled without the |+statusline|
6813 feature}
6814 When this option is not empty, it determines the content of the ruler
6815 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006816 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006817 This option cannot be set in a modeline when 'modelineexpr' is off.
6818
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 The default ruler width is 17 characters. To make the ruler 15
6820 characters wide, put "%15(" at the start and "%)" at the end.
6821 Example: >
6822 :set rulerformat=%15(%c%V\ %p%%%)
6823<
6824 *'runtimepath'* *'rtp'* *vimfiles*
6825'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006826 Unix: "$HOME/.vim or
6827 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 $VIM/vimfiles,
6829 $VIMRUNTIME,
6830 $VIM/vimfiles/after,
6831 $HOME/.vim/after"
6832 Amiga: "home:vimfiles,
6833 $VIM/vimfiles,
6834 $VIMRUNTIME,
6835 $VIM/vimfiles/after,
6836 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006837 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 $VIM/vimfiles,
6839 $VIMRUNTIME,
6840 $VIM/vimfiles/after,
6841 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006842 Haiku: "$BE_USER_SETTINGS/vim,
6843 $VIM/vimfiles,
6844 $VIMRUNTIME,
6845 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006846 $BE_USER_SETTINGS/vim/after"
6847 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 $VIM/vimfiles,
6849 $VIMRUNTIME,
6850 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006851 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 This is a list of directories which will be searched for runtime
6854 files:
6855 filetype.vim filetypes by file name |new-filetype|
6856 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006857 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 colors/ color scheme files |:colorscheme|
6859 compiler/ compiler files |:compiler|
6860 doc/ documentation |write-local-help|
6861 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006862 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 indent/ indent scripts |indent-expression|
6864 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006865 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006867 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 plugin/ plugin scripts |write-plugin|
6869 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006870 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 syntax/ syntax files |mysyntaxfile|
6872 tutor/ files for vimtutor |tutor|
6873
6874 And any other file searched for with the |:runtime| command.
6875
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006876 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6877
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 The defaults for most systems are setup to search five locations:
6879 1. In your home directory, for your personal preferences.
6880 2. In a system-wide Vim directory, for preferences from the system
6881 administrator.
6882 3. In $VIMRUNTIME, for files distributed with Vim.
6883 *after-directory*
6884 4. In the "after" directory in the system-wide Vim directory. This is
6885 for the system administrator to overrule or add to the distributed
6886 defaults (rarely needed)
6887 5. In the "after" directory in your home directory. This is for
6888 personal preferences to overrule or add to the distributed defaults
6889 or system-wide settings (rarely needed).
6890
Bram Moolenaard0796902016-09-16 20:02:31 +02006891 More entries are added when using |packages|. If it gets very long
6892 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6893 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006894
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6896 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006897 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 wildcards.
6899 See |:runtime|.
6900 Example: >
6901 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6902< This will use the directory "~/vimruntime" first (containing your
6903 personal Vim runtime files), then "/mygroup/vim" (shared between a
6904 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6905 files).
6906 You probably should always include $VIMRUNTIME somewhere, to use the
6907 distributed runtime files. You can put a directory before $VIMRUNTIME
6908 to find files which replace a distributed runtime files. You can put
6909 a directory after $VIMRUNTIME to find files which add to distributed
6910 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006911 When Vim is started with |--clean| the home directory entries are not
6912 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 This option cannot be set from a |modeline| or in the |sandbox|, for
6914 security reasons.
6915
6916 *'scroll'* *'scr'*
6917'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006918 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6920 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006921 changes. This may happen when enabling the |status-line| or
6922 'tabline' option after setting the 'scroll' option.
6923 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006924 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006925 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926
6927 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6928'scrollbind' 'scb' boolean (default off)
6929 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006930 See also |scroll-binding|. When this option is set, scrolling the
6931 current window also scrolls other scrollbind windows (windows that
6932 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 differences between two versions of a file, see 'diff'.
6934 See |'scrollopt'| for options that determine how this option should be
6935 interpreted.
6936 This option is mostly reset when splitting a window to edit another
6937 file. This means that ":split | edit file" results in two windows
6938 with scroll-binding, but ":split file" does not.
6939
Bram Moolenaarae20f342019-11-05 21:09:23 +01006940 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6941'scrollfocus' 'scf' boolean (default off)
6942 global
6943 {only for MS-Windows GUI}
6944 When using the scroll wheel and this option is set, the window under
6945 the mouse pointer is scrolled. With this option off the current
6946 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006947 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006948
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 *'scrolljump'* *'sj'*
6950'scrolljump' 'sj' number (default 1)
6951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 Minimal number of lines to scroll when the cursor gets off the
6953 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6954 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006955 When set to a negative number from -1 to -100 this is used as the
6956 percentage of the window height. Thus -50 scrolls half the window
6957 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 NOTE: This option is set to 1 when 'compatible' is set.
6959
6960 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006961'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006962 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 Minimal number of screen lines to keep above and below the cursor.
6964 This will make some context visible around where you are working. If
6965 you set it to a very large value (999) the cursor line will always be
6966 in the middle of the window (except at the start or end of the file or
6967 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006968 After using the local value, go back the global value with one of
6969 these two: >
6970 setlocal scrolloff<
6971 setlocal scrolloff=-1
6972< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 NOTE: This option is set to 0 when 'compatible' is set.
6974
6975 *'scrollopt'* *'sbo'*
6976'scrollopt' 'sbo' string (default "ver,jump")
6977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006979 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6980 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 The following words are available:
6982 ver Bind vertical scrolling for 'scrollbind' windows
6983 hor Bind horizontal scrolling for 'scrollbind' windows
6984 jump Applies to the offset between two windows for vertical
6985 scrolling. This offset is the difference in the first
6986 displayed line of the bound windows. When moving
6987 around in a window, another 'scrollbind' window may
6988 reach a position before the start or after the end of
6989 the buffer. The offset is not changed though, when
6990 moving back the 'scrollbind' window will try to scroll
6991 to the desired position when possible.
6992 When now making that window the current one, two
6993 things can be done with the relative offset:
6994 1. When "jump" is not included, the relative offset is
6995 adjusted for the scroll position in the new current
6996 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006997 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 2. When "jump" is included, the other windows are
6999 scrolled to keep the same relative offset. When
7000 going back to the other window, it still uses the
7001 same relative offset.
7002 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007003 When 'diff' mode is active there always is vertical scroll binding,
7004 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005
7006 *'sections'* *'sect'*
7007'sections' 'sect' string (default "SHNHH HUnhsh")
7008 global
7009 Specifies the nroff macros that separate sections. These are pairs of
7010 two letters (See |object-motions|). The default makes a section start
7011 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7012
7013 *'secure'* *'nosecure'* *E523*
7014'secure' boolean (default off)
7015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 When on, ":autocmd", shell and write commands are not allowed in
7017 ".vimrc" and ".exrc" in the current directory and map commands are
7018 displayed. Switch it off only if you know that you will not run into
7019 problems, or when the 'exrc' option is off. On Unix this option is
7020 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007021 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 'secure' at the end of your ~/.vimrc then.
7023 This option cannot be set from a |modeline| or in the |sandbox|, for
7024 security reasons.
7025
7026 *'selection'* *'sel'*
7027'selection' 'sel' string (default "inclusive")
7028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 This option defines the behavior of the selection. It is only used
7030 in Visual and Select mode.
7031 Possible values:
7032 value past line inclusive ~
7033 old no yes
7034 inclusive yes yes
7035 exclusive yes no
7036 "past line" means that the cursor is allowed to be positioned one
7037 character past the line.
7038 "inclusive" means that the last character of the selection is included
7039 in an operation. For example, when "x" is used to delete the
7040 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007041 When "old" is used and 'virtualedit' allows the cursor to move past
7042 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007043 When "exclusive" is used, cursor position in visual mode will be
7044 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 Note that when "exclusive" is used and selecting from the end
7046 backwards, you cannot include the last character of a line, when
7047 starting in Normal mode and 'virtualedit' empty.
7048
7049 The 'selection' option is set by the |:behave| command.
7050
7051 *'selectmode'* *'slm'*
7052'selectmode' 'slm' string (default "")
7053 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007054 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 Select mode instead of Visual mode, when a selection is started.
7056 Possible values:
7057 mouse when using the mouse
7058 key when using shifted special keys
7059 cmd when using "v", "V" or CTRL-V
7060 See |Select-mode|.
7061 The 'selectmode' option is set by the |:behave| command.
7062
7063 *'sessionoptions'* *'ssop'*
7064'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007065 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007067 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 feature}
7069 Changes the effect of the |:mksession| command. It is a comma
7070 separated list of words. Each word enables saving and restoring
7071 something:
7072 word save and restore ~
7073 blank empty windows
7074 buffers hidden and unloaded buffers, not just those in windows
7075 curdir the current directory
7076 folds manually created folds, opened/closed folds and local
7077 fold options
7078 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007079 and contain at least one lowercase letter. Only
7080 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 help the help window
7082 localoptions options and mappings local to a window or buffer (not
7083 global values for local options)
7084 options all options and mappings (also global values for local
7085 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007086 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 resize size of the Vim window: 'lines' and 'columns'
7088 sesdir the directory in which the session file is located
7089 will become the current directory (useful with
7090 projects accessed over a network from different
7091 systems)
7092 slash backslashes in file names replaced with forward
7093 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007094 tabpages all tab pages; without this only the current tab page
7095 is restored, so that you can make a session for each
7096 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007097 terminal include terminal windows where the command can be
7098 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 unix with Unix end-of-line format (single <NL>), even when
7100 on Windows or DOS
7101 winpos position of the whole Vim window
7102 winsize window sizes
7103
7104 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007105 When neither "curdir" nor "sesdir" is included, file names are stored
7106 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007107 If you leave out "options" many things won't work well after restoring
7108 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 "slash" and "unix" are useful on Windows when sharing session files
7110 with Unix. The Unix version of Vim cannot source dos format scripts,
7111 but the Windows version of Vim can source unix format scripts.
7112
7113 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007114'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 global
7116 Name of the shell to use for ! and :! commands. When changing the
7117 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7118 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007119 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 See |option-backslash| about including spaces and backslashes.
7121 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007122
Bram Moolenaara2baa732022-02-04 16:09:54 +00007123 In |restricted-mode| shell commands will not be possible. This mode
7124 is used if the value of $SHELL ends in "false" or "nologin".
7125
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007126 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007127 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7129< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007130 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007132 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007134 Example with escaped space (Vim will do this when initializing the
7135 option from $SHELL): >
7136 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007137< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007138 backslashes are consumed by `:set`.
7139
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 Under MS-Windows, when the executable ends in ".com" it must be
7141 included. Thus setting the shell to "command.com" or "4dos.com"
7142 works, but "command" and "4dos" do not work for all commands (e.g.,
7143 filtering).
7144 For unknown reasons, when using "4dos.com" the current directory is
7145 changed to "C:\". To avoid this set 'shell' like this: >
7146 :set shell=command.com\ /c\ 4dos
7147< This option cannot be set from a |modeline| or in the |sandbox|, for
7148 security reasons.
7149
7150 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007151'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007152 Win32, when 'shell' contains "powershell":
7153 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007154 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007157 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7158 For MS-Windows, the default is set according to the value of 'shell',
7159 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007160 On Unix it can have more than one flag. Each white space separated
7161 part is passed as an argument to the shell command.
7162 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007163 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 This option cannot be set from a |modeline| or in the |sandbox|, for
7165 security reasons.
7166
7167 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007168'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7169 "2>&1| tee", or
7170 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 {not available when compiled without the |+quickfix|
7173 feature}
7174 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007175 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 including spaces and backslashes.
7177 The name of the temporary file can be represented by "%s" if necessary
7178 (the file name is appended automatically if no %s appears in the value
7179 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007180 For the Amiga the default is ">". For MS-Windows using powershell the
7181 default is "2>&1 | Out-File -Encoding default", otherwise the default
7182 is ">%s 2>&1". The output is directly saved in a file and not echoed
7183 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007184 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 in a file and echoed to the screen. If the 'shell' option is "csh" or
7186 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007187 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007188 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7189 means that stderr is also included. Before using the 'shell' option a
7190 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007191 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7192 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 The initialization of this option is done after reading the ".vimrc"
7194 and the other initializations, so that when the 'shell' option is set
7195 there, the 'shellpipe' option changes automatically, unless it was
7196 explicitly set before.
7197 When 'shellpipe' is set to an empty string, no redirection of the
7198 ":make" output will be done. This is useful if you use a 'makeprg'
7199 that writes to 'makeef' by itself. If you want no piping, but do
7200 want to include the 'makeef', set 'shellpipe' to a single space.
7201 Don't forget to precede the space with a backslash: ":set sp=\ ".
7202 In the future pipes may be used for filtering and this option will
7203 become obsolete (at least for Unix).
7204 This option cannot be set from a |modeline| or in the |sandbox|, for
7205 security reasons.
7206
7207 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007208'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 Quoting character(s), put around the command passed to the shell, for
7211 the "!" and ":!" commands. The redirection is kept outside of the
7212 quoting. See 'shellxquote' to include the redirection. It's
7213 probably not useful to set both options.
7214 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007215 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007216 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 This option cannot be set from a |modeline| or in the |sandbox|, for
7218 security reasons.
7219
7220 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007221'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7222 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 String to be used to put the output of a filter command in a temporary
7225 file. See also |:!|. See |option-backslash| about including spaces
7226 and backslashes.
7227 The name of the temporary file can be represented by "%s" if necessary
7228 (the file name is appended automatically if no %s appears in the value
7229 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007230 The default is ">". For Unix, if the 'shell' option is "csh" or
7231 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007232 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007233 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7234 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007235 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7236 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007237 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7238 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 The initialization of this option is done after reading the ".vimrc"
7240 and the other initializations, so that when the 'shell' option is set
7241 there, the 'shellredir' option changes automatically unless it was
7242 explicitly set before.
7243 In the future pipes may be used for filtering and this option will
7244 become obsolete (at least for Unix).
7245 This option cannot be set from a |modeline| or in the |sandbox|, for
7246 security reasons.
7247
7248 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7249'shellslash' 'ssl' boolean (default off)
7250 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007251 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007253 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007254 powershell.exe. Backward slashes can still be typed, but they are
7255 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 Note that setting or resetting this option has no effect for some
7257 existing file names, thus this option needs to be set before opening
7258 any file for best results. This might change in the future.
7259 'shellslash' only works when a backslash can be used as a path
7260 separator. To test if this is so use: >
7261 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007262< Also see 'completeslash'.
7263
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007264 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7265'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7266 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007267 When on, use temp files for shell commands. When off use a pipe.
7268 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007269 Currently a pipe is only supported on Unix and MS-Windows 2K and
7270 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007271 :if has("filterpipe")
7272< The advantage of using a pipe is that nobody can read the temp file
7273 and the 'shell' command does not need to support redirection.
7274 The advantage of using a temp file is that the file type and encoding
7275 can be detected.
7276 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7277 |FilterWritePost| autocommands event are not triggered when
7278 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007279 The `system()` function does not respect this option and always uses
7280 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007281 NOTE: This option is set to the Vim default value when 'compatible'
7282 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007283
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 *'shelltype'* *'st'*
7285'shelltype' 'st' number (default 0)
7286 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007287 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 On the Amiga this option influences the way how the commands work
7289 which use a shell.
7290 0 and 1: always use the shell
7291 2 and 3: use the shell only to filter lines
7292 4 and 5: use shell only for ':sh' command
7293 When not using the shell, the command is executed directly.
7294
7295 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7296 1 and 3: use "shell cmd" to start external commands
7297
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007298 *'shellxescape'* *'sxe'*
7299'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007300 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007301 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007302 When 'shellxquote' is set to "(" then the characters listed in this
7303 option will be escaped with a '^' character. This makes it possible
7304 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007305 This option cannot be set from a |modeline| or in the |sandbox|, for
7306 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007307
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 *'shellxquote'* *'sxq'*
7309'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007310 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007311 for Win32, when 'shell' is
7312 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007313 for Win32, when 'shell' contains "sh"
7314 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 for Unix, when using system(): "\"")
7316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 Quoting character(s), put around the command passed to the shell, for
7318 the "!" and ":!" commands. Includes the redirection. See
7319 'shellquote' to exclude the redirection. It's probably not useful
7320 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007321 When the value is '(' then ')' is appended. When the value is '"('
7322 then ')"' is appended.
7323 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007324 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007325 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7326 pwsh.exe which automatically strips off the first and last quote on a
7327 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7328 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007329 'shell', to reduce the need to set this option by the user. See
7330 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 This option cannot be set from a |modeline| or in the |sandbox|, for
7332 security reasons.
7333
7334 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7335'shiftround' 'sr' boolean (default off)
7336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 Round indent to multiple of 'shiftwidth'. Applies to > and <
7338 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7339 a multiple of 'shiftwidth' (this is Vi compatible).
7340 NOTE: This option is reset when 'compatible' is set.
7341
7342 *'shiftwidth'* *'sw'*
7343'shiftwidth' 'sw' number (default 8)
7344 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007345 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007347 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007348 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349
7350 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007351'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7352 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007353 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007355 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 It is a list of flags:
7357 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007358 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7359 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7360 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7361 m use "[+]" instead of "[Modified]" *shm-m*
7362 n use "[New]" instead of "[New File]" *shm-n*
7363 r use "[RO]" instead of "[readonly]" *shm-r*
7364 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007366 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7367 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007368 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007369 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007371 o overwrite message for writing a file with subsequent *shm-o*
7372 message for reading a file (useful for ":wn" or when
7373 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007374 O message for reading a file overwrites any previous *shm-O*
7375 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007376 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7377 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007378 the search count do not show "W" before the count message
7379 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007380 t truncate file message at the start if it is too long *shm-t*
7381 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007382 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007383 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007384 long to fit on the command line; "..." will appear in the
7385 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007386 W don't give "written" or "[w]" when writing a file *shm-W*
7387 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007388 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007389 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007390 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007391 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007392 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7393 match", "Pattern not found", "Back at original", etc.
7394 C don't give messages while scanning for ins-completion *shm-C*
7395 items, for instance "scanning tags"
7396 q use "recording" instead of "recording @a" *shm-q*
7397 F don't give the file info when editing a file, like *shm-F*
7398 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007399 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007400 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007401 "[1/5]". When the "S" flag is not present (e.g. search count
7402 is shown), the "search hit BOTTOM, continuing at TOP" and
7403 "search hit TOP, continuing at BOTTOM" messages are only
7404 indicated by a "W" (Mnemonic: Wrapped) letter before the
7405 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406
7407 This gives you the opportunity to avoid that a change between buffers
7408 requires you to hit <Enter>, but still gives as useful a message as
7409 possible for the space available. To get the whole message that you
7410 would have got with 'shm' empty, use ":file!"
7411 Useful values:
7412 shm= No abbreviation of message.
7413 shm=a Abbreviation, but no loss of information.
7414 shm=at Abbreviation, and truncate message when necessary.
7415
7416 NOTE: This option is set to the Vi default value when 'compatible' is
7417 set and to the Vim default value when 'compatible' is reset.
7418
7419 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7420'shortname' 'sn' boolean (default off)
7421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 Filenames are assumed to be 8 characters plus one extension of 3
7423 characters. Multiple dots in file names are not allowed. When this
7424 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007425 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007427 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428
7429 *'showbreak'* *'sbr'* *E595*
7430'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007431 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007432 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 feature}
7434 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007435 values are "> " or "+++ ": >
7436 :set showbreak=>\
7437< Note the backslash to escape the trailing space. It's easier like
7438 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007439 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007440< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 comma (in a future version the comma might be used to separate the
7442 part that is shown at the end and at the start of a line).
7443 The characters are highlighted according to the '@' flag in
7444 'highlight'.
7445 Note that tabs after the showbreak will be displayed differently.
7446 If you want the 'showbreak' to appear in between line numbers, add the
7447 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007448 A window-local value overrules a global value. If the global value is
7449 set and you want no value in the current window use NONE: >
7450 :setlocal showbreak=NONE
7451<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007453'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7454 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007456 Show (partial) command in the last line of the screen. Set this
7457 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 In Visual mode the size of the selected area is shown:
7459 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007460 If the number of bytes is different it is also displayed: "2-6"
7461 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007463 - When selecting a block, the size in screen characters:
7464 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007465 This information can be displayed in an alternative location using the
7466 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 NOTE: This option is set to the Vi default value when 'compatible' is
7468 set and to the Vim default value when 'compatible' is reset.
7469
Luuk van Baalba936f62022-12-15 13:15:39 +00007470 *'showcmdloc'* *'sloc'*
7471'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007472 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007473 This option can be used to display the (partially) entered command in
7474 another location. Possible values are:
7475 last Last line of the screen (default).
7476 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007477 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007478 Setting this option to "statusline" or "tabline" means that these will
7479 be redrawn whenever the command changes, which can be on every key
7480 pressed.
7481 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7482 place the text. Without a custom 'statusline' or 'tabline' it will be
7483 displayed in a convenient location.
7484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7486'showfulltag' 'sft' boolean (default off)
7487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 When completing a word in insert mode (see |ins-completion|) from the
7489 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007490 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 matched a C function, you can see a template for what arguments are
7492 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007493 Note that this doesn't work well together with having "longest" in
7494 'completeopt', because the completion from the search pattern may not
7495 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
7497 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7498'showmatch' 'sm' boolean (default off)
7499 global
7500 When a bracket is inserted, briefly jump to the matching one. The
7501 jump is only done if the match can be seen on the screen. The time to
7502 show the match can be set with 'matchtime'.
7503 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007504 seen or not).
7505 This option is reset when 'paste' is set and restored when 'paste' is
7506 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 When the 'm' flag is not included in 'cpoptions', typing a character
7508 will immediately move the cursor back to where it belongs.
7509 See the "sm" field in 'guicursor' for setting the cursor shape and
7510 blinking when showing the match.
7511 The 'matchpairs' option can be used to specify the characters to show
7512 matches for. 'rightleft' and 'revins' are used to look for opposite
7513 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007514 Also see the matchparen plugin for highlighting the match when moving
7515 around |pi_paren.txt|.
7516 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7519'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7520 global
7521 If in Insert, Replace or Visual mode put a message on the last line.
7522 Use the 'M' flag in 'highlight' to set the type of highlighting for
7523 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 doesn't mean XIM is really active, especially when 'imactivatekey' is
7526 not set.
7527 NOTE: This option is set to the Vi default value when 'compatible' is
7528 set and to the Vim default value when 'compatible' is reset.
7529
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007530 *'showtabline'* *'stal'*
7531'showtabline' 'stal' number (default 1)
7532 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007533 The value of this option specifies when the line with tab page labels
7534 will be displayed:
7535 0: never
7536 1: only if there are at least two tab pages
7537 2: always
7538 This is both for the GUI and non-GUI implementation of the tab pages
7539 line.
7540 See |tab-page| for more information about tab pages.
7541
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 *'sidescroll'* *'ss'*
7543'sidescroll' 'ss' number (default 0)
7544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 The minimal number of columns to scroll horizontally. Used only when
7546 the 'wrap' option is off and the cursor is moved off of the screen.
7547 When it is zero the cursor will be put in the middle of the screen.
7548 When using a slow terminal set it to a large number or 0. When using
7549 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7550 commands.
7551
7552 *'sidescrolloff'* *'siso'*
7553'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007554 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007556 right of the cursor if 'nowrap' is set. Setting this option to a
7557 value greater than 0 while having |'sidescroll'| also at a non-zero
7558 value makes some context visible in the line you are scrolling in
7559 horizontally (except at beginning of the line). Setting this option
7560 to a large value (like 999) has the effect of keeping the cursor
7561 horizontally centered in the window, as long as one does not come too
7562 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007563 After using the local value, go back the global value with one of
7564 these two: >
7565 setlocal sidescrolloff<
7566 setlocal sidescrolloff=-1
7567< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568
7569 Example: Try this together with 'sidescroll' and 'listchars' as
7570 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007571 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572
7573 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7574 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007575<
7576 *'signcolumn'* *'scl'*
7577'signcolumn' 'scl' string (default "auto")
7578 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007579 {not available when compiled without the |+signs|
7580 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007581 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007582 "auto" only when there is a sign to display
7583 "no" never
7584 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007585 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007586 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7589'smartcase' 'scs' boolean (default off)
7590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 Override the 'ignorecase' option if the search pattern contains upper
7592 case characters. Only used when the search pattern is typed and
7593 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007594 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7596 recalling the search pattern from history and hitting <Enter>.
7597 NOTE: This option is reset when 'compatible' is set.
7598
7599 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7600'smartindent' 'si' boolean (default off)
7601 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 Do smart autoindenting when starting a new line. Works for C-like
7603 programs, but can also be used for other languages. 'cindent' does
7604 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007605 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007606 setting 'si' has no effect. 'indentexpr' is a more advanced
7607 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 Normally 'autoindent' should also be on when using 'smartindent'.
7609 An indent is automatically inserted:
7610 - After a line ending in '{'.
7611 - After a line starting with a keyword from 'cinwords'.
7612 - Before a line starting with '}' (only with the "O" command).
7613 When typing '}' as the first character in a new line, that line is
7614 given the same indent as the matching '{'.
7615 When typing '#' as the first character in a new line, the indent for
7616 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007617 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7619 When using the ">>" command, lines starting with '#' are not shifted
7620 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007621 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007622 This option is reset when 'paste' is set and restored when 'paste' is
7623 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624
7625 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7626'smarttab' 'sta' boolean (default off)
7627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007629 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7630 <BS> will delete a 'shiftwidth' worth of space at the start of the
7631 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007632 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007633 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7634 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007635 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007637 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007638 This option is reset when 'paste' is set and restored when 'paste' is
7639 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 NOTE: This option is reset when 'compatible' is set.
7641
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007642 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7643'smoothscroll' 'sms' boolean (default off)
7644 local to window
7645 Scrolling works with screen lines. When 'wrap' is set and the first
7646 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007647 above the window. "<<<" is displayed at the start of the first line,
7648 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007649 You may also want to add "lastline" to the 'display' option to show as
7650 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007651 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007652
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 *'softtabstop'* *'sts'*
7654'softtabstop' 'sts' number (default 0)
7655 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 Number of spaces that a <Tab> counts for while performing editing
7657 operations, like inserting a <Tab> or using <BS>. It "feels" like
7658 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7659 used. This is useful to keep the 'ts' setting at its standard value
7660 of 8, while being able to edit like it is set to 'sts'. However,
7661 commands like "x" still work on the actual characters.
7662 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007663 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007664 'softtabstop' is set to 0 when the 'paste' option is set and restored
7665 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7667 spaces is minimized by using <Tab>s.
7668 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7669 set.
7670 NOTE: This option is set to 0 when 'compatible' is set.
7671
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007672 If Vim is compiled with the |+vartabs| feature then the value of
7673 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7674 anything other than an empty string.
7675
Bram Moolenaar217ad922005-03-20 22:37:15 +00007676 *'spell'* *'nospell'*
7677'spell' boolean (default off)
7678 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007679 {not available when compiled without the |+syntax|
7680 feature}
7681 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007682 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007683
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007684 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007685'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007686 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007687 {not available when compiled without the |+syntax|
7688 feature}
7689 Pattern to locate the end of a sentence. The following word will be
7690 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007691 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007692 When this check is not wanted make this option empty.
7693 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007694 Be careful with special characters, see |option-backslash| about
7695 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007696 To set this option automatically depending on the language, see
7697 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007698
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007699 *'spellfile'* *'spf'*
7700'spellfile' 'spf' string (default empty)
7701 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007702 {not available when compiled without the |+syntax|
7703 feature}
7704 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007705 commands. It must end in ".{encoding}.add". You need to include the
7706 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007707 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007708 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007709 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007710 |zg| and |zw| commands can be used to access each. This allows using
7711 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007712 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007713 you: Using the first directory in 'runtimepath' that is writable. If
7714 there is no "spell" directory yet it will be created. For the file
7715 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007716 ignoring the region.
7717 The resulting ".spl" file will be used for spell checking, it does not
7718 have to appear in 'spelllang'.
7719 Normally one file is used for all regions, but you can add the region
7720 name if you want to. However, it will then only be used when
7721 'spellfile' is set to it, for entries in 'spelllang' only files
7722 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007723 This option cannot be set from a |modeline| or in the |sandbox|, for
7724 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007725
Bram Moolenaar217ad922005-03-20 22:37:15 +00007726 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007727'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007728 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007729 {not available when compiled without the |+syntax|
7730 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007731 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007732 on spellchecking will be done for these languages. Example: >
7733 set spelllang=en_us,nl,medical
7734< This means US English, Dutch and medical words are recognized. Words
7735 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007736 The word list name must consist of alphanumeric characters, a dash or
7737 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007738 recommended to separate the two letter language name from a
7739 specification. Thus "en-rare" is used for rare English words.
7740 A region name must come last and have the form "_xx", where "xx" is
7741 the two-letter, lower case region name. You can use more than one
7742 region by listing them: "en_us,en_ca" supports both US and Canadian
7743 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007744 Britain. (Note: currently en_au and en_nz dictionaries are older than
7745 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007746 If the name "cjk" is included East Asian characters are excluded from
7747 spell checking. This is useful when editing text that also has Asian
7748 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007749 Note that the "medical" dictionary does not exist, it is just an
7750 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007751 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007752 As a special case the name of a .spl file can be given as-is. The
7753 first "_xx" in the name is removed and used as the region name
7754 (_xx is an underscore, two letters and followed by a non-letter).
7755 This is mainly for testing purposes. You must make sure the correct
7756 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007757 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007758 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7759 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007760 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007761
Bram Moolenaar98692072006-02-04 00:57:42 +00007762 If the |spellfile.vim| plugin is active and you use a language name
7763 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7764 will ask you if you want to download the file.
7765
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007766 After this option has been set successfully, Vim will source the files
7767 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007768 up to the first character that is not an ASCII letter or number and
7769 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007770
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007771 *'spelloptions'* *'spo'*
7772'spelloptions' 'spo' string (default "")
7773 local to buffer
7774 {not available when compiled without the |+syntax|
7775 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007776 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007777 camel When a word is CamelCased, assume "Cased" is a
7778 separate word: every upper-case character in a word
7779 that comes after a lower case character indicates the
7780 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007781
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007782 *'spellsuggest'* *'sps'*
7783'spellsuggest' 'sps' string (default "best")
7784 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007785 {not available when compiled without the |+syntax|
7786 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007787 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007788 the |spellsuggest()| function. This is a comma-separated list of
7789 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007790
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007791 best Internal method that works best for English. Finds
7792 changes like "fast" and uses a bit of sound-a-like
7793 scoring to improve the ordering.
7794
7795 double Internal method that uses two methods and mixes the
7796 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007797 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007798 word. That only works when the language specifies
7799 sound folding. Can be slow and doesn't always give
7800 better results.
7801
7802 fast Internal method that only checks for simple changes:
7803 character inserts/deletes/swaps. Works well for
7804 simple typing mistakes.
7805
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007806 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007807 Not used for |spellsuggest()|. The number of
7808 suggestions is never more than the value of 'lines'
7809 minus two.
7810
Bram Moolenaar585ee072022-01-29 11:22:17 +00007811 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007812 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007813 methods. When omitted the limit is 5000. When
7814 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007815 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007816
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007817 file:{filename} Read file {filename}, which must have two columns,
7818 separated by a slash. The first column contains the
7819 bad word, the second column the suggested good word.
7820 Example:
7821 theribal/terrible ~
7822 Use this for common mistakes that do not appear at the
7823 top of the suggestion list with the internal methods.
7824 Lines without a slash are ignored, use this for
7825 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007826 The word in the second column must be correct,
7827 otherwise it will not be used. Add the word to an
7828 ".add" file if it is currently flagged as a spelling
7829 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007830 The file is used for all languages.
7831
7832 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007833 trouble with spaces. Best is to call a function
7834 without arguments, see |expr-option-function|.
7835 |v:val| holds the badly spelled word. The expression
7836 must evaluate to a List of Lists, each with a
7837 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007838 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007839 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007840 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007841 internal methods use. A lower score is better.
7842 This may invoke |spellsuggest()| if you temporarily
7843 set 'spellsuggest' to exclude the "expr:" part.
7844 Errors are silently ignored, unless you set the
7845 'verbose' option to a non-zero value.
7846
7847 Only one of "best", "double" or "fast" may be used. The others may
7848 appear several times in any order. Example: >
7849 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7850<
7851 This option cannot be set from a |modeline| or in the |sandbox|, for
7852 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007853
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7855'splitbelow' 'sb' boolean (default off)
7856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 When on, splitting a window will put the new window below the current
7858 one. |:split|
7859
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007860 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007861'splitkeep' 'spk' string (default "cursor")
7862 global
7863 The value of this option determines the scroll behavior when opening,
7864 closing or resizing horizontal splits.
7865
7866 Possible values are:
7867 cursor Keep the same relative cursor position.
7868 screen Keep the text on the same screen line.
7869 topline Keep the topline the same.
7870
7871 For the "screen" and "topline" values, the cursor position will be
7872 changed when necessary. In this case, the jumplist will be populated
7873 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007874 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007875
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7877'splitright' 'spr' boolean (default off)
7878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 When on, splitting a window will put the new window right of the
7880 current one. |:vsplit|
7881
7882 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7883'startofline' 'sol' boolean (default on)
7884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007886 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007887 (if possible). This applies to the commands:
7888 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007889 - "d", "<<", "==" and ">>" with a linewise operator
7890 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007891 - "%" with a count
7892 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7893 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 In case of buffer changing commands the cursor is placed at the column
7895 where it was the last time the buffer was edited.
7896 NOTE: This option is set when 'compatible' is set.
7897
Bram Moolenaar00654022011-02-25 14:42:19 +01007898 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007900 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 {not available when compiled without the |+statusline|
7902 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007903 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 Also see |status-line|.
7905
7906 The option consists of printf style '%' items interspersed with
7907 normal text. Each status line item is of the form:
7908 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007909 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007910 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007912 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007913 When the option starts with "%!" then it is used as an expression,
7914 evaluated and the result is used as the option value. Example: >
7915 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007916< The *g:statusline_winid* variable will be set to the |window-ID| of the
7917 window that the status line belongs to.
7918 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007919 Note that the "%!" expression is evaluated in the context of the
7920 current window and buffer, while %{} items are evaluated in the
7921 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007922
7923 When there is error while evaluating the option then it will be made
7924 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007925 When the result contains unprintable characters the result is
7926 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007927
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 Note that the only effect of 'ruler' when this option is set (and
7929 'laststatus' is 2) is controlling the output of |CTRL-G|.
7930
7931 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007932 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007934 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 minwid Minimum width of the item, padding as set by '-' & '0'.
7936 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007937 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 on the left for text items. Numeric items will be
7939 shifted down to maxwid-2 digits followed by '>'number
7940 where number is the amount of missing digits, much like
7941 an exponential notation.
7942 item A one letter code as described below.
7943
7944 Following is a description of the possible statusline items. The
7945 second character in "item" is the type:
7946 N for number
7947 S for string
7948 F for flags as described below
7949 - not applicable
7950
7951 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007952 f S Path to the file in the buffer, as typed or relative to current
7953 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 F S Full path to the file in the buffer.
7955 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007956 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007958 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007960 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007962 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007964 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007966 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7968 being used: "<keymap>"
7969 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007970 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 B N As above, in hexadecimal.
7972 o N Byte number in file of byte under cursor, first byte is 1.
7973 Mnemonic: Offset from start of file (with one added)
7974 {not available when compiled without |+byte_offset| feature}
7975 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007976 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 l N Line number.
7978 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007979 c N Column number (byte index).
7980 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007981 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 p N Percentage through file in lines as in |CTRL-G|.
7983 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007984 percentage described for 'ruler'. Always 3 in length, unless
7985 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007986 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007987 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007989 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007990 Note that there is no '%' before the closing '}'. The
7991 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007992 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007993 {% - This is almost same as { except the result of the expression is
7994 re-evaluated as a statusline format string. Thus if the
7995 return value of expr contains % items they will get expanded.
7996 The expression can contain the } character, the end of
7997 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007998 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007999 func! Stl_filename() abort
8000 return "%t"
8001 endfunc
8002< `stl=%{Stl_filename()}` results in `"%t"`
8003 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008004 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 ( - Start of item group. Can be used for setting the width and
8006 alignment of a section. Must be followed by %) somewhere.
8007 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008008 T N For 'tabline': start of tab page N label. Use %T after the last
8009 label. This information is used for mouse clicks.
8010 X N For 'tabline': start of close tab N label. Use %X after the
8011 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8012 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 < - Where to truncate line if too long. Default is at the start.
8014 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008015 = - Separation point between alignment sections. Each section will
8016 be separated by an equal number of spaces. With one %= what
8017 comes after it will be right-aligned. With two %= there is a
8018 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008020 # - Set highlight group. The name must follow and then a # again.
8021 Thus use %#HLname# for highlight group HLname. The same
8022 highlighting is used, also for the statusline of non-current
8023 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008025 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008026 The difference between User{N} and StatusLine will be applied to
8027 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 The number N must be between 1 and 9. See |hl-User1..9|
8029
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008030 When displaying a flag, Vim removes the leading comma, if any, when
8031 that flag comes right after plaintext. This will make a nice display
8032 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033
Bram Moolenaar582fd852005-03-28 20:58:01 +00008034 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 not set) and a minwid is not set for the group, the whole group will
8036 become empty. This will make a group like the following disappear
8037 completely from the statusline when none of the flags are set. >
8038 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008039< Beware that an expression is evaluated each and every time the status
8040 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008041 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008042 While evaluating %{} the current buffer and current window will be set
8043 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008044 currently being drawn. The expression will evaluate in this context.
8045 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8046 real current buffer and "g:actual_curwin" to the |window-ID| of the
8047 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008048
Bram Moolenaar30b65812012-07-12 22:01:11 +02008049 The 'statusline' option will be evaluated in the |sandbox| if set from
8050 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008051 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008052
8053 It is not allowed to change text or jump to another window while
8054 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055
8056 If the statusline is not updated when you want it (e.g., after setting
8057 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008058 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008060 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 Otherwise the result is taken as flag text and applied to the rules
8062 described above.
8063
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008064 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008066 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067
8068 Examples:
8069 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008070 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071< Similar, but add ASCII value of char under the cursor (like "ga") >
8072 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8073< Display byte count and byte value, modified flag in red. >
8074 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8075 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8076< Display a ,GZ flag if a compressed file is loaded >
8077 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8078< In the |:autocmd|'s: >
8079 :let b:gzflag = 1
8080< And: >
8081 :unlet b:gzflag
8082< And define this function: >
8083 :function VarExists(var, val)
8084 : if exists(a:var) | return a:val | else | return '' | endif
8085 :endfunction
8086<
8087 *'suffixes'* *'su'*
8088'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 Files with these suffixes get a lower priority when multiple files
8091 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008092 suffixes. Spaces after the comma are ignored. A dot is also seen as
8093 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 separator, precede it with a backslash (see |option-backslash| about
8095 including spaces and backslashes).
8096 See 'wildignore' for completely ignoring files.
8097 The use of |:set+=| and |:set-=| is preferred when adding or removing
8098 suffixes from the list. This avoids problems when a future version
8099 uses another default.
8100
8101 *'suffixesadd'* *'sua'*
8102'suffixesadd' 'sua' string (default "")
8103 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008104 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 file for the "gf", "[I", etc. commands. Example: >
8106 :set suffixesadd=.java
8107<
8108 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8109'swapfile' 'swf' boolean (default on)
8110 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008111 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 swapfile is not wanted for a specific buffer. For example, with
8113 confidential information that even root must not be able to access.
8114 Careful: All text will be in memory:
8115 - Don't use this for big files.
8116 - Recovery will be impossible!
8117 A swapfile will only be present when |'updatecount'| is non-zero and
8118 'swapfile' is set.
8119 When 'swapfile' is reset, the swap file for the current buffer is
8120 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8121 non-zero, a swap file is immediately created.
8122 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008123 If you want to open a new buffer without creating a swap file for it,
8124 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008125 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126
8127 This option is used together with 'bufhidden' and 'buftype' to
8128 specify special kinds of buffers. See |special-buffers|.
8129
8130 *'swapsync'* *'sws'*
8131'swapsync' 'sws' string (default "fsync")
8132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008134 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 When this option is empty parts of the swap file may be in memory and
8136 not written to disk. When the system crashes you may lose more work.
8137 On Unix the system does a sync now and then without Vim asking for it,
8138 so the disadvantage of setting this option off is small. On some
8139 systems the swap file will not be written at all. For a unix system
8140 setting it to "sync" will use the sync() call instead of the default
8141 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008142 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143
8144 *'switchbuf'* *'swb'*
8145'switchbuf' 'swb' string (default "")
8146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008148 This option is checked, when
8149 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008150 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008151 - jumping to a tag using the |:stag| command.
8152 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8153 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8154 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008155 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008156 useopen If included, jump to the first open window in the
8157 current tab page that contains the specified buffer
8158 (if there is one). Otherwise: Do not examine other
8159 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008160 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008161 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008163 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008164 Otherwise: do not split, use current window (when used
8165 in the quickfix window: the previously used window or
8166 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008167 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008168 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008169 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008170 uselast If included, jump to the previously used window when
8171 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008172 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8173 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008175 *'synmaxcol'* *'smc'*
8176'synmaxcol' 'smc' number (default 3000)
8177 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008178 {not available when compiled without the |+syntax|
8179 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008180 Maximum column in which to search for syntax items. In long lines the
8181 text after this column is not highlighted and following lines may not
8182 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008183 This helps to avoid very slow redrawing for an XML file that is one
8184 long line.
8185 Set to zero to remove the limit.
8186
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 *'syntax'* *'syn'*
8188'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008189 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 {not available when compiled without the |+syntax|
8191 feature}
8192 When this option is set, the syntax with this name is loaded, unless
8193 syntax highlighting has been switched off with ":syntax off".
8194 Otherwise this option does not always reflect the current syntax (the
8195 b:current_syntax variable does).
8196 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008197 not automatically recognized. Example, in an IDL file:
8198 /* vim: set syntax=idl : */ ~
8199 When a dot appears in the value then this separates two filetype
8200 names. Example:
8201 /* vim: set syntax=c.doxygen : */ ~
8202 This will use the "c" syntax first, then the "doxygen" syntax.
8203 Note that the second one must be prepared to be loaded as an addition,
8204 otherwise it will be skipped. More than one dot may appear.
8205 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 :set syntax=OFF
8207< To switch syntax highlighting on according to the current value of the
8208 'filetype' option: >
8209 :set syntax=ON
8210< What actually happens when setting the 'syntax' option is that the
8211 Syntax autocommand event is triggered with the value as argument.
8212 This option is not copied to another buffer, independent of the 's' or
8213 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008214 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215
LemonBoy5247b0b2024-07-12 19:30:58 +02008216 *'tabclose'* *'tcl'*
8217'tabclose' 'tcl' string (default "")
8218 global
8219 This option controls the behavior when closing tab pages (e.g., using
8220 |:tabclose|). When empty Vim goes to the next (right) tab page.
8221
8222 Possible values (comma-separated list):
8223 left If included, go to the previous tab page instead of
8224 the next one.
8225 uselast If included, go to the previously used tab page if
8226 possible. This option takes precedence over the
8227 others.
8228
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008229 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008230'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008231 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008232 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008233 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008234 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008235
8236 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008237 option and only when there is no GUI tab line. When 'e' is in
8238 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008239 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008240
8241 The value is evaluated like with 'statusline'. You can use
8242 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008243 the text to be displayed. Use "%1T" for the first label, "%2T" for
8244 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008245
Bram Moolenaare12bab32019-01-08 22:02:56 +01008246 When changing something that is used in 'tabline' that does not
8247 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008248 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008249
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008250 Keep in mind that only one of the tab pages is the current one, others
8251 are invisible and you can't jump to their windows.
8252
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008253 *'tabpagemax'* *'tpm'*
8254'tabpagemax' 'tpm' number (default 10)
8255 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008256 Maximum number of tab pages to be opened by the |-p| command line
8257 argument or the ":tab all" command. |tabpage|
8258
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008259 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260'tabstop' 'ts' number (default 8)
8261 local to buffer
8262 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008263 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264
8265 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008266 appear wrong in many places, e.g., when printing it.
8267 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008269 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8271 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008272 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008274 This is the recommended way, the file will look the same with other
8275 tools and when listing it in a terminal.
8276 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8277 'expandtab'. This way you will always insert spaces. The
8278 formatting will never be messed up when 'tabstop' is changed (leave
8279 it at 8 just in case). The file will be a bit larger.
8280 You do need to check if no Tabs exist in the file. You can get rid
8281 of them by first setting 'expandtab' and using `%retab!`, making
8282 sure the value of 'tabstop' is set correctly.
8283 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 'expandtab'. This way you will always insert spaces. The
8285 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008286 You do need to check if no Tabs exist in the file, just like in the
8287 item just above.
8288 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008289 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008290 works when using Vim to edit the file, other tools assume a tabstop
8291 is worth 8 spaces.
8292 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 'noexpandtab'. This should then work (for initial indents only)
8294 for any tabstop setting that people use. It might be nice to have
8295 tabs after the first non-blank inserted as spaces if you do this
8296 though. Otherwise aligned comments will be wrong when 'tabstop' is
8297 changed.
8298
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008299 If Vim is compiled with the |+vartabs| feature then the value of
8300 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8301 than an empty string.
8302
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8304'tagbsearch' 'tbs' boolean (default on)
8305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008307 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 searching makes searching for a tag a LOT faster, but a linear search
8309 will find more tags if the tags file wasn't properly sorted.
8310 Vim normally assumes that your tags files are sorted, or indicate that
8311 they are not sorted. Only when this is not the case does the
8312 'tagbsearch' option need to be switched off.
8313
8314 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008315 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 certain files, or retry all files with a linear search. When
8317 'tagbsearch' is off, only a linear search is done.
8318
8319 Linear searching is done anyway, for one file, when Vim finds a line
8320 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008321 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322< [The whitespace before and after the '0' must be a single <Tab>]
8323
8324 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008325 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 instead of a normal tag name, a retry is done with a linear search.
8327 Tags in unsorted tags files, and matches with different case will only
8328 be found in the retry.
8329
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008330 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008331 linear search can be avoided when case is ignored. Use a value of '2'
8332 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8333 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008334 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8335 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8336 used for this as well. Note that case must be folded to uppercase for
8337 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008338
8339 By default, tag searches are case-sensitive. Case is ignored when
8340 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8341 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008342 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8343 'tagcase' is "smart", and the pattern contains only lowercase
8344 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345
8346 When 'tagbsearch' is off, tags searching is slower when a full match
8347 exists, but faster when no full match exists. Tags in unsorted tags
8348 files may only be found with 'tagbsearch' off.
8349 When the tags file is not sorted, or sorted in a wrong way (not on
8350 ASCII byte value), 'tagbsearch' should be off, or the line given above
8351 must be included in the tags file.
8352 This option doesn't affect commands that find all matching tags (e.g.,
8353 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008355 *'tagcase'* *'tc'*
8356'tagcase' 'tc' string (default "followic")
8357 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008358 This option specifies how case is handled when searching the tags
8359 file:
8360 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008361 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008362 ignore Ignore case
8363 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008364 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008365 NOTE: This option is set to the Vi default value when 'compatible' is
8366 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008367
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008368 *'tagfunc'* *'tfu'*
8369'tagfunc' 'tfu' string (default: empty)
8370 local to buffer
8371 {not available when compiled without the |+eval|
8372 feature}
8373 This option specifies a function to be used to perform tag searches.
8374 The function gets the tag pattern and should return a List of matching
8375 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008376 function and an example. The value can be the name of a function, a
8377 |lambda| or a |Funcref|. See |option-value-function| for more
8378 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008379 This option cannot be set from a |modeline| or in the |sandbox|, for
8380 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008381
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 *'taglength'* *'tl'*
8383'taglength' 'tl' number (default 0)
8384 global
8385 If non-zero, tags are significant up to this number of characters.
8386
8387 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8388'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8389 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008390 If on and using a tags file in another directory, file names in that
8391 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 NOTE: This option is set to the Vi default value when 'compatible' is
8393 set and to the Vim default value when 'compatible' is reset.
8394
8395 *'tags'* *'tag'* *E433*
8396'tags' 'tag' string (default "./tags,tags", when compiled with
8397 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8398 global or local to buffer |global-local|
8399 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008400 include a space or comma in a file name, precede it with backslashes
8401 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 When a file name starts with "./", the '.' is replaced with the path
8403 of the current file. But only when the 'd' flag is not included in
8404 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8405 |tags-option|.
8406 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008407 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8408 find all files named "tags" below "/lib". The filename itself cannot
8409 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008410 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008411 The |tagfiles()| function can be used to get a list of the file names
8412 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8414 files are also supported. They are automatically recognized. The
8415 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8416 differences are ignored (MS-Windows). |emacs-tags|
8417 The use of |:set+=| and |:set-=| is preferred when adding or removing
8418 file names from the list. This avoids problems when a future version
8419 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420
8421 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8422'tagstack' 'tgst' boolean (default on)
8423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 When on, the |tagstack| is used normally. When off, a ":tag" or
8425 ":tselect" command with an argument will not push the tag onto the
8426 tagstack. A following ":tag" without an argument, a ":pop" command or
8427 any other command that uses the tagstack will use the unmodified
8428 tagstack, but does change the pointer to the active entry.
8429 Resetting this option is useful when using a ":tag" command in a
8430 mapping which should not change the tagstack.
8431
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008432 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008433'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008434 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008435 {only available when compiled with the |+tcl/dyn|
8436 feature}
8437 Specifies the name of the Tcl shared library. The default is
8438 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008439 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008440 This option cannot be set from a |modeline| or in the |sandbox|, for
8441 security reasons.
8442
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 *'term'* *E529* *E530* *E531*
8444'term' string (default is $TERM, if that fails:
8445 in the GUI: "builtin_gui"
8446 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008447 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 on Unix: "ansi"
8450 on VMS: "ansi"
8451 on Win 32: "win32")
8452 global
8453 Name of the terminal. Used for choosing the terminal control
8454 characters. Environment variables are expanded |:set_env|.
8455 For example: >
8456 :set term=$TERM
8457< See |termcap|.
8458
8459 *'termbidi'* *'tbidi'*
8460 *'notermbidi'* *'notbidi'*
8461'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 {only available when compiled with the |+arabic|
8464 feature}
8465 The terminal is in charge of Bi-directionality of text (as specified
8466 by Unicode). The terminal is also expected to do the required shaping
8467 that some languages (such as Arabic) require.
8468 Setting this option implies that 'rightleft' will not be set when
8469 'arabic' is set and the value of 'arabicshape' will be ignored.
8470 Note that setting 'termbidi' has the immediate effect that
8471 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8472 This option is reset when the GUI is started.
8473 For further details see |arabic.txt|.
8474
8475 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008476'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 Encoding used for the terminal. This specifies what character
8479 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008480 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008481 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008482 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008483 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8485 Any attempts to set a different value will be rejected, and an error
8486 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008487 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 because the Win32 system always passes Unicode characters.
8489 When empty, the same encoding is used as for the 'encoding' option.
8490 This is the normal value.
8491 Not all combinations for 'termencoding' and 'encoding' are valid. See
8492 |encoding-table|.
8493 The value for this option must be supported by internal conversions or
8494 iconv(). When this is not possible no conversion will be done and you
8495 will probably experience problems with non-ASCII characters.
8496 Example: You are working with the locale set to euc-jp (Japanese) and
8497 want to edit a UTF-8 file: >
8498 :let &termencoding = &encoding
8499 :set encoding=utf-8
8500< You need to do this when your system has no locale support for UTF-8.
8501
Bram Moolenaar938ae282023-02-20 20:44:55 +00008502 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008503'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8504 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008505 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008506 {not available when compiled without the
8507 |+termguicolors| feature}
8508 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008509 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008510
Christian Brabandt279dd702025-01-26 10:49:59 +01008511 Will automatically be enabled, if Vim detects that it runs in a
8512 capable terminal (when the terminal supports the RGB terminfo
8513 capability or when the number of colors |t_Co| supported by the
Christian Brabandtd7f58542025-01-31 16:13:14 +01008514 terminal is 0x1000000, e.g. with $TERM=xterm-direct). Due to the async
8515 nature of querying the terminal, enabling this automatically is
8516 noticable. Use >
8517 set notermguicolors
8518< to explicitly disable.
Christian Brabandt279dd702025-01-26 10:49:59 +01008519
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008520 Requires a ISO-8613-3 compatible terminal. If setting this option
8521 does not work (produces a colorless UI) reading |xterm-true-color|
8522 might help.
8523
8524 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8525 is required. Use this check to find out: >
8526 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008527< This requires Vim to be built with the |+vtp| feature.
8528
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008529 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008530
8531 When using Vim with Windows Terminal, the background of Windows
8532 Terminal is normally filled with the Vim background color. Setting
8533 'termguicolors' and the guibg of the Normal highlight group to NONE
8534 will make the background transparent: >
8535 :hi Normal guibg=NONE
8536<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008537 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008538
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008539 *'termwinkey'* *'twk'*
8540'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008541 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008542 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008543 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008544 The key can be specified as a single character, a |key-notation| (e.g.
8545 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8546 :set twk=X
8547 :set twk=^I
8548 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008549< The string must be one key stroke but can be multiple bytes.
8550 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008551 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008552 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008553
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008554 *'termwinscroll'* *'twsl'*
8555'termwinscroll' 'twsl' number (default 10000)
8556 local to buffer
8557 {not available when compiled without the
8558 |+terminal| feature}
8559 Number of scrollback lines to keep. When going over this limit the
8560 first 10% of the scrollback lines are deleted. This is just to reduce
8561 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008562 Also used as a limit for text sent to the terminal in one write,
8563 multiplied by the number of columns times 3 (average number of bytes
8564 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008565
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008566 *'termwinsize'* *'tws'*
8567'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008568 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008569 Size used when opening the |terminal| window. Format:
8570 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008571 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008572 - When set with a "x" (e.g., "24x80") the terminal size is not
8573 adjusted to the window size. If the window is smaller only the
8574 top-left part is displayed.
8575 - When set with a "*" (e.g., "10*50") the terminal size follows the
8576 window size, but will not be smaller than the specified rows and/or
8577 columns.
8578 - When rows is zero then use the height of the window.
8579 - When columns is zero then use the width of the window.
8580 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008581 - Can be overruled in the |term_start()| options with "term_rows" and
8582 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008583
8584 Examples:
8585 "30x0" uses 30 rows and the current window width.
8586 "20*0" uses at least 20 rows and the current window width.
8587 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008588 Note that the command running in the terminal window may still change
8589 the size of the terminal. In that case the Vim window will be
8590 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008591
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008592 *'termwintype'* *'twt'*
8593'termwintype' 'twt' string (default "")
8594 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008595 {only available when compiled with the |terminal|
8596 feature on MS-Windows}
8597 Specify the virtual console (pty) used when opening the terminal
8598 window.
8599
8600 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008601 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008602 "winpty" use winpty, fail if not supported
8603 "conpty" use |ConPTY|, fail if not supported
8604
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008605 |ConPTY| support depends on the platform. Windows 10 October 2018
8606 Update is the first version that supports ConPTY, however it is still
8607 considered unstable. ConPTY might become stable in the next release
8608 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008609 supported then you cannot open a terminal window.
8610
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 *'terse'* *'noterse'*
8612'terse' boolean (default off)
8613 global
8614 When set: Add 's' flag to 'shortmess' option (this makes the message
8615 for a search that hits the start or end of the file not being
8616 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8617 shortens a lot of messages}
8618
8619 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8620'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 This option is obsolete. Use 'fileformats'.
8623 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8624 set to the default value for the current system. When 'textauto' is
8625 reset, 'fileformats' is made empty.
8626 NOTE: This option is set to the Vi default value when 'compatible' is
8627 set and to the Vim default value when 'compatible' is reset.
8628
8629 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008630'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 others: default off)
8632 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 This option is obsolete. Use 'fileformat'.
8634 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8635 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8636 "unix".
8637
8638 *'textwidth'* *'tw'*
8639'textwidth' 'tw' number (default 0)
8640 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 Maximum width of text that is being inserted. A longer line will be
8642 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008643 this.
8644 'textwidth' is set to 0 when the 'paste' option is set and restored
8645 when 'paste' is reset.
8646 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008648 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 NOTE: This option is set to 0 when 'compatible' is set.
8650
8651 *'thesaurus'* *'tsr'*
8652'thesaurus' 'tsr' string (default "")
8653 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008655 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8656 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008657
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008658 This option is not used if 'thesaurusfunc' is set, either for the
8659 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008660
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008661 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008663 name. See |option-backslash| about using backslashes. The use of
8664 |:set+=| and |:set-=| is preferred when adding or removing directories
8665 from the list. This avoids problems when a future version uses
8666 another default. Backticks cannot be used in this option for security
8667 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008669 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008670'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008671 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008672 {not available when compiled without the |+eval|
8673 feature}
8674 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008675 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008676 The value can be the name of a function, a |lambda| or a |Funcref|.
8677 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008678
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008679 This option cannot be set from a |modeline| or in the |sandbox|, for
8680 security reasons.
8681
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8683'tildeop' 'top' boolean (default off)
8684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 When on: The tilde command "~" behaves like an operator.
8686 NOTE: This option is reset when 'compatible' is set.
8687
8688 *'timeout'* *'to'* *'notimeout'* *'noto'*
8689'timeout' 'to' boolean (default on)
8690 global
laburnumT3f7855a2023-12-05 18:37:03 +01008691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008693'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 These two options together determine the behavior when part of a
8696 mapped key sequence or keyboard code has been received:
8697
8698 'timeout' 'ttimeout' action ~
8699 off off do not time out
8700 on on or off time out on :mappings and key codes
8701 off on time out on key codes
8702
8703 If both options are off, Vim will wait until either the complete
8704 mapping or key sequence has been received, or it is clear that there
8705 is no mapping or key sequence for the received characters. For
8706 example: if you have mapped "vl" and Vim has received 'v', the next
8707 character is needed to see if the 'v' is followed by an 'l'.
8708 When one of the options is on, Vim will wait for about 1 second for
8709 the next character to arrive. After that the already received
8710 characters are interpreted as single characters. The waiting time can
8711 be changed with the 'timeoutlen' option.
8712 On slow terminals or very busy systems timing out may cause
8713 malfunctioning cursor keys. If both options are off, Vim waits
8714 forever after an entered <Esc> if there are key codes that start
8715 with <Esc>. You will have to type <Esc> twice. If you do not have
8716 problems with key codes, but would like to have :mapped key
8717 sequences not timing out in 1 second, set the 'ttimeout' option and
8718 reset the 'timeout' option.
8719
8720 NOTE: 'ttimeout' is reset when 'compatible' is set.
8721
8722 *'timeoutlen'* *'tm'*
8723'timeoutlen' 'tm' number (default 1000)
8724 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008725
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008727'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 The time in milliseconds that is waited for a key code or mapped key
8730 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8731 when part of a command has been typed.
8732 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8733 different timeout value for key codes is desired set 'ttimeoutlen' to
8734 a non-negative number.
8735
8736 ttimeoutlen mapping delay key code delay ~
8737 < 0 'timeoutlen' 'timeoutlen'
8738 >= 0 'timeoutlen' 'ttimeoutlen'
8739
8740 The timeout only happens when the 'timeout' and 'ttimeout' options
8741 tell so. A useful setting would be >
8742 :set timeout timeoutlen=3000 ttimeoutlen=100
8743< (time out on mapping after three seconds, time out on key codes after
8744 a tenth of a second).
8745
8746 *'title'* *'notitle'*
8747'title' boolean (default off, on when title can be restored)
8748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 When on, the title of the window will be set to the value of
8750 'titlestring' (if it is not empty), or to:
8751 filename [+=-] (path) - VIM
8752 Where:
8753 filename the name of the file being edited
8754 - indicates the file cannot be modified, 'ma' off
8755 + indicates the file was modified
8756 = indicates the file is read-only
8757 =+ indicates the file is read-only and modified
8758 (path) is the path of the file being edited
8759 - VIM the server name |v:servername| or "VIM"
8760 Only works if the terminal supports setting window titles
8761 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008762 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8764 *X11*
8765 When Vim was compiled with HAVE_X11 defined, the original title will
8766 be restored if possible. The output of ":version" will include "+X11"
8767 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8768 works for the icon name |'icon'|.
8769 But: When Vim was started with the |-X| argument, restoring the title
8770 will not work (except in the GUI).
8771 If the title cannot be restored, it is set to the value of 'titleold'.
8772 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008773 When using an xterm from a remote machine you can use this command: >
8774
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008776 ssh -X machine_name xterm &
8777<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 then the WINDOWID environment variable should be inherited and the
8779 title of the window should change back to what it should be after
8780 exiting Vim.
8781
8782 *'titlelen'*
8783'titlelen' number (default 85)
8784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008786 title. When the title is longer, only the end of the path name is
8787 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 Using a percentage makes this adapt to the width of the window. But
8789 it won't work perfectly, because the actual number of characters
8790 available also depends on the font used and other things in the title
8791 bar. When 'titlelen' is zero the full path is used. Otherwise,
8792 values from 1 to 30000 percent can be used.
8793 'titlelen' is also used for the 'titlestring' option.
8794
8795 *'titleold'*
8796'titleold' string (default "Thanks for flying Vim")
8797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 This option will be used for the window title when exiting Vim if the
8799 original title cannot be restored. Only happens if 'title' is on or
8800 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008801 This option cannot be set from a |modeline| or in the |sandbox|, for
8802 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 *'titlestring'*
8804'titlestring' string (default "")
8805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 When this option is not empty, it will be used for the title of the
8807 window. This happens only when the 'title' option is on.
8808 Only works if the terminal supports setting window titles (currently
8809 Amiga console, Win32 console, all GUI versions and terminals with a
8810 non-empty 't_ts' option).
8811 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008812 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008813
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008815 expanded according to the rules used for 'statusline'. If it contains
8816 an invalid '%' format, the value is used as-is and no error or warning
8817 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008818 This option cannot be set in a modeline when 'modelineexpr' is off.
8819
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008821 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8823< The value of 'titlelen' is used to align items in the middle or right
8824 of the available space.
8825 Some people prefer to have the file name first: >
8826 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8827< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008828 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 separating space only when needed.
8830 NOTE: Use of special characters in 'titlestring' may cause the display
8831 to be garbled (e.g., when it contains a CR or NL character).
8832 {not available when compiled without the |+statusline| feature}
8833
8834 *'toolbar'* *'tb'*
8835'toolbar' 'tb' string (default "icons,tooltips")
8836 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008837 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008838 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 possible values are:
8840 icons Toolbar buttons are shown with icons.
8841 text Toolbar buttons shown with text.
8842 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008843 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 tooltips Tooltips are active for toolbar buttons.
8845 Tooltips refer to the popup help text which appears after the mouse
8846 cursor is placed over a toolbar button for a brief moment.
8847
8848 If you want the toolbar to be shown with icons as well as text, do the
8849 following: >
8850 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008851< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 will show icons if both are requested.
8853
8854 If none of the strings specified in 'toolbar' are valid or if
8855 'toolbar' is empty, this option is ignored. If you want to disable
8856 the toolbar, you need to set the 'guioptions' option. For example: >
8857 :set guioptions-=T
8858< Also see |gui-toolbar|.
8859
8860 *'toolbariconsize'* *'tbis'*
8861'toolbariconsize' 'tbis' string (default "small")
8862 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008863 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008865 tiny Use tiny icons.
8866 small Use small icons (default).
8867 medium Use medium-sized icons.
8868 large Use large icons.
8869 huge Use even larger icons.
8870 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008872 the current theme. Common dimensions are giant=48x48, huge=32x32,
8873 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874
8875 If 'toolbariconsize' is empty, the global default size as determined
8876 by user preferences or the current theme is used.
8877
8878 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8879'ttybuiltin' 'tbi' boolean (default on)
8880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 When on, the builtin termcaps are searched before the external ones.
8882 When off the builtin termcaps are searched after the external ones.
8883 When this option is changed, you should set the 'term' option next for
8884 the change to take effect, for example: >
8885 :set notbi term=$TERM
8886< See also |termcap|.
8887 Rationale: The default for this option is "on", because the builtin
8888 termcap entries are generally better (many systems contain faulty
8889 xterm entries...).
8890
8891 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008892'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 Indicates a fast terminal connection. More characters will be sent to
8895 the screen for redrawing, instead of using insert/delete line
8896 commands. Improves smoothness of redrawing when there are multiple
8897 windows and the terminal does not support a scrolling region.
8898 Also enables the extra writing of characters at the end of each screen
8899 line for lines that wrap. This helps when using copy/paste with the
8900 mouse in an xterm and other terminals.
8901
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008902 The default used to be set only for some terminal names, but these
8903 days nearly all terminals are fast, therefore the default is now "on".
8904 If you have a slow connection you may want to set this option off,
8905 e.g. depending on the host name: >
8906 if hostname() =~ 'faraway'
8907 set nottyfast
8908 endif
8909<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 *'ttymouse'* *'ttym'*
8911'ttymouse' 'ttym' string (default depends on 'term')
8912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 {only in Unix and VMS, doesn't work in the GUI; not
8914 available when compiled without |+mouse|}
8915 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008916 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 *xterm-mouse*
8918 xterm xterm-like mouse handling. The mouse generates
8919 "<Esc>[Mscr", where "scr" is three bytes:
8920 "s" = button state
8921 "c" = column plus 33
8922 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008923 This only works up to 223 columns! See "dec",
8924 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 xterm2 Works like "xterm", but with the xterm reporting the
8926 mouse position while the mouse is dragged. This works
8927 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008928 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 work. See below for how Vim detects this
8930 automatically.
8931 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008932 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008934 for the row and column. No other mouse events are
8935 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 *dec-mouse*
8937 dec DEC terminal mouse handling. The mouse generates a
8938 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008939 This is also available for an Xterm, if it was
8940 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 *jsbterm-mouse*
8942 jsbterm JSB term mouse handling.
8943 *pterm-mouse*
8944 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008945 *urxvt-mouse*
8946 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008947 The mouse works only if the terminal supports this
8948 encoding style, but it does not have 223 columns limit
8949 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008950 *sgr-mouse*
8951 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008952 mouse reporting. The mouse works even in columns
8953 beyond 223. This option is backward compatible with
8954 "xterm2" because it can also decode "xterm2" style
8955 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956
8957 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008958 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8959 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8961 recognized, if enabled at compile time. DEC terminal mouse codes
8962 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008963 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8964 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008966 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8967 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8968 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008969 If the terminfo/termcap entry "XM" exists and the first number is
8970 "1006" then 'ttymouse' will be set to "sgr". This works for many
8971 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008972 Additionally, if vim is compiled with the |+termresponse| feature and
8973 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008974 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008976 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8977 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8978 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008979 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8980 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 :set t_RV=
8982<
8983 *'ttyscroll'* *'tsl'*
8984'ttyscroll' 'tsl' number (default 999)
8985 global
8986 Maximum number of lines to scroll the screen. If there are more lines
8987 to scroll the window is redrawn. For terminals where scrolling is
8988 very slow and redrawing is not slow this can be set to a small number,
8989 e.g., 3, to speed up displaying.
8990
8991 *'ttytype'* *'tty'*
8992'ttytype' 'tty' string (default from $TERM)
8993 global
8994 Alias for 'term', see above.
8995
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008996 *'undodir'* *'udir'*
8997'undodir' 'udir' string (default ".")
8998 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008999 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009000 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009001 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009002 "." means using the directory of the file. The undo file name for
9003 "file.txt" is ".file.txt.un~".
9004 For other directories the file name is the full path of the edited
9005 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009006 When writing: The first directory that exists is used. "." always
9007 works, no directories after "." will be used for writing.
9008 When reading all entries are tried to find an undo file. The first
9009 undo file that exists is used. When it cannot be read an error is
9010 given, no further entry is used.
9011 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009012 This option cannot be set from a |modeline| or in the |sandbox|, for
9013 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009014
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009015 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009016'undofile' 'udf' boolean (default off)
9017 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009018 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009019 When on, Vim automatically saves undo history to an undo file when
9020 writing a buffer to a file, and restores undo history from the same
9021 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009022 The directory where the undo file is stored is specified by 'undodir'.
9023 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009024 The undo file is not read when 'undoreload' causes the buffer from
9025 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009026 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009027 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009028
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009030'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009031 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009033 is kept in memory, higher numbers will cause more memory to be used.
9034 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009035 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9036 itself: >
9037 set ul=0
9038< But you can also get Vi compatibility by including the 'u' flag in
9039 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009040 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009041 Set to -1 for no undo at all. You might want to do this only for the
9042 current buffer: >
9043 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009045
9046 The local value is set to -123456 when the global value is to be used.
9047
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009048 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009049
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009050 *'undoreload'* *'ur'*
9051'undoreload' 'ur' number (default 10000)
9052 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009053 Save the whole buffer for undo when reloading it. This applies to the
9054 ":e!" command and reloading for when the buffer changed outside of
9055 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009056 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009057 of lines is smaller than the value of this option.
9058 Set this option to zero to disable undo for a reload.
9059
9060 When saving undo for a reload, any undo file is not read.
9061
9062 Note that this causes the whole buffer to be stored in memory. Set
9063 this option to a lower value if you run out of memory.
9064
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 *'updatecount'* *'uc'*
9066'updatecount' 'uc' number (default: 200)
9067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 After typing this many characters the swap file will be written to
9069 disk. When zero, no swap file will be created at all (see chapter on
9070 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9071 Vim with the "-n" option, see |startup|. When editing in readonly
9072 mode this option will be initialized to 10000.
9073 The swapfile can be disabled per buffer with |'swapfile'|.
9074 When 'updatecount' is set from zero to non-zero, swap files are
9075 created for all buffers that have 'swapfile' set. When 'updatecount'
9076 is set to zero, existing swap files are not deleted.
9077 Also see |'swapsync'|.
9078 This option has no meaning in buffers where |'buftype'| is "nofile"
9079 or "nowrite".
9080
9081 *'updatetime'* *'ut'*
9082'updatetime' 'ut' number (default 4000)
9083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 If this many milliseconds nothing is typed the swap file will be
9085 written to disk (see |crash-recovery|). Also used for the
9086 |CursorHold| autocommand event.
9087
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009088 *'varsofttabstop'* *'vsts'*
9089'varsofttabstop' 'vsts' string (default "")
9090 local to buffer
9091 {only available when compiled with the |+vartabs|
9092 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009093 A list of the number of spaces that a <Tab> counts for while editing,
9094 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9095 width <Tab>s are being inserted, while in fact a mixture of spaces
9096 and <Tab>s is used. Tab widths are separated with commas, with the
9097 final value applying to all subsequent tabs.
9098
9099 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009100 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009101 to use the following: >
9102 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009103< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9104 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009105
9106 Note that the value of |'softtabstop'| will be ignored while
9107 'varsofttabstop' is set.
9108
9109 *'vartabstop'* *'vts'*
9110'vartabstop' 'vts' string (default "")
9111 local to buffer
9112 {only available when compiled with the |+vartabs|
9113 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009114 A list of the number of spaces that a <Tab> in the file counts for,
9115 separated by commas. Each value corresponds to one tab, with the
9116 final value applying to all subsequent tabs. For example: >
9117 :set vartabstop=4,20,10,8
9118< This will make the first tab 4 spaces wide, the second 20 spaces,
9119 the third 10 spaces, and all following tabs 8 spaces.
9120
9121 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9122 is set.
9123
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 *'verbose'* *'vbs'*
9125'verbose' 'vbs' number (default 0)
9126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 When bigger than zero, Vim will give messages about what it is doing.
9128 Currently, these messages are given:
9129 >= 1 When the viminfo file is read or written.
9130 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009131 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009132 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 >= 8 Files for which a group of autocommands is executed.
9134 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009135 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136 >= 12 Every executed function.
9137 >= 13 When an exception is thrown, caught, finished, or discarded.
9138 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009139 >= 15 Every executed Ex command from a script (truncated at 200
9140 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009141 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142
9143 This option can also be set with the "-V" argument. See |-V|.
9144 This option is also set by the |:verbose| command.
9145
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009146 When the 'verbosefile' option is set then the verbose messages are not
9147 displayed.
9148
9149 *'verbosefile'* *'vfile'*
9150'verbosefile' 'vfile' string (default empty)
9151 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009152 When not empty all messages are written in a file with this name.
9153 When the file exists messages are appended.
9154 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009155 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009156 Setting 'verbosefile' to a new value is like making it empty first.
9157 The difference with |:redir| is that verbose messages are not
9158 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009159 This option cannot be set from a |modeline| or in the |sandbox|, for
9160 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009161
Bram Moolenaar071d4272004-06-13 20:20:40 +00009162 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009163'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009164 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009165 for Unix: "$HOME/.vim/view" or
9166 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009167 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009168 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009169 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 feature}
9171 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009172 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 This option cannot be set from a |modeline| or in the |sandbox|, for
9174 security reasons.
9175
9176 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009177'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009179 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009181 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009182 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 word save and restore ~
9184 cursor cursor position in file and in window
9185 folds manually created folds, opened/closed folds and local
9186 fold options
9187 options options and mappings local to a window or buffer (not
9188 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009189 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009190 slash backslashes in file names replaced with forward
9191 slashes
9192 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009193 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009194 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009196 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009198 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199
9200 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009201'viminfo' 'vi' string (Vi default: "", Vim default for
9202 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009203 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9204 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009206 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 feature}
9208 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009209 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9210 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009211 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009212 consisting of a single character identifying the particular parameter,
9213 followed by a number or string which specifies the value of that
9214 parameter. If a particular character is left out, then the default
9215 value is used for that parameter. The following is a list of the
9216 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009217 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009218 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 ! When included, save and restore global variables that start
9220 with an uppercase letter, and don't contain a lowercase
9221 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009222 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009223 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009224 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 " Maximum number of lines saved for each register. Old name of
9226 the '<' item, with the disadvantage that you need to put a
9227 backslash before the ", otherwise it will be recognized as the
9228 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009229 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 % When included, save and restore the buffer list. If Vim is
9231 started with a file name argument, the buffer list is not
9232 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009233 buffer list is restored from the viminfo file. Quickfix
9234 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9235 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009236 When followed by a number, the number specifies the maximum
9237 number of buffers that are stored. Without a number all
9238 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009239 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 ' Maximum number of previously edited files for which the marks
9241 are remembered. This parameter must always be included when
9242 'viminfo' is non-empty.
9243 Including this item also means that the |jumplist| and the
9244 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009245 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009247 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 patterns are also saved. When not included, the value of
9249 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009250 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009252 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009253 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254 < Maximum number of lines saved for each register. If zero then
9255 registers are not saved. When not included, all lines are
9256 saved. '"' is the old name for this item.
9257 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009258 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009260 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009261 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 c When included, convert the text in the viminfo file from the
9263 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009264 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009265 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009266 f Whether file marks need to be stored. If zero, file marks ('0
9267 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009268 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009270 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 h Disable the effect of 'hlsearch' when loading the viminfo
9272 file. When not included, it depends on whether ":nohlsearch"
9273 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009274 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009276 the 'n'. Must be at the end of the option! If the
9277 'viminfofile' option is set, that file name overrides the one
9278 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009279 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009280 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 r Removable media. The argument is a string (up to the next
9282 ','). This parameter can be given several times. Each
9283 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009284 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9286 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9287 ignored. Maximum length of each 'r' argument is 50
9288 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009289 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290 s Maximum size of an item in Kbyte. If zero then registers are
9291 not saved. Currently only applies to registers. The default
9292 "s10" will exclude registers with more than 10 Kbyte of text.
9293 Also see the '<' item above: line count limit.
9294
9295 Example: >
9296 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9297<
9298 '50 Marks will be remembered for the last 50 files you
9299 edited.
9300 <1000 Contents of registers (up to 1000 lines each) will be
9301 remembered.
9302 s100 Registers with more than 100 Kbyte text are skipped.
9303 :0 Command-line history will not be saved.
9304 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9305 no / Since '/' is not specified, the default will be used,
9306 that is, save all of the search history, and also the
9307 previous search and substitute patterns.
9308 no % The buffer list will not be saved nor read back.
9309 no h 'hlsearch' highlighting will be restored.
9310
9311 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9312 load the contents of the file, this is not done automatically.
9313
9314 This option cannot be set from a |modeline| or in the |sandbox|, for
9315 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009316 NOTE: This option is set to the Vim default value when 'compatible'
9317 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009319 *'viminfofile'* *'vif'*
9320'viminfofile' 'vif' string (default: "")
9321 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009322 {not available when compiled without the |+viminfo|
9323 feature}
9324 When non-empty, overrides the file name used for viminfo.
9325 When equal to "NONE" no viminfo file will be read or written.
9326 This option can be set with the |-i| command line flag. The |--clean|
9327 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009328 This option cannot be set from a |modeline| or in the |sandbox|, for
9329 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009330
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 *'virtualedit'* *'ve'*
9332'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009333 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009334 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009335 block Allow virtual editing in Visual block mode.
9336 insert Allow virtual editing in Insert mode.
9337 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009338 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009339 none When used as the local value, do not allow virtual
9340 editing even when the global value is set. When used
9341 as the global value, "none" is the same as "".
9342 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009343
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009345 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346 of the line. Useful for selecting a rectangle in Visual mode and
9347 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009348 "onemore" is not the same, it will only allow moving the cursor just
9349 after the last character of the line. This makes some commands more
9350 consistent. Previously the cursor was always past the end of the line
9351 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009352 break some plugins or Vim scripts. For example because |l| can move
9353 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009354 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009355 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009356 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009357 It doesn't make sense to combine "all" with "onemore", but you will
9358 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009359 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009360 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361
9362 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9363'visualbell' 'vb' boolean (default off)
9364 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009365 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009367 use: >
9368 :set vb t_vb=
9369< If you want a short flash, you can use this on many terminals: >
9370 :set vb t_vb=[?5h$<100>[?5l
9371< Here $<100> specifies the time, you can use a smaller or bigger value
9372 to get a shorter or longer flash.
9373
9374 Note: Vim will limit the bell to once per half a second. This avoids
9375 having to wait for the flashing to finish when there are lots of
9376 bells, e.g. on key repeat. This also happens without 'visualbell'
9377 set.
9378
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9380 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9381 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009382
9383 Note: When the GUI starts, 't_vb' is reset to its default value. You
9384 might want to set it again in your |gvimrc|.
9385
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386 Does not work on the Amiga, you always get a screen flash.
9387 Also see 'errorbells'.
9388
9389 *'warn'* *'nowarn'*
9390'warn' boolean (default on)
9391 global
9392 Give a warning message when a shell command is used while the buffer
9393 has been changed.
9394
9395 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9396'weirdinvert' 'wiv' boolean (default off)
9397 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009398 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399 It is provided for backwards compatibility with version 4.x.
9400 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9401 vice versa. Has no effect when the GUI is running.
9402
9403 *'whichwrap'* *'ww'*
9404'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009406 Allow specified keys that move the cursor left/right to move to the
9407 previous/next line when the cursor is on the first/last character in
9408 the line. Concatenate characters to allow this for these keys:
9409 char key mode ~
9410 b <BS> Normal and Visual
9411 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009412 h "h" Normal and Visual (not recommended)
9413 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009414 < <Left> Normal and Visual
9415 > <Right> Normal and Visual
9416 ~ "~" Normal
9417 [ <Left> Insert and Replace
9418 ] <Right> Insert and Replace
9419 For example: >
9420 :set ww=<,>,[,]
9421< allows wrap only when cursor keys are used.
9422 When the movement keys are used in combination with a delete or change
9423 operator, the <EOL> also counts for a character. This makes "3h"
9424 different from "3dh" when the cursor crosses the end of a line. This
9425 is also true for "x" and "X", because they do the same as "dl" and
9426 "dh". If you use this, you may also want to use the mapping
9427 ":map <BS> X" to make backspace delete the character in front of the
9428 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009429 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009430 line (not an empty line) then it will not move to the next line. This
9431 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009432 NOTE: This option is set to the Vi default value when 'compatible' is
9433 set and to the Vim default value when 'compatible' is reset.
9434
9435 *'wildchar'* *'wc'*
9436'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009438 Character you have to type to start wildcard expansion in the
9439 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009440 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009441 The character is not recognized when used inside a macro. See
9442 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009443 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009444 <Esc> can be used, but hitting it twice in a row will still exit
9445 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009446 Although 'wc' is a number option, it can be specified as a number, a
9447 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9448 preceded with a caret (e.g. `^F` is CTRL-F): >
9449 :set wc=27
9450 :set wc=X
9451 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009452 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009453< NOTE: This option is set to the Vi default value when 'compatible' is
9454 set and to the Vim default value when 'compatible' is reset.
9455
9456 *'wildcharm'* *'wcm'*
9457'wildcharm' 'wcm' number (default: none (0))
9458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009459 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009460 recognized when used inside a macro. You can find "spare" command-line
9461 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009462 you'll never actually type 'wildcharm', just use it in mappings that
9463 automatically invoke completion mode, e.g.: >
9464 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009465 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466< Then after typing :ss you can use CTRL-P & CTRL-N.
9467
9468 *'wildignore'* *'wig'*
9469'wildignore' 'wig' string (default "")
9470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009471 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009472 patterns is ignored when expanding |wildcards|, completing file or
9473 directory names, and influences the result of |expand()|, |glob()| and
9474 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009475 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9476 Also see 'suffixes'.
9477 Example: >
9478 :set wildignore=*.o,*.obj
9479< The use of |:set+=| and |:set-=| is preferred when adding or removing
9480 a pattern from the list. This avoids problems when a future version
9481 uses another default.
9482
h_east596a9f22023-11-21 21:24:23 +09009483 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009484'wildignorecase' 'wic' boolean (default off)
9485 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009486 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009487 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009488 Does not apply when the shell is used to expand wildcards, which
9489 happens when there are special characters.
9490
Bram Moolenaar071d4272004-06-13 20:20:40 +00009491 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009492'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009494 When 'wildmenu' is on, command-line completion operates in an enhanced
9495 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009496 the possible matches are shown.
9497 When 'wildoptions' contains "pum", then the completion matches are
9498 shown in a popup menu. Otherwise they are displayed just above the
9499 command line, with the first match highlighted (overwriting the status
9500 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009501 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009502 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9503 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9504 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009505 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009506 If there are more matches than can fit in the line, a ">" is shown on
9507 the right and/or a "<" is shown on the left. The status line scrolls
9508 as needed.
9509 The "wildmenu" mode is abandoned when a key is hit that is not used
9510 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009511 While the "wildmenu" is active, the following keys have special
9512 meanings:
9513 CTRL-P - go to the previous entry
9514 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009515 <CR> - in menu completion, when the cursor is just after a
9516 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009517 CTRL-E - end completion, go back to what was there before
9518 selecting a match.
9519 CTRL-Y - accept the currently selected match and stop
9520 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009521
9522 When not using the popup menu for command line completion, the
9523 following keys have special meanings:
9524 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009525 <Up> - in filename/menu name completion: move up into
9526 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009527 <Down> - in filename/menu name completion: move into a
9528 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009529
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009530 When using the popup menu for command line completion, the following
9531 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009532 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009533 <PageUp> - select a match several entries back
9534 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009535 <Left> - in filename/menu name completion: move up into
9536 parent directory or parent menu.
9537 <Right> - in filename/menu name completion: move into a
9538 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009539
Bram Moolenaar071d4272004-06-13 20:20:40 +00009540 This makes the menus accessible from the console |console-menus|.
9541
9542 If you prefer the <Left> and <Right> keys to move the cursor instead
9543 of selecting a different match, use this: >
9544 :cnoremap <Left> <Space><BS><Left>
9545 :cnoremap <Right> <Space><BS><Right>
9546<
9547 The "WildMenu" highlighting is used for displaying the current match
9548 |hl-WildMenu|.
9549
9550 *'wildmode'* *'wim'*
9551'wildmode' 'wim' string (Vim default: "full")
9552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009553 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009554 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009555 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009556 first part specifies the behavior for the first use of 'wildchar',
9557 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009558
9559 Each part consists of a colon separated list consisting of the
9560 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009561 "" Complete only the first match.
9562 "full" Complete the next full match. After the last match,
9563 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009564 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565 "longest" Complete till longest common string. If this doesn't
9566 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009567 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009568 "lastused" When completing buffer names and more than one buffer
9569 matches, sort buffers by time last used (other than
9570 the current buffer).
9571 When there is only a single match, it is fully completed in all cases.
9572
9573 Examples of useful colon-separated values:
9574 "longest:full" Like "longest", but also start 'wildmenu' if it is
9575 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 "list:full" When more than one match, list all matches and
9577 complete first match.
9578 "list:longest" When more than one match, list all matches and
9579 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009580 "list:lastused" When more than one buffer matches, list all matches
9581 and sort buffers by time last used (other than the
9582 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009583
9584 Examples: >
9585 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009586< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009587 :set wildmode=longest,full
9588< Complete longest common string, then each full match >
9589 :set wildmode=list:full
9590< List all matches and complete each full match >
9591 :set wildmode=list,full
9592< List all matches without completing, then each full match >
9593 :set wildmode=longest,list
9594< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009595 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009596
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009597 *'wildoptions'* *'wop'*
9598'wildoptions' 'wop' string (default "")
9599 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009600 A list of words that change how |cmdline-completion| is done.
9601 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009602 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009603 this value is specified, wildcard expansion will not
9604 be used for completion. The matches will be sorted by
9605 the "best match" rather than alphabetically sorted.
9606 This will find more matches than the wildcard
9607 expansion. Currently fuzzy matching based completion
9608 is not supported for file and directory names and
9609 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009610 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009611 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009612 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009613 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009614 is displayed per line. Often used tag kinds are:
9615 d #define
9616 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009617
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 *'winaltkeys'* *'wak'*
9619'winaltkeys' 'wak' string (default "menu")
9620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009621 {only used in Win32, Motif, GTK and Photon GUI}
9622 Some GUI versions allow the access to menu entries by using the ALT
9623 key in combination with a character that appears underlined in the
9624 menu. This conflicts with the use of the ALT key for mappings and
9625 entering special characters. This option tells what to do:
9626 no Don't use ALT keys for menus. ALT key combinations can be
9627 mapped, but there is no automatic handling. This can then be
9628 done with the |:simalt| command.
9629 yes ALT key handling is done by the windowing system. ALT key
9630 combinations cannot be mapped.
9631 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009632 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009633 keys can be mapped.
9634 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9635 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009636 This option is not used for <F10>; on Win32 and with GTK <F10> will
9637 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009639 *'wincolor'* *'wcr'*
9640'wincolor' 'wcr' string (default empty)
9641 local to window
9642 Highlight group name to use for this window instead of the Normal
9643 color |hl-Normal|.
9644
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009645 *'window'* *'wi'*
9646'window' 'wi' number (default screen height - 1)
9647 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009648 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9649 window and the value is smaller than 'lines' minus one. The screen
9650 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009651 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9652 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009653 When resizing the Vim window, and the value is smaller than 1 or more
9654 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009655 Note: Do not confuse this with the height of the Vim window, use
9656 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009657
Colin Kennedy21570352024-03-03 16:16:47 +01009658 *'winfixbuf'*
9659'winfixbuf' 'wfb' boolean (default off)
9660 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009661 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009662 For example, attempting to change the buffer with |:edit| will fail.
9663 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009664 also skip any window with 'winfixbuf' enabled. However if an Ex
9665 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009666
laburnumT3f7855a2023-12-05 18:37:03 +01009667 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9668'winfixheight' 'wfh' boolean (default off)
9669 local to window |local-noglobal|
9670 Keep the window height when windows are opened or closed and
9671 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9672 |preview-window| and |quickfix-window|.
9673 The height may be changed anyway when running out of room.
9674
9675 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9676'winfixwidth' 'wfw' boolean (default off)
9677 local to window |local-noglobal|
9678 Keep the window width when windows are opened or closed and
9679 'equalalways' is set. Also for |CTRL-W_=|.
9680 The width may be changed anyway when running out of room.
9681
Bram Moolenaar071d4272004-06-13 20:20:40 +00009682 *'winheight'* *'wh'* *E591*
9683'winheight' 'wh' number (default 1)
9684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009685 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009686 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009687 focus goes to a window that is smaller, its size is increased, at the
9688 cost of the height of other windows.
9689 Set 'winheight' to a small number for normal editing.
9690 Set it to 999 to make the current window fill most of the screen.
9691 Other windows will be only 'winminheight' high. This has the drawback
9692 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9693 to create only two windows, set the option after startup is done,
9694 using the |VimEnter| event: >
9695 au VimEnter * set winheight=999
9696< Minimum value is 1.
9697 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009698 height of the current window.
9699 'winheight' applies to the current window. Use 'winminheight' to set
9700 the minimal height for other windows.
9701
Bram Moolenaar071d4272004-06-13 20:20:40 +00009702 *'winminheight'* *'wmh'*
9703'winminheight' 'wmh' number (default 1)
9704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009705 The minimal height of a window, when it's not the current window.
9706 This is a hard minimum, windows will never become smaller.
9707 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9708 status bar) if necessary. They will return to at least one line when
9709 they become active (since the cursor has to have somewhere to go.)
9710 Use 'winheight' to set the minimal height of the current window.
9711 This option is only checked when making a window smaller. Don't use a
9712 large number, it will cause errors when opening more than a few
9713 windows. A value of 0 to 3 is reasonable.
9714
9715 *'winminwidth'* *'wmw'*
9716'winminwidth' 'wmw' number (default 1)
9717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009718 The minimal width of a window, when it's not the current window.
9719 This is a hard minimum, windows will never become smaller.
9720 When set to zero, windows may be "squashed" to zero columns (i.e. just
9721 a vertical separator) if necessary. They will return to at least one
9722 line when they become active (since the cursor has to have somewhere
9723 to go.)
9724 Use 'winwidth' to set the minimal width of the current window.
9725 This option is only checked when making a window smaller. Don't use a
9726 large number, it will cause errors when opening more than a few
9727 windows. A value of 0 to 12 is reasonable.
9728
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009729 *'winptydll'*
9730'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9731 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009732 {only available when compiled with the |terminal|
9733 feature on MS-Windows}
9734 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009735 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009736 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009737 a fallback.
9738 Environment variables are expanded |:set_env|.
9739 This option cannot be set from a |modeline| or in the |sandbox|, for
9740 security reasons.
9741
Bram Moolenaar071d4272004-06-13 20:20:40 +00009742 *'winwidth'* *'wiw'* *E592*
9743'winwidth' 'wiw' number (default 20)
9744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009745 Minimal number of columns for the current window. This is not a hard
9746 minimum, Vim will use fewer columns if there is not enough room. If
9747 the current window is smaller, its size is increased, at the cost of
9748 the width of other windows. Set it to 999 to make the current window
9749 always fill the screen. Set it to a small number for normal editing.
9750 The width is not adjusted after one of the commands to change the
9751 width of the current window.
9752 'winwidth' applies to the current window. Use 'winminwidth' to set
9753 the minimal width for other windows.
9754
9755 *'wrap'* *'nowrap'*
9756'wrap' boolean (default on)
9757 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009758 This option changes how text is displayed. It doesn't change the text
9759 in the buffer, see 'textwidth' for that.
9760 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009761 displaying continues on the next line. When off lines will not wrap
9762 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009763 moved to a part that is not shown, the screen will scroll
9764 horizontally.
9765 The line will be broken in the middle of a word if necessary. See
9766 'linebreak' to get the break at a word boundary.
9767 To make scrolling horizontally a bit more useful, try this: >
9768 :set sidescroll=5
9769 :set listchars+=precedes:<,extends:>
9770< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009771 This option can't be set from a |modeline| when the 'diff' option is
9772 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009773
9774 *'wrapmargin'* *'wm'*
9775'wrapmargin' 'wm' number (default 0)
9776 local to buffer
9777 Number of characters from the right window border where wrapping
9778 starts. When typing text beyond this limit, an <EOL> will be inserted
9779 and inserting continues on the next line.
9780 Options that add a margin, such as 'number' and 'foldcolumn', cause
9781 the text width to be further reduced. This is Vi compatible.
9782 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009783 This option is set to 0 when 'paste' is set and restored when 'paste'
9784 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009785 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009786
9787 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9788'wrapscan' 'ws' boolean (default on) *E384* *E385*
9789 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009790 Searches wrap around the end of the file. Also applies to |]s| and
9791 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009792
9793 *'write'* *'nowrite'*
9794'write' boolean (default on)
9795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009796 Allows writing files. When not set, writing a file is not allowed.
9797 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009798 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009799 argument. Filtering text is still possible, even though this requires
9800 writing a temporary file.
9801
9802 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9803'writeany' 'wa' boolean (default off)
9804 global
9805 Allows writing to any file with no need for "!" override.
9806
9807 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9808'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9809 otherwise)
9810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009811 Make a backup before overwriting a file. The backup is removed after
9812 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009813 also on.
9814 WARNING: Switching this option off means that when Vim fails to write
9815 your buffer correctly and then, for whatever reason, Vim exits, you
9816 lose both the original file and what you were writing. Only reset
9817 this option if your file system is almost full and it makes the write
9818 fail (and make sure not to exit Vim until the write was successful).
9819 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009820 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009821 Depending on 'backupcopy' the backup is a new file or the original
9822 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009823 NOTE: This option is set to the default value when 'compatible' is
9824 set.
9825
9826 *'writedelay'* *'wd'*
9827'writedelay' 'wd' number (default 0)
9828 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009829 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009830 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009831 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009832
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009833 *'xtermcodes'* *'noxtermcodes'*
9834'xtermcodes' boolean (default on)
9835 global
9836 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009837 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009838 key codes and number of colors from the terminal. This takes care of
9839 various configuration options of the terminal that cannot be obtained
9840 from the termlib/terminfo entry, see |xterm-codes|.
9841 A side effect may be that t_Co changes and Vim will redraw the
9842 display.
9843
9844
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009845 vim:tw=78:ts=8:noet:ft=help:norl: