blob: 6c60b5896815b580775963e1c984411d790e556d [file] [log] [blame]
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02001*options.txt* For Vim version 9.1. Last change: 2025 Apr 30
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"
Qiming zhaoab2fe652025-04-12 11:40:17 +0200215 :set tags=tags\\,file results in "tags\,file"
Yee Cheng Chin54844852023-10-09 18:12:31 +0200216 :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
64-bitman88d41ab2025-04-06 17:20:39 +02001720 *'chistory'* *'chi'*
1721'chistory' 'chi' number (default: 10)
1722 global
1723 {only available when compiled with the |+quickfix|
1724 feature}
1725 Number of quickfix lists that should be remembered for the quickfix
1726 stack. Must be between 1 and 100. If the option is set to a value
1727 that is lower than the amount of entries in the quickfix list stack,
1728 entries will be removed starting from the oldest one. If the current
1729 quickfix list was removed, then the quickfix list at top of the stack
1730 (the most recently created) will be used in its place. For additional
1731 info, see |quickfix-stack|.
1732
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1734'cindent' 'cin' boolean (default off)
1735 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001736 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 that trigger reindenting in insert mode and 'cinoptions' to set your
1738 preferred indent style.
1739 If 'indentexpr' is not empty, it overrules 'cindent'.
1740 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1741 the "=" operator indents using this algorithm rather than calling an
1742 external program.
1743 See |C-indenting|.
1744 When you don't like the way 'cindent' works, try the 'smartindent'
1745 option or 'indentexpr'.
1746 This option is not used when 'paste' is set.
1747 NOTE: This option is reset when 'compatible' is set.
1748
1749 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001750'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 A list of keys that, when typed in Insert mode, cause reindenting of
1753 the current line. Only used if 'cindent' is on and 'indentexpr' is
1754 empty.
1755 For the format of this option see |cinkeys-format|.
1756 See |C-indenting|.
1757
1758 *'cinoptions'* *'cino'*
1759'cinoptions' 'cino' string (default "")
1760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1762 program. See |cinoptions-values| for the values of this option, and
1763 |C-indenting| for info on C indenting in general.
1764
laburnumT3f7855a2023-12-05 18:37:03 +01001765 *'cinscopedecls'* *'cinsd'*
1766'cinscopedecls' 'cinsd' string (default "public,protected,private")
1767 local to buffer
1768 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1769 Useful e.g. for working with the Qt framework that defines additional
1770 scope declarations "signals", "public slots" and "private slots": >
1771 set cinscopedecls+=signals,public\ slots,private\ slots
1772<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 *'cinwords'* *'cinw'*
1774'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 These keywords start an extra indent in the next line when
1777 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1778 an appropriate place (inside {}).
1779 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1780 matter, include the keyword both the uppercase and lowercase:
1781 "if,If,IF".
1782
laburnumT3f7855a2023-12-05 18:37:03 +01001783 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1785 for X-windows, "" otherwise)
1786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 {only in GUI versions or when the |+xterm_clipboard|
1788 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001789 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001790 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001791 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001792 prepend, e.g.: >
1793 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001794< When using the GUI see |'go-A'|.
1795 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001797 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 unnamed When included, Vim will use the clipboard register '*'
1799 for all yank, delete, change and put operations which
1800 would normally go to the unnamed register. When a
1801 register is explicitly specified, it will always be
1802 used regardless of whether "unnamed" is in 'clipboard'
1803 or not. The clipboard register can always be
1804 explicitly accessed using the "* notation. Also see
1805 |gui-clipboard|.
1806
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001808 unnamedplus A variant of the "unnamed" flag which uses the
1809 clipboard register '+' (|quoteplus|) instead of
1810 register '*' for all yank, delete, change and put
1811 operations which would normally go to the unnamed
1812 register. When "unnamed" is also included to the
1813 option, yank operations (but not delete, change or
1814 put) will additionally copy the text into register
1815 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001816 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001817 Availability can be checked with: >
1818 if has('unnamedplus')
1819<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001820 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 autoselect Works like the 'a' flag in 'guioptions': If present,
1822 then whenever Visual mode is started, or the Visual
1823 area extended, Vim tries to become the owner of the
1824 windowing system's global selection or put the
1825 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001826 register "*. See |'go-a'| and |quotestar| for details.
1827 When the GUI is active, the 'a' flag in 'guioptions'
1828 is used, when the GUI is not active, this "autoselect"
1829 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 Also applies to the modeless selection.
1831
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001832 *clipboard-autoselectplus*
1833 autoselectplus Like "autoselect" but using the + register instead of
1834 the * register. Compare to the 'P' flag in
1835 'guioptions'.
1836
1837 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 autoselectml Like "autoselect", but for the modeless selection
1839 only. Compare to the 'A' flag in 'guioptions'.
1840
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001841 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001842 html When the clipboard contains HTML, use this when
1843 pasting. When putting text on the clipboard, mark it
1844 as HTML. This works to copy rendered HTML from
1845 Firefox, paste it as raw HTML in Vim, select the HTML
1846 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001847 You probably want to add this only temporarily,
1848 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001849 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001850
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001851 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 exclude:{pattern}
1853 Defines a pattern that is matched against the name of
1854 the terminal 'term'. If there is a match, no
1855 connection will be made to the X server. This is
1856 useful in this situation:
1857 - Running Vim in a console.
1858 - $DISPLAY is set to start applications on another
1859 display.
1860 - You do not want to connect to the X server in the
1861 console, but do want this in a terminal emulator.
1862 To never connect to the X server use: >
1863 exclude:.*
1864< This has the same effect as using the |-X| argument.
1865 Note that when there is no connection to the X server
1866 the window title won't be restored and the clipboard
1867 cannot be accessed.
1868 The value of 'magic' is ignored, {pattern} is
1869 interpreted as if 'magic' was on.
1870 The rest of the option value will be used for
1871 {pattern}, this must be the last entry.
1872
1873 *'cmdheight'* *'ch'*
1874'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001875 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001876 Number of screen lines to use for the command-line. A larger value
1877 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001878 The value of this option is stored with the tab page, so that each tab
1879 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880
1881 *'cmdwinheight'* *'cwh'*
1882'cmdwinheight' 'cwh' number (default 7)
1883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 Number of screen lines to use for the command-line window. |cmdwin|
1885
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001886 *'colorcolumn'* *'cc'*
1887'colorcolumn' 'cc' string (default "")
1888 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001889 {not available when compiled without the |+syntax|
1890 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001891 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001892 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1893 text. Will make screen redrawing slower.
1894 The screen column can be an absolute number, or a number preceded with
1895 '+' or '-', which is added to or subtracted from 'textwidth'. >
1896
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001897 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001898 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1899 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1900<
1901 When 'textwidth' is zero then the items with '-' and '+' are not used.
1902 A maximum of 256 columns are highlighted.
1903
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 *'columns'* *'co'* *E594*
1905'columns' 'co' number (default 80 or terminal width)
1906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001908 initialization and does not have to be set by hand. Also see
1909 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 When Vim is running in the GUI or in a resizable window, setting this
1911 option will cause the window size to be changed. When you only want
1912 to use the size for the GUI, put the command in your |gvimrc| file.
1913 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001914 number of columns of the display, the display may be messed up. For
1915 the GUI it is always possible and Vim limits the number of columns to
1916 what fits on the screen. You can use this command to get the widest
1917 window possible: >
1918 :set columns=9999
1919< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920
1921 *'comments'* *'com'* *E524* *E525*
1922'comments' 'com' string (default
1923 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1924 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001925 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 |format-comments|. See |option-backslash| about using backslashes to
1927 insert a space.
1928
1929 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001930'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 {not available when compiled without the |+folding|
1933 feature}
1934 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001935 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001936 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001937 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938
1939 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001940'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001941 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 This option has the effect of making Vim either more Vi-compatible, or
1944 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001945
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001947 other options are also changed as a side effect.
1948 NOTE: Setting or resetting this option can have a lot of unexpected
1949 effects: Mappings are interpreted in another way, undo behaves
1950 differently, etc. If you set this option in your vimrc file, you
1951 should probably put it at the very start.
1952
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 By default this option is on and the Vi defaults are used for the
1954 options. This default was chosen for those people who want to use Vim
1955 just like Vi, and don't even (want to) know about the 'compatible'
1956 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001957 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001958 this option is switched off, and all options that have not been
1959 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001960 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001961 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001962 happen for the system-wide vimrc or gvimrc file, nor for a file given
1963 with the |-u| argument). Also see |compatible-default| and
1964 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 You can also set this option with the "-C" argument, and reset it with
1966 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001967 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 When this option is set, numerous other options are set to make Vim as
1970 Vi-compatible as possible. When this option is unset, various options
1971 are set to make Vim more useful. The table below lists all the
1972 options affected.
1973 The {?} column indicates when the options are affected:
1974 + Means that the option is set to the value given in {set value} when
1975 'compatible' is set.
1976 & Means that the option is set to the value given in {set value} when
1977 'compatible' is set AND is set to its Vim default value when
1978 'compatible' is unset.
1979 - Means the option is NOT changed when setting 'compatible' but IS
1980 set to its Vim default when 'compatible' is unset.
1981 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
Bram Moolenaar036986f2017-03-16 17:41:02 +01001983 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984
1985 'allowrevins' + off no CTRL-_ command
1986 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001987 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001988 'arabicshape' + on correct character shapes
1989 'backspace' + "" normal backspace
1990 'backup' + off no backup file
1991 'backupcopy' & Unix: "yes" backup file is a copy
1992 else: "auto" copy or rename backup file
1993 'balloonexpr' + "" text to show in evaluation balloon
1994 'breakindent' + off don't indent when wrapping lines
1995 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001996 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001997 'cindent' + off no C code indentation
1998 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1999 'copyindent' + off don't copy indent structure
2000 'cpoptions' & (all flags) Vi-compatible flags
2001 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01002002 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01002003 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01002004 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002005 'cscopeverbose' + off see |cscopeverbose|
2006 'delcombine' + off unicode: delete whole char combination
2007 'digraph' + off no digraphs
2008 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02002009 this also disables |modifyOtherKeys|
2010 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01002011 'expandtab' + off tabs not expanded to spaces
2012 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002013 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002014 'formatexpr' + "" use 'formatprg' for auto-formatting
2015 'formatoptions' & "vt" Vi compatible formatting
2016 'gdefault' + off no default 'g' flag for ":s"
2017 'history' & 0 no commandline history
2018 'hkmap' + off no Hebrew keyboard mapping
2019 'hkmapp' + off no phonetic Hebrew keyboard mapping
2020 'hlsearch' + off no highlighting of search matches
2021 'incsearch' + off no incremental searching
2022 'indentexpr' + "" no indenting by expression
2023 'insertmode' + off do not start in Insert mode
2024 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002026 'joinspaces' + on insert 2 spaces after period
2027 'modeline' & off no modelines
2028 'more' & off no pauses in listings
2029 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2030 'numberwidth' & 8 min number of columns for line number
2031 'preserveindent'+ off don't preserve current indent structure
2032 when changing it
2033 'revins' + off no reverse insert
2034 'ruler' + off no ruler
2035 'scrolljump' + 1 no jump scroll
2036 'scrolloff' + 0 no scroll offset
2037 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2038 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002039 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002040 'showcmd' & off command characters not shown
2041 'showmode' & off current mode not shown
2042 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2043 'smartcase' + off no automatic ignore case switch
2044 'smartindent' + off no smart indentation
2045 'smarttab' + off no smart tab size
2046 'softtabstop' + 0 tabs are always 'tabstop' positions
2047 'startofline' + on goto startofline with some commands
2048 'tagcase' & "followic" 'ignorecase' when searching tags file
2049 'tagrelative' & off tag file names are not relative
2050 'termguicolors' + off don't use highlight-(guifg|guibg)
2051 'textauto' & off no automatic textmode detection
2052 'textwidth' + 0 no automatic line wrap
2053 'tildeop' + off tilde is not an operator
2054 'ttimeout' + off no terminal timeout
2055 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002056 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002057 'virtualedit' + "" cursor can only be placed on characters
2058 'whichwrap' & "" left-right movements don't wrap
2059 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002061 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062
2063 *'complete'* *'cpt'* *E535*
2064'complete' 'cpt' string (default: ".,w,b,u,t,i")
2065 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 This option specifies how keyword completion |ins-completion| works
2067 when CTRL-P or CTRL-N are used. It is also used for whole-line
2068 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002069 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002070 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 w scan buffers from other windows
2072 b scan other loaded buffers that are in the buffer list
2073 u scan the unloaded buffers that are in the buffer list
2074 U scan the buffers that are not in the buffer list
2075 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002076 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 k{dict} scan the file {dict}. Several "k" flags can be given,
2078 patterns are valid too. For example: >
2079 :set cpt=k/usr/dict/*,k~/spanish
2080< s scan the files given with the 'thesaurus' option
2081 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2082 are valid too.
2083 i scan current and included files
2084 d scan current and included files for defined name or macro
2085 |i_CTRL-X_CTRL-D|
2086 ] tag completion
2087 t same as "]"
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02002088 f{func} call the function {func}. Multiple "f" flags may be specified.
Girish Palyacbe53192025-04-14 22:13:15 +02002089 Refer to |complete-functions| for details on how the function
2090 is invoked and what it should return. The value can be the
2091 name of a function or a |Funcref|. For |Funcref| values,
2092 spaces must be escaped with a backslash ('\'), and commas with
2093 double backslashes ('\\') (see |option-backslash|).
2094 If the Dict returned by the {func} includes {"refresh": "always"},
2095 the function will be invoked again whenever the leading text
2096 changes.
2097 Completion matches are always inserted at the keyword
2098 boundary, regardless of the column returned by {func} when
2099 a:findstart is 1. This ensures compatibility with other
2100 completion sources.
2101 To make further modifications to the inserted text, {func}
2102 can make use of |CompleteDonePre|.
2103 If generating matches is potentially slow, |complete_check()|
2104 should be used to avoid blocking and preserve editor
2105 responsiveness.
2106 f equivalent to using "f{func}", where the function is taken from
2107 the 'completefunc' option.
2108 o equivalent to using "f{func}", where the function is taken from
2109 the 'omnifunc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2112 not executed, this may lead to unexpected completions from some files
2113 (gzipped files for example). Unloaded buffers are not scanned for
2114 whole-line completion.
2115
2116 The default is ".,w,b,u,t,i", which means to scan:
2117 1. the current buffer
2118 2. buffers in other windows
2119 3. other loaded buffers
2120 4. unloaded buffers
2121 5. tags
2122 6. included files
2123
2124 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002125 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2126 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127
Girish Palya0ac1eb32025-04-16 20:18:33 +02002128 An optional match limit can be specified for a completion source by
2129 appending a caret ("^") followed by a {count} to the source flag.
2130 For example: ".^9,w,u,t^5" limits matches from the current buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02002131 to 9 and from tags to 5. Other sources remain unlimited.
2132 Note: The match limit takes effect only during forward completion
2133 (CTRL-N) and is ignored during backward completion (CTRL-P).
Girish Palya0ac1eb32025-04-16 20:18:33 +02002134
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002135 *'completefunc'* *'cfu'*
2136'completefunc' 'cfu' string (default: empty)
2137 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002138 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002139 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002140 This option specifies a function to be used for Insert mode completion
2141 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002142 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002143 invoked and what it should return. The value can be the name of a
2144 function, a |lambda| or a |Funcref|. See |option-value-function| for
2145 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002146 This option cannot be set from a |modeline| or in the |sandbox|, for
2147 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002148
glepnirf31cfa22025-03-06 21:59:13 +01002149 *'completefuzzycollect'* *'cfc'*
2150'completefuzzycollect' 'cfc' string (default: empty)
2151 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002152 A comma-separated list of strings to enable fuzzy collection for
2153 specific |ins-completion| modes, affecting how matches are gathered
2154 during completion. For specified modes, fuzzy matching is used to
2155 find completion candidates instead of the standard prefix-based
2156 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002157
glepnir58760162025-03-13 21:39:51 +01002158 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2159 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2160 "b", "u", "U" and "k{dict}" in 'complete'
2161 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002162
glepnir58760162025-03-13 21:39:51 +01002163 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002164
glepnir58760162025-03-13 21:39:51 +01002165 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002166
Christian Brabandtf22580e2025-03-14 12:05:52 +01002167 When using the 'completeopt' "longest" option value, fuzzy collection
glepnir58760162025-03-13 21:39:51 +01002168 can identify the longest common string among the best fuzzy matches
2169 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002170
glepnir6a89c942024-10-01 20:32:12 +02002171 *'completeitemalign'* *'cia'*
2172'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2173 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002174 A comma-separated list of strings that controls the alignment and
2175 display order of items in the popup menu during Insert mode
2176 completion. The supported values are "abbr", "kind", and "menu".
2177 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002178 popup menu. Note: must always contain those three values in any
2179 order.
2180
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002181 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002182'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002183 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002184 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002185 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002186
glepnira2c55592025-02-28 17:43:42 +01002187 fuzzy Enable |fuzzy-matching| for completion candidates. This
2188 allows for more flexible and intuitive matching, where
2189 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002190 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002191 does not affect the collection of candidate list, it only
2192 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002193 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002194 to gather more alternatives for your candidate list,
2195 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002196
2197 longest Only insert the longest common text of the matches. If
2198 the menu is displayed you can use CTRL-L to add more
2199 characters. Whether case is ignored depends on the kind
2200 of completion. For buffer text the 'ignorecase' option is
2201 used.
2202
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002203 menu Use a popup menu to show the possible completions. The
2204 menu is only shown when there is more than one match and
2205 sufficient colors are available. |ins-completion-menu|
2206
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002207 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002208 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002209 match, e.g., what file it comes from.
2210
Girish Palyacb3b7522025-04-18 18:52:28 +02002211 nearest Matches are listed based on their proximity to the cursor
2212 position, unlike the default behavior, which only
2213 considers proximity for matches appearing below the
2214 cursor. This applies only to matches from the current
Girish Palyab1565882025-04-15 20:16:00 +02002215 buffer. No effect if "fuzzy" is present.
2216
glepnira2c55592025-02-28 17:43:42 +01002217 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002218 a match from the menu. Only works in combination with
2219 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002220
glepnira2c55592025-02-28 17:43:42 +01002221 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002222 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002223 present, "noselect" has precedence.
2224
2225 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002226 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002227 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002228
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002229 popup Show extra information about the currently selected
2230 completion in a popup window. Only works in combination
2231 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002232 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002233 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002234
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002235 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002236 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002237 |CompleteChanged| autocommand to fetch the info and call
2238 |popup_show()| once the popup has been filled.
2239 See the example at |complete-popuphidden|.
2240 {only works when compiled with the |+textprop| feature}
2241
glepniredd4ac32025-01-29 18:53:51 +01002242 preinsert
2243 Preinsert the portion of the first candidate word that is
2244 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002245 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002246 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002247
2248 preview Show extra information about the currently selected
2249 completion in the preview window. Only works in
2250 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002251
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002252 *'completepopup'* *'cpp'*
2253'completepopup' 'cpp' string (default empty)
2254 global
2255 {not available when compiled without the |+textprop|
2256 or |+quickfix| feature}
2257 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002258 properties of the info popup when it is created. If an info popup
2259 window already exists it is closed, so that the option value is
2260 applied when it is created again.
2261 You can also use |popup_findinfo()| and then set properties for an
2262 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002263
laburnumT3f7855a2023-12-05 18:37:03 +01002264 *'completeslash'* *'csl'*
2265'completeslash' 'csl' string (default: "")
2266 local to buffer
2267 {only for MS-Windows}
2268 When this option is set it overrules 'shellslash' for completion:
2269 - When this option is set to "slash", a forward slash is used for path
2270 completion in insert mode. This is useful when editing HTML tag, or
2271 Makefile with 'noshellslash' on MS-Windows.
2272 - When this option is set to "backslash", backslash is used. This is
2273 useful when editing a batch file with 'shellslash' set on MS-Windows.
2274 - When this option is empty, same character is used as for
2275 'shellslash'.
2276 For Insert mode completion the buffer-local value is used. For
2277 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002278
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002279 *'concealcursor'* *'cocu'*
2280'concealcursor' 'cocu' string (default: "")
2281 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002282 {not available when compiled without the |+conceal|
2283 feature}
2284 Sets the modes in which text in the cursor line can also be concealed.
2285 When the current mode is listed then concealing happens just like in
2286 other lines.
2287 n Normal mode
2288 v Visual mode
2289 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002290 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002291
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002292 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002293 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002294 are moving around text is concealed, but when starting to insert text
2295 or selecting a Visual area the concealed text is displayed, so that
2296 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002297 Keep in mind that the cursor position is not always where it's
2298 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002299
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002300 *'conceallevel'* *'cole'*
2301'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002302 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002303 {not available when compiled without the |+conceal|
2304 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002305 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2306 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002307
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002308 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002309 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002310 1 Each block of concealed text is replaced with one
2311 character. If the syntax item does not have a custom
2312 replacement character defined (see |:syn-cchar|) the
2313 character defined in 'listchars' is used (default is a
2314 space).
2315 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002316 2 Concealed text is completely hidden unless it has a
2317 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002318 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002319 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002320
Bram Moolenaara7781e02010-07-19 20:13:22 +02002321 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002322 edit and copy the text. This can be changed with the 'concealcursor'
2323 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002324
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2326'confirm' 'cf' boolean (default off)
2327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 When 'confirm' is on, certain operations that would normally
2329 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2330 instead raise a |dialog| asking if you wish to save the current
2331 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2332 If 'confirm' is off you can still activate confirmation for one
2333 command only (this is most useful in mappings) with the |:confirm|
2334 command.
2335 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2336
2337 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2338'conskey' 'consk' boolean (default off)
2339 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002340 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341
2342 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2343'copyindent' 'ci' boolean (default off)
2344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 Copy the structure of the existing lines indent when autoindenting a
2346 new line. Normally the new indent is reconstructed by a series of
2347 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2348 in which case only spaces are used). Enabling this option makes the
2349 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002350 existing line. 'expandtab' has no effect on these characters, a Tab
2351 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002353 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 Also see 'preserveindent'.
2355
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002356 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002357'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2358 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002359 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002362 this indicates Vi-compatible behavior. This is used for things where
2363 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 'cpoptions' stands for "compatible-options".
2365 Commas can be added for readability.
2366 To avoid problems with flags that are added in the future, use the
2367 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 NOTE: This option is set to the Vi default value when 'compatible' is
2370 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002371
2372 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2373 is saved, 'cpoptions' is set to the Vim default, and the saved value
2374 is restored at the end of the script. Changes to the value of
2375 'cpoptions' will be applied to the saved value, but keep in mind that
2376 removing a flag that is not present when 'cpoptions' is changed has no
2377 effect. In the |.vimrc| file the value is not restored, thus using
2378 `vim9script` in the |.vimrc| file results in using the Vim default.
2379
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002380 NOTE: This option is set to the POSIX default value at startup when
2381 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002382 variable exists |posix|. This means Vim tries to behave like the
2383 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384
2385 contains behavior ~
2386 *cpo-a*
2387 a When included, a ":read" command with a file name
2388 argument will set the alternate file name for the
2389 current window.
2390 *cpo-A*
2391 A When included, a ":write" command with a file name
2392 argument will set the alternate file name for the
2393 current window.
2394 *cpo-b*
2395 b "\|" in a ":map" command is recognized as the end of
2396 the map command. The '\' is included in the mapping,
2397 the text after the '|' is interpreted as the next
2398 command. Use a CTRL-V instead of a backslash to
2399 include the '|' in the mapping. Applies to all
2400 mapping, abbreviation, menu and autocmd commands.
2401 See also |map_bar|.
2402 *cpo-B*
2403 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002404 abbreviations, user commands and the "to" part of the
2405 menu commands. Remove this flag to be able to use a
2406 backslash like a CTRL-V. For example, the command
2407 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 'B' included: "\^[" (^[ is a real <Esc>)
2409 'B' excluded: "<Esc>" (5 characters)
2410 ('<' excluded in both cases)
2411 *cpo-c*
2412 c Searching continues at the end of any match at the
2413 cursor position, but not further than the start of the
2414 next line. When not present searching continues
2415 one character from the cursor position. With 'c'
2416 "abababababab" only gets three matches when repeating
2417 "/abab", without 'c' there are five matches.
2418 *cpo-C*
2419 C Do not concatenate sourced lines that start with a
2420 backslash. See |line-continuation|.
2421 *cpo-d*
2422 d Using "./" in the 'tags' option doesn't mean to use
2423 the tags file relative to the current file, but the
2424 tags file in the current directory.
2425 *cpo-D*
2426 D Can't use CTRL-K to enter a digraph after Normal mode
2427 commands with a character argument, like |r|, |f| and
2428 |t|.
2429 *cpo-e*
2430 e When executing a register with ":@r", always add a
2431 <CR> to the last line, also when the register is not
2432 linewise. If this flag is not present, the register
2433 is not linewise and the last line does not end in a
2434 <CR>, then the last line is put on the command-line
2435 and can be edited before hitting <CR>.
2436 *cpo-E*
2437 E It is an error when using "y", "d", "c", "g~", "gu" or
2438 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002439 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 This makes "y0" fail in the first column.
2441 *cpo-f*
2442 f When included, a ":read" command with a file name
2443 argument will set the file name for the current buffer,
2444 if the current buffer doesn't have a file name yet.
2445 *cpo-F*
2446 F When included, a ":write" command with a file name
2447 argument will set the file name for the current
2448 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002449 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *cpo-g*
2451 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002452 *cpo-H*
2453 H When using "I" on a line with only blanks, insert
2454 before the last blank. Without this flag insert after
2455 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 *cpo-i*
2457 i When included, interrupting the reading of a file will
2458 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002459 *cpo-I*
2460 I When moving the cursor up or down just after inserting
2461 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 *cpo-j*
2463 j When joining lines, only add two spaces after a '.',
2464 not after '!' or '?'. Also see 'joinspaces'.
2465 *cpo-J*
2466 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002467 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 white space.
2469 *cpo-k*
2470 k Disable the recognition of raw key codes in
2471 mappings, abbreviations, and the "to" part of menu
2472 commands. For example, if <Key> sends ^[OA (where ^[
2473 is <Esc>), the command ":map X ^[OA" results in X
2474 being mapped to:
2475 'k' included: "^[OA" (3 characters)
2476 'k' excluded: "<Key>" (one key code)
2477 Also see the '<' flag below.
2478 *cpo-K*
2479 K Don't wait for a key code to complete when it is
2480 halfway a mapping. This breaks mapping <F1><F1> when
2481 only part of the second <F1> has been read. It
2482 enables cancelling the mapping by typing <F1><Esc>.
2483 *cpo-l*
2484 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002485 literally, only "\]", "\^", "\-" and "\\" are special.
2486 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2488 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002489 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 *cpo-L*
2491 L When the 'list' option is set, 'wrapmargin',
2492 'textwidth', 'softtabstop' and Virtual Replace mode
2493 (see |gR|) count a <Tab> as two characters, instead of
2494 the normal behavior of a <Tab>.
2495 *cpo-m*
2496 m When included, a showmatch will always wait half a
2497 second. When not included, a showmatch will wait half
2498 a second or until a character is typed. |'showmatch'|
2499 *cpo-M*
2500 M When excluded, "%" matching will take backslashes into
2501 account. Thus in "( \( )" and "\( ( \)" the outer
2502 parenthesis match. When included "%" ignores
2503 backslashes, which is Vi compatible.
2504 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002505 n When included, the column used for 'number' and
2506 'relativenumber' will also be used for text of wrapped
2507 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 *cpo-o*
2509 o Line offset to search command is not remembered for
2510 next search.
2511 *cpo-O*
2512 O Don't complain if a file is being overwritten, even
2513 when it didn't exist when editing it. This is a
2514 protection against a file unexpectedly created by
2515 someone else. Vi didn't complain about this.
2516 *cpo-p*
2517 p Vi compatible Lisp indenting. When not present, a
2518 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002519 *cpo-P*
2520 P When included, a ":write" command that appends to a
2521 file will set the file name for the current buffer, if
2522 the current buffer doesn't have a file name yet and
2523 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002524 *cpo-q*
2525 q When joining multiple lines leave the cursor at the
2526 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 *cpo-r*
2528 r Redo ("." command) uses "/" to repeat a search
2529 command, instead of the actually used search string.
2530 *cpo-R*
2531 R Remove marks from filtered lines. Without this flag
2532 marks are kept like |:keepmarks| was used.
2533 *cpo-s*
2534 s Set buffer options when entering the buffer for the
2535 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002536 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 set when the buffer is created.
2538 *cpo-S*
2539 S Set buffer options always when entering a buffer
2540 (except 'readonly', 'fileformat', 'filetype' and
2541 'syntax'). This is the (most) Vi compatible setting.
2542 The options are set to the values in the current
2543 buffer. When you change an option and go to another
2544 buffer, the value is copied. Effectively makes the
2545 buffer options global to all buffers.
2546
2547 's' 'S' copy buffer options
2548 no no when buffer created
2549 yes no when buffer first entered (default)
2550 X yes each time when buffer entered (vi comp.)
2551 *cpo-t*
2552 t Search pattern for the tag command is remembered for
2553 "n" command. Otherwise Vim only puts the pattern in
2554 the history for search pattern, but doesn't change the
2555 last used search pattern.
2556 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002557 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 *cpo-v*
2559 v Backspaced characters remain visible on the screen in
2560 Insert mode. Without this flag the characters are
2561 erased from the screen right away. With this flag the
2562 screen newly typed text overwrites backspaced
2563 characters.
2564 *cpo-w*
2565 w When using "cw" on a blank character, only change one
2566 character and not all blanks until the start of the
2567 next word.
2568 *cpo-W*
2569 W Don't overwrite a readonly file. When omitted, ":w!"
2570 overwrites a readonly file, if possible.
2571 *cpo-x*
2572 x <Esc> on the command-line executes the command-line.
2573 The default in Vim is to abandon the command-line,
2574 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002575 *cpo-X*
2576 X When using a count with "R" the replaced text is
2577 deleted only once. Also when repeating "R" with "."
2578 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002580 y A yank command can be redone with ".". Think twice if
2581 you really want to use this, it may break some
2582 plugins, since most people expect "." to only repeat a
2583 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002584 *cpo-Z*
2585 Z When using "w!" while the 'readonly' option is set,
2586 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002587 *cpo-z*
2588 z Special casing the "cw" and "d" command (see |cw| and
2589 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 *cpo-!*
2591 ! When redoing a filter command, use the last used
2592 external command, whatever it was. Otherwise the last
2593 used -filter- command is used.
2594 *cpo-$*
2595 $ When making a change to one line, don't redisplay the
2596 line, but put a '$' at the end of the changed text.
2597 The changed text will be overwritten when you type the
2598 new text. The line is redisplayed if you type any
2599 command that moves the cursor from the insertion
2600 point.
2601 *cpo-%*
2602 % Vi-compatible matching is done for the "%" command.
2603 Does not recognize "#if", "#endif", etc.
2604 Does not recognize "/*" and "*/".
2605 Parens inside single and double quotes are also
2606 counted, causing a string that contains a paren to
2607 disturb the matching. For example, in a line like
2608 "if (strcmp("foo(", s))" the first paren does not
2609 match the last one. When this flag is not included,
2610 parens inside single and double quotes are treated
2611 specially. When matching a paren outside of quotes,
2612 everything inside quotes is ignored. When matching a
2613 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002614 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002615 This flag is also used for other features, such as
2616 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002617 *cpo--*
2618 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002619 it would go above the first line or below the last
2620 line. Without it the cursor moves to the first or
2621 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002622 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002623 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002624 *cpo-+*
2625 + When included, a ":write file" command will reset the
2626 'modified' flag of the buffer, even though the buffer
2627 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002628 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 * Use ":*" in the same way as ":@". When not included,
2630 ":*" is an alias for ":'<,'>", select the Visual area.
2631 *cpo-<*
2632 < Disable the recognition of special key codes in |<>|
2633 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002634 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 ":map X <Tab>" results in X being mapped to:
2636 '<' included: "<Tab>" (5 characters)
2637 '<' excluded: "^I" (^I is a real <Tab>)
2638 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002639 *cpo->*
2640 > When appending to a register, put a line break before
2641 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002642 *cpo-;*
2643 ; When using |,| or |;| to repeat the last |t| search
2644 and the cursor is right in front of the searched
2645 character, the cursor won't move. When not included,
2646 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002647 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002648
2649 POSIX flags. These are not included in the Vi default value, except
2650 when $VIM_POSIX was set on startup. |posix|
2651
2652 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002653 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002654 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002655 *cpo-&*
2656 & When ":preserve" was used keep the swap file when
2657 exiting normally while this buffer is still loaded.
2658 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002659 *cpo-\*
2660 \ Backslash in a [] range in a search pattern is taken
2661 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002662 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2663 '\' excluded: "/[ \-]" finds <Space> and '-'
2664 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002665 *cpo-/*
2666 / When "%" is used as the replacement string in a |:s|
2667 command, use the previous replacement string. |:s%|
2668 *cpo-{*
2669 { The |{| and |}| commands also stop at a "{" character
2670 at the start of a line.
2671 *cpo-.*
2672 . The ":chdir" and ":cd" commands fail if the current
2673 buffer is modified, unless ! is used. Vim doesn't
2674 need this, since it remembers the full path of an
2675 opened file.
2676 *cpo-bar*
2677 | The value of the $LINES and $COLUMNS environment
2678 variables overrule the terminal size values obtained
2679 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002680
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002681 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002682'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002683 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002684 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002685 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002686 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002687 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002688 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002689 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002690 blowfish Blowfish method. Medium strong encryption but it has
2691 an implementation flaw. Requires Vim 7.3 or later,
2692 files can NOT be read by Vim 7.2 and older. This adds
2693 a "seed" to the file, every time you write the file
2694 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002695 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002696 *blowfish2*
2697 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002698 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002699 and older. This adds a "seed" to the file, every time
2700 you write the file the encrypted bytes will be
2701 different. The whole undo file is encrypted, not just
2702 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002703 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002704 *E1197* *E1198* *E1199* *E1200* *E1201*
2705 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
clach042afdb3a2025-04-06 17:37:12 +02002706 Code. Medium strong to strong encryption.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002707 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002708 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002709 It adds a seed and a message authentication code (MAC)
2710 to the file. This needs at least a Vim 8.2.3022 to
2711 read the encrypted file.
2712 Encryption of swap files is not supported, therefore
2713 no swap file will be used when xchacha20 encryption is
2714 enabled.
2715 Encryption of undo files is not yet supported,
2716 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002717 CAREFUL: Files written with this method might have to
2718 be read back with the same version of Vim if the
2719 binary format changes later.
2720 Obsolete, please do no longer use.
2721 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2722 stores the key derivation parameters together with the
2723 encrypted file. Should work better in case the
2724 parameters in the libsodium library ever change.
2725 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002726 might have to be read back with the same version of
2727 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002728
Christian Brabandtaae58342023-04-23 17:50:22 +01002729 You should use "blowfish2", also to re-encrypt older files. The
2730 "xchacha20" method provides better encryption, but it does not work
2731 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002732
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002733 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002734 to the detected method of the file being read. Thus if you write it
2735 without changing 'cryptmethod' the same method will be used.
2736 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002737 explicitly write it, you don't get a warning unless there are other
2738 modifications. Also see |:X|.
2739
2740 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002741 the value "blowfish2". When setting the local value to an empty
2742 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002743
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002744 When a new encryption method is added in a later version of Vim, and
2745 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002746 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002747
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 *'cscopepathcomp'* *'cspc'*
2749'cscopepathcomp' 'cspc' number (default 0)
2750 global
2751 {not available when compiled without the |+cscope|
2752 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 Determines how many components of the path to show in a list of tags.
2754 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002755 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756
2757 *'cscopeprg'* *'csprg'*
2758'cscopeprg' 'csprg' string (default "cscope")
2759 global
2760 {not available when compiled without the |+cscope|
2761 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 Specifies the command to execute cscope. See |cscopeprg|.
2763 This option cannot be set from a |modeline| or in the |sandbox|, for
2764 security reasons.
2765
2766 *'cscopequickfix'* *'csqf'*
2767'cscopequickfix' 'csqf' string (default "")
2768 global
2769 {not available when compiled without the |+cscope|
2770 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 Specifies whether to use quickfix window to show cscope results.
2772 See |cscopequickfix|.
2773
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002774 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002775'cscoperelative' 'csre' boolean (default off)
2776 global
2777 {not available when compiled without the |+cscope|
2778 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002779 In the absence of a prefix (-P) for cscope. setting this option enables
2780 to use the basename of cscope.out path as the prefix.
2781 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002782 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2785'cscopetag' 'cst' boolean (default off)
2786 global
2787 {not available when compiled without the |+cscope|
2788 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 Use cscope for tag commands. See |cscope-options|.
2790 NOTE: This option is reset when 'compatible' is set.
2791
2792 *'cscopetagorder'* *'csto'*
2793'cscopetagorder' 'csto' number (default 0)
2794 global
2795 {not available when compiled without the |+cscope|
2796 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 Determines the order in which ":cstag" performs a search. See
2798 |cscopetagorder|.
2799 NOTE: This option is set to 0 when 'compatible' is set.
2800
2801 *'cscopeverbose'* *'csverb'*
2802 *'nocscopeverbose'* *'nocsverb'*
2803'cscopeverbose' 'csverb' boolean (default off)
2804 global
2805 {not available when compiled without the |+cscope|
2806 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 Give messages when adding a cscope database. See |cscopeverbose|.
2808 NOTE: This option is reset when 'compatible' is set.
2809
Bram Moolenaar860cae12010-06-05 23:22:07 +02002810 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2811'cursorbind' 'crb' boolean (default off)
2812 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002813 When this option is set, as the cursor in the current
2814 window moves other cursorbound windows (windows that also have
2815 this option set) move their cursors to the corresponding line and
2816 column. This option is useful for viewing the
2817 differences between two versions of a file (see 'diff'); in diff mode,
2818 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002819 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002820
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002821 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2822'cursorcolumn' 'cuc' boolean (default off)
2823 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002824 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002825 feature}
2826 Highlight the screen column of the cursor with CursorColumn
2827 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2828 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002829 If you only want the highlighting in the current window you can use
2830 these autocommands: >
2831 au WinLeave * set nocursorline nocursorcolumn
2832 au WinEnter * set cursorline cursorcolumn
2833<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002834
2835 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2836'cursorline' 'cul' boolean (default off)
2837 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002838 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002839 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002840 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2841 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002842 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002843 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002844
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002845 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002846'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002847 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002848 {not available when compiled without the |+syntax|
2849 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002850 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002851 Valid values:
2852 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002853 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002854 "screenline" Highlight only the screen line of the cursor with
2855 CursorLine |hl-CursorLine|.
2856 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002857 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002858
2859 Special value:
2860 "both" Alias for the values "line,number".
2861
2862 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002863
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 *'debug'*
2865'debug' string (default "")
2866 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002867 These values can be used:
2868 msg Error messages that would otherwise be omitted will be given
2869 anyway.
2870 throw Error messages that would otherwise be omitted will be given
2871 anyway and also throw an exception and set |v:errmsg|.
2872 beep A message will be given when otherwise only a beep would be
2873 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002874 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002875 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2876 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877
2878 *'define'* *'def'*
2879'define' 'def' string (default "^\s*#\s*define")
2880 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 pattern, just like for the "/" command. This option is used for the
2883 commands like "[i" and "[d" |include-search|. The 'isident' option is
2884 used to recognize the defined name after the match:
2885 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2886 See |option-backslash| about inserting backslashes to include a space
2887 or backslash.
2888 The default value is for C programs. For C++ this value would be
2889 useful, to include const type declarations: >
2890 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002891< You can also use "\ze" just before the name and continue the pattern
2892 to check what is following. E.g. for Javascript, if a function is
2893 defined with "func_name = function(args)": >
2894 ^\s*\ze\i\+\s*=\s*function(
2895< If the function is defined with "func_name : function() {...": >
2896 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002898 To avoid that use `:let` with a single quote string: >
2899 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002900<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901
2902 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2903'delcombine' 'deco' boolean (default off)
2904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 If editing Unicode and this option is set, backspace and Normal mode
2906 "x" delete each combining character on its own. When it is off (the
2907 default) the character along with its combining characters are
2908 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002909 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910
2911 This is useful for Arabic, Hebrew and many other languages where one
2912 may have combining characters overtop of base characters, and want
2913 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002914 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915
2916 *'dictionary'* *'dict'*
2917'dictionary' 'dict' string (default "")
2918 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 List of file names, separated by commas, that are used to lookup words
2920 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2921 contain a list of words. This can be one word per line, or several
2922 words per line, separated by non-keyword characters (white space is
2923 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002924
2925 When this option is empty or an entry "spell" is present, and spell
2926 checking is enabled, words in the word lists for the currently active
2927 'spelllang' are used. See |spell|.
2928
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002929 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 after a comma are ignored, otherwise spaces are included in the file
2931 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002932 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 Where to find a list of words?
2934 - On FreeBSD, there is the file "/usr/share/dict/words".
2935 - In the Simtel archive, look in the "msdos/linguist" directory.
2936 - In "miscfiles" of the GNU collection.
2937 The use of |:set+=| and |:set-=| is preferred when adding or removing
2938 directories from the list. This avoids problems when a future version
2939 uses another default.
2940 Backticks cannot be used in this option for security reasons.
2941
2942 *'diff'* *'nodiff'*
2943'diff' boolean (default off)
2944 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 {not available when compiled without the |+diff|
2946 feature}
2947 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002948 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
2950 *'dex'* *'diffexpr'*
2951'diffexpr' 'dex' string (default "")
2952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 {not available when compiled without the |+diff|
2954 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002955 Expression which is evaluated to obtain a diff file (either ed-style
2956 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 This option cannot be set from a |modeline| or in the |sandbox|, for
2958 security reasons.
2959
2960 *'dip'* *'diffopt'*
Yee Cheng Chin9943d472025-03-26 19:41:02 +01002961'diffopt' 'dip' string (default
2962 "internal,filler,closeoff,inline:simple")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 {not available when compiled without the |+diff|
2965 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002966 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 All are optional. Items must be separated by a comma.
2968
Jonathon7c7a4e62025-01-12 09:58:00 +01002969 algorithm:{text} Use the specified diff algorithm with the
2970 internal diff engine. Currently supported
2971 algorithms are:
2972 myers the default algorithm
2973 minimal spend extra time to generate the
2974 smallest possible diff
2975 patience patience diff algorithm
2976 histogram histogram diff algorithm
2977
2978 closeoff When a window is closed where 'diff' is set
2979 and there is only one window remaining in the
2980 same tab page with 'diff' set, execute
2981 `:diffoff` in that window. This undoes a
2982 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983
2984 context:{n} Use a context of {n} lines between a change
2985 and a fold that contains unchanged lines.
2986 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002987 When using zero the context is actually one,
2988 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002989 for a deleted line. Set it to a very large
2990 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 See |fold-diff|.
2992
Jonathon7c7a4e62025-01-12 09:58:00 +01002993 filler Show filler lines, to keep the text
2994 synchronized with a window that has inserted
2995 lines at the same position. Mostly useful
2996 when windows are side-by-side and 'scrollbind'
2997 is set.
2998
2999 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
3000 starting diff mode. Without this 2 is used.
3001
3002 followwrap Follow the 'wrap' option and leave as it is.
3003
3004 horizontal Start diff mode with horizontal splits (unless
3005 explicitly specified otherwise).
3006
3007 hiddenoff Do not use diff mode for a buffer when it
3008 becomes hidden.
3009
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003010 iblank Ignore changes where lines are all blank. Adds
3011 the "-B" flag to the "diff" command if
3012 'diffexpr' is empty. Check the documentation
3013 of the "diff" command for what this does
3014 exactly.
3015 NOTE: the diff windows will get out of sync,
3016 because no differences between blank lines are
3017 taken into account.
3018
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 icase Ignore changes in case of text. "a" and "A"
3020 are considered the same. Adds the "-i" flag
3021 to the "diff" command if 'diffexpr' is empty.
3022
Jonathon7c7a4e62025-01-12 09:58:00 +01003023 indent-heuristic
3024 Use the indent heuristic for the internal
3025 diff library.
3026
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003027 inline:{text} Highlight inline differences within a change.
3028 See |view-diffs|. Supported values are:
3029
3030 none Do not perform inline highlighting.
3031 simple Highlight from first different
3032 character to the last one in each
zeertzjq5a307c32025-03-28 19:01:32 +01003033 line. This is the default if no
3034 `inline:` value is set.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003035 char Use internal diff to perform a
3036 character-wise diff and highlight the
3037 difference.
3038 word Use internal diff to perform a
3039 |word|-wise diff and highlight the
Yee Cheng Chin9aa120f2025-04-04 19:16:21 +02003040 difference. Non-alphanumeric
3041 multi-byte characters such as emoji
3042 and CJK characters are considered
3043 individual words.
Yee Cheng Chin9943d472025-03-26 19:41:02 +01003044
Jonathon7c7a4e62025-01-12 09:58:00 +01003045 internal Use the internal diff library. This is
3046 ignored when 'diffexpr' is set. *E960*
3047 When running out of memory when writing a
3048 buffer this item will be ignored for diffs
3049 involving that buffer. Set the 'verbose'
3050 option to see when this happens.
3051
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 iwhite Ignore changes in amount of white space. Adds
3053 the "-b" flag to the "diff" command if
3054 'diffexpr' is empty. Check the documentation
3055 of the "diff" command for what this does
3056 exactly. It should ignore adding trailing
3057 white space, but not leading white space.
3058
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003059 iwhiteall Ignore all white space changes. Adds
3060 the "-w" flag to the "diff" command if
3061 'diffexpr' is empty. Check the documentation
3062 of the "diff" command for what this does
3063 exactly.
3064
3065 iwhiteeol Ignore white space changes at end of line.
3066 Adds the "-Z" flag to the "diff" command if
3067 'diffexpr' is empty. Check the documentation
3068 of the "diff" command for what this does
3069 exactly.
3070
Jonathon7c7a4e62025-01-12 09:58:00 +01003071 linematch:{n} Align and mark changes between the most
3072 similar lines between the buffers. When the
3073 total number of lines in the diff hunk exceeds
3074 {n}, the lines will not be aligned because for
3075 very large diff hunks there will be a
3076 noticeable lag. A reasonable setting is
3077 "linematch:60", as this will enable alignment
3078 for a 2 buffer diff hunk of 30 lines each,
3079 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003080
3081 vertical Start diff mode with vertical splits (unless
3082 explicitly specified otherwise).
3083
Bram Moolenaare828b762018-09-10 17:51:58 +02003084 Examples: >
3085 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003087 :set diffopt=internal,filler,foldcolumn:3
3088 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089<
3090 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3091'digraph' 'dg' boolean (default off)
3092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 {not available when compiled without the |+digraphs|
3094 feature}
3095 Enable the entering of digraphs in Insert mode with {char1} <BS>
3096 {char2}. See |digraphs|.
3097 NOTE: This option is reset when 'compatible' is set.
3098
3099 *'directory'* *'dir'*
3100'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003101 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 for Unix: ".,~/tmp,/var/tmp,/tmp")
3103 global
3104 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003105 Recommended value: ".,~/vimswap//" - this will put the swap file next
3106 to the edited file if possible, and in your personal swap directory
3107 otherwise. Make sure "~/vimswap//" is only readable for you.
3108
3109 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 - The swap file will be created in the first directory where this is
3111 possible.
3112 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003113 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 - A directory "." means to put the swap file in the same directory as
3115 the edited file. On Unix, a dot is prepended to the file name, so
3116 it doesn't show in a directory listing. On MS-Windows the "hidden"
3117 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003118 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3119 the swap file relative to where the edited file is. The leading "."
3120 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003121 - For Unix and Win32, if a directory ends in two path separators "//",
3122 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003123 with all path separators replaced by percent '%' signs (including
3124 the colon following the drive letter on Win32). This will ensure
3125 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003126 On Win32, it is also possible to end with "\\". However, When a
3127 separating comma is following, you must use "//", since "\\" will
3128 include the comma in the file name. Therefore it is recommended to
3129 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 - Spaces after the comma are ignored, other spaces are considered part
3131 of the directory name. To have a space at the start of a directory
3132 name, precede it with a backslash.
3133 - To include a comma in a directory name precede it with a backslash.
3134 - A directory name may end in an ':' or '/'.
3135 - Environment variables are expanded |:set_env|.
3136 - Careful with '\' characters, type one before a space, type two to
3137 get one in the option (see |option-backslash|), for example: >
3138 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3139< - For backwards compatibility with Vim version 3.0 a '>' at the start
3140 of the option is removed.
3141 Using "." first in the list is recommended. This means that editing
3142 the same file twice will result in a warning. Using "/tmp" on Unix is
3143 discouraged: When the system crashes you lose the swap file.
3144 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003145 choice than "/tmp". But others on the computer may be able to see the
3146 files, and it can contain a lot of files, your swap files get lost in
3147 the crowd. That is why a "tmp" directory in your home directory is
3148 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 The use of |:set+=| and |:set-=| is preferred when adding or removing
3150 directories from the list. This avoids problems when a future version
3151 uses another default.
3152 This option cannot be set from a |modeline| or in the |sandbox|, for
3153 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154
3155 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003156'display' 'dy' string (default "", set to "truncate" in
3157 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003159 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 flags:
3161 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003162 in a window will be displayed. "@@@" is put in the
3163 last columns of the last screen line to indicate the
3164 rest of the line is not displayed.
3165 truncate Like "lastline", but "@@@" is displayed in the first
3166 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 uhex Show unprintable characters hexadecimal as <xx>
3168 instead of using ^C and ~C.
3169
Bram Moolenaard0796902016-09-16 20:02:31 +02003170 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003171 doesn't fit is replaced with "@" lines.
3172
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003173 The "@" character can be changed by setting the "lastline" item in
3174 'fillchars'. The character is highlighted with |hl-NonText|.
3175
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 *'eadirection'* *'ead'*
3177'eadirection' 'ead' string (default "both")
3178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 Tells when the 'equalalways' option applies:
3180 ver vertically, width of windows is not affected
3181 hor horizontally, height of windows is not affected
3182 both width and height of windows is affected
3183
3184 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3185'edcompatible' 'ed' boolean (default off)
3186 global
3187 Makes the 'g' and 'c' flags of the ":substitute" command to be
3188 toggled each time the flag is given. See |complex-change|. See
3189 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003190 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003191 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192
Bram Moolenaar03413f42016-04-12 21:07:15 +02003193 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003194'emoji' 'emo' boolean (default: on)
3195 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003196 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003197 This excludes "text emoji" characters, which are normally displayed as
3198 single width. Unfortunately there is no good specification for this
3199 and it has been determined on trial-and-error basis. Use the
3200 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003203'encoding' 'enc' string (default for MS-Windows: "utf-8",
3204 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 Sets the character encoding used inside Vim. It applies to text in
3207 the buffers, registers, Strings in expressions, text stored in the
3208 viminfo file, etc. It sets the kind of characters which Vim can work
3209 with. See |encoding-names| for the possible values.
3210
3211 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003212 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003214 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215
Bram Moolenaar865242e2010-07-14 21:12:05 +02003216 This option cannot be set from a |modeline|. It would most likely
3217 corrupt the text.
3218
Bram Moolenaar3df01732017-02-17 22:47:16 +01003219 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3220 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 'encoding', "utf-8" is the natural choice for the environment and
3222 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003223 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 versions, and to avoid changing the encoding of newly created files
3225 without your knowledge (in case 'fileencodings' is empty).
3226
3227 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003228 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 iconv() or as specified with 'charconvert'.
3230
Bram Moolenaar207f0092020-08-30 17:20:20 +02003231 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003232 can use: >
3233 if has("multi_byte_encoding")
3234<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 Normally 'encoding' will be equal to your current locale. This will
3236 be the default if Vim recognizes your environment settings. If
3237 'encoding' is not set to the current locale, 'termencoding' must be
3238 set to convert typed and displayed text. See |encoding-table|.
3239
3240 When you set this option, it fires the |EncodingChanged| autocommand
3241 event so that you can set up fonts if necessary.
3242
3243 When the option is set, the value is converted to lowercase. Thus
3244 you can set it with uppercase values too. Underscores are translated
3245 to '-' signs.
3246 When the encoding is recognized, it is changed to the standard name.
3247 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3248 "iso-8859-2" and "utf8" becomes "utf-8".
3249
3250 Note: "latin1" is also used when the encoding could not be detected.
3251 This only works when editing files in the same encoding! When the
3252 actual character set is not latin1, make sure 'fileencoding' and
3253 'fileencodings' are empty. When conversion is needed, switch to using
3254 utf-8.
3255
3256 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3257 You don't notice this while editing, but it does matter for the
3258 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3259 setting 'encoding' to one of these values instead of utf-8 only has
3260 effect for encoding used for files when 'fileencoding' is empty.
3261
Bram Moolenaar661b1822005-07-28 22:36:45 +00003262 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3263 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003265 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003266'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003268 Indicates that a CTRL-Z character was found at the end of the file
3269 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003271 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003272 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003273 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003274
3275 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3276'endofline' 'eol' boolean (default on)
3277 local to buffer
3278 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003279 is on, or 'fixeol' option is off, no <EOL> will be written for the
3280 last line in the file. This option is automatically set or reset when
3281 starting to edit a new file, depending on whether file has an <EOL>
3282 for the last line in the file. Normally you don't have to set or
3283 reset this option.
3284 When 'binary' is off and 'fixeol' is on the value is not used when
3285 writing the file. When 'binary' is on or 'fixeol' is off it is used
3286 to remember the presence of a <EOL> for the last line in the file, so
3287 that when you write the file the situation from the original file can
3288 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003289 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290
3291 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3292'equalalways' 'ea' boolean (default on)
3293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003295 splitting or closing a window. This also happens the moment the
3296 option is switched on. When off, splitting a window will reduce the
3297 size of the current window and leave the other windows the same. When
3298 closing a window the extra lines are given to the window next to it
3299 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 When mixing vertically and horizontally split windows, a minimal size
3301 is computed and some windows may be larger if there is room. The
3302 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003303 Changing the height and width of a window can be avoided by setting
3304 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003305 If a window size is specified when creating a new window sizes are
3306 currently not equalized (it's complicated, but may be implemented in
3307 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308
3309 *'equalprg'* *'ep'*
3310'equalprg' 'ep' string (default "")
3311 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003313 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003314 or 'indentexpr'. When Vim was compiled without internal formatting,
3315 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003316 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 about including spaces and backslashes.
3318 This option cannot be set from a |modeline| or in the |sandbox|, for
3319 security reasons.
3320
3321 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3322'errorbells' 'eb' boolean (default off)
3323 global
3324 Ring the bell (beep or screen flash) for error messages. This only
3325 makes a difference for error messages, the bell will be used always
3326 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003327 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003328 screen flash or do nothing. See 'belloff' to finetune when to ring the
3329 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330
3331 *'errorfile'* *'ef'*
3332'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3333 others: "errors.err")
3334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 {not available when compiled without the |+quickfix|
3336 feature}
3337 Name of the errorfile for the QuickFix mode (see |:cf|).
3338 When the "-q" command-line argument is used, 'errorfile' is set to the
3339 following argument. See |-q|.
3340 NOT used for the ":make" command. See 'makeef' for that.
3341 Environment variables are expanded |:set_env|.
3342 See |option-backslash| about including spaces and backslashes.
3343 This option cannot be set from a |modeline| or in the |sandbox|, for
3344 security reasons.
3345
3346 *'errorformat'* *'efm'*
3347'errorformat' 'efm' string (default is very long)
3348 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 {not available when compiled without the |+quickfix|
3350 feature}
3351 Scanf-like description of the format for the lines in the error file
3352 (see |errorformat|).
3353
3354 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3355'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3356 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 Function keys that start with an <Esc> are recognized in Insert
3358 mode. When this option is off, the cursor and function keys cannot be
3359 used in Insert mode if they start with an <Esc>. The advantage of
3360 this is that the single <Esc> is recognized immediately, instead of
3361 after one second. Instead of resetting this option, you might want to
3362 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3363 when 'esckeys' is off, you can still map anything, but the cursor keys
3364 won't work by default.
3365 NOTE: This option is set to the Vi default value when 'compatible' is
3366 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003367 NOTE: when this option is off then the |modifyOtherKeys| and
3368 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3369 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370
3371 *'eventignore'* *'ei'*
3372'eventignore' 'ei' string (default "")
3373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003375 When set to "all" or when "all" is one of the items, all autocommand
3376 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003377 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 :set ei=WinEnter,WinLeave
3379<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003380 *'eventignorewin'* *'eiw'*
3381'eventignorewin' 'eiw' string (default "")
3382 window-local
3383 Similar to 'eventignore' but applies to a particular window and its
3384 buffers, for which window and buffer related autocommands can be
3385 ignored indefinitely without affecting the global 'eventignore'.
3386
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3388'expandtab' 'et' boolean (default off)
3389 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003391 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3393 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003394 This option is reset when the 'paste' option is set and restored when
3395 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 NOTE: This option is reset when 'compatible' is set.
3397
3398 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3399'exrc' 'ex' boolean (default off)
3400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003402 directory.
3403
3404 Setting this option is a potential security leak. E.g., consider
3405 unpacking a package or fetching files from github, a .vimrc in there
3406 might be a trojan horse. BETTER NOT SET THIS OPTION!
3407 Instead, define an autocommand in your .vimrc to set options for a
3408 matching directory.
3409
3410 If you do switch this option on you should also consider setting the
3411 'secure' option (see |initialization|).
3412 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 This option cannot be set from a |modeline| or in the |sandbox|, for
3414 security reasons.
3415
3416 *'fileencoding'* *'fenc'* *E213*
3417'fileencoding' 'fenc' string (default: "")
3418 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003420
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003422 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 When 'fileencoding' is empty, the same value as 'encoding' will be
3424 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003425 No error will be given when the value is set, only when it is used,
3426 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003427 Conversion will also be done when 'encoding' and 'fileencoding' are
3428 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3429 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003431 'encoding' is "utf-8" or another Unicode encoding, conversion
3432 is most likely done in a way that the reverse conversion
3433 results in the same text. When 'encoding' is not "utf-8" some
3434 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003435
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 See 'encoding' for the possible values. Additionally, values may be
3437 specified that can be handled by the converter, see
3438 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 When reading a file 'fileencoding' will be set from 'fileencodings'.
3441 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003442 'fileencoding', use the |++enc| argument. One exception: when
3443 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003444 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003445
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3447 When the option is set, the value is converted to lowercase. Thus
3448 you can set it with uppercase values too. '_' characters are
3449 replaced with '-'. If a name is recognized from the list for
3450 'encoding', it is replaced by the standard name. For example
3451 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 When this option is set, after starting to edit a file, the 'modified'
3454 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003455
3456 Keep in mind that changing 'fenc' from a modeline happens
3457 AFTER the text has been read, thus it applies to when the file will be
3458 written. If you do set 'fenc' in a modeline, you might want to set
3459 'nomodified' to avoid not being able to ":q".
3460
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 This option can not be changed when 'modifiable' is off.
3462
3463 *'fe'*
3464 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003465 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 old short name was 'fe', which is no longer used.
3467
3468 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003469'fileencodings' 'fencs' string (default: "ucs-bom",
3470 "ucs-bom,utf-8,default,latin1" when
3471 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 This is a list of character encodings considered when starting to edit
3474 an existing file. When a file is read, Vim tries to use the first
3475 mentioned character encoding. If an error is detected, the next one
3476 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003477 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 an empty string, which means the value of 'encoding' is used.
3479 WARNING: Conversion can cause loss of information! When
3480 'encoding' is "utf-8" (or one of the other Unicode variants)
3481 conversion is most likely done in a way that the reverse
3482 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003483 "utf-8" some non-ASCII characters may be lost! You can use
3484 the |++bad| argument to specify what is done with characters
3485 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 For an empty file or a file with only ASCII characters most encodings
3487 will work and the first entry of 'fileencodings' will be used (except
3488 "ucs-bom", which requires the BOM to be present). If you prefer
3489 another encoding use an BufReadPost autocommand event to test if your
3490 preferred encoding is to be used. Example: >
3491 au BufReadPost * if search('\S', 'w') == 0 |
3492 \ set fenc=iso-2022-jp | endif
3493< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3494 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003495 When the |++enc| argument is used then the value of 'fileencodings' is
3496 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003497 Note that 'fileencodings' is not used for a new file, the global value
3498 of 'fileencoding' is used instead. You can set it with: >
3499 :setglobal fenc=iso-8859-2
3500< This means that a non-existing file may get a different encoding than
3501 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 The special value "ucs-bom" can be used to check for a Unicode BOM
3503 (Byte Order Mark) at the start of the file. It must not be preceded
3504 by "utf-8" or another Unicode encoding for this to work properly.
3505 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3506 because Vim cannot detect an error, thus the encoding is always
3507 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003508 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003509 environment. On MS-Windows this is the system encoding. Otherwise
3510 this is the default value for 'encoding'. It is useful when
3511 'encoding' is set to "utf-8" and your environment uses a non-latin1
3512 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003513 When 'encoding' is "utf-8" and a file contains an illegal byte
3514 sequence it won't be recognized as UTF-8. You can use the |8g8|
3515 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 WRONG VALUES: WHAT'S WRONG:
3517 latin1,utf-8 "latin1" will always be used
3518 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3519 file
3520 cp1250,latin1 "cp1250" will always be used
3521 If 'fileencodings' is empty, 'fileencoding' is not modified.
3522 See 'fileencoding' for the possible values.
3523 Setting this option does not have an effect until the next time a file
3524 is read.
3525
3526 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003527'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003528 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 This gives the <EOL> of the current buffer, which is used for
3531 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003532 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 unix <NL>
3534 mac <CR>
3535 When "dos" is used, CTRL-Z at the end of a file is ignored.
3536 See |file-formats| and |file-read|.
3537 For the character encoding of the file see 'fileencoding'.
3538 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003539 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 This option is set automatically when starting to edit a file and
3541 'fileformats' is not empty and 'binary' is off.
3542 When this option is set, after starting to edit a file, the 'modified'
3543 option is set, because the file would be different when written.
3544 This option can not be changed when 'modifiable' is off.
3545 For backwards compatibility: When this option is set to "dos",
3546 'textmode' is set, otherwise 'textmode' is reset.
3547
3548 *'fileformats'* *'ffs'*
3549'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003550 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003551 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 Vi Cygwin: "unix,dos",
3553 Vi others: "")
3554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 This gives the end-of-line (<EOL>) formats that will be tried when
3556 starting to edit a new buffer and when reading a file into an existing
3557 buffer:
3558 - When empty, the format defined with 'fileformat' will be used
3559 always. It is not set automatically.
3560 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003561 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 'fileformats' name will be used when a file is read into an existing
3563 buffer, no matter what 'fileformat' for that buffer is set to.
3564 - When more than one name is present, separated by commas, automatic
3565 <EOL> detection will be done when reading a file. When starting to
3566 edit a file, a check is done for the <EOL>:
3567 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3568 'fileformat' is set to "dos".
3569 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003570 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003572 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3573 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003574 This means that "mac" is only chosen when:
3575 "unix" is not present or no <NL> is found in the file, and
3576 "dos" is not present or no <CR><NL> is found in the file.
3577 Except: if "unix" was chosen, but there is a <CR> before
3578 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003579 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 4. If 'fileformat' is still not set, the first name from
3581 'fileformats' is used.
3582 When reading a file into an existing buffer, the same is done, but
3583 this happens like 'fileformat' has been set appropriately for that
3584 file only, the option is not changed.
3585 When 'binary' is set, the value of 'fileformats' is not used.
3586
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003587 When Vim starts up with an empty buffer the first item is used. You
3588 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003589
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3591 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3592 done:
3593 - When 'fileformats' is empty, there is no automatic detection. Dos
3594 format will be used.
3595 - When 'fileformats' is set to one or more names, automatic detection
3596 is done. This is based on the first <NL> in the file: If there is a
3597 <CR> in front of it, Dos format is used, otherwise Unix format is
3598 used.
3599 Also see |file-formats|.
3600 For backwards compatibility: When this option is set to an empty
3601 string or one format (no comma is included), 'textauto' is reset,
3602 otherwise 'textauto' is set.
3603 NOTE: This option is set to the Vi default value when 'compatible' is
3604 set and to the Vim default value when 'compatible' is reset.
3605
Bram Moolenaarbf884932013-04-05 22:26:15 +02003606 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3607'fileignorecase' 'fic' boolean (default on for systems where case in file
3608 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003609 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003610 When set case is ignored when using file names and directories.
3611 See 'wildignorecase' for only ignoring case when doing completion.
3612
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 *'filetype'* *'ft'*
3614'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003615 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 When this option is set, the FileType autocommand event is triggered.
3617 All autocommands that match with the value of this option will be
3618 executed. Thus the value of 'filetype' is used in place of the file
3619 name.
3620 Otherwise this option does not always reflect the current file type.
3621 This option is normally set when the file type is detected. To enable
3622 this use the ":filetype on" command. |:filetype|
3623 Setting this option to a different value is most useful in a modeline,
3624 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003625 Example, for in an IDL file:
3626 /* vim: set filetype=idl : */ ~
3627 |FileType| |filetypes|
3628 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003629 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003630 /* vim: set filetype=c.doxygen : */ ~
3631 This will use the "c" filetype first, then the "doxygen" filetype.
3632 This works both for filetype plugins and for syntax files. More than
3633 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 This option is not copied to another buffer, independent of the 's' or
3635 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003636 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
3638 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003639'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003640 global or local to window |global-local|
glepnirb8762042025-04-07 20:57:14 +02003641 Characters to fill the statuslines, vertical separators, special
3642 lines in the window and truncated text in the |ins-completion-menu|.
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003643 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003644 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003646 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003647 stl ' ' statusline of the current window
3648 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003649 vert '|' vertical separators |:vsplit|
3650 fold '-' filling 'foldtext'
3651 foldopen '-' mark the beginning of a fold
3652 foldclose '+' show a closed fold
3653 foldsep '|' open fold middle character
3654 diff '-' deleted lines of the 'diff' option
3655 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003656 lastline '@' 'display' contains lastline/truncate
glepnirb8762042025-04-07 20:57:14 +02003657 trunc '>' truncated text in the
3658 |ins-completion-menu|.
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02003659 truncrl '<' same as "trunc" in 'rightleft' mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003661 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662
3663 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003664 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3665<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003666 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3667 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003668 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003669
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003671 item name highlight group ~
3672 stl StatusLine |hl-StatusLine|
3673 stlnc StatusLineNC |hl-StatusLineNC|
3674 vert VertSplit |hl-VertSplit|
3675 fold Folded |hl-Folded|
glepnirb8762042025-04-07 20:57:14 +02003676 foldopen FoldColumn |hl-FoldColumn|
3677 foldclose FoldColumn |hl-FoldColumn|
3678 foldsep FoldColumn |hl-FoldColumn|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003679 diff DiffDelete |hl-DiffDelete|
3680 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003681 lastline NonText |hl-NonText|
glepnirb8762042025-04-07 20:57:14 +02003682 trunc one of the many Popup menu highlighting groups like
3683 |hl-PmenuSel|
glepnird4dbf822025-04-12 18:35:34 +02003684 truncrl same as "trunc"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003686 *'findfunc'* *'ffu'* *E1514*
3687'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003688 global or local to buffer |global-local|
3689 {not available when compiled without the |+eval|
3690 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003691 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003692 command. When this option is empty, the internal |file-searching|
3693 mechanism is used.
3694
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003695 The value can be the name of a function, a |lambda| or a |Funcref|.
3696 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003697
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003698 The function is called with two arguments. The first argument is a
3699 |String| and is the |:find| command argument. The second argument is
3700 a |Boolean| and is set to |v:true| when the function is called to get
3701 a List of command-line completion matches for the |:find| command.
3702 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003703
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003704 The function is called only once per |:find| command invocation.
3705 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003706
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003707 If a match is found, the function should return a |List| containing
3708 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003709 should return an empty List.
3710
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003711 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003712 empty List is used as the return value.
3713
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003714 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003715 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003716
3717 This option cannot be set from a |modeline| or in the |sandbox|, for
3718 security reasons.
3719
3720 Examples:
3721>
3722 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003723 func FindFuncGlob(cmdarg, cmdcomplete)
3724 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003725 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003726 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003727 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003728
3729 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003730 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003731 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003732 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003733 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003734 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003735<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003736 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3737'fixendofline' 'fixeol' boolean (default on)
3738 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003739 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003740 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003741 preserve the situation from the original file.
3742 When the 'binary' option is set the value of this option doesn't
3743 matter.
3744 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003745 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003746
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003748'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 {only available when compiled with the |+rightleft|
3751 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003752 This option was for using Farsi, which has been removed. See
3753 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754
3755 *'foldclose'* *'fcl'*
3756'foldclose' 'fcl' string (default "")
3757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 {not available when compiled without the |+folding|
3759 feature}
3760 When set to "all", a fold is closed when the cursor isn't in it and
3761 its level is higher than 'foldlevel'. Useful if you want folds to
3762 automatically close when moving out of them.
3763
3764 *'foldcolumn'* *'fdc'*
3765'foldcolumn' 'fdc' number (default 0)
3766 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 {not available when compiled without the |+folding|
3768 feature}
3769 When non-zero, a column with the specified width is shown at the side
3770 of the window which indicates open and closed folds. The maximum
3771 value is 12.
3772 See |folding|.
3773
3774 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3775'foldenable' 'fen' boolean (default on)
3776 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 {not available when compiled without the |+folding|
3778 feature}
3779 When off, all folds are open. This option can be used to quickly
3780 switch between showing all text unfolded and viewing the text with
3781 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003782 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 'foldenable' is off.
3784 This option is set by commands that create a new fold or close a fold.
3785 See |folding|.
3786
3787 *'foldexpr'* *'fde'*
3788'foldexpr' 'fde' string (default: "0")
3789 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003791 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003793 for each line to obtain its fold level. The context is set to the
3794 script where 'foldexpr' was set, script-local items can be accessed.
3795 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003796
Bram Moolenaar30b65812012-07-12 22:01:11 +02003797 The expression will be evaluated in the |sandbox| if set from a
3798 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003799 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003800 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003801
3802 It is not allowed to change text or jump to another window while
3803 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804
3805 *'foldignore'* *'fdi'*
3806'foldignore' 'fdi' string (default: "#")
3807 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 {not available when compiled without the |+folding|
3809 feature}
3810 Used only when 'foldmethod' is "indent". Lines starting with
3811 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003812 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 The default "#" works well for C programs. See |fold-indent|.
3814
3815 *'foldlevel'* *'fdl'*
3816'foldlevel' 'fdl' number (default: 0)
3817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 {not available when compiled without the |+folding|
3819 feature}
3820 Sets the fold level: Folds with a higher level will be closed.
3821 Setting this option to zero will close all folds. Higher numbers will
3822 close fewer folds.
3823 This option is set by commands like |zm|, |zM| and |zR|.
3824 See |fold-foldlevel|.
3825
3826 *'foldlevelstart'* *'fdls'*
3827'foldlevelstart' 'fdls' number (default: -1)
3828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 {not available when compiled without the |+folding|
3830 feature}
3831 Sets 'foldlevel' when starting to edit another buffer in a window.
3832 Useful to always start editing with all folds closed (value zero),
3833 some folds closed (one) or no folds closed (99).
3834 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003835 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 ignores this option and closes all folds.
3837 It is also done before BufReadPre autocommands, to allow an autocmd to
3838 overrule the 'foldlevel' value for specific files.
3839 When the value is negative, it is not used.
3840
3841 *'foldmarker'* *'fmr'* *E536*
3842'foldmarker' 'fmr' string (default: "{{{,}}}")
3843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 {not available when compiled without the |+folding|
3845 feature}
3846 The start and end marker used when 'foldmethod' is "marker". There
3847 must be one comma, which separates the start and end marker. The
3848 marker is a literal string (a regular expression would be too slow).
3849 See |fold-marker|.
3850
3851 *'foldmethod'* *'fdm'*
3852'foldmethod' 'fdm' string (default: "manual")
3853 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 {not available when compiled without the |+folding|
3855 feature}
3856 The kind of folding used for the current window. Possible values:
3857 |fold-manual| manual Folds are created manually.
3858 |fold-indent| indent Lines with equal indent form a fold.
3859 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3860 |fold-marker| marker Markers are used to specify folds.
3861 |fold-syntax| syntax Syntax highlighting items specify folds.
3862 |fold-diff| diff Fold text that is not changed.
3863
3864 *'foldminlines'* *'fml'*
3865'foldminlines' 'fml' number (default: 1)
3866 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 {not available when compiled without the |+folding|
3868 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003869 Sets the number of screen lines above which a fold can be displayed
3870 closed. Also for manually closed folds. With the default value of
3871 one a fold can only be closed if it takes up two or more screen lines.
3872 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003873 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 "zc" to close a fold, which is displayed open because it's smaller
3875 than 'foldminlines', a following "zc" may close a containing fold.
3876
3877 *'foldnestmax'* *'fdn'*
3878'foldnestmax' 'fdn' number (default: 20)
3879 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 {not available when compiled without the |+folding|
3881 feature}
3882 Sets the maximum nesting of folds for the "indent" and "syntax"
3883 methods. This avoids that too many folds will be created. Using more
3884 than 20 doesn't work, because the internal limit is 20.
3885
3886 *'foldopen'* *'fdo'*
3887'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3888 search,tag,undo")
3889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 {not available when compiled without the |+folding|
3891 feature}
3892 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003893 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003895 NOTE: When the command is part of a mapping this option is not used.
3896 Add the |zv| command to the mapping to get the same effect.
3897 (rationale: the mapping may want to control opening folds itself)
3898
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 item commands ~
3900 all any
3901 block "(", "{", "[[", "[{", etc.
3902 hor horizontal movements: "l", "w", "fx", etc.
3903 insert any command in Insert mode
3904 jump far jumps: "G", "gg", etc.
3905 mark jumping to a mark: "'m", CTRL-O, etc.
3906 percent "%"
3907 quickfix ":cn", ":crew", ":make", etc.
3908 search search for a pattern: "/", "n", "*", "gd", etc.
3909 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003910 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 tag jumping to a tag: ":ta", CTRL-T, etc.
3912 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 When a movement command is used for an operator (e.g., "dl" or "y%")
3914 this option is not used. This means the operator will include the
3915 whole closed fold.
3916 Note that vertical movements are not here, because it would make it
3917 very difficult to move onto a closed fold.
3918 In insert mode the folds containing the cursor will always be open
3919 when text is inserted.
3920 To close folds you can re-apply 'foldlevel' with the |zx| command or
3921 set the 'foldclose' option to "all".
3922
3923 *'foldtext'* *'fdt'*
3924'foldtext' 'fdt' string (default: "foldtext()")
3925 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 {not available when compiled without the |+folding|
3927 feature}
3928 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003929 fold. The context is set to the script where 'foldexpr' was set,
3930 script-local items can be accessed. See |fold-foldtext| for the
3931 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932
Bram Moolenaar30b65812012-07-12 22:01:11 +02003933 The expression will be evaluated in the |sandbox| if set from a
3934 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003935 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003936
3937 It is not allowed to change text or jump to another window while
3938 evaluating 'foldtext' |textlock|.
3939
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003940 *'formatexpr'* *'fex'*
3941'formatexpr' 'fex' string (default "")
3942 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003943 {not available when compiled without the |+eval|
3944 feature}
3945 Expression which is evaluated to format a range of lines for the |gq|
3946 operator or automatic formatting (see 'formatoptions'). When this
3947 option is empty 'formatprg' is used.
3948
3949 The |v:lnum| variable holds the first line to be formatted.
3950 The |v:count| variable holds the number of lines to be formatted.
3951 The |v:char| variable holds the character that is going to be
3952 inserted if the expression is being evaluated due to
3953 automatic formatting. This can be empty. Don't insert
3954 it yet!
3955
3956 Example: >
3957 :set formatexpr=mylang#Format()
3958< This will invoke the mylang#Format() function in the
3959 autoload/mylang.vim file in 'runtimepath'. |autoload|
3960
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003961 The advantage of using a function call without arguments is that it is
3962 faster, see |expr-option-function|.
3963
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003964 The expression is also evaluated when 'textwidth' is set and adding
3965 text beyond that limit. This happens under the same conditions as
3966 when internal formatting is used. Make sure the cursor is kept in the
3967 same spot relative to the text then! The |mode()| function will
3968 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003969
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003970 When the expression evaluates to non-zero Vim will fall back to using
3971 the internal format mechanism.
3972
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003973 If the expression starts with s: or |<SID>|, then it is replaced with
3974 the script ID (|local-function|). Example: >
3975 set formatexpr=s:MyFormatExpr()
3976 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003977< Otherwise, the expression is evaluated in the context of the script
3978 where the option was set, thus script-local items are available.
3979
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003980 The expression will be evaluated in the |sandbox| when set from a
3981 modeline, see |sandbox-option|. That stops the option from working,
3982 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003983 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003984 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003985
Bram Moolenaar86b68352004-12-27 21:59:20 +00003986 *'formatlistpat'* *'flp'*
3987'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3988 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003989 A pattern that is used to recognize a list header. This is used for
3990 the "n" flag in 'formatoptions'.
3991 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003992 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003993 while still checking more characters. There must be a character
3994 following the pattern, when it matches the whole line it is handled
3995 like there is no match.
3996 The default recognizes a number, followed by an optional punctuation
3997 character and white space.
3998
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003999 *'formatoptions'* *'fo'*
4000'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
4001 local to buffer
4002 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01004003 formatting is to be done.
4004 See |fo-table| for possible values and |gq| for how to format text.
4005 When the 'paste' option is on, no formatting is done (like
4006 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004007 To avoid problems with flags that are added in the future, use the
4008 "+=" and "-=" feature of ":set" |add-option-flags|.
4009 NOTE: This option is set to the Vi default value when 'compatible' is
4010 set and to the Vim default value when 'compatible' is reset.
4011
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 *'formatprg'* *'fp'*
4013'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01004014 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004016 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00004018 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004019 If the 'formatexpr' option is not empty it will be used instead.
4020 Otherwise, if 'formatprg' option is an empty string, the internal
4021 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00004022 Environment variables are expanded |:set_env|. See |option-backslash|
4023 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004024 This option cannot be set from a |modeline| or in the |sandbox|, for
4025 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026
Bram Moolenaard94464e2015-11-02 15:28:18 +01004027 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004028'fsync' 'fs' boolean (default on)
4029 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004030 When on, the library function fsync() will be called after writing a
4031 file. This will flush a file to disk, ensuring that it is safely
4032 written even on filesystems which do metadata-only journaling. This
4033 will force the harddrive to spin up on Linux systems running in laptop
4034 mode, so it may be undesirable in some situations. Be warned that
4035 turning this off increases the chances of data loss after a crash. On
4036 systems without an fsync() implementation, this variable is always
4037 off.
4038 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01004039 'fsync' also applies to |writefile()| (unless a flag is used to
4040 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02004041 This option cannot be set from a |modeline| or in the |sandbox|, for
4042 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004043
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
4045'gdefault' 'gd' boolean (default off)
4046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 When on, the ":substitute" flag 'g' is default on. This means that
4048 all matches in a line are substituted instead of one. When a 'g' flag
4049 is given to a ":substitute" command, this will toggle the substitution
4050 of all or one match. See |complex-change|.
4051
4052 command 'gdefault' on 'gdefault' off ~
4053 :s/// subst. all subst. one
4054 :s///g subst. one subst. all
4055 :s///gg subst. all subst. one
4056
4057 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01004058 Setting this option may break plugins that rely on the default
4059 behavior of the 'g' flag. This will also make the 'g' flag have the
4060 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004061 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062
4063 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02004064'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 Format to recognize for the ":grep" command output.
4067 This is a scanf-like string that uses the same format as the
4068 'errorformat' option: see |errorformat|.
4069
4070 *'grepprg'* *'gp'*
4071'grepprg' 'gp' string (default "grep -n ",
4072 Unix: "grep -n $* /dev/null",
4073 Win32: "findstr /n" or "grep -n",
4074 VMS: "SEARCH/NUMBERS ")
4075 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004076 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 and '#' characters, which are expanded like when used in a command-
4078 line. The placeholder "$*" is allowed to specify where the arguments
4079 will be included. Environment variables are expanded |:set_env|. See
4080 |option-backslash| about including spaces and backslashes.
4081 When your "grep" accepts the "-H" argument, use this to make ":grep"
4082 also work well with a single file: >
4083 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004084< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004085 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4086 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004087 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 apply equally to 'grepprg'.
4089 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4090 otherwise it's "grep -n".
4091 This option cannot be set from a |modeline| or in the |sandbox|, for
4092 security reasons.
4093
4094 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4095'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4096 ve:ver35-Cursor,
4097 o:hor50-Cursor,
4098 i-ci:ver25-Cursor/lCursor,
4099 r-cr:hor20-Cursor/lCursor,
4100 sm:block-Cursor
4101 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004102 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 "n-v-c:block,o:hor50,i-ci:hor15,
4104 r-cr:hor30,sm:block")
4105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004107 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004109 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004110 height of the cursor can be changed. This can be done by specifying a
4111 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004112 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4113 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004115 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 mode-list and an argument-list:
4117 mode-list:argument-list,mode-list:argument-list,..
4118 The mode-list is a dash separated list of these modes:
4119 n Normal mode
4120 v Visual mode
4121 ve Visual mode with 'selection' "exclusive" (same as 'v',
4122 if not specified)
4123 o Operator-pending mode
4124 i Insert mode
4125 r Replace mode
4126 c Command-line Normal (append) mode
4127 ci Command-line Insert mode
4128 cr Command-line Replace mode
4129 sm showmatch in Insert mode
4130 a all modes
4131 The argument-list is a dash separated list of these arguments:
4132 hor{N} horizontal bar, {N} percent of the character height
4133 ver{N} vertical bar, {N} percent of the character width
4134 block block cursor, fills the whole character
4135 [only one of the above three should be present]
4136 blinkwait{N} *cursor-blinking*
4137 blinkon{N}
4138 blinkoff{N}
4139 blink times for cursor: blinkwait is the delay before
4140 the cursor starts blinking, blinkon is the time that
4141 the cursor is shown and blinkoff is the time that the
4142 cursor is not shown. The times are in msec. When one
4143 of the numbers is zero, there is no blinking. The
4144 default is: "blinkwait700-blinkon400-blinkoff250".
4145 These numbers are used for a missing entry. This
4146 means that blinking is enabled by default. To switch
4147 blinking off you can use "blinkon0". The cursor only
4148 blinks when Vim is waiting for input, not while
4149 executing a command.
4150 To make the cursor blink in an xterm, see
4151 |xterm-blink|.
4152 {group-name}
4153 a highlight group name, that sets the color and font
4154 for the cursor
4155 {group-name}/{group-name}
4156 Two highlight group names, the first is used when
4157 no language mappings are used, the other when they
4158 are. |language-mapping|
4159
4160 Examples of parts:
4161 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4162 block cursor with colors from the "nCursor"
4163 highlight group
4164 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4165 In Insert and Command-line Insert mode, use a
4166 30% vertical bar cursor with colors from the
4167 "iCursor" highlight group. Blink a bit
4168 faster.
4169
4170 The 'a' mode is different. It will set the given argument-list for
4171 all modes. It does not reset anything to defaults. This can be used
4172 to do a common setting for all modes. For example, to switch off
4173 blinking: "a:blinkon0"
4174
4175 Examples of cursor highlighting: >
4176 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4177 :highlight Cursor gui=NONE guifg=bg guibg=fg
4178<
4179 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004180 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181'guifont' 'gfn' string (default "")
4182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 {only available when compiled with GUI enabled}
4184 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004185 In its simplest form the value is just one font name.
4186 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187
4188 *'guifontset'* *'gfs'*
4189 *E250* *E252* *E234* *E597* *E598*
4190'guifontset' 'gfs' string (default "")
4191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 {only available when compiled with GUI enabled and
4193 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004194 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 When not empty, specifies two (or more) fonts to be used. The first
4196 one for normal English, the second one for your special language. See
4197 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004198
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4200'guifontwide' 'gfw' string (default "")
4201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 {only available when compiled with GUI enabled}
4203 When not empty, specifies a comma-separated list of fonts to be used
4204 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004205 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004206
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 *'guiheadroom'* *'ghr'*
4208'guiheadroom' 'ghr' number (default 50)
4209 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004210 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 The number of pixels subtracted from the screen height when fitting
4212 the GUI window on the screen. Set this before the GUI is started,
4213 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004214 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 lines will be left for window decorations and other items on the
4216 screen. Set it to a negative value to allow windows taller than the
4217 screen.
4218
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004219 *'guiligatures'* *'gli'* *E1243*
4220'guiligatures' 'gli' string (default "")
4221 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004222 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004223 List of ASCII characters that, when combined together, can create more
4224 complex shapes. Each character must be a printable ASCII character
4225 with a value in the 32-127 range.
4226 Example: >
4227 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4228< Changing this option updates screen output immediately. Set it to an
4229 empty string to disable ligatures.
4230
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004232'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4233 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004234 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004235 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004238 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 sequence of letters which describes what components and options of the
4240 GUI should be used.
4241 To avoid problems with flags that are added in the future, use the
4242 "+=" and "-=" feature of ":set" |add-option-flags|.
4243
Bram Moolenaar13568252018-03-16 20:46:58 +01004244 Valid characters are as follows:
4245 *'go-!'*
4246 '!' External commands are executed in a terminal window. Without
4247 this flag the MS-Windows GUI will open a console window to
4248 execute the command. The Unix GUI will simulate a dumb
4249 terminal to list the command output.
4250 The terminal window will be positioned at the bottom, and grow
4251 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004252 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 'a' Autoselect: If present, then whenever VISUAL mode is started,
4254 or the Visual area extended, Vim tries to become the owner of
4255 the windowing system's global selection. This means that the
4256 Visually highlighted text is available for pasting into other
4257 applications as well as into Vim itself. When the Visual mode
4258 ends, possibly due to an operation on the text, or when an
4259 application wants to paste the selection, the highlighted text
4260 is automatically yanked into the "* selection register.
4261 Thus the selection is still available for pasting into other
4262 applications after the VISUAL mode has ended.
4263 If not present, then Vim won't become the owner of the
4264 windowing system's global selection unless explicitly told to
4265 by a yank or delete operation for the "* register.
4266 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004267 *'go-P'*
4268 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004269 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004270 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004271 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 applies to the modeless selection.
4273
4274 'guioptions' autoselect Visual autoselect modeless ~
4275 "" - -
4276 "a" yes yes
4277 "A" - yes
4278 "aA" yes yes
4279
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004280 When using a terminal see the 'clipboard' option.
4281
Bram Moolenaar02467872007-05-06 13:22:01 +00004282 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 'c' Use console dialogs instead of popup dialogs for simple
4284 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004285 *'go-d'*
4286 'd' Use dark theme variant if available. Currently only works for
4287 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004288 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004289 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004290 'guitablabel' can be used to change the text in the labels.
4291 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004292 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004293 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004294 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 'f' Foreground: Don't use fork() to detach the GUI from the shell
4296 where it was started. Use this for programs that wait for the
4297 editor to finish (e.g., an e-mail program). Alternatively you
4298 can use "gvim -f" or ":gui -f" to start the GUI in the
4299 foreground. |gui-fork|
4300 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004301 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004302 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4304 corner of the window. It's black&white on non-GTK, because of
4305 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004306 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004308 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004309 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004311 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004313 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004314 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 'g' Grey menu items: Make menu items that are not active grey. If
4316 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004317 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 't' Include tearoff menu items. Currently only works for Win32,
4319 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004320 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004321 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4322 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004323 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004325 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 'R' Right-hand scrollbar is present when there is a vertically
4327 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004328 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004330 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 'L' Left-hand scrollbar is present when there is a vertically
4332 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004333 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4335 the longest visible line, or on the cursor line if the 'h'
4336 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004337 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 'h' Limit horizontal scrollbar size to the length of the cursor
4339 line. Reduces computations. |gui-horiz-scroll|
4340
4341 And yes, you may even have scrollbars on the left AND the right if
4342 you really want to :-). See |gui-scrollbars| for more information.
4343
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004344 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 'v' Use a vertical button layout for dialogs. When not included,
4346 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004347 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004348 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 'p' Use Pointer callbacks for X11 GUI. This is required for some
4350 window managers. If the cursor is not blinking or hollow at
4351 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004352 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004354 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004355 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004356 *'go-k'*
4357 'k' Keep the GUI window size when adding/removing a scrollbar, or
4358 toolbar, tabline, etc. Instead, the behavior is similar to
4359 when the window is maximized and will adjust 'lines' and
4360 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004361 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004362 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004363
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 *'guipty'* *'noguipty'*
4365'guipty' boolean (default on)
4366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 {only available when compiled with GUI enabled}
4368 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4369 I/O to/from shell commands. See |gui-pty|.
4370
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004371 *'guitablabel'* *'gtl'*
4372'guitablabel' 'gtl' string (default empty)
4373 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004374 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004375 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004376 pages line. When empty and when the result is empty Vim will use a
4377 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004378
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004379 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004380 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004381 The expression will be evaluated in the |sandbox| when set from a
4382 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004383 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004384
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004385 Only used when the GUI tab pages line is displayed. 'e' must be
4386 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4387 used.
4388
Bram Moolenaar57657d82006-04-21 22:12:41 +00004389 *'guitabtooltip'* *'gtt'*
4390'guitabtooltip' 'gtt' string (default empty)
4391 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004392 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004393 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004394 pages line. When empty Vim will use a default tooltip.
4395 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004396 You can include a line break. Simplest method is to use |:let|: >
4397 :let &guitabtooltip = "line one\nline two"
4398<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004399
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004401'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 (others) "$VIMRUNTIME/doc/help.txt")
4403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 Name of the main help file. All distributed help files should be
4405 placed together in one directory. Additionally, all "doc" directories
4406 in 'runtimepath' will be used.
4407 Environment variables are expanded |:set_env|. For example:
4408 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 spaces and backslashes.
4411 This option cannot be set from a |modeline| or in the |sandbox|, for
4412 security reasons.
4413
4414 *'helpheight'* *'hh'*
4415'helpheight' 'hh' number (default 20)
4416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 Minimal initial height of the help window when it is opened with the
4418 ":help" command. The initial height of the help window is half of the
4419 current window, or (when the 'ea' option is on) the same as other
4420 windows. When the height is less than 'helpheight', the height is
4421 set to 'helpheight'. Set to zero to disable.
4422
4423 *'helplang'* *'hlg'*
4424'helplang' 'hlg' string (default: messages language or empty)
4425 global
4426 {only available when compiled with the |+multi_lang|
4427 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004428 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 for which the desired help can be found. The English help will always
4430 be used as a last resort. You can add "en" to prefer English over
4431 another language, but that will only find tags that exist in that
4432 language and not in the English help.
4433 Example: >
4434 :set helplang=de,it
4435< This will first search German, then Italian and finally English help
4436 files.
4437 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4438 try to find the tag in the current language before using this option.
4439 See |help-translated|.
4440
4441 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4442'hidden' 'hid' boolean (default off)
4443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 When off a buffer is unloaded when it is |abandon|ed. When on a
4445 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4446 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004447
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004449 hidden even if the 'hidden' option is off when these three are true:
4450 - the buffer is modified
4451 - 'autowrite' is off or writing is not possible
4452 - the '!' flag was used
4453 Also see |windows.txt|.
4454
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004455 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 This option is set for one command with ":hide {command}" |:hide|.
4457 WARNING: It's easy to forget that you have changes in hidden buffers.
4458 Think twice when using ":q!" or ":qa!".
4459
4460 *'highlight'* *'hl'*
4461'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004462 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4463 d:Directory,e:ErrorMsg,i:IncSearch,
4464 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004465 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004466 N:CursorLineNr,r:Question,s:StatusLine,
4467 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004468 v:Visual,V:VisualNOS,w:WarningMsg,
4469 W:WildMenu,f:Folded,F:FoldColumn,
4470 A:DiffAdd,C:DiffChange,D:DiffDelete,
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004471 T:DiffText,E:DiffTextAdd,>:SignColumn,
4472 -:Conceal,B:SpellBad,P:SpellCap,
4473 R:SpellRare, L:SpellLocal,+:Pmenu,
4474 =:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004475 [:PmenuKind,]:PmenuKindSel,
4476 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004477 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4478 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004479 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004480 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004481 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004484 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004486 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004488 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4489 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 characters from 'showbreak'
4491 |hl-Directory| d directories in CTRL-D listing and other special
4492 things in listings
4493 |hl-ErrorMsg| e error messages
4494 h (obsolete, ignored)
4495 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004496 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4498 |hl-MoreMsg| m |more-prompt|
4499 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004500 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004501 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004502 |hl-LineNr| n line number for ":number" and ":#" commands, and
4503 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004504 |hl-LineNrAbove| a line number above the cursor for when the
4505 'relativenumber' option is set.
4506 |hl-LineNrBelow| b line number below the cursor for when the
4507 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004508 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4509 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 |hl-Question| r |hit-enter| prompt and yes/no questions
4511 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004512 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4514 |hl-VertSplit| c column used to separate vertically split windows
4515 |hl-Visual| v Visual mode
4516 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4517 Selection" Only X11 Gui's |gui-x11| and
4518 |xterm-clipboard|.
4519 |hl-WarningMsg| w warning messages
4520 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4521 |hl-Folded| f line used for closed folds
4522 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004523 |hl-DiffAdd| A added line in diff mode
4524 |hl-DiffChange| C changed line in diff mode
4525 |hl-DiffDelete| D deleted line in diff mode
Yee Cheng Chin9943d472025-03-26 19:41:02 +01004526 |hl-DiffText| T changed text in diff mode
4527 |hl-DiffTextAdd| E inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004529 |hl-Conceal| - the placeholders used for concealed characters
4530 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004531 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004532 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004533 |hl-SpellRare| R rare word |spell|
4534 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004535 |hl-Pmenu| + popup menu normal line
4536 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004537 |hl-PmenuKind| [ popup menu "kind" normal line
4538 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004539 |hl-PmenuExtra| { popup menu "extra" normal line
4540 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004541 |hl-PmenuSbar| x popup menu scrollbar
4542 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004543 |hl-PmenuMatch| k popup menu matched text
4544 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545
4546 The display modes are:
4547 r reverse (termcap entry "mr" and "me")
4548 i italic (termcap entry "ZH" and "ZR")
4549 b bold (termcap entry "md" and "me")
4550 s standout (termcap entry "so" and "se")
4551 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004552 c undercurl (termcap entry "Us" and "Ce")
4553 2 double underline (termcap entry "Ds" and "Ce")
4554 d dotted underline (termcap entry "ds" and "Ce")
4555 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004556 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 n no highlighting
4558 - no highlighting
4559 : use a highlight group
4560 The default is used for occasions that are not included.
4561 If you want to change what the display modes do, see |dos-colors|
4562 for an example.
4563 When using the ':' display mode, this must be followed by the name of
4564 a highlight group. A highlight group can be used to define any type
4565 of highlighting, including using color. See |:highlight| on how to
4566 define one. The default uses a different group for each occasion.
4567 See |highlight-default| for the default highlight groups.
4568
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004570'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004573 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004574 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004575 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004576 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 NOTE: This option is set to the Vi default value when 'compatible' is
4578 set and to the Vim default value when 'compatible' is reset.
4579
4580 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4581'hkmap' 'hk' boolean (default off)
4582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 {only available when compiled with the |+rightleft|
4584 feature}
4585 When on, the keyboard is mapped for the Hebrew character set.
4586 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4587 toggle this option. See |rileft.txt|.
4588 NOTE: This option is reset when 'compatible' is set.
4589
4590 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4591'hkmapp' 'hkp' boolean (default off)
4592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 {only available when compiled with the |+rightleft|
4594 feature}
4595 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4596 This is useful if you have a non-Hebrew keyboard.
4597 See |rileft.txt|.
4598 NOTE: This option is reset when 'compatible' is set.
4599
Bram Moolenaar036986f2017-03-16 17:41:02 +01004600 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4601'hlsearch' 'hls' boolean (default off)
4602 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004603 {not available when compiled without the
4604 |+extra_search| feature}
4605 When there is a previous search pattern, highlight all its matches.
4606 The type of highlighting used can be set with the 'l' occasion in the
4607 'highlight' option. This uses the "Search" highlight group by
4608 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004609 are not applied. If the "CurSearch" highlight group is set then the
4610 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004611 See also: 'incsearch' and |:match|.
4612 When you get bored looking at the highlighted matches, you can turn it
4613 off with |:nohlsearch|. This does not change the option value, as
4614 soon as you use a search command, the highlighting comes back.
4615 'redrawtime' specifies the maximum time spent on finding matches.
4616 When the search pattern can match an end-of-line, Vim will try to
4617 highlight all of the matched text. However, this depends on where the
4618 search starts. This will be the first line in the window or the first
4619 line below a closed fold. A match in a previous line which is not
4620 drawn may not continue in a newly drawn line.
4621 You can specify whether the highlight status is restored on startup
4622 with the 'h' flag in 'viminfo' |viminfo-h|.
4623 NOTE: This option is reset when 'compatible' is set.
4624
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 *'icon'* *'noicon'*
4626'icon' boolean (default off, on when title can be restored)
4627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 When on, the icon text of the window will be set to the value of
4629 'iconstring' (if it is not empty), or to the name of the file
4630 currently being edited. Only the last part of the name is used.
4631 Overridden by the 'iconstring' option.
4632 Only works if the terminal supports setting window icons (currently
4633 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4634 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4635 builtin termcap).
4636 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004637 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004639 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640
4641 *'iconstring'*
4642'iconstring' string (default "")
4643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 When this option is not empty, it will be used for the icon text of
4645 the window. This happens only when the 'icon' option is on.
4646 Only works if the terminal supports setting window icon text
4647 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004648 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 When Vim was compiled with HAVE_X11 defined, the original icon will be
4650 restored if possible |X11|.
4651 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004652 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004654 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 {not available when compiled without the |+statusline| feature}
4656
4657 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4658'ignorecase' 'ic' boolean (default off)
4659 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004660 Ignore case in search patterns, |cmdline-completion|, when
4661 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004662 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 Can be overruled by using "\c" or "\C" in the pattern, see
4664 |/ignorecase|.
4665
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004666 *'imactivatefunc'* *'imaf'*
4667'imactivatefunc' 'imaf' string (default "")
4668 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004669 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004670 activate or deactivate the Input Method. The value can be the name of
4671 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4672 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004673 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004674 The expression will be evaluated in the |sandbox| when set from a
4675 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004676
4677 Example: >
4678 function ImActivateFunc(active)
4679 if a:active
4680 ... do something
4681 else
4682 ... do something
4683 endif
4684 " return value is not used
4685 endfunction
4686 set imactivatefunc=ImActivateFunc
4687<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 *'imactivatekey'* *'imak'*
4689'imactivatekey' 'imak' string (default "")
4690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004692 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 Specifies the key that your Input Method in X-Windows uses for
4694 activation. When this is specified correctly, vim can fully control
4695 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4696 You can't use this option to change the activation key, the option
4697 tells Vim what the key is.
4698 Format:
4699 [MODIFIER_FLAG-]KEY_STRING
4700
4701 These characters can be used for MODIFIER_FLAG (case is ignored):
4702 S Shift key
4703 L Lock key
4704 C Control key
4705 1 Mod1 key
4706 2 Mod2 key
4707 3 Mod3 key
4708 4 Mod4 key
4709 5 Mod5 key
4710 Combinations are allowed, for example "S-C-space" or "SC-space" are
4711 both shift+ctrl+space.
4712 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4713
4714 Example: >
4715 :set imactivatekey=S-space
4716< "S-space" means shift+space. This is the activation key for kinput2 +
4717 canna (Japanese), and ami (Korean).
4718
4719 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4720'imcmdline' 'imc' boolean (default off)
4721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 When set the Input Method is always on when starting to edit a command
4723 line, unless entering a search pattern (see 'imsearch' for that).
4724 Setting this option is useful when your input method allows entering
4725 English characters directly, e.g., when it's used to type accented
4726 characters with dead keys.
4727
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004728 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 When set the Input Method is never used. This is useful to disable
4732 the IM when it doesn't work properly.
4733 Currently this option is on by default for SGI/IRIX machines. This
4734 may change in later releases.
4735
4736 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004737'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 Specifies whether :lmap or an Input Method (IM) is to be used in
4740 Insert mode. Valid values:
4741 0 :lmap is off and IM is off
4742 1 :lmap is ON and IM is off
4743 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 To always reset the option to zero when leaving Insert mode with <Esc>
4745 this can be used: >
4746 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4747< This makes :lmap and IM turn off automatically when leaving Insert
4748 mode.
4749 Note that this option changes when using CTRL-^ in Insert mode
4750 |i_CTRL-^|.
4751 The value is set to 1 when setting 'keymap' to a valid keymap name.
4752 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004753 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 methods. Use 'imdisable' to disable XIM then.
4755
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004756 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004757 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004758 |+multi_byte_ime| or |global-ime|.
4759
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004761'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 Specifies whether :lmap or an Input Method (IM) is to be used when
4764 entering a search pattern. Valid values:
4765 -1 the value of 'iminsert' is used, makes it look like
4766 'iminsert' is also used when typing a search pattern
4767 0 :lmap is off and IM is off
4768 1 :lmap is ON and IM is off
4769 2 :lmap is off and IM is ON
4770 Note that this option changes when using CTRL-^ in Command-line mode
4771 |c_CTRL-^|.
4772 The value is set to 1 when it is not -1 and setting the 'keymap'
4773 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004774 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 methods. Use 'imdisable' to disable XIM then.
4776
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004777 *'imstatusfunc'* *'imsf'*
4778'imstatusfunc' 'imsf' string (default "")
4779 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004780 This option specifies a function that is called to obtain the status
4781 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004782 The value can be the name of a function, a |lambda| or a |Funcref|.
4783 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004784 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004785
4786 Example: >
4787 function ImStatusFunc()
4788 let is_active = ...do something
4789 return is_active ? 1 : 0
4790 endfunction
4791 set imstatusfunc=ImStatusFunc
4792<
4793 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004794 The expression will be evaluated in the |sandbox| when set from a
4795 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004796
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004797 *'imstyle'* *'imst'*
4798'imstyle' 'imst' number (default 1)
4799 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004800 {only available when compiled with |+xim| and
4801 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004802 This option specifies the input style of Input Method:
4803 0 use on-the-spot style
4804 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004805 See: |xim-input-style|
4806
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004807 For a long time on-the-spot style had been used in the GTK version of
4808 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004809 |single-repeat|, etc. Therefore over-the-spot style becomes the
4810 default now. This should work fine for most people, however if you
4811 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004812 The expression will be evaluated in the |sandbox| when set from a
4813 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004814
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 *'include'* *'inc'*
4816'include' 'inc' string (default "^\s*#\s*include")
4817 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 {not available when compiled without the
4819 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004820 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 pattern, just like for the "/" command (See |pattern|). The default
4822 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004823 "]I", "[d", etc.
4824 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004825 comes after the matched pattern. But if "\zs" appears in the pattern
4826 then the text matched from "\zs" to the end, or until "\ze" if it
4827 appears, is used as the file name. Use this to include characters
4828 that are not in 'isfname', such as a space. You can then use
4829 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004830 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831
4832 *'includeexpr'* *'inex'*
4833'includeexpr' 'inex' string (default "")
4834 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004836 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004838 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004839 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004841 Note the double backslash: the `:set` command first halves them, then
4842 one remains it the value, where "\." matches a dot literally. For
4843 simple character replacements `tr()` avoids the need for escaping: >
4844 :setlocal includeexpr=tr(v:fname,'.','/')
4845<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004847 found. Allows doing "gf" on the name after an 'include' statement.
Christian Brabandt23984602025-04-19 11:54:08 +02004848 Note: Not used for |<cfile>|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004850 If the expression starts with s: or |<SID>|, then it is replaced with
4851 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004852 setlocal includeexpr=s:MyIncludeExpr()
4853 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004854< Otherwise, the expression is evaluated in the context of the script
4855 where the option was set, thus script-local items are available.
4856
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004857 It is more efficient if the value is just a function call without
4858 arguments, see |expr-option-function|.
4859
Bram Moolenaar30b65812012-07-12 22:01:11 +02004860 The expression will be evaluated in the |sandbox| when set from a
4861 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004862 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004863
4864 It is not allowed to change text or jump to another window while
4865 evaluating 'includeexpr' |textlock|.
4866
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004868'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004869 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004872 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004873 While typing a search command, show where the pattern, as it was typed
4874 so far, matches. The matched string is highlighted. If the pattern
4875 is invalid or not found, nothing is shown. The screen will be updated
4876 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004877 Also applies to the pattern in commands: >
4878 :global
4879 :lvimgrep
4880 :lvimgrepadd
4881 :smagic
4882 :snomagic
4883 :sort
4884 :substitute
4885 :vglobal
4886 :vimgrep
4887 :vimgrepadd
4888< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004889 original position when no match is found and when pressing <Esc>. You
4890 still need to finish the search command with <Enter> to move the
4891 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004892 You can use the CTRL-G and CTRL-T keys to move to the next and
4893 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004894 When compiled with the |+reltime| feature Vim only searches for about
4895 half a second. With a complicated pattern and/or a lot of text the
4896 match may not be found. This is to avoid that Vim hangs while you
4897 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004898 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004899 When 'hlsearch' is on, all matched strings are highlighted too while
4900 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004901 If you don't want to turn 'hlsearch' on, but want to highlight all
4902 matches while searching, you can turn on and off 'hlsearch' with
4903 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004904 augroup vimrc-incsearch-highlight
4905 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004906 autocmd CmdlineEnter /,\? :set hlsearch
4907 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004908 augroup END
4909<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004910 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004911 to the command line. If 'ignorecase' and 'smartcase' are set and the
4912 command line has no uppercase characters, the added character is
4913 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004914 CTRL-R CTRL-W can be used to add the word at the end of the current
4915 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 NOTE: This option is reset when 'compatible' is set.
4917
4918 *'indentexpr'* *'inde'*
4919'indentexpr' 'inde' string (default "")
4920 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004921 {not available when compiled without the |+eval|
4922 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 Expression which is evaluated to obtain the proper indent for a line.
4924 It is used when a new line is created, for the |=| operator and
4925 in Insert mode as specified with the 'indentkeys' option.
4926 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004927 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004928 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 When 'paste' is set this option is not used for indenting.
4930 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004931 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004933
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004934 If the expression starts with s: or |<SID>|, then it is replaced with
4935 the script ID (|local-function|). Example: >
4936 set indentexpr=s:MyIndentExpr()
4937 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004938< Otherwise, the expression is evaluated in the context of the script
4939 where the option was set, thus script-local items are available.
4940
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004941 The advantage of using a function call without arguments is that it is
4942 faster, see |expr-option-function|.
4943
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 The expression must return the number of spaces worth of indent. It
4945 can return "-1" to keep the current indent (this means 'autoindent' is
4946 used for the indent).
4947 Functions useful for computing the indent are |indent()|, |cindent()|
4948 and |lispindent()|.
4949 The evaluation of the expression must not have side effects! It must
4950 not change the text, jump to another window, etc. Afterwards the
4951 cursor position is always restored, thus the cursor may be moved.
4952 Normally this option would be set to call a function: >
4953 :set indentexpr=GetMyIndent()
4954< Error messages will be suppressed, unless the 'debug' option contains
4955 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004956 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004957 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958
Bram Moolenaar30b65812012-07-12 22:01:11 +02004959 The expression will be evaluated in the |sandbox| when set from a
4960 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004961 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004962
4963 It is not allowed to change text or jump to another window while
4964 evaluating 'indentexpr' |textlock|.
4965
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004967'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 A list of keys that, when typed in Insert mode, cause reindenting of
4970 the current line. Only happens if 'indentexpr' isn't empty.
4971 The format is identical to 'cinkeys', see |indentkeys-format|.
4972 See |C-indenting| and |indent-expression|.
4973
4974 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4975'infercase' 'inf' boolean (default off)
4976 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004978 'ignorecase' is also on, the case of the match is adjusted depending
4979 on the typed text. If the typed text contains a lowercase letter
4980 where the match has an upper case letter, the completed part is made
4981 lowercase. If the typed text has no lowercase letters and the match
4982 has a lowercase letter where the typed text has an uppercase letter,
4983 and there is a letter before it, the completed part is made uppercase.
4984 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
glepnirbcd59952025-04-24 21:48:35 +02004986 *'isexpand'* *'ise'*
4987'isexpand' 'ise' string (default: "")
4988 local to buffer
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02004989 Defines characters and patterns for completion in insert mode. Used
4990 by the |complete_match()| function to determine the starting position
4991 for completion. This is a comma-separated list of triggers. Each
4992 trigger can be:
glepnirbcd59952025-04-24 21:48:35 +02004993 - A single character like "." or "/"
4994 - A sequence of characters like "->", "/*", or "/**"
4995
4996 Note: Use "\\," to add a literal comma as trigger character, see
4997 |option-backslash|.
4998
glepnirffc89e42025-04-27 14:59:17 +02004999 Examples: >
5000 set isexpand=.,->,/*,\\,
5001<
5002
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
5004'insertmode' 'im' boolean (default off)
5005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 Makes Vim work in a way that Insert mode is the default mode. Useful
5007 if you want to use Vim as a modeless editor. Used for |evim|.
5008 These Insert mode commands will be useful:
5009 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005010 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 this is a mapping, it is executed as if 'insertmode' was off.
5012 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00005014 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
5015 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
5017 These items change when 'insertmode' is set:
5018 - when starting to edit of a file, Vim goes to Insert mode.
5019 - <Esc> in Insert mode is a no-op and beeps.
5020 - <Esc> in Normal mode makes Vim go to Insert mode.
5021 - CTRL-L in Insert mode is a command, it is not inserted.
5022 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
5023 However, when <Esc> is used inside a mapping, it behaves like
5024 'insertmode' was not set. This was done to be able to use the same
5025 mappings with 'insertmode' set or not set.
5026 When executing commands with |:normal| 'insertmode' is not used.
5027
5028 NOTE: This option is reset when 'compatible' is set.
5029
5030 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005031'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
5033 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
5034 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
5035 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
5036 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
5037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 The characters specified by this option are included in file names and
5039 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005040 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 Multi-byte characters 256 and above are always included, only the
5042 characters up to 255 are specified with this option.
5043 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005044 Think twice before adding white space to this option. Although a
5045 space may appear inside a file name, the effect will be that Vim
5046 doesn't know where a file name starts or ends when doing completion.
5047 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
5049 Note that on systems using a backslash as path separator, Vim tries to
5050 do its best to make it work as you would expect. That is a bit
5051 tricky, since Vi originally used the backslash to escape special
5052 characters. Vim will not remove a backslash in front of a normal file
5053 name character on these systems, but it will on Unix and alikes. The
5054 '&' and '^' are not included by default, because these are special for
5055 cmd.exe.
5056
5057 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005058 Each part can be a single character number or a range. A range is two
5059 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 decimal number between 0 and 255 or the ASCII character itself (does
5061 not work for digits). Example:
5062 "_,-,128-140,#-43" (include '_' and '-' and the range
5063 128 to 140 and '#' to 43)
5064 If a part starts with '^', the following character number or range
5065 will be excluded from the option. The option is interpreted from left
5066 to right. Put the excluded character after the range where it is
5067 included. To include '^' itself use it as the last character of the
5068 option or the end of a range. Example:
5069 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
5070 If the character is '@', all characters where isalpha() returns TRUE
5071 are included. Normally these are the characters a to z and A to Z,
5072 plus accented characters. To include '@' itself use "@-@". Examples:
5073 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00005074 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 "a-z,A-Z,@-@" All letters plus the '@' character.
5076 A comma can be included by using it where a character number is
5077 expected. Example:
5078 "48-57,,,_" Digits, comma and underscore.
5079 A comma can be excluded by prepending a '^'. Example:
5080 " -~,^,,9" All characters from space to '~', excluding
5081 comma, plus <Tab>.
5082 See |option-backslash| about including spaces and backslashes.
5083
5084 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005085'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 "@,48-57,_,128-167,224-235"
5087 otherwise: "@,48-57,_,192-255")
5088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 The characters given by this option are included in identifiers.
5090 Identifiers are used in recognizing environment variables and after a
5091 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00005092 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005093 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005095 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5097
5098 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005099'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 "@,48-57,_,128-167,224-235"
5101 otherwise: "@,48-57,_,192-255"
5102 Vi default: "@,48-57,_")
5103 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005105 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005106 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005107 characters above 255 check the "word" character class (any character
5108 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005109 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 For a help file it is set to all non-blank printable characters except
5111 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5112 command).
5113 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005114 This option also influences syntax highlighting, unless the syntax
5115 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 NOTE: This option is set to the Vi default value when 'compatible' is
5117 set and to the Vim default value when 'compatible' is reset.
5118
5119 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005120'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 "@,~-255"; otherwise: "@,161-255")
5122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 The characters given by this option are displayed directly on the
5124 screen. It is also used for "\p" in a |pattern|. The characters from
5125 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5126 even when they are not included in 'isprint' or excluded. See
5127 'isfname' for a description of the format of this option.
5128
5129 Non-printable characters are displayed with two characters:
5130 0 - 31 "^@" - "^_"
5131 32 - 126 always single characters
5132 127 "^?"
5133 128 - 159 "~@" - "~_"
5134 160 - 254 "| " - "|~"
5135 255 "~?"
5136 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5137 displayed as <xx>, with the hexadecimal value of the byte.
5138 When 'display' contains "uhex" all unprintable characters are
5139 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005140 The SpecialKey highlighting will be used for unprintable characters.
5141 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
5143 Multi-byte characters 256 and above are always included, only the
5144 characters up to 255 are specified with this option. When a character
5145 is printable but it is not available in the current font, a
5146 replacement character will be shown.
5147 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5148 There is no option to specify these characters.
5149
5150 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5151'joinspaces' 'js' boolean (default on)
5152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 Insert two spaces after a '.', '?' and '!' with a join command.
5154 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5155 Otherwise only one space is inserted.
5156 NOTE: This option is set when 'compatible' is set.
5157
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005158 *'jumpoptions'* *'jop'*
5159'jumpoptions' 'jop' string (default "")
5160 global
5161 List of words that change the behavior of the |jumplist|.
5162 stack Make the jumplist behave like the tagstack.
5163 Relative location of entries in the jumplist is
5164 preserved at the cost of discarding subsequent entries
5165 when navigating backwards in the jumplist and then
5166 jumping to a location. |jumplist-stack|
5167
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 *'key'*
5169'key' string (default "")
5170 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005171 {only available when compiled with the |+cryptv|
5172 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005174 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Careful: Do not set the key value by hand, someone might see the typed
5176 key. Use the |:X| command. But you can make 'key' empty: >
5177 :set key=
5178< It is not possible to get the value of this option with ":set key" or
5179 "echo &key". This is to avoid showing it to someone who shouldn't
5180 know. It also means you cannot see it yourself once you have set it,
5181 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005182 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5183 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005184 You can use "&key" in an expression to detect whether encryption is
5185 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186
5187 *'keymap'* *'kmp'* *E544*
5188'keymap' 'kmp' string (default "")
5189 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 {only available when compiled with the |+keymap|
5191 feature}
5192 Name of a keyboard mapping. See |mbyte-keymap|.
5193 Setting this option to a valid keymap name has the side effect of
5194 setting 'iminsert' to one, so that the keymap becomes effective.
5195 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005196 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197
5198 *'keymodel'* *'km'*
5199'keymodel' 'km' string (default "")
5200 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005201 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 can do. These values can be used:
5203 startsel Using a shifted special key starts selection (either
5204 Select mode or Visual mode, depending on "key" being
5205 present in 'selectmode').
5206 stopsel Using a not-shifted special key stops selection.
5207 Special keys in this context are the cursor keys, <End>, <Home>,
5208 <PageUp> and <PageDown>.
5209 The 'keymodel' option is set by the |:behave| command.
5210
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005211 *'keyprotocol'* *'kpc'*
5212'keyprotocol' 'kpc' string (default: see below)
5213 global
5214 Specifies what keyboard protocol to use depending on the value of
5215 'term'. The supported keyboard protocols names are:
5216 none whatever the terminal uses
5217 mok2 modifyOtherKeys level 2, as supported by xterm
5218 kitty Kitty keyboard protocol, as supported by Kitty
5219
Bram Moolenaara87749e2022-11-30 10:23:17 +00005220 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005221 a pattern that is matched against the 'term' option, a colon and the
5222 protocol name to be used. To illustrate this, the default value would
5223 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005224 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5225 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005226
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005227< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005228 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5229 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005230
5231 The first match is used, thus if you want to have "kitty" use the
5232 kitty protocol, but "badkitty" not, then you should match "badkitty"
5233 first and use the "none" value: >
5234 set keyprotocol=badkitty:none,kitty:kitty
5235<
5236 The option is used after 'term' has been changed. First the termcap
5237 entries are set, possibly using the builtin list, see |builtin-terms|.
5238 Then this option is inspected and if there is a match and a protocol
5239 is specified the following happens:
5240 none Nothing, the regular t_TE and t_TI values remain
5241
5242 mok2 The t_TE value is changed to:
5243 CSI >4;m disables modifyOtherKeys
5244 The t_TI value is changed to:
5245 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005246 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005247
5248 kitty The t_TE value is changed to:
5249 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005250 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005251 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005252 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005253 CSI ?u request kitty keyboard protocol state
5254 CSI >c request the termresponse
5255
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005256 If you notice problems, such as characters being displayed that
5257 disappear after `CTRL-L`, you might want to try making this option
5258 empty. Then set the 'term' option to have it take effect: >
5259 set keyprotocol=
5260 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005261<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005262
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 *'keywordprg'* *'kp'*
5264'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005265 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 Program to use for the |K| command. Environment variables are
5268 expanded |:set_env|. ":help" may be used to access the Vim internal
5269 help. (Note that previously setting the global option to the empty
5270 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005271 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005272 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005273 When "man", "man -s" or an Ex command is used, Vim will automatically
5274 translate a count for the "K" command and pass it as the first
5275 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 See |option-backslash| about including spaces and backslashes.
5277 Example: >
5278 :set keywordprg=man\ -s
5279< This option cannot be set from a |modeline| or in the |sandbox|, for
5280 security reasons.
5281
5282 *'langmap'* *'lmap'* *E357* *E358*
5283'langmap' 'lmap' string (default "")
5284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 {only available when compiled with the |+langmap|
5286 feature}
5287 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005288 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005289 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 care of translating these special characters to the original meaning
5291 of the key. This means you don't have to change the keyboard mode to
5292 be able to execute Normal mode commands.
5293 This is the opposite of the 'keymap' option, where characters are
5294 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005295 Also consider setting 'langremap' to off, to prevent 'langmap' from
5296 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005297 This option cannot be set from a |modeline| or in the |sandbox|, for
5298 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005300 Example (for Greek, in UTF-8): *greek* >
5301 :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 +00005302< Example (exchanges meaning of z and y for commands): >
5303 :set langmap=zy,yz,ZY,YZ
5304<
5305 The 'langmap' option is a list of parts, separated with commas. Each
5306 part can be in one of two forms:
5307 1. A list of pairs. Each pair is a "from" character immediately
5308 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005309 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 characters. Example: "abc;ABC"
5311 Example: "aA,fgh;FGH,cCdDeE"
5312 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005313 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314
5315 This will allow you to activate vim actions without having to switch
5316 back and forth between the languages. Your language characters will
5317 be understood as normal vim English characters (according to the
5318 langmap mappings) in the following cases:
5319 o Normal/Visual mode (commands, buffer/register names, user mappings)
5320 o Insert/Replace Mode: Register names after CTRL-R
5321 o Insert/Replace Mode: Mappings
5322 Characters entered in Command-line mode will NOT be affected by
5323 this option. Note that this option can be changed at any time
5324 allowing to switch between mappings for different languages/encodings.
5325 Use a mapping to avoid having to type it each time!
5326
5327 *'langmenu'* *'lm'*
5328'langmenu' 'lm' string (default "")
5329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 {only available when compiled with the |+menu| and
5331 |+multi_lang| features}
5332 Language to use for menu translation. Tells which file is loaded
5333 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005334 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335< (without the spaces). For example, to always use the Dutch menus, no
5336 matter what $LANG is set to: >
5337 :set langmenu=nl_NL.ISO_8859-1
5338< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005339 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 If your $LANG is set to a non-English language but you do want to use
5341 the English menus: >
5342 :set langmenu=none
5343< This option must be set before loading menus, switching on filetype
5344 detection or syntax highlighting. Once the menus are defined setting
5345 this option has no effect. But you could do this: >
5346 :source $VIMRUNTIME/delmenu.vim
5347 :set langmenu=de_DE.ISO_8859-1
5348 :source $VIMRUNTIME/menu.vim
5349< Warning: This deletes all menus that you defined yourself!
5350
Bram Moolenaard94464e2015-11-02 15:28:18 +01005351 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005352'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005353 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005354 {only available when compiled with the |+langmap|
5355 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005356 This is just like 'langremap' but with the value inverted. It only
5357 exists for backwards compatibility. When setting 'langremap' then
5358 'langnoremap' is set to the inverted value, and the other way around.
5359
5360 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005361'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005362 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005363 {only available when compiled with the |+langmap|
5364 feature}
5365 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005366 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005367 'langmap' disables some of your mappings, try resetting this option.
5368 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005369 that works for you to avoid mappings to break.
5370
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 *'laststatus'* *'ls'*
5372'laststatus' 'ls' number (default 1)
5373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 The value of this option influences when the last window will have a
5375 status line:
5376 0: never
5377 1: only if there are at least two windows
5378 2: always
5379 The screen looks nicer with a status line if you have several
5380 windows, but it takes another screen line. |status-line|
5381
5382 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5383'lazyredraw' 'lz' boolean (default off)
5384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 When this option is set, the screen will not be redrawn while
5386 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005389 This may occasionally cause display errors. It is only meant to be set
5390 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005391 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
64-bitman88d41ab2025-04-06 17:20:39 +02005393 *'lhistory'* *'lhi'*
5394'lhistory' 'lhi' number (default: 10)
5395 local to window
5396 {only available when compiled with the |+quickfix|
5397 feature}
zeertzjqb71f1302025-04-08 20:29:40 +02005398 Like 'chistory', but for the location list stack associated with a
5399 window. If the option is changed in either the location list window
5400 itself or the window that is associated with the location list stack,
5401 the new value will also be applied to the other one. This means this
5402 value will always be the same for a given location list window and its
5403 corresponding window. See |quickfix-stack| for additional info.
64-bitman88d41ab2025-04-06 17:20:39 +02005404
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5406'linebreak' 'lbr' boolean (default off)
5407 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005408 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005410 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 than at the last character that fits on the screen. Unlike
5412 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005413 it only affects the way the file is displayed, not its contents.
5414 If 'breakindent' is set, line is visually indented. Then, the value
5415 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005416 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 Note that <Tab> characters after an <EOL> are mostly not displayed
5418 with the right amount of white space.
5419
5420 *'lines'* *E593*
5421'lines' number (default 24 or terminal height)
5422 global
5423 Number of lines of the Vim window.
5424 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005425 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 When Vim is running in the GUI or in a resizable window, setting this
5427 option will cause the window size to be changed. When you only want
5428 to use the size for the GUI, put the command in your |gvimrc| file.
5429 Vim limits the number of lines to what fits on the screen. You can
5430 use this command to get the tallest window possible: >
5431 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005432< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005433 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 When you set this option and Vim is unable to change the physical
5435 number of lines of the display, the display may be messed up.
5436
5437 *'linespace'* *'lsp'*
5438'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 {only in the GUI}
5441 Number of pixel lines inserted between characters. Useful if the font
5442 uses the full character cell height, making lines touch each other.
5443 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005444 With some fonts there can be too much room between lines (to have
5445 space for ascents and descents). Then it makes sense to set
5446 'linespace' to a negative value. This may cause display problems
5447 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
5449 *'lisp'* *'nolisp'*
5450'lisp' boolean (default off)
5451 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 Lisp mode: When <Enter> is typed in insert mode set the indent for
5453 the next line to Lisp standards (well, sort of). Also happens with
5454 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5455 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5456 better. Also see 'lispwords'.
5457 The '-' character is included in keyword characters. Redefines the
5458 "=" operator to use this same indentation algorithm rather than
5459 calling an external program if 'equalprg' is empty.
5460 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005462 *'lispoptions'* *'lop'*
5463'lispoptions' 'lop' string (default "")
5464 local to buffer
5465 Comma-separated list of items that influence the Lisp indenting when
5466 enabled with the |'lisp'| option. Currently only one item is
5467 supported:
5468 expr:1 use 'indentexpr' for Lisp indenting when it is set
5469 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5470 Note that when using 'indentexpr' the `=` operator indents all the
5471 lines, otherwise the first line is not indented (Vi-compatible).
5472
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 *'lispwords'* *'lw'*
5474'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005475 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005476 Comma-separated list of words that influence the Lisp indenting when
5477 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478
5479 *'list'* *'nolist'*
5480'list' boolean (default off)
5481 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005482 List mode: By default show tabs as CTRL-I is displayed, display $
5483 after end of line. Useful to see the difference between tabs and
5484 spaces and for trailing blanks. Further changed by the 'listchars'
5485 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005486
5487 The cursor is displayed at the start of the space a Tab character
5488 occupies, not at the end as usual in Normal mode. To get this cursor
5489 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005490 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005491<
5492 Note that list mode will also affect formatting (set with 'textwidth'
5493 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 changing the way tabs are displayed.
5495
5496 *'listchars'* *'lcs'*
5497'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005498 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005499 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005500 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005501 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 eol:c Character to show at the end of each line. When
5503 omitted, there is no extra character at the end of the
5504 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005505 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005506 tab:xy[z] Two or three characters to be used to show a tab.
5507 The third character is optional.
5508
5509 tab:xy The 'x' is always used, then 'y' as many times as will
5510 fit. Thus "tab:>-" displays:
5511 >
5512 >-
5513 >--
5514 etc.
5515
5516 tab:xyz The 'z' is always used, then 'x' is prepended, and
5517 then 'y' is used as many times as will fit. Thus
5518 "tab:<->" displays:
5519 >
5520 <>
5521 <->
5522 <-->
5523 etc.
5524
5525 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005526 *lcs-space*
5527 space:c Character to show for a space. When omitted, spaces
5528 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005529 *lcs-multispace*
5530 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005531 One or more characters to use cyclically to show for
5532 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005533 setting, except for single spaces. When omitted, the
5534 "space" setting is used. For example,
5535 `:set listchars=multispace:---+` shows ten consecutive
5536 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005537 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005538 *lcs-lead*
5539 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005540 leading spaces are blank. Overrides the "space" and
5541 "multispace" settings for leading spaces. You can
5542 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005543 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005544< *lcs-leadmultispace*
5545 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005546 Like the |lcs-multispace| value, but for leading
5547 spaces only. Also overrides |lcs-lead| for leading
5548 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005549 `:set listchars=leadmultispace:---+` shows ten
5550 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005551 ---+---+--XXX ~
5552 Where "XXX" denotes the first non-blank characters in
5553 the line.
5554 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005556 trailing spaces are blank. Overrides the "space" and
5557 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005558 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 extends:c Character to show in the last column, when 'wrap' is
5560 off and the line continues beyond the right of the
5561 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005562 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005563 precedes:c Character to show in the first visible column of the
5564 physical line, when there is text preceding the
5565 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005566 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005567 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005568 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005569 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005570 nbsp:c Character to show for a non-breakable space character
5571 (0xA0 (160 decimal) and U+202F). Left blank when
5572 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005574 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005576 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005578 Each character can be specified as hex: >
5579 set listchars=eol:\\x24
5580 set listchars=eol:\\u21b5
5581 set listchars=eol:\\U000021b5
5582< Note that a double backslash is used. The number of hex characters
5583 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5584
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 Examples: >
5586 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005587 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 :set lcs=extends:>,precedes:<
5589< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005590 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5591 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005592 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593
5594 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5595'loadplugins' 'lpl' boolean (default on)
5596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 When on the plugin scripts are loaded when starting up |load-plugins|.
5598 This option can be reset in your |vimrc| file to disable the loading
5599 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005600 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5601 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602
Bram Moolenaard94464e2015-11-02 15:28:18 +01005603 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005604'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005605 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005606 {only available when compiled with the |+lua/dyn|
5607 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005608 Specifies the name of the Lua shared library. The default is
5609 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005610 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005611 This option cannot be set from a |modeline| or in the |sandbox|, for
5612 security reasons.
5613
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005614 *'macatsui'* *'nomacatsui'*
5615'macatsui' boolean (default on)
5616 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005617 {not supported}
5618 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005619
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 *'magic'* *'nomagic'*
5621'magic' boolean (default on)
5622 global
5623 Changes the special characters that can be used in search patterns.
5624 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005625 WARNING: Switching this option off most likely breaks plugins! That
5626 is because many patterns assume it's on and will fail when it's off.
5627 Only switch it off when working with old Vi scripts. In any other
5628 situation write patterns that work when 'magic' is on. Include "\M"
5629 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005630 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5631 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632
5633 *'makeef'* *'mef'*
5634'makeef' 'mef' string (default: "")
5635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 {not available when compiled without the |+quickfix|
5637 feature}
5638 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5639 and the |:grep| command.
5640 When it is empty, an internally generated temp file will be used.
5641 When "##" is included, it is replaced by a number to make the name
5642 unique. This makes sure that the ":make" command doesn't overwrite an
5643 existing file.
5644 NOT used for the ":cf" command. See 'errorfile' for that.
5645 Environment variables are expanded |:set_env|.
5646 See |option-backslash| about including spaces and backslashes.
5647 This option cannot be set from a |modeline| or in the |sandbox|, for
5648 security reasons.
5649
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005650 *'makeencoding'* *'menc'*
5651'makeencoding' 'menc' string (default "")
5652 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005653 Encoding used for reading the output of external commands. When empty,
5654 encoding is not converted.
5655 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5656 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5657 and `:laddfile`.
5658
5659 This would be mostly useful when you use MS-Windows and set 'encoding'
5660 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5661 'makeencoding' to "char" has the same effect as setting to the system
5662 locale encoding. Example: >
5663 :set encoding=utf-8
5664 :set makeencoding=char " system locale is used
5665<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 *'makeprg'* *'mp'*
5667'makeprg' 'mp' string (default "make", VMS: "MMS")
5668 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005669 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005670 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5671 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005672 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005673 Environment variables are expanded |:set_env|. See |option-backslash|
5674 about including spaces and backslashes.
5675 Note that a '|' must be escaped twice: once for ":set" and once for
5676 the interpretation of a command. When you use a filter called
5677 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 :set makeprg=gmake\ \\\|\ myfilter
5679< The placeholder "$*" can be given (even multiple times) to specify
5680 where the arguments will be included, for example: >
5681 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5682< This option cannot be set from a |modeline| or in the |sandbox|, for
5683 security reasons.
5684
5685 *'matchpairs'* *'mps'*
5686'matchpairs' 'mps' string (default "(:),{:},[:]")
5687 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005689 other.
5690 Only character pairs are allowed that are different, thus you cannot
5691 jump between two double quotes.
5692 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005693 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005694 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 :set mps+=<:>
5696
5697< A more exotic example, to jump between the '=' and ';' in an
5698 assignment, useful for languages like C and Java: >
5699 :au FileType c,cpp,java set mps+==:;
5700
5701< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005702 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703
5704 *'matchtime'* *'mat'*
5705'matchtime' 'mat' number (default 5)
5706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 Tenths of a second to show the matching paren, when 'showmatch' is
5708 set. Note that this is not in milliseconds, like other options that
5709 set a time. This is to be compatible with Nvi.
5710
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005711 *'maxcombine'* *'mco'*
5712'maxcombine' 'mco' number (default 2)
5713 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005714 The maximum number of combining characters supported for displaying.
5715 Only used when 'encoding' is "utf-8".
5716 The default is OK for most languages. Hebrew may require 4.
5717 Maximum value is 6.
5718 Even when this option is set to 2 you can still edit text with more
5719 combining characters, you just can't see them. Use |g8| or |ga|.
5720 See |mbyte-combining|.
5721
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 *'maxfuncdepth'* *'mfd'*
5723'maxfuncdepth' 'mfd' number (default 100)
5724 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005725 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005726 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 Maximum depth of function calls for user functions. This normally
5728 catches endless recursion. When using a recursive function with
5729 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5730 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005731 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005732 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005734 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
5736 *'maxmapdepth'* *'mmd'* *E223*
5737'maxmapdepth' 'mmd' number (default 1000)
5738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 Maximum number of times a mapping is done without resulting in a
5740 character to be used. This normally catches endless mappings, like
5741 ":map x y" with ":map y x". It still does not catch ":map g wg",
5742 because the 'w' is used before the next mapping is done. See also
5743 |key-mapping|.
5744
5745 *'maxmem'* *'mm'*
5746'maxmem' 'mm' number (default between 256 to 5120 (system
5747 dependent) or half the amount of memory
5748 available)
5749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5751 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005752 other memory to be freed.
5753 The maximum usable value is about 2000000. Use this to work without a
5754 limit.
5755 The value is ignored when 'swapfile' is off.
5756 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005758 *'maxmempattern'* *'mmp'*
5759'maxmempattern' 'mmp' number (default 1000)
5760 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005761 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005762 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005763 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005764 When Vim runs into the limit it gives an error message and mostly
5765 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005766 Running into the limit often means that the pattern is very
5767 inefficient or too complex. This may already happen with the pattern
5768 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005769 Might also happen on redraw, when syntax rules try to match a complex
5770 text structure.
5771 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5772 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005773
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 *'maxmemtot'* *'mmt'*
5775'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5776 dependent) or half the amount of memory
5777 available)
5778 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005779 Maximum amount of memory in Kbyte to use for all buffers together.
5780 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005781 without a limit.
5782 On 64 bit machines higher values might work. But hey, do you really
5783 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005784 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005785 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005786 Buffers with 'swapfile' off still count to the total amount of memory
5787 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005788 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
5790 *'menuitems'* *'mis'*
5791'menuitems' 'mis' number (default 25)
5792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 {not available when compiled without the |+menu|
5794 feature}
5795 Maximum number of items to use in a menu. Used for menus that are
5796 generated from a list of items, e.g., the Buffers menu. Changing this
5797 option has no direct effect, the menu must be refreshed first.
5798
Christian Brabandt51d4d842024-12-06 17:26:25 +01005799 *'messagesopt'* *'mopt'*
5800'messagesopt' 'mopt' string (default "hit-enter,history:500")
5801 global
5802
zeertzjq8cc43da2024-12-07 16:09:08 +01005803 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005804 following items. Items must be separated by a comma.
5805
zeertzjq8cc43da2024-12-07 16:09:08 +01005806 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005807 'cmdheight' size.
5808
zeertzjq8cc43da2024-12-07 16:09:08 +01005809 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5810 {n} milliseconds so that the user has a chance to read
5811 the message. The maximum value of {n} is 10000. Use
5812 0 to disable the wait (but then the user may miss an
5813 important message).
5814 This item is ignored when "hit-enter" is present, but
5815 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005816
5817 history:{n} Determines how many entries are remembered in the
5818 |:messages| history. The maximum value is 10000.
5819 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005820 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005821
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005822 *'mkspellmem'* *'msm'*
5823'mkspellmem' 'msm' string (default "460000,2000,500")
5824 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005825 {not available when compiled without the |+syntax|
5826 feature}
5827 Parameters for |:mkspell|. This tunes when to start compressing the
5828 word tree. Compression can be slow when there are many words, but
5829 it's needed to avoid running out of memory. The amount of memory used
5830 per word depends very much on how similar the words are, that's why
5831 this tuning is complicated.
5832
5833 There are three numbers, separated by commas:
5834 {start},{inc},{added}
5835
5836 For most languages the uncompressed word tree fits in memory. {start}
5837 gives the amount of memory in Kbyte that can be used before any
5838 compression is done. It should be a bit smaller than the amount of
5839 memory that is available to Vim.
5840
5841 When going over the {start} limit the {inc} number specifies the
5842 amount of memory in Kbyte that can be allocated before another
5843 compression is done. A low number means compression is done after
5844 less words are added, which is slow. A high number means more memory
5845 will be allocated.
5846
5847 After doing compression, {added} times 1024 words can be added before
5848 the {inc} limit is ignored and compression is done when any extra
5849 amount of memory is needed. A low number means there is a smaller
5850 chance of hitting the {inc} limit, less memory is used but it's
5851 slower.
5852
5853 The languages for which these numbers are important are Italian and
5854 Hungarian. The default works for when you have about 512 Mbyte. If
5855 you have 1 Gbyte you could use: >
5856 :set mkspellmem=900000,3000,800
5857< If you have less than 512 Mbyte |:mkspell| may fail for some
5858 languages, no matter what you set 'mkspellmem' to.
5859
dkearns8ebdbc92023-10-29 06:26:19 +11005860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005862
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005864'modeline' 'ml' boolean (Vim default: on (off for root),
5865 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005867 If 'modeline' is on 'modelines' gives the number of lines that is
5868 checked for set commands. If 'modeline' is off or 'modelines' is zero
5869 no lines are checked. See |modeline|.
5870
5871 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5872'modelineexpr' 'mle' boolean (default: off)
5873 global
5874 When on allow some options that are an expression to be set in the
5875 modeline. Check the option for whether it is affected by
5876 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005877 This option cannot be set from a |modeline| or in the |sandbox|, for
5878 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005879
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 *'modelines'* *'mls'*
5881'modelines' 'mls' number (default 5)
5882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 If 'modeline' is on 'modelines' gives the number of lines that is
5884 checked for set commands. If 'modeline' is off or 'modelines' is zero
5885 no lines are checked. See |modeline|.
5886 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5887 set and to the Vim default value when 'compatible' is reset.
5888
5889 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005890 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891'modifiable' 'ma' boolean (default on)
5892 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 When off the buffer contents cannot be changed. The 'fileformat' and
5894 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005895 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896
5897 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5898'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005899 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 When on, the buffer is considered to be modified. This option is set
5901 when:
5902 1. A change was made to the text since it was last written. Using the
5903 |undo| command to go back to the original text will reset the
5904 option. But undoing changes that were made before writing the
5905 buffer will set the option again, since the text is different from
5906 when it was written.
5907 2. 'fileformat' or 'fileencoding' is different from its original
5908 value. The original value is set when the buffer is read or
5909 written. A ":set nomodified" command also resets the original
5910 values to the current values and the 'modified' option will be
5911 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005912 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005913 This option is not set when a change is made to the buffer as the
5914 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5915 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5916 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5918 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005919 Note that the text may actually be the same, e.g. 'modified' is set
5920 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921
5922 *'more'* *'nomore'*
5923'more' boolean (Vim default: on, Vi default: off)
5924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 When on, listings pause when the whole screen is filled. You will get
5926 the |more-prompt|. When this option is off there are no pauses, the
5927 listing continues until finished.
5928 NOTE: This option is set to the Vi default value when 'compatible' is
5929 set and to the Vim default value when 'compatible' is reset.
5930
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005931 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005932'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005933 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005935 Enable the use of the mouse. Works for most terminals (xterm, Win32
5936 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5937 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5938 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005939 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 v Visual mode
5941 i Insert mode
5942 c Command-line mode
5943 h all previous modes when editing a help file
5944 a all previous modes
5945 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005946 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005948< If your terminal can't overrule the mouse events going to the
5949 application, use: >
5950 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005951< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005952 back to Vim using the mouse events.
5953 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5954 "xterm".
5955
5956 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 modeless selection. This doesn't move the text cursor.
5958
5959 See |mouse-using|. Also see |'clipboard'|.
5960
5961 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005962 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 the mouse buttons can still be used by keeping the shift key pressed.
5964 Also see the 'clipboard' option.
5965
5966 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5967'mousefocus' 'mousef' boolean (default off)
5968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 {only works in the GUI}
5970 The window that the mouse pointer is on is automatically activated.
5971 When changing the window layout or window focus in another way, the
5972 mouse pointer is moved to the window with keyboard focus. Off is the
5973 default because it makes using the pull down menus a little goofy, as
5974 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005975 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005976 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977
5978 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5979'mousehide' 'mh' boolean (default on)
5980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 {only works in the GUI}
5982 When on, the mouse pointer is hidden when characters are typed.
5983 The mouse pointer is restored when the mouse is moved.
5984
5985 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005986'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 Sets the model to use for the mouse. The name mostly specifies what
5989 the right mouse button is used for:
5990 extend Right mouse button extends a selection. This works
5991 like in an xterm.
5992 popup Right mouse button pops up a menu. The shifted left
5993 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005994 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 popup_setpos Like "popup", but the cursor will be moved to the
5996 position where the mouse was clicked, and thus the
5997 selected operation will act upon the clicked object.
5998 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005999 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 course, that right clicking outside a selection will
6001 end Visual mode.
6002 Overview of what button does what for each model:
6003 mouse extend popup(_setpos) ~
6004 left click place cursor place cursor
6005 left drag start selection start selection
6006 shift-left search word extend selection
6007 right click extend selection popup menu (place cursor)
6008 right drag extend selection -
6009 middle click paste paste
6010
6011 In the "popup" model the right mouse button produces a pop-up menu.
6012 You need to define this first, see |popup-menu|.
6013
6014 Note that you can further refine the meaning of buttons with mappings.
6015 See |gui-mouse-mapping|. But mappings are NOT used for modeless
6016 selection (because that's handled in the GUI code directly).
6017
6018 The 'mousemodel' option is set by the |:behave| command.
6019
h_east59858792023-10-25 22:47:05 +09006020 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01006021'mousemoveevent' 'mousemev' boolean (default off)
6022 global
6023 {only works in the GUI}
6024 When on, mouse move events are delivered to the input queue and are
6025 available for mapping. The default, off, avoids the mouse movement
6026 overhead except when needed. See |gui-mouse-mapping|.
6027 Warning: Setting this option can make pending mappings to be aborted
6028 when the mouse is moved.
6029 Currently only works in the GUI, may be made to work in a terminal
6030 later.
6031
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01006033'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
6034 vs:leftright,vd:lrsizing,m:no,
6035 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 {only available when compiled with the |+mouseshape|
6038 feature}
6039 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006040 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 like used for 'guicursor'. Each part consist of a mode/location-list
6042 and an argument-list:
6043 mode-list:shape,mode-list:shape,..
6044 The mode-list is a dash separated list of these modes/locations:
6045 In a normal window: ~
6046 n Normal mode
6047 v Visual mode
6048 ve Visual mode with 'selection' "exclusive" (same as 'v',
6049 if not specified)
6050 o Operator-pending mode
6051 i Insert mode
6052 r Replace mode
6053
6054 Others: ~
6055 c appending to the command-line
6056 ci inserting in the command-line
6057 cr replacing in the command-line
6058 m at the 'Hit ENTER' or 'More' prompts
6059 ml idem, but cursor in the last line
6060 e any mode, pointer below last window
6061 s any mode, pointer on a status line
6062 sd any mode, while dragging a status line
6063 vs any mode, pointer on a vertical separator line
6064 vd any mode, while dragging a vertical separator line
6065 a everywhere
6066
6067 The shape is one of the following:
6068 avail name looks like ~
6069 w x arrow Normal mouse pointer
6070 w x blank no pointer at all (use with care!)
6071 w x beam I-beam
6072 w x updown up-down sizing arrows
6073 w x leftright left-right sizing arrows
6074 w x busy The system's usual busy pointer
6075 w x no The system's usual 'no input' pointer
6076 x udsizing indicates up-down resizing
6077 x lrsizing indicates left-right resizing
6078 x crosshair like a big thin +
6079 x hand1 black hand
6080 x hand2 white hand
6081 x pencil what you write with
6082 x question big ?
6083 x rightup-arrow arrow pointing right-up
6084 w x up-arrow arrow pointing up
6085 x <number> any X11 pointer number (see X11/cursorfont.h)
6086
6087 The "avail" column contains a 'w' if the shape is available for Win32,
6088 x for X11.
6089 Any modes not specified or shapes not available use the normal mouse
6090 pointer.
6091
6092 Example: >
6093 :set mouseshape=s:udsizing,m:no
6094< will make the mouse turn to a sizing arrow over the status lines and
6095 indicate no input when the hit-enter prompt is displayed (since
6096 clicking the mouse has no effect in this state.)
6097
6098 *'mousetime'* *'mouset'*
6099'mousetime' 'mouset' number (default 500)
6100 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006101 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 time in msec between two mouse clicks for the second click to be
6103 recognized as a multi click.
6104
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01006105
laburnumT3f7855a2023-12-05 18:37:03 +01006106 *'mzquantum'* *'mzq'*
6107'mzquantum' 'mzq' number (default 100)
6108 global
6109 {not available when compiled without the |+mzscheme|
6110 feature}
6111 The number of milliseconds between polls for MzScheme threads.
6112 Negative or zero value means no thread scheduling.
6113 NOTE: This option is set to the Vim default value when 'compatible'
6114 is reset.
6115
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006116 *'mzschemedll'*
6117'mzschemedll' string (default depends on the build)
6118 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006119 {only available when compiled with the |+mzscheme/dyn|
6120 feature}
6121 Specifies the name of the MzScheme shared library. The default is
6122 DYNAMIC_MZSCH_DLL which was specified at compile time.
6123 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006124 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006125 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006126 This option cannot be set from a |modeline| or in the |sandbox|, for
6127 security reasons.
6128
6129 *'mzschemegcdll'*
6130'mzschemegcdll' string (default depends on the build)
6131 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006132 {only available when compiled with the |+mzscheme/dyn|
6133 feature}
6134 Specifies the name of the MzScheme GC shared library. The default is
6135 DYNAMIC_MZGC_DLL which was specified at compile time.
6136 The value can be equal to 'mzschemedll' if it includes the GC code.
6137 Environment variables are expanded |:set_env|.
6138 This option cannot be set from a |modeline| or in the |sandbox|, for
6139 security reasons.
6140
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006142'nrformats' 'nf' string (default "bin,octal,hex",
6143 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 This defines what bases Vim will consider for numbers when using the
6146 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6147 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006148 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006150 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006151 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006153 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 considered to be hexadecimal. Example: Using CTRL-X on
6155 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006156 bin If included, numbers starting with "0b" or "0B" will be
6157 considered to be binary. Example: Using CTRL-X on
6158 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006159 unsigned If included, numbers are recognized as unsigned. Thus a
6160 leading dash or negative sign won't be considered as part of
6161 the number. Examples:
6162 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6163 (without "unsigned" it would become "9-2021").
6164 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6165 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006166 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6167 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006168 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006169 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006170 dash immediately preceded by a non-whitespace character (i.e.,
6171 not a tab or a " "), the negative sign won't be considered as
6172 part of the number. For example:
6173 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6174 (without "blank" it would become "Carbon-13").
6175 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006176 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006177 set, it would result in "Carbon -7").
6178 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006179 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006180 included, "unsigned" will take precedence.
6181
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 Numbers which simply begin with a digit in the range 1-9 are always
6183 considered decimal. This also happens for numbers that are not
6184 recognized as octal or hex.
6185
6186 *'number'* *'nu'* *'nonumber'* *'nonu'*
6187'number' 'nu' boolean (default off)
6188 local to window
6189 Print the line number in front of each line. When the 'n' option is
6190 excluded from 'cpoptions' a wrapped line will not use the column of
6191 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006192 The 'numberwidth' option can be used to set the room used for the line
6193 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 When a long, wrapped line doesn't start with the first character, '-'
6195 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006196 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6197 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006198 *number_relativenumber*
6199 The 'relativenumber' option changes the displayed number to be
6200 relative to the cursor. Together with 'number' there are these
6201 four combinations (cursor in line 3):
6202
Bram Moolenaar3848e002016-03-19 18:42:29 +01006203 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006204 'nornu' 'nornu' 'rnu' 'rnu'
6205
6206 |apple | 1 apple | 2 apple | 2 apple
6207 |pear | 2 pear | 1 pear | 1 pear
6208 |nobody | 3 nobody | 0 nobody |3 nobody
6209 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006211 *'numberwidth'* *'nuw'*
6212'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6213 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006214 {only available when compiled with the |+linebreak|
6215 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006216 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006217 when the 'number' or 'relativenumber' option is set or printing lines
6218 with a line number. Since one space is always between the number and
6219 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006220 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006221 fit the highest line number in the buffer respectively the number of
6222 rows in the window, depending on whether 'number' or 'relativenumber'
6223 is set. Thus with the Vim default of 4 there is room for a line number
6224 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006225 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006226 NOTE: This option is set to the Vi default value when 'compatible' is
6227 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006228
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006229 *'omnifunc'* *'ofu'*
6230'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006231 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006232 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006233 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006234 This option specifies a function to be used for Insert mode omni
6235 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006236 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006237 invoked and what it should return. The value can be the name of a
6238 function, a |lambda| or a |Funcref|. See |option-value-function| for
6239 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006240 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006241 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006242 This option cannot be set from a |modeline| or in the |sandbox|, for
6243 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006244
Bram Moolenaar02467872007-05-06 13:22:01 +00006245 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006246'opendevice' 'odev' boolean (default off)
6247 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006248 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006249 Enable reading and writing from devices. This may get Vim stuck on a
6250 device that can be opened but doesn't actually do the I/O. Therefore
6251 it is off by default.
6252 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6253 result in editing a device.
6254
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006255 *'operatorfunc'* *'opfunc'*
6256'operatorfunc' 'opfunc' string (default: empty)
6257 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006258 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006259 See |:map-operator| for more info and an example. The value can be
6260 the name of a function, a |lambda| or a |Funcref|. See
6261 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006262
6263 This option cannot be set from a |modeline| or in the |sandbox|, for
6264 security reasons.
6265
Bram Moolenaar251e1912011-06-19 05:09:16 +02006266 *'osfiletype'* *'oft'*
6267'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006269 This option was supported on RISC OS, which has been removed.
6270
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006271 *'packpath'* *'pp'*
6272'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006273 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006274 This option cannot be set from a |modeline| or in the |sandbox|, for
6275 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006276
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006278'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 global
6280 Specifies the nroff macros that separate paragraphs. These are pairs
6281 of two letters (see |object-motions|).
6282
6283 *'paste'* *'nopaste'*
6284'paste' boolean (default off)
6285 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006286 Put Vim in Paste mode. This is useful if you want to cut or copy
6287 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 unexpected effects.
6289 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006290 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 knows about pasting and will mostly do the right thing without 'paste'
6292 being set. The same is true for a terminal where Vim handles the
6293 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006294 This option is reset when starting the GUI. Thus if you set it in
6295 your .vimrc it will work in a terminal, but not in the GUI. Setting
6296 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6297 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 When the 'paste' option is switched on (also when it was already on):
6299 - mapping in Insert mode and Command-line mode is disabled
6300 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006302 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006303 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 - 'revins' is reset
6305 - 'ruler' is reset
6306 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006307 - 'smarttab' is reset
6308 - 'softtabstop' is set to 0
6309 - 'textwidth' is set to 0
6310 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006311 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006314 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006315 - 'indentexpr'
6316 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006317 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 NOTE: When you start editing another file while the 'paste' option is
6319 on, settings from the modelines or autocommands may change the
6320 settings again, causing trouble when pasting text. You might want to
6321 set the 'paste' option again.
6322 When the 'paste' option is reset the mentioned options are restored to
6323 the value before the moment 'paste' was switched from off to on.
6324 Resetting 'paste' before ever setting it does not have any effect.
6325 Since mapping doesn't work while 'paste' is active, you need to use
6326 the 'pastetoggle' option to toggle the 'paste' option with some key.
6327
6328 *'pastetoggle'* *'pt'*
6329'pastetoggle' 'pt' string (default "")
6330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 When non-empty, specifies the key sequence that toggles the 'paste'
6332 option. This is like specifying a mapping: >
6333 :map {keys} :set invpaste<CR>
6334< Where {keys} is the value of 'pastetoggle'.
6335 The difference is that it will work even when 'paste' is set.
6336 'pastetoggle' works in Insert mode and Normal mode, but not in
6337 Command-line mode.
6338 Mappings are checked first, thus overrule 'pastetoggle'. However,
6339 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6340 this: >
6341 :map <F10> :set paste<CR>
6342 :map <F11> :set nopaste<CR>
6343 :imap <F10> <C-O>:set paste<CR>
6344 :imap <F11> <nop>
6345 :set pastetoggle=<F11>
6346< This will make <F10> start paste mode and <F11> stop paste mode.
6347 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6348 mode everything is inserted literally, except the 'pastetoggle' key
6349 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006350 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351
6352 *'pex'* *'patchexpr'*
6353'patchexpr' 'pex' string (default "")
6354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 {not available when compiled without the |+diff|
6356 feature}
6357 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006358 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006359 This option cannot be set from a |modeline| or in the |sandbox|, for
6360 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361
Bram Moolenaardbc28022014-07-26 13:40:44 +02006362 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363'patchmode' 'pm' string (default "")
6364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 When non-empty the oldest version of a file is kept. This can be used
6366 to keep the original version of a file if you are changing files in a
6367 source distribution. Only the first time that a file is written a
6368 copy of the original file will be kept. The name of the copy is the
6369 name of the original file with the string in the 'patchmode' option
6370 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006371 ".orig" or ".org". 'backupdir' must not be empty for this to work
6372 (Detail: The backup file is renamed to the patchmode file after the
6373 new file has been successfully written, that's why it must be possible
6374 to write a backup file). If there was no file to be backed up, an
6375 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 When the 'backupskip' pattern matches, a patchmode file is not made.
6377 Using 'patchmode' for compressed files appends the extension at the
6378 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6379 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006380 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006382 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 other systems: ".,,")
6385 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006387 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6388 provided that the file being searched for has a relative path (not
6389 starting with "/", "./" or "../"). The directories in the 'path'
6390 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 - Use commas to separate directory names: >
6392 :set path=.,/usr/local/include,/usr/include
6393< - Spaces can also be used to separate directory names (for backwards
6394 compatibility with version 3.0). To have a space in a directory
6395 name, precede it with an extra backslash, and escape the space: >
6396 :set path=.,/dir/with\\\ space
6397< - To include a comma in a directory name precede it with an extra
6398 backslash: >
6399 :set path=.,/dir/with\\,comma
6400< - To search relative to the directory of the current file, use: >
6401 :set path=.
6402< - To search in the current directory use an empty string between two
6403 commas: >
6404 :set path=,,
6405< - A directory name may end in a ':' or '/'.
6406 - Environment variables are expanded |:set_env|.
6407 - When using |netrw.vim| URLs can be used. For example, adding
6408 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006409 - Search upwards and downwards in a directory tree using "*", "**" and
6410 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 - Careful with '\' characters, type two to get one in the option: >
6412 :set path=.,c:\\include
6413< Or just use '/' instead: >
6414 :set path=.,c:/include
6415< Don't forget "." or files won't even be found in the same directory as
6416 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006417 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 it is something like 256 or 1024 characters.
6419 You can check if all the include files are found, using the value of
6420 'path', see |:checkpath|.
6421 The use of |:set+=| and |:set-=| is preferred when adding or removing
6422 directories from the list. This avoids problems when a future version
6423 uses another default. To remove the current directory use: >
6424 :set path-=
6425< To add the current directory use: >
6426 :set path+=
6427< To use an environment variable, you probably need to replace the
6428 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006429 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006430 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431< Replace the ';' with a ':' or whatever separator is used. Note that
6432 this doesn't work when $INCL contains a comma or white space.
6433
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006434 *'perldll'*
6435'perldll' string (default depends on the build)
6436 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006437 {only available when compiled with the |+perl/dyn|
6438 feature}
6439 Specifies the name of the Perl shared library. The default is
6440 DYNAMIC_PERL_DLL, which was specified at compile time.
6441 Environment variables are expanded |:set_env|.
6442 This option cannot be set from a |modeline| or in the |sandbox|, for
6443 security reasons.
6444
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6446'preserveindent' 'pi' boolean (default off)
6447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 When changing the indent of the current line, preserve as much of the
6449 indent structure as possible. Normally the indent is replaced by a
6450 series of tabs followed by spaces as required (unless |'expandtab'| is
6451 enabled, in which case only spaces are used). Enabling this option
6452 means the indent will preserve as many existing characters as possible
6453 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006454 'expandtab' does not apply to the preserved white space, a Tab remains
6455 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 NOTE: When using ">>" multiple times the resulting indent is a mix of
6457 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006458 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 Also see 'copyindent'.
6460 Use |:retab| to clean up white space.
6461
6462 *'previewheight'* *'pvh'*
6463'previewheight' 'pvh' number (default 12)
6464 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006465 {not available when compiled without the |+quickfix|
6466 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006468 commands. Used for |CTRL-W_}| when no count is given. Not used when
6469 'previewpopup' is set.
6470
6471 *'previewpopup'* *'pvp'*
6472'previewpopup' 'pvp' string (default empty)
6473 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006474 {not available when compiled without the |+textprop|
6475 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006476 When not empty a popup window is used for commands that would open a
6477 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006478 Not used for the insert completion info, add "popup" to
6479 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480
6481 *'previewwindow'* *'nopreviewwindow'*
6482 *'pvw'* *'nopvw'* *E590*
6483'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006484 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006485 {not available when compiled without the |+quickfix|
6486 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006487 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 set. It's normally not set directly, but by using one of the commands
6489 |:ptag|, |:pedit|, etc.
6490
6491 *'printdevice'* *'pdev'*
6492'printdevice' 'pdev' string (default empty)
6493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 {only available when compiled with the |+printer|
6495 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006496 The name of the printer to be used for |:hardcopy|.
6497 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006498 This option cannot be set from a |modeline| or in the |sandbox|, for
6499 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500
Bram Moolenaar8299df92004-07-10 09:47:34 +00006501 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006502'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 {only available when compiled with the |+printer|
6505 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006506 Sets the character encoding used when printing.
6507 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508
6509 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006510'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 {only available when compiled with the |+printer|
6513 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006514 Expression used to print the PostScript produced with |:hardcopy|.
6515 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006516 This option cannot be set from a |modeline| or in the |sandbox|, for
6517 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518
Bram Moolenaar8299df92004-07-10 09:47:34 +00006519 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520'printfont' 'pfn' string (default "courier")
6521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 {only available when compiled with the |+printer|
6523 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006524 The name of the font that will be used for |:hardcopy|.
6525 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526
6527 *'printheader'* *'pheader'*
6528'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 {only available when compiled with the |+printer|
6531 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006532 The format of the header produced in |:hardcopy| output.
6533 See |pheader-option|.
6534
6535 *'printmbcharset'* *'pmbcs'*
6536'printmbcharset' 'pmbcs' string (default "")
6537 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006538 {only available when compiled with the |+printer|
6539 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006540 The CJK character set to be used for CJK output from |:hardcopy|.
6541 See |pmbcs-option|.
6542
6543 *'printmbfont'* *'pmbfn'*
6544'printmbfont' 'pmbfn' string (default "")
6545 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006546 {only available when compiled with the |+printer|
6547 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006548 List of font names to be used for CJK output from |:hardcopy|.
6549 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550
6551 *'printoptions'* *'popt'*
6552'printoptions' 'popt' string (default "")
6553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006555 List of items that control the format of the output of |:hardcopy|.
6556 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006558 *'prompt'* *'noprompt'*
6559'prompt' boolean (default on)
6560 global
6561 When on a ":" prompt is used in Ex mode.
6562
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006563 *'pumheight'* *'ph'*
6564'pumheight' 'ph' number (default 0)
6565 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006566 Determines the maximum number of items to show in the popup menu for
6567 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006568 |ins-completion-menu|.
6569
glepnir88d75932025-03-27 20:09:07 +01006570 *'pummaxwidth'* *'pmw'*
6571'pummaxwidth' 'pmw' number (default 0)
6572 global
6573 Determines the maximum width to use for the popup menu for completion.
6574 When zero, there is no maximum width limit, otherwise the popup menu
6575 will never be wider than this value. Truncated text will be indicated
glepnirb8762042025-04-07 20:57:14 +02006576 by "trunc" value of 'fillchars' option.
6577
6578 This option takes precedence over 'pumwidth'.
glepnir88d75932025-03-27 20:09:07 +01006579 |ins-completion-menu|.
6580
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006581 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006582'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006583 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006584 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006585 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006586
Bram Moolenaard94464e2015-11-02 15:28:18 +01006587 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006588'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006589 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006590 {only available when compiled with the |+python/dyn|
6591 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006592 Specifies the name of the Python 2.x shared library. The default is
6593 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006594 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006595 This option cannot be set from a |modeline| or in the |sandbox|, for
6596 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006597
Bram Moolenaar94073162018-01-31 21:49:05 +01006598 *'pythonhome'*
6599'pythonhome' string (default "")
6600 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006601 {only available when compiled with the |+python/dyn|
6602 feature}
6603 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6604 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6605 which was specified at compile time, will be used for the Python 2.x
6606 home directory.
6607 Environment variables are expanded |:set_env|.
6608 This option cannot be set from a |modeline| or in the |sandbox|, for
6609 security reasons.
6610
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006611 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006612'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006613 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006614 {only available when compiled with the |+python3/dyn|
6615 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006616 Specifies the name of the Python 3 shared library. The default is
6617 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006618 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006619 This option cannot be set from a |modeline| or in the |sandbox|, for
6620 security reasons.
6621
Bram Moolenaar94073162018-01-31 21:49:05 +01006622 *'pythonthreehome'*
6623'pythonthreehome' string (default "")
6624 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006625 {only available when compiled with the |+python3/dyn|
6626 feature}
6627 Specifies the name of the Python 3 home directory. When
6628 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6629 PYTHON3_HOME, which was specified at compile time, will be used for
6630 the Python 3 home directory.
6631 Environment variables are expanded |:set_env|.
6632 This option cannot be set from a |modeline| or in the |sandbox|, for
6633 security reasons.
6634
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006635 *'pyxversion'* *'pyx'*
6636'pyxversion' 'pyx' number (default depends on the build)
6637 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006638 {only available when compiled with the |+python| or
6639 the |+python3| feature}
6640 Specifies the python version used for pyx* functions and commands
6641 |python_x|. The default value is as follows:
6642
6643 Compiled with Default ~
6644 |+python| and |+python3| 0
6645 only |+python| 2
6646 only |+python3| 3
6647
6648 Available values are 0, 2 and 3.
6649 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6650 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6651 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6652 to 2 if Python 2 is available.
6653 See also: |has-pythonx|
6654
6655 If Vim is compiled with only |+python| or |+python3| setting
6656 'pyxversion' has no effect. The pyx* functions and commands are
6657 always the same as the compiled version.
6658
6659 This option cannot be set from a |modeline| or in the |sandbox|, for
6660 security reasons.
6661
Bram Moolenaar858ba062020-05-31 23:11:59 +02006662 *'quickfixtextfunc'* *'qftf'*
6663'quickfixtextfunc' 'qftf' string (default "")
6664 global
6665 {only available when compiled with the |+quickfix|
6666 feature}
6667 This option specifies a function to be used to get the text to display
6668 in the quickfix and location list windows. This can be used to
6669 customize the information displayed in the quickfix or location window
6670 for each entry in the corresponding quickfix or location list. See
6671 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006672 function and an example. The value can be the name of a function, a
6673 |lambda| or a |Funcref|. See |option-value-function| for more
6674 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006675
6676 This option cannot be set from a |modeline| or in the |sandbox|, for
6677 security reasons.
6678
Bram Moolenaar677ee682005-01-27 14:41:15 +00006679 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006680'quoteescape' 'qe' string (default "\")
6681 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006682 The characters that are used to escape quotes in a string. Used for
6683 objects like a', a" and a` |a'|.
6684 When one of the characters in this option is found inside a string,
6685 the following character will be skipped. The default value makes the
6686 text "foo\"bar\\" considered to be one string.
6687
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6689'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006690 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 If on, writes fail unless you use a '!'. Protects you from
6692 accidentally overwriting a file. Default on when Vim is started
6693 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006694 When using ":w!" the 'readonly' option is reset for the current
6695 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006696 When using the ":view" command the 'readonly' option is set for the
6697 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006698 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006700 *'redrawtime'* *'rdt'*
6701'redrawtime' 'rdt' number (default 2000)
6702 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006703 {only available when compiled with the |+reltime|
6704 feature}
6705 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006706 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006707 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006708 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006709 matches will be highlighted.
6710 For syntax highlighting the time applies per window. When over the
6711 limit syntax highlighting is disabled until |CTRL-L| is used.
6712 This is used to avoid that Vim hangs when using a very complicated
6713 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006714
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006715 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006716'regexpengine' 're' number (default 0)
6717 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006718 This selects the default regexp engine. |two-engines|
6719 The possible values are:
6720 0 automatic selection
6721 1 old engine
6722 2 NFA engine
6723 Note that when using the NFA engine and the pattern contains something
6724 that is not supported the pattern will not match. This is only useful
6725 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006726 Using automatic selection enables Vim to switch the engine, if the
6727 default engine becomes too costly. E.g., when the NFA engine uses too
6728 many states. This should prevent Vim from hanging on a combination of
6729 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006730
Bram Moolenaar64486672010-05-16 15:46:46 +02006731 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6732'relativenumber' 'rnu' boolean (default off)
6733 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006734 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006735 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006736 precede some vertical motion commands (e.g. j k + -) with, without
6737 having to calculate it yourself. Especially useful in combination with
6738 other commands (e.g. y d c < > gq gw =).
6739 When the 'n' option is excluded from 'cpoptions' a wrapped
6740 line will not use the column of line numbers (this is the default when
6741 'compatible' isn't set).
6742 The 'numberwidth' option can be used to set the room used for the line
6743 number.
6744 When a long, wrapped line doesn't start with the first character, '-'
6745 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006746 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6747 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006748
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006749 The number in front of the cursor line also depends on the value of
6750 'number', see |number_relativenumber| for all combinations of the two
6751 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006752
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 *'remap'* *'noremap'*
6754'remap' boolean (default on)
6755 global
6756 Allows for mappings to work recursively. If you do not want this for
6757 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006758 NOTE: To avoid portability problems with Vim scripts, always keep
6759 this option at the default "on". Only switch it off when working with
6760 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761
zeertzjqd086b8f2024-02-25 15:42:52 +08006762 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006763'renderoptions' 'rop' string (default: empty)
6764 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006765 {only available when compiled with GUI and DIRECTX on
6766 MS-Windows}
6767 Select a text renderer and set its options. The options depend on the
6768 renderer.
6769
6770 Syntax: >
6771 set rop=type:{renderer}(,{name}:{value})*
6772<
6773 Currently, only one optional renderer is available.
6774
6775 render behavior ~
6776 directx Vim will draw text using DirectX (DirectWrite). It makes
6777 drawn glyphs more beautiful than default GDI.
6778 It requires 'encoding' is "utf-8", and only works on
6779 MS-Windows Vista or newer version.
6780
6781 Options:
6782 name meaning type value ~
6783 gamma gamma float 1.0 - 2.2 (maybe)
6784 contrast enhancedContrast float (unknown)
6785 level clearTypeLevel float (unknown)
6786 geom pixelGeometry int 0 - 2 (see below)
6787 renmode renderingMode int 0 - 6 (see below)
6788 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006789 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006790
Bram Moolenaar92467d32017-12-05 13:22:16 +01006791 See this URL for detail (except for scrlines):
6792 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006793
6794 For geom: structure of a device pixel.
6795 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6796 1 - DWRITE_PIXEL_GEOMETRY_RGB
6797 2 - DWRITE_PIXEL_GEOMETRY_BGR
6798
6799 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006800 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006801
6802 For renmode: method of rendering glyphs.
6803 0 - DWRITE_RENDERING_MODE_DEFAULT
6804 1 - DWRITE_RENDERING_MODE_ALIASED
6805 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6806 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6807 4 - DWRITE_RENDERING_MODE_NATURAL
6808 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6809 6 - DWRITE_RENDERING_MODE_OUTLINE
6810
6811 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006812 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006813
6814 For taamode: antialiasing mode used for drawing text.
6815 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6816 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6817 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6818 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6819
6820 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006821 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6822
Bram Moolenaara338adc2018-01-31 20:51:47 +01006823 For scrlines:
6824 This was used for optimizing scrolling behavior, however this
6825 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006826
6827 Example: >
6828 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006829 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006830 set rop=type:directx
6831<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006832 If select a raster font (Courier, Terminal or FixedSys which
6833 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006834 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006835
6836 NOTE: It is known that some fonts and options combination
6837 causes trouble on drawing glyphs.
6838
Bram Moolenaar92467d32017-12-05 13:22:16 +01006839 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006840 special made fonts (True-Type fonts which includes only
6841 bitmap glyphs).
6842 - 'taamode:3' will not work with some vector fonts.
6843
6844 NOTE: With this option, you can display colored emoji
6845 (emoticon) in Windows 8.1 or later. To display colored emoji,
6846 there are some conditions which you should notice.
6847
6848 - If your font includes non-colored emoji already, it will
6849 be used.
6850 - If your font doesn't have emoji, the system chooses an
6851 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6852 will be used.
6853 - When this alternative font didn't have fixed width glyph,
6854 emoji might be rendered beyond the bounding box of drawing
6855 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006856
6857 Other render types are currently not supported.
6858
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 *'report'*
6860'report' number (default 2)
6861 global
6862 Threshold for reporting number of lines changed. When the number of
6863 changed lines is more than 'report' a message will be given for most
6864 ":" commands. If you want it always, set 'report' to 0.
6865 For the ":substitute" command the number of substitutions is used
6866 instead of the number of lines.
6867
6868 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6869'restorescreen' 'rs' boolean (default on)
6870 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006871 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 When set, the screen contents is restored when exiting Vim. This also
6873 happens when executing external commands.
6874
6875 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6876 options in your .vimrc. To disable restoring:
6877 set t_ti= t_te=
6878 To enable restoring (for an xterm):
6879 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6880 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6881
6882 *'revins'* *'ri'* *'norevins'* *'nori'*
6883'revins' 'ri' boolean (default off)
6884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 {only available when compiled with the |+rightleft|
6886 feature}
6887 Inserting characters in Insert mode will work backwards. See "typing
6888 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6889 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006890 NOTE: This option is reset when 'compatible' is set.
6891 This option is reset when 'paste' is set and restored when 'paste' is
6892 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893
6894 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6895'rightleft' 'rl' boolean (default off)
6896 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 {only available when compiled with the |+rightleft|
6898 feature}
6899 When on, display orientation becomes right-to-left, i.e., characters
6900 that are stored in the file appear from the right to the left.
6901 Using this option, it is possible to edit files for languages that
6902 are written from the right to the left such as Hebrew and Arabic.
6903 This option is per window, so it is possible to edit mixed files
6904 simultaneously, or to view the same file in both ways (this is
6905 useful whenever you have a mixed text file with both right-to-left
6906 and left-to-right strings so that both sets are displayed properly
6907 in different windows). Also see |rileft.txt|.
6908
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006909 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910'rightleftcmd' 'rlc' string (default "search")
6911 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 {only available when compiled with the |+rightleft|
6913 feature}
6914 Each word in this option enables the command line editing to work in
6915 right-to-left mode for a group of commands:
6916
6917 search "/" and "?" commands
6918
6919 This is useful for languages such as Hebrew, Arabic and Farsi.
6920 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6921
Bram Moolenaard94464e2015-11-02 15:28:18 +01006922 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006923'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006924 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006925 {only available when compiled with the |+ruby/dyn|
6926 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006927 Specifies the name of the Ruby shared library. The default is
6928 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006929 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006930 This option cannot be set from a |modeline| or in the |sandbox|, for
6931 security reasons.
6932
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006934'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006937 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 text in the file is shown on the far right:
6939 Top first line is visible
6940 Bot last line is visible
6941 All first and last line are visible
6942 45% relative position in the file
6943 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006944 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006945 ruler is shown there. Otherwise it is shown in the last line of the
6946 screen. If the statusline is given by 'statusline' (i.e. not empty),
6947 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006949 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 the text column (byte number) and the screen column are shown,
6951 separated with a dash.
6952 For an empty line "0-1" is shown.
6953 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006954 This option is reset when 'paste' is set and restored when 'paste' is
6955 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 If you don't want to see the ruler all the time but want to know where
6957 you are, use "g CTRL-G" |g_CTRL-G|.
6958 NOTE: This option is reset when 'compatible' is set.
6959
6960 *'rulerformat'* *'ruf'*
6961'rulerformat' 'ruf' string (default empty)
6962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 {not available when compiled without the |+statusline|
6964 feature}
6965 When this option is not empty, it determines the content of the ruler
6966 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006967 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006968 This option cannot be set in a modeline when 'modelineexpr' is off.
6969
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 The default ruler width is 17 characters. To make the ruler 15
6971 characters wide, put "%15(" at the start and "%)" at the end.
6972 Example: >
6973 :set rulerformat=%15(%c%V\ %p%%%)
6974<
6975 *'runtimepath'* *'rtp'* *vimfiles*
6976'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006977 Unix: "$HOME/.vim or
6978 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 $VIM/vimfiles,
6980 $VIMRUNTIME,
6981 $VIM/vimfiles/after,
6982 $HOME/.vim/after"
6983 Amiga: "home:vimfiles,
6984 $VIM/vimfiles,
6985 $VIMRUNTIME,
6986 $VIM/vimfiles/after,
6987 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006988 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 $VIM/vimfiles,
6990 $VIMRUNTIME,
6991 $VIM/vimfiles/after,
6992 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006993 Haiku: "$BE_USER_SETTINGS/vim,
6994 $VIM/vimfiles,
6995 $VIMRUNTIME,
6996 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006997 $BE_USER_SETTINGS/vim/after"
6998 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 $VIM/vimfiles,
7000 $VIMRUNTIME,
7001 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00007002 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 This is a list of directories which will be searched for runtime
7005 files:
7006 filetype.vim filetypes by file name |new-filetype|
7007 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007008 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 colors/ color scheme files |:colorscheme|
7010 compiler/ compiler files |:compiler|
7011 doc/ documentation |write-local-help|
7012 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007013 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 indent/ indent scripts |indent-expression|
7015 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02007016 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02007018 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 plugin/ plugin scripts |write-plugin|
7020 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007021 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 syntax/ syntax files |mysyntaxfile|
7023 tutor/ files for vimtutor |tutor|
7024
7025 And any other file searched for with the |:runtime| command.
7026
Christian Brabandtc3e6e392024-05-04 09:48:15 +02007027 For $XDG_CONFIG_HOME see |xdg-base-dir|.
7028
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 The defaults for most systems are setup to search five locations:
7030 1. In your home directory, for your personal preferences.
7031 2. In a system-wide Vim directory, for preferences from the system
7032 administrator.
7033 3. In $VIMRUNTIME, for files distributed with Vim.
7034 *after-directory*
7035 4. In the "after" directory in the system-wide Vim directory. This is
7036 for the system administrator to overrule or add to the distributed
7037 defaults (rarely needed)
7038 5. In the "after" directory in your home directory. This is for
7039 personal preferences to overrule or add to the distributed defaults
7040 or system-wide settings (rarely needed).
7041
Bram Moolenaard0796902016-09-16 20:02:31 +02007042 More entries are added when using |packages|. If it gets very long
7043 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
7044 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02007045
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
7047 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007048 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 wildcards.
7050 See |:runtime|.
7051 Example: >
7052 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
7053< This will use the directory "~/vimruntime" first (containing your
7054 personal Vim runtime files), then "/mygroup/vim" (shared between a
7055 group of people) and finally "$VIMRUNTIME" (the distributed runtime
7056 files).
7057 You probably should always include $VIMRUNTIME somewhere, to use the
7058 distributed runtime files. You can put a directory before $VIMRUNTIME
7059 to find files which replace a distributed runtime files. You can put
7060 a directory after $VIMRUNTIME to find files which add to distributed
7061 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007062 When Vim is started with |--clean| the home directory entries are not
7063 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 This option cannot be set from a |modeline| or in the |sandbox|, for
7065 security reasons.
7066
7067 *'scroll'* *'scr'*
7068'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02007069 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
7071 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01007072 changes. This may happen when enabling the |status-line| or
7073 'tabline' option after setting the 'scroll' option.
7074 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007076 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077
7078 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
7079'scrollbind' 'scb' boolean (default off)
7080 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08007081 See also |scroll-binding|. When this option is set, scrolling the
7082 current window also scrolls other scrollbind windows (windows that
7083 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 differences between two versions of a file, see 'diff'.
7085 See |'scrollopt'| for options that determine how this option should be
7086 interpreted.
7087 This option is mostly reset when splitting a window to edit another
7088 file. This means that ":split | edit file" results in two windows
7089 with scroll-binding, but ":split file" does not.
7090
Bram Moolenaarae20f342019-11-05 21:09:23 +01007091 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
7092'scrollfocus' 'scf' boolean (default off)
7093 global
7094 {only for MS-Windows GUI}
7095 When using the scroll wheel and this option is set, the window under
7096 the mouse pointer is scrolled. With this option off the current
7097 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007098 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01007099
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 *'scrolljump'* *'sj'*
7101'scrolljump' 'sj' number (default 1)
7102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 Minimal number of lines to scroll when the cursor gets off the
7104 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
7105 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00007106 When set to a negative number from -1 to -100 this is used as the
7107 percentage of the window height. Thus -50 scrolls half the window
7108 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 NOTE: This option is set to 1 when 'compatible' is set.
7110
7111 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007112'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007113 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 Minimal number of screen lines to keep above and below the cursor.
7115 This will make some context visible around where you are working. If
7116 you set it to a very large value (999) the cursor line will always be
7117 in the middle of the window (except at the start or end of the file or
7118 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007119 After using the local value, go back the global value with one of
7120 these two: >
7121 setlocal scrolloff<
7122 setlocal scrolloff=-1
7123< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 NOTE: This option is set to 0 when 'compatible' is set.
7125
7126 *'scrollopt'* *'sbo'*
7127'scrollopt' 'sbo' string (default "ver,jump")
7128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007130 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7131 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 The following words are available:
7133 ver Bind vertical scrolling for 'scrollbind' windows
7134 hor Bind horizontal scrolling for 'scrollbind' windows
7135 jump Applies to the offset between two windows for vertical
7136 scrolling. This offset is the difference in the first
7137 displayed line of the bound windows. When moving
7138 around in a window, another 'scrollbind' window may
7139 reach a position before the start or after the end of
7140 the buffer. The offset is not changed though, when
7141 moving back the 'scrollbind' window will try to scroll
7142 to the desired position when possible.
7143 When now making that window the current one, two
7144 things can be done with the relative offset:
7145 1. When "jump" is not included, the relative offset is
7146 adjusted for the scroll position in the new current
7147 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007148 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 2. When "jump" is included, the other windows are
7150 scrolled to keep the same relative offset. When
7151 going back to the other window, it still uses the
7152 same relative offset.
7153 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007154 When 'diff' mode is active there always is vertical scroll binding,
7155 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156
7157 *'sections'* *'sect'*
7158'sections' 'sect' string (default "SHNHH HUnhsh")
7159 global
7160 Specifies the nroff macros that separate sections. These are pairs of
7161 two letters (See |object-motions|). The default makes a section start
7162 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7163
7164 *'secure'* *'nosecure'* *E523*
7165'secure' boolean (default off)
7166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 When on, ":autocmd", shell and write commands are not allowed in
7168 ".vimrc" and ".exrc" in the current directory and map commands are
7169 displayed. Switch it off only if you know that you will not run into
7170 problems, or when the 'exrc' option is off. On Unix this option is
7171 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007172 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 'secure' at the end of your ~/.vimrc then.
7174 This option cannot be set from a |modeline| or in the |sandbox|, for
7175 security reasons.
7176
7177 *'selection'* *'sel'*
7178'selection' 'sel' string (default "inclusive")
7179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 This option defines the behavior of the selection. It is only used
7181 in Visual and Select mode.
7182 Possible values:
7183 value past line inclusive ~
7184 old no yes
7185 inclusive yes yes
7186 exclusive yes no
7187 "past line" means that the cursor is allowed to be positioned one
7188 character past the line.
7189 "inclusive" means that the last character of the selection is included
7190 in an operation. For example, when "x" is used to delete the
7191 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007192 When "old" is used and 'virtualedit' allows the cursor to move past
7193 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007194 When "exclusive" is used, cursor position in visual mode will be
7195 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 Note that when "exclusive" is used and selecting from the end
7197 backwards, you cannot include the last character of a line, when
7198 starting in Normal mode and 'virtualedit' empty.
7199
7200 The 'selection' option is set by the |:behave| command.
7201
7202 *'selectmode'* *'slm'*
7203'selectmode' 'slm' string (default "")
7204 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007205 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 Select mode instead of Visual mode, when a selection is started.
7207 Possible values:
7208 mouse when using the mouse
7209 key when using shifted special keys
7210 cmd when using "v", "V" or CTRL-V
7211 See |Select-mode|.
7212 The 'selectmode' option is set by the |:behave| command.
7213
7214 *'sessionoptions'* *'ssop'*
7215'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007216 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007218 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 feature}
7220 Changes the effect of the |:mksession| command. It is a comma
7221 separated list of words. Each word enables saving and restoring
7222 something:
7223 word save and restore ~
7224 blank empty windows
7225 buffers hidden and unloaded buffers, not just those in windows
7226 curdir the current directory
7227 folds manually created folds, opened/closed folds and local
7228 fold options
7229 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007230 and contain at least one lowercase letter. Only
7231 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 help the help window
7233 localoptions options and mappings local to a window or buffer (not
7234 global values for local options)
7235 options all options and mappings (also global values for local
7236 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007237 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 resize size of the Vim window: 'lines' and 'columns'
7239 sesdir the directory in which the session file is located
7240 will become the current directory (useful with
7241 projects accessed over a network from different
7242 systems)
7243 slash backslashes in file names replaced with forward
7244 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007245 tabpages all tab pages; without this only the current tab page
7246 is restored, so that you can make a session for each
7247 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007248 terminal include terminal windows where the command can be
7249 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 unix with Unix end-of-line format (single <NL>), even when
7251 on Windows or DOS
7252 winpos position of the whole Vim window
7253 winsize window sizes
7254
7255 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007256 When neither "curdir" nor "sesdir" is included, file names are stored
7257 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007258 If you leave out "options" many things won't work well after restoring
7259 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 "slash" and "unix" are useful on Windows when sharing session files
7261 with Unix. The Unix version of Vim cannot source dos format scripts,
7262 but the Windows version of Vim can source unix format scripts.
7263
7264 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007265'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 global
7267 Name of the shell to use for ! and :! commands. When changing the
7268 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7269 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007270 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 See |option-backslash| about including spaces and backslashes.
7272 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007273
Bram Moolenaara2baa732022-02-04 16:09:54 +00007274 In |restricted-mode| shell commands will not be possible. This mode
7275 is used if the value of $SHELL ends in "false" or "nologin".
7276
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007277 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007278 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7280< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007281 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007283 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007285 Example with escaped space (Vim will do this when initializing the
7286 option from $SHELL): >
7287 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007288< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007289 backslashes are consumed by `:set`.
7290
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 Under MS-Windows, when the executable ends in ".com" it must be
7292 included. Thus setting the shell to "command.com" or "4dos.com"
7293 works, but "command" and "4dos" do not work for all commands (e.g.,
7294 filtering).
7295 For unknown reasons, when using "4dos.com" the current directory is
7296 changed to "C:\". To avoid this set 'shell' like this: >
7297 :set shell=command.com\ /c\ 4dos
7298< This option cannot be set from a |modeline| or in the |sandbox|, for
7299 security reasons.
7300
7301 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007302'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007303 Win32, when 'shell' contains "powershell":
7304 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007305 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007308 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7309 For MS-Windows, the default is set according to the value of 'shell',
7310 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007311 On Unix it can have more than one flag. Each white space separated
7312 part is passed as an argument to the shell command.
7313 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007314 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 This option cannot be set from a |modeline| or in the |sandbox|, for
7316 security reasons.
7317
7318 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007319'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7320 "2>&1| tee", or
7321 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 {not available when compiled without the |+quickfix|
7324 feature}
7325 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007326 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327 including spaces and backslashes.
7328 The name of the temporary file can be represented by "%s" if necessary
7329 (the file name is appended automatically if no %s appears in the value
7330 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007331 For the Amiga the default is ">". For MS-Windows using powershell the
7332 default is "2>&1 | Out-File -Encoding default", otherwise the default
7333 is ">%s 2>&1". The output is directly saved in a file and not echoed
7334 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007335 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 in a file and echoed to the screen. If the 'shell' option is "csh" or
7337 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007338 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007339 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7340 means that stderr is also included. Before using the 'shell' option a
7341 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007342 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7343 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 The initialization of this option is done after reading the ".vimrc"
7345 and the other initializations, so that when the 'shell' option is set
7346 there, the 'shellpipe' option changes automatically, unless it was
7347 explicitly set before.
7348 When 'shellpipe' is set to an empty string, no redirection of the
7349 ":make" output will be done. This is useful if you use a 'makeprg'
7350 that writes to 'makeef' by itself. If you want no piping, but do
7351 want to include the 'makeef', set 'shellpipe' to a single space.
7352 Don't forget to precede the space with a backslash: ":set sp=\ ".
7353 In the future pipes may be used for filtering and this option will
7354 become obsolete (at least for Unix).
7355 This option cannot be set from a |modeline| or in the |sandbox|, for
7356 security reasons.
7357
7358 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007359'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 Quoting character(s), put around the command passed to the shell, for
7362 the "!" and ":!" commands. The redirection is kept outside of the
7363 quoting. See 'shellxquote' to include the redirection. It's
7364 probably not useful to set both options.
7365 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007366 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007367 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 This option cannot be set from a |modeline| or in the |sandbox|, for
7369 security reasons.
7370
7371 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007372'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7373 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 String to be used to put the output of a filter command in a temporary
7376 file. See also |:!|. See |option-backslash| about including spaces
7377 and backslashes.
7378 The name of the temporary file can be represented by "%s" if necessary
7379 (the file name is appended automatically if no %s appears in the value
7380 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007381 The default is ">". For Unix, if the 'shell' option is "csh" or
7382 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007383 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007384 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7385 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007386 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7387 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007388 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7389 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 The initialization of this option is done after reading the ".vimrc"
7391 and the other initializations, so that when the 'shell' option is set
7392 there, the 'shellredir' option changes automatically unless it was
7393 explicitly set before.
7394 In the future pipes may be used for filtering and this option will
7395 become obsolete (at least for Unix).
7396 This option cannot be set from a |modeline| or in the |sandbox|, for
7397 security reasons.
7398
7399 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7400'shellslash' 'ssl' boolean (default off)
7401 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007402 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007404 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007405 powershell.exe. Backward slashes can still be typed, but they are
7406 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 Note that setting or resetting this option has no effect for some
7408 existing file names, thus this option needs to be set before opening
7409 any file for best results. This might change in the future.
7410 'shellslash' only works when a backslash can be used as a path
7411 separator. To test if this is so use: >
7412 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007413< Also see 'completeslash'.
7414
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007415 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7416'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7417 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007418 When on, use temp files for shell commands. When off use a pipe.
7419 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007420 Currently a pipe is only supported on Unix and MS-Windows 2K and
7421 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007422 :if has("filterpipe")
7423< The advantage of using a pipe is that nobody can read the temp file
7424 and the 'shell' command does not need to support redirection.
7425 The advantage of using a temp file is that the file type and encoding
7426 can be detected.
7427 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7428 |FilterWritePost| autocommands event are not triggered when
7429 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007430 The `system()` function does not respect this option and always uses
7431 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007432 NOTE: This option is set to the Vim default value when 'compatible'
7433 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007434
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *'shelltype'* *'st'*
7436'shelltype' 'st' number (default 0)
7437 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007438 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 On the Amiga this option influences the way how the commands work
7440 which use a shell.
7441 0 and 1: always use the shell
7442 2 and 3: use the shell only to filter lines
7443 4 and 5: use shell only for ':sh' command
7444 When not using the shell, the command is executed directly.
7445
7446 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7447 1 and 3: use "shell cmd" to start external commands
7448
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007449 *'shellxescape'* *'sxe'*
7450'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007451 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007452 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007453 When 'shellxquote' is set to "(" then the characters listed in this
7454 option will be escaped with a '^' character. This makes it possible
7455 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007456 This option cannot be set from a |modeline| or in the |sandbox|, for
7457 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007458
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 *'shellxquote'* *'sxq'*
7460'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007461 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007462 for Win32, when 'shell' is
7463 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007464 for Win32, when 'shell' contains "sh"
7465 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 for Unix, when using system(): "\"")
7467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 Quoting character(s), put around the command passed to the shell, for
7469 the "!" and ":!" commands. Includes the redirection. See
7470 'shellquote' to exclude the redirection. It's probably not useful
7471 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007472 When the value is '(' then ')' is appended. When the value is '"('
7473 then ')"' is appended.
7474 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007475 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007476 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7477 pwsh.exe which automatically strips off the first and last quote on a
7478 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7479 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007480 'shell', to reduce the need to set this option by the user. See
7481 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 This option cannot be set from a |modeline| or in the |sandbox|, for
7483 security reasons.
7484
7485 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7486'shiftround' 'sr' boolean (default off)
7487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 Round indent to multiple of 'shiftwidth'. Applies to > and <
7489 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7490 a multiple of 'shiftwidth' (this is Vi compatible).
7491 NOTE: This option is reset when 'compatible' is set.
7492
7493 *'shiftwidth'* *'sw'*
7494'shiftwidth' 'sw' number (default 8)
7495 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007496 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007498 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007499 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500
7501 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007502'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7503 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007504 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007506 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 It is a list of flags:
7508 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007509 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7510 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7511 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7512 m use "[+]" instead of "[Modified]" *shm-m*
7513 n use "[New]" instead of "[New File]" *shm-n*
7514 r use "[RO]" instead of "[readonly]" *shm-r*
7515 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007517 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7518 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007519 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007520 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007522 o overwrite message for writing a file with subsequent *shm-o*
7523 message for reading a file (useful for ":wn" or when
7524 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007525 O message for reading a file overwrites any previous *shm-O*
7526 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007527 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7528 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007529 the search count do not show "W" before the count message
7530 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007531 t truncate file message at the start if it is too long *shm-t*
7532 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007533 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007534 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007535 long to fit on the command line; "..." will appear in the
7536 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007537 W don't give "written" or "[w]" when writing a file *shm-W*
7538 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007539 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007540 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007541 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007542 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007543 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7544 match", "Pattern not found", "Back at original", etc.
7545 C don't give messages while scanning for ins-completion *shm-C*
7546 items, for instance "scanning tags"
7547 q use "recording" instead of "recording @a" *shm-q*
7548 F don't give the file info when editing a file, like *shm-F*
7549 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007550 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007551 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007552 "[1/5]". When the "S" flag is not present (e.g. search count
7553 is shown), the "search hit BOTTOM, continuing at TOP" and
7554 "search hit TOP, continuing at BOTTOM" messages are only
7555 indicated by a "W" (Mnemonic: Wrapped) letter before the
7556 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557
7558 This gives you the opportunity to avoid that a change between buffers
7559 requires you to hit <Enter>, but still gives as useful a message as
7560 possible for the space available. To get the whole message that you
7561 would have got with 'shm' empty, use ":file!"
7562 Useful values:
7563 shm= No abbreviation of message.
7564 shm=a Abbreviation, but no loss of information.
7565 shm=at Abbreviation, and truncate message when necessary.
7566
7567 NOTE: This option is set to the Vi default value when 'compatible' is
7568 set and to the Vim default value when 'compatible' is reset.
7569
7570 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7571'shortname' 'sn' boolean (default off)
7572 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 Filenames are assumed to be 8 characters plus one extension of 3
7574 characters. Multiple dots in file names are not allowed. When this
7575 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007576 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007578 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579
7580 *'showbreak'* *'sbr'* *E595*
7581'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007582 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007583 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 feature}
7585 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007586 values are "> " or "+++ ": >
7587 :set showbreak=>\
7588< Note the backslash to escape the trailing space. It's easier like
7589 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007590 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007591< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 comma (in a future version the comma might be used to separate the
7593 part that is shown at the end and at the start of a line).
7594 The characters are highlighted according to the '@' flag in
7595 'highlight'.
7596 Note that tabs after the showbreak will be displayed differently.
7597 If you want the 'showbreak' to appear in between line numbers, add the
7598 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007599 A window-local value overrules a global value. If the global value is
7600 set and you want no value in the current window use NONE: >
7601 :setlocal showbreak=NONE
7602<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007604'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7605 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007607 Show (partial) command in the last line of the screen. Set this
7608 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 In Visual mode the size of the selected area is shown:
7610 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007611 If the number of bytes is different it is also displayed: "2-6"
7612 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007614 - When selecting a block, the size in screen characters:
7615 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007616 This information can be displayed in an alternative location using the
7617 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 NOTE: This option is set to the Vi default value when 'compatible' is
7619 set and to the Vim default value when 'compatible' is reset.
7620
Luuk van Baalba936f62022-12-15 13:15:39 +00007621 *'showcmdloc'* *'sloc'*
7622'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007623 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007624 This option can be used to display the (partially) entered command in
7625 another location. Possible values are:
7626 last Last line of the screen (default).
7627 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007628 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007629 Setting this option to "statusline" or "tabline" means that these will
7630 be redrawn whenever the command changes, which can be on every key
7631 pressed.
7632 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7633 place the text. Without a custom 'statusline' or 'tabline' it will be
7634 displayed in a convenient location.
7635
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7637'showfulltag' 'sft' boolean (default off)
7638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 When completing a word in insert mode (see |ins-completion|) from the
7640 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007641 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 matched a C function, you can see a template for what arguments are
7643 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007644 Note that this doesn't work well together with having "longest" in
7645 'completeopt', because the completion from the search pattern may not
7646 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647
7648 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7649'showmatch' 'sm' boolean (default off)
7650 global
7651 When a bracket is inserted, briefly jump to the matching one. The
7652 jump is only done if the match can be seen on the screen. The time to
7653 show the match can be set with 'matchtime'.
7654 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007655 seen or not).
7656 This option is reset when 'paste' is set and restored when 'paste' is
7657 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 When the 'm' flag is not included in 'cpoptions', typing a character
7659 will immediately move the cursor back to where it belongs.
7660 See the "sm" field in 'guicursor' for setting the cursor shape and
7661 blinking when showing the match.
7662 The 'matchpairs' option can be used to specify the characters to show
7663 matches for. 'rightleft' and 'revins' are used to look for opposite
7664 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007665 Also see the matchparen plugin for highlighting the match when moving
7666 around |pi_paren.txt|.
7667 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668
7669 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7670'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7671 global
7672 If in Insert, Replace or Visual mode put a message on the last line.
7673 Use the 'M' flag in 'highlight' to set the type of highlighting for
7674 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007675 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 doesn't mean XIM is really active, especially when 'imactivatekey' is
7677 not set.
7678 NOTE: This option is set to the Vi default value when 'compatible' is
7679 set and to the Vim default value when 'compatible' is reset.
7680
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007681 *'showtabline'* *'stal'*
7682'showtabline' 'stal' number (default 1)
7683 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007684 The value of this option specifies when the line with tab page labels
7685 will be displayed:
7686 0: never
7687 1: only if there are at least two tab pages
7688 2: always
7689 This is both for the GUI and non-GUI implementation of the tab pages
7690 line.
7691 See |tab-page| for more information about tab pages.
7692
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 *'sidescroll'* *'ss'*
7694'sidescroll' 'ss' number (default 0)
7695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 The minimal number of columns to scroll horizontally. Used only when
7697 the 'wrap' option is off and the cursor is moved off of the screen.
7698 When it is zero the cursor will be put in the middle of the screen.
7699 When using a slow terminal set it to a large number or 0. When using
7700 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7701 commands.
7702
7703 *'sidescrolloff'* *'siso'*
7704'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007705 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007707 right of the cursor if 'nowrap' is set. Setting this option to a
7708 value greater than 0 while having |'sidescroll'| also at a non-zero
7709 value makes some context visible in the line you are scrolling in
7710 horizontally (except at beginning of the line). Setting this option
7711 to a large value (like 999) has the effect of keeping the cursor
7712 horizontally centered in the window, as long as one does not come too
7713 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007714 After using the local value, go back the global value with one of
7715 these two: >
7716 setlocal sidescrolloff<
7717 setlocal sidescrolloff=-1
7718< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719
7720 Example: Try this together with 'sidescroll' and 'listchars' as
7721 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007722 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723
7724 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7725 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007726<
7727 *'signcolumn'* *'scl'*
7728'signcolumn' 'scl' string (default "auto")
7729 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007730 {not available when compiled without the |+signs|
7731 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007732 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007733 "auto" only when there is a sign to display
7734 "no" never
7735 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007736 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007737 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7740'smartcase' 'scs' boolean (default off)
7741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 Override the 'ignorecase' option if the search pattern contains upper
7743 case characters. Only used when the search pattern is typed and
7744 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007745 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7747 recalling the search pattern from history and hitting <Enter>.
7748 NOTE: This option is reset when 'compatible' is set.
7749
7750 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7751'smartindent' 'si' boolean (default off)
7752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 Do smart autoindenting when starting a new line. Works for C-like
7754 programs, but can also be used for other languages. 'cindent' does
7755 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007756 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007757 setting 'si' has no effect. 'indentexpr' is a more advanced
7758 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 Normally 'autoindent' should also be on when using 'smartindent'.
7760 An indent is automatically inserted:
7761 - After a line ending in '{'.
7762 - After a line starting with a keyword from 'cinwords'.
7763 - Before a line starting with '}' (only with the "O" command).
7764 When typing '}' as the first character in a new line, that line is
7765 given the same indent as the matching '{'.
7766 When typing '#' as the first character in a new line, the indent for
7767 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007768 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7770 When using the ">>" command, lines starting with '#' are not shifted
7771 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007772 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007773 This option is reset when 'paste' is set and restored when 'paste' is
7774 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775
7776 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7777'smarttab' 'sta' boolean (default off)
7778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007780 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7781 <BS> will delete a 'shiftwidth' worth of space at the start of the
7782 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007783 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007784 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7785 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007786 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007788 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007789 This option is reset when 'paste' is set and restored when 'paste' is
7790 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 NOTE: This option is reset when 'compatible' is set.
7792
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007793 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7794'smoothscroll' 'sms' boolean (default off)
7795 local to window
7796 Scrolling works with screen lines. When 'wrap' is set and the first
7797 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007798 above the window. "<<<" is displayed at the start of the first line,
7799 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007800 You may also want to add "lastline" to the 'display' option to show as
7801 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007802 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007803
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 *'softtabstop'* *'sts'*
7805'softtabstop' 'sts' number (default 0)
7806 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 Number of spaces that a <Tab> counts for while performing editing
7808 operations, like inserting a <Tab> or using <BS>. It "feels" like
7809 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7810 used. This is useful to keep the 'ts' setting at its standard value
7811 of 8, while being able to edit like it is set to 'sts'. However,
7812 commands like "x" still work on the actual characters.
7813 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007814 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007815 'softtabstop' is set to 0 when the 'paste' option is set and restored
7816 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7818 spaces is minimized by using <Tab>s.
7819 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7820 set.
7821 NOTE: This option is set to 0 when 'compatible' is set.
7822
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007823 If Vim is compiled with the |+vartabs| feature then the value of
7824 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7825 anything other than an empty string.
7826
Bram Moolenaar217ad922005-03-20 22:37:15 +00007827 *'spell'* *'nospell'*
7828'spell' boolean (default off)
7829 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007830 {not available when compiled without the |+syntax|
7831 feature}
7832 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007833 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007834
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007835 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007836'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007837 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007838 {not available when compiled without the |+syntax|
7839 feature}
7840 Pattern to locate the end of a sentence. The following word will be
7841 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007842 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007843 When this check is not wanted make this option empty.
7844 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007845 Be careful with special characters, see |option-backslash| about
7846 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007847 To set this option automatically depending on the language, see
7848 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007849
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007850 *'spellfile'* *'spf'*
7851'spellfile' 'spf' string (default empty)
7852 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007853 {not available when compiled without the |+syntax|
7854 feature}
7855 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007856 commands. It must end in ".{encoding}.add". You need to include the
7857 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007858 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007859 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007860 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007861 |zg| and |zw| commands can be used to access each. This allows using
7862 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007863 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007864 you: Using the first directory in 'runtimepath' that is writable. If
7865 there is no "spell" directory yet it will be created. For the file
7866 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007867 ignoring the region.
7868 The resulting ".spl" file will be used for spell checking, it does not
7869 have to appear in 'spelllang'.
7870 Normally one file is used for all regions, but you can add the region
7871 name if you want to. However, it will then only be used when
7872 'spellfile' is set to it, for entries in 'spelllang' only files
7873 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007874 This option cannot be set from a |modeline| or in the |sandbox|, for
7875 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007876
Bram Moolenaar217ad922005-03-20 22:37:15 +00007877 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007878'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007879 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007880 {not available when compiled without the |+syntax|
7881 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007882 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007883 on spellchecking will be done for these languages. Example: >
7884 set spelllang=en_us,nl,medical
7885< This means US English, Dutch and medical words are recognized. Words
7886 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007887 The word list name must consist of alphanumeric characters, a dash or
7888 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007889 recommended to separate the two letter language name from a
7890 specification. Thus "en-rare" is used for rare English words.
7891 A region name must come last and have the form "_xx", where "xx" is
7892 the two-letter, lower case region name. You can use more than one
7893 region by listing them: "en_us,en_ca" supports both US and Canadian
7894 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007895 Britain. (Note: currently en_au and en_nz dictionaries are older than
7896 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007897 If the name "cjk" is included East Asian characters are excluded from
7898 spell checking. This is useful when editing text that also has Asian
7899 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007900 Note that the "medical" dictionary does not exist, it is just an
7901 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007902 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007903 As a special case the name of a .spl file can be given as-is. The
7904 first "_xx" in the name is removed and used as the region name
7905 (_xx is an underscore, two letters and followed by a non-letter).
7906 This is mainly for testing purposes. You must make sure the correct
7907 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007908 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007909 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7910 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007911 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007912
Bram Moolenaar98692072006-02-04 00:57:42 +00007913 If the |spellfile.vim| plugin is active and you use a language name
7914 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7915 will ask you if you want to download the file.
7916
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007917 After this option has been set successfully, Vim will source the files
7918 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007919 up to the first character that is not an ASCII letter or number and
7920 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007921
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007922 *'spelloptions'* *'spo'*
7923'spelloptions' 'spo' string (default "")
7924 local to buffer
7925 {not available when compiled without the |+syntax|
7926 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007927 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007928 camel When a word is CamelCased, assume "Cased" is a
7929 separate word: every upper-case character in a word
7930 that comes after a lower case character indicates the
7931 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007932
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007933 *'spellsuggest'* *'sps'*
7934'spellsuggest' 'sps' string (default "best")
7935 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007936 {not available when compiled without the |+syntax|
7937 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007938 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007939 the |spellsuggest()| function. This is a comma-separated list of
7940 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007941
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007942 best Internal method that works best for English. Finds
7943 changes like "fast" and uses a bit of sound-a-like
7944 scoring to improve the ordering.
7945
7946 double Internal method that uses two methods and mixes the
7947 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007948 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007949 word. That only works when the language specifies
7950 sound folding. Can be slow and doesn't always give
7951 better results.
7952
7953 fast Internal method that only checks for simple changes:
7954 character inserts/deletes/swaps. Works well for
7955 simple typing mistakes.
7956
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007957 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007958 Not used for |spellsuggest()|. The number of
7959 suggestions is never more than the value of 'lines'
7960 minus two.
7961
Bram Moolenaar585ee072022-01-29 11:22:17 +00007962 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007963 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007964 methods. When omitted the limit is 5000. When
7965 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007966 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007967
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007968 file:{filename} Read file {filename}, which must have two columns,
7969 separated by a slash. The first column contains the
7970 bad word, the second column the suggested good word.
7971 Example:
7972 theribal/terrible ~
7973 Use this for common mistakes that do not appear at the
7974 top of the suggestion list with the internal methods.
7975 Lines without a slash are ignored, use this for
7976 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007977 The word in the second column must be correct,
7978 otherwise it will not be used. Add the word to an
7979 ".add" file if it is currently flagged as a spelling
7980 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007981 The file is used for all languages.
7982
7983 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007984 trouble with spaces. Best is to call a function
7985 without arguments, see |expr-option-function|.
7986 |v:val| holds the badly spelled word. The expression
7987 must evaluate to a List of Lists, each with a
7988 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007989 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007990 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007991 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007992 internal methods use. A lower score is better.
7993 This may invoke |spellsuggest()| if you temporarily
7994 set 'spellsuggest' to exclude the "expr:" part.
7995 Errors are silently ignored, unless you set the
7996 'verbose' option to a non-zero value.
7997
7998 Only one of "best", "double" or "fast" may be used. The others may
7999 appear several times in any order. Example: >
8000 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
8001<
8002 This option cannot be set from a |modeline| or in the |sandbox|, for
8003 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008004
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
8006'splitbelow' 'sb' boolean (default off)
8007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 When on, splitting a window will put the new window below the current
8009 one. |:split|
8010
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008011 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008012'splitkeep' 'spk' string (default "cursor")
8013 global
8014 The value of this option determines the scroll behavior when opening,
8015 closing or resizing horizontal splits.
8016
8017 Possible values are:
8018 cursor Keep the same relative cursor position.
8019 screen Keep the text on the same screen line.
8020 topline Keep the topline the same.
8021
8022 For the "screen" and "topline" values, the cursor position will be
8023 changed when necessary. In this case, the jumplist will be populated
8024 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01008025 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01008026
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
8028'splitright' 'spr' boolean (default off)
8029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 When on, splitting a window will put the new window right of the
8031 current one. |:vsplit|
8032
8033 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
8034'startofline' 'sol' boolean (default on)
8035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00008037 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01008038 (if possible). This applies to the commands:
8039 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02008040 - "d", "<<", "==" and ">>" with a linewise operator
8041 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01008042 - "%" with a count
8043 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
8044 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 In case of buffer changing commands the cursor is placed at the column
8046 where it was the last time the buffer was edited.
8047 NOTE: This option is set when 'compatible' is set.
8048
Bram Moolenaar00654022011-02-25 14:42:19 +01008049 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008051 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 {not available when compiled without the |+statusline|
8053 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00008054 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 Also see |status-line|.
8056
8057 The option consists of printf style '%' items interspersed with
8058 normal text. Each status line item is of the form:
8059 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008060 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01008061 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01008063 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00008064 When the option starts with "%!" then it is used as an expression,
8065 evaluated and the result is used as the option value. Example: >
8066 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008067< The *g:statusline_winid* variable will be set to the |window-ID| of the
8068 window that the status line belongs to.
8069 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008070 Note that the "%!" expression is evaluated in the context of the
8071 current window and buffer, while %{} items are evaluated in the
8072 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008073
8074 When there is error while evaluating the option then it will be made
8075 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00008076 When the result contains unprintable characters the result is
8077 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008078
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 Note that the only effect of 'ruler' when this option is set (and
8080 'laststatus' is 2) is controlling the output of |CTRL-G|.
8081
8082 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00008083 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008085 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 minwid Minimum width of the item, padding as set by '-' & '0'.
8087 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008088 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 on the left for text items. Numeric items will be
8090 shifted down to maxwid-2 digits followed by '>'number
8091 where number is the amount of missing digits, much like
8092 an exponential notation.
8093 item A one letter code as described below.
8094
8095 Following is a description of the possible statusline items. The
8096 second character in "item" is the type:
8097 N for number
8098 S for string
8099 F for flags as described below
8100 - not applicable
8101
8102 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00008103 f S Path to the file in the buffer, as typed or relative to current
8104 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 F S Full path to the file in the buffer.
8106 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008107 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008109 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008111 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008113 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008115 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008117 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8119 being used: "<keymap>"
8120 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008121 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008122 B N As above, in hexadecimal.
8123 o N Byte number in file of byte under cursor, first byte is 1.
8124 Mnemonic: Offset from start of file (with one added)
8125 {not available when compiled without |+byte_offset| feature}
8126 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008127 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 l N Line number.
8129 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008130 c N Column number (byte index).
8131 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008132 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 p N Percentage through file in lines as in |CTRL-G|.
8134 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008135 percentage described for 'ruler'. Always 3 in length, unless
8136 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008137 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008138 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008140 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008141 Note that there is no '%' before the closing '}'. The
8142 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008143 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008144 {% - This is almost same as { except the result of the expression is
8145 re-evaluated as a statusline format string. Thus if the
8146 return value of expr contains % items they will get expanded.
8147 The expression can contain the } character, the end of
8148 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008149 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008150 func! Stl_filename() abort
8151 return "%t"
8152 endfunc
8153< `stl=%{Stl_filename()}` results in `"%t"`
8154 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008155 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 ( - Start of item group. Can be used for setting the width and
8157 alignment of a section. Must be followed by %) somewhere.
8158 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008159 T N For 'tabline': start of tab page N label. Use %T after the last
8160 label. This information is used for mouse clicks.
8161 X N For 'tabline': start of close tab N label. Use %X after the
8162 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8163 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 < - Where to truncate line if too long. Default is at the start.
8165 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008166 = - Separation point between alignment sections. Each section will
8167 be separated by an equal number of spaces. With one %= what
8168 comes after it will be right-aligned. With two %= there is a
8169 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008171 # - Set highlight group. The name must follow and then a # again.
8172 Thus use %#HLname# for highlight group HLname. The same
8173 highlighting is used, also for the statusline of non-current
8174 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008176 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008177 The difference between User{N} and StatusLine will be applied to
8178 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 The number N must be between 1 and 9. See |hl-User1..9|
8180
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008181 When displaying a flag, Vim removes the leading comma, if any, when
8182 that flag comes right after plaintext. This will make a nice display
8183 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184
Bram Moolenaar582fd852005-03-28 20:58:01 +00008185 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 not set) and a minwid is not set for the group, the whole group will
8187 become empty. This will make a group like the following disappear
8188 completely from the statusline when none of the flags are set. >
8189 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008190< Beware that an expression is evaluated each and every time the status
8191 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008192 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008193 While evaluating %{} the current buffer and current window will be set
8194 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008195 currently being drawn. The expression will evaluate in this context.
8196 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8197 real current buffer and "g:actual_curwin" to the |window-ID| of the
8198 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008199
Bram Moolenaar30b65812012-07-12 22:01:11 +02008200 The 'statusline' option will be evaluated in the |sandbox| if set from
8201 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008202 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008203
8204 It is not allowed to change text or jump to another window while
8205 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206
8207 If the statusline is not updated when you want it (e.g., after setting
8208 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008209 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008211 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 Otherwise the result is taken as flag text and applied to the rules
8213 described above.
8214
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008215 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008217 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218
8219 Examples:
8220 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008221 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222< Similar, but add ASCII value of char under the cursor (like "ga") >
8223 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8224< Display byte count and byte value, modified flag in red. >
8225 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8226 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8227< Display a ,GZ flag if a compressed file is loaded >
8228 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8229< In the |:autocmd|'s: >
8230 :let b:gzflag = 1
8231< And: >
8232 :unlet b:gzflag
8233< And define this function: >
8234 :function VarExists(var, val)
8235 : if exists(a:var) | return a:val | else | return '' | endif
8236 :endfunction
8237<
8238 *'suffixes'* *'su'*
8239'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 Files with these suffixes get a lower priority when multiple files
8242 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008243 suffixes. Spaces after the comma are ignored. A dot is also seen as
8244 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 separator, precede it with a backslash (see |option-backslash| about
8246 including spaces and backslashes).
8247 See 'wildignore' for completely ignoring files.
8248 The use of |:set+=| and |:set-=| is preferred when adding or removing
8249 suffixes from the list. This avoids problems when a future version
8250 uses another default.
8251
8252 *'suffixesadd'* *'sua'*
8253'suffixesadd' 'sua' string (default "")
8254 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008255 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 file for the "gf", "[I", etc. commands. Example: >
8257 :set suffixesadd=.java
8258<
8259 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8260'swapfile' 'swf' boolean (default on)
8261 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008262 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 swapfile is not wanted for a specific buffer. For example, with
8264 confidential information that even root must not be able to access.
8265 Careful: All text will be in memory:
8266 - Don't use this for big files.
8267 - Recovery will be impossible!
8268 A swapfile will only be present when |'updatecount'| is non-zero and
8269 'swapfile' is set.
8270 When 'swapfile' is reset, the swap file for the current buffer is
8271 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8272 non-zero, a swap file is immediately created.
8273 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008274 If you want to open a new buffer without creating a swap file for it,
8275 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008276 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277
8278 This option is used together with 'bufhidden' and 'buftype' to
8279 specify special kinds of buffers. See |special-buffers|.
8280
8281 *'swapsync'* *'sws'*
8282'swapsync' 'sws' string (default "fsync")
8283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008285 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 When this option is empty parts of the swap file may be in memory and
8287 not written to disk. When the system crashes you may lose more work.
8288 On Unix the system does a sync now and then without Vim asking for it,
8289 so the disadvantage of setting this option off is small. On some
8290 systems the swap file will not be written at all. For a unix system
8291 setting it to "sync" will use the sync() call instead of the default
8292 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008293 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294
8295 *'switchbuf'* *'swb'*
8296'switchbuf' 'swb' string (default "")
8297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008299 This option is checked, when
8300 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008301 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008302 - jumping to a tag using the |:stag| command.
8303 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8304 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8305 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008306 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008307 useopen If included, jump to the first open window in the
8308 current tab page that contains the specified buffer
8309 (if there is one). Otherwise: Do not examine other
8310 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008311 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008312 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008314 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008315 Otherwise: do not split, use current window (when used
8316 in the quickfix window: the previously used window or
8317 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008318 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008319 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008320 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008321 uselast If included, jump to the previously used window when
8322 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008323 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8324 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008326 *'synmaxcol'* *'smc'*
8327'synmaxcol' 'smc' number (default 3000)
8328 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008329 {not available when compiled without the |+syntax|
8330 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008331 Maximum column in which to search for syntax items. In long lines the
8332 text after this column is not highlighted and following lines may not
8333 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008334 This helps to avoid very slow redrawing for an XML file that is one
8335 long line.
8336 Set to zero to remove the limit.
8337
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 *'syntax'* *'syn'*
8339'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008340 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 {not available when compiled without the |+syntax|
8342 feature}
8343 When this option is set, the syntax with this name is loaded, unless
8344 syntax highlighting has been switched off with ":syntax off".
8345 Otherwise this option does not always reflect the current syntax (the
8346 b:current_syntax variable does).
8347 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008348 not automatically recognized. Example, in an IDL file:
8349 /* vim: set syntax=idl : */ ~
8350 When a dot appears in the value then this separates two filetype
8351 names. Example:
8352 /* vim: set syntax=c.doxygen : */ ~
8353 This will use the "c" syntax first, then the "doxygen" syntax.
8354 Note that the second one must be prepared to be loaded as an addition,
8355 otherwise it will be skipped. More than one dot may appear.
8356 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 :set syntax=OFF
8358< To switch syntax highlighting on according to the current value of the
8359 'filetype' option: >
8360 :set syntax=ON
8361< What actually happens when setting the 'syntax' option is that the
8362 Syntax autocommand event is triggered with the value as argument.
8363 This option is not copied to another buffer, independent of the 's' or
8364 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008365 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366
LemonBoy5247b0b2024-07-12 19:30:58 +02008367 *'tabclose'* *'tcl'*
8368'tabclose' 'tcl' string (default "")
8369 global
8370 This option controls the behavior when closing tab pages (e.g., using
8371 |:tabclose|). When empty Vim goes to the next (right) tab page.
8372
8373 Possible values (comma-separated list):
8374 left If included, go to the previous tab page instead of
8375 the next one.
8376 uselast If included, go to the previously used tab page if
8377 possible. This option takes precedence over the
8378 others.
8379
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008380 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008381'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008382 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008383 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008384 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008385 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008386
8387 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008388 option and only when there is no GUI tab line. When 'e' is in
8389 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008390 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008391
8392 The value is evaluated like with 'statusline'. You can use
8393 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008394 the text to be displayed. Use "%1T" for the first label, "%2T" for
8395 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008396
Bram Moolenaare12bab32019-01-08 22:02:56 +01008397 When changing something that is used in 'tabline' that does not
8398 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008399 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008400
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008401 Keep in mind that only one of the tab pages is the current one, others
8402 are invisible and you can't jump to their windows.
8403
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008404 *'tabpagemax'* *'tpm'*
8405'tabpagemax' 'tpm' number (default 10)
8406 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008407 Maximum number of tab pages to be opened by the |-p| command line
8408 argument or the ":tab all" command. |tabpage|
8409
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008410 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411'tabstop' 'ts' number (default 8)
8412 local to buffer
8413 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008414 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415
8416 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008417 appear wrong in many places, e.g., when printing it.
8418 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008420 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008421 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8422 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008423 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008425 This is the recommended way, the file will look the same with other
8426 tools and when listing it in a terminal.
8427 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8428 'expandtab'. This way you will always insert spaces. The
8429 formatting will never be messed up when 'tabstop' is changed (leave
8430 it at 8 just in case). The file will be a bit larger.
8431 You do need to check if no Tabs exist in the file. You can get rid
8432 of them by first setting 'expandtab' and using `%retab!`, making
8433 sure the value of 'tabstop' is set correctly.
8434 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 'expandtab'. This way you will always insert spaces. The
8436 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008437 You do need to check if no Tabs exist in the file, just like in the
8438 item just above.
8439 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008440 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008441 works when using Vim to edit the file, other tools assume a tabstop
8442 is worth 8 spaces.
8443 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 'noexpandtab'. This should then work (for initial indents only)
8445 for any tabstop setting that people use. It might be nice to have
8446 tabs after the first non-blank inserted as spaces if you do this
8447 though. Otherwise aligned comments will be wrong when 'tabstop' is
8448 changed.
8449
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008450 If Vim is compiled with the |+vartabs| feature then the value of
8451 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8452 than an empty string.
8453
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8455'tagbsearch' 'tbs' boolean (default on)
8456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008458 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 searching makes searching for a tag a LOT faster, but a linear search
8460 will find more tags if the tags file wasn't properly sorted.
8461 Vim normally assumes that your tags files are sorted, or indicate that
8462 they are not sorted. Only when this is not the case does the
8463 'tagbsearch' option need to be switched off.
8464
8465 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008466 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 certain files, or retry all files with a linear search. When
8468 'tagbsearch' is off, only a linear search is done.
8469
8470 Linear searching is done anyway, for one file, when Vim finds a line
8471 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008472 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473< [The whitespace before and after the '0' must be a single <Tab>]
8474
8475 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008476 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 instead of a normal tag name, a retry is done with a linear search.
8478 Tags in unsorted tags files, and matches with different case will only
8479 be found in the retry.
8480
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008481 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008482 linear search can be avoided when case is ignored. Use a value of '2'
8483 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8484 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008485 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8486 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8487 used for this as well. Note that case must be folded to uppercase for
8488 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008489
8490 By default, tag searches are case-sensitive. Case is ignored when
8491 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8492 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008493 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8494 'tagcase' is "smart", and the pattern contains only lowercase
8495 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496
8497 When 'tagbsearch' is off, tags searching is slower when a full match
8498 exists, but faster when no full match exists. Tags in unsorted tags
8499 files may only be found with 'tagbsearch' off.
8500 When the tags file is not sorted, or sorted in a wrong way (not on
8501 ASCII byte value), 'tagbsearch' should be off, or the line given above
8502 must be included in the tags file.
8503 This option doesn't affect commands that find all matching tags (e.g.,
8504 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008506 *'tagcase'* *'tc'*
8507'tagcase' 'tc' string (default "followic")
8508 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008509 This option specifies how case is handled when searching the tags
8510 file:
8511 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008512 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008513 ignore Ignore case
8514 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008515 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008516 NOTE: This option is set to the Vi default value when 'compatible' is
8517 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008518
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008519 *'tagfunc'* *'tfu'*
8520'tagfunc' 'tfu' string (default: empty)
8521 local to buffer
8522 {not available when compiled without the |+eval|
8523 feature}
Christian Brabandtfb081922025-04-30 19:31:58 +02008524 This option specifies a function to be used to perform tag searches
8525 (including |taglist()|).
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008526 The function gets the tag pattern and should return a List of matching
8527 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008528 function and an example. The value can be the name of a function, a
8529 |lambda| or a |Funcref|. See |option-value-function| for more
8530 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008531 This option cannot be set from a |modeline| or in the |sandbox|, for
8532 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008533
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 *'taglength'* *'tl'*
8535'taglength' 'tl' number (default 0)
8536 global
8537 If non-zero, tags are significant up to this number of characters.
8538
8539 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8540'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8541 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008542 If on and using a tags file in another directory, file names in that
8543 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 NOTE: This option is set to the Vi default value when 'compatible' is
8545 set and to the Vim default value when 'compatible' is reset.
8546
8547 *'tags'* *'tag'* *E433*
8548'tags' 'tag' string (default "./tags,tags", when compiled with
8549 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8550 global or local to buffer |global-local|
8551 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008552 include a space or comma in a file name, precede it with backslashes
8553 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 When a file name starts with "./", the '.' is replaced with the path
8555 of the current file. But only when the 'd' flag is not included in
8556 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8557 |tags-option|.
8558 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008559 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8560 find all files named "tags" below "/lib". The filename itself cannot
8561 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008562 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008563 The |tagfiles()| function can be used to get a list of the file names
8564 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8566 files are also supported. They are automatically recognized. The
8567 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8568 differences are ignored (MS-Windows). |emacs-tags|
8569 The use of |:set+=| and |:set-=| is preferred when adding or removing
8570 file names from the list. This avoids problems when a future version
8571 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572
8573 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8574'tagstack' 'tgst' boolean (default on)
8575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 When on, the |tagstack| is used normally. When off, a ":tag" or
8577 ":tselect" command with an argument will not push the tag onto the
8578 tagstack. A following ":tag" without an argument, a ":pop" command or
8579 any other command that uses the tagstack will use the unmodified
8580 tagstack, but does change the pointer to the active entry.
8581 Resetting this option is useful when using a ":tag" command in a
8582 mapping which should not change the tagstack.
8583
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008584 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008585'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008586 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008587 {only available when compiled with the |+tcl/dyn|
8588 feature}
8589 Specifies the name of the Tcl shared library. The default is
8590 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008591 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008592 This option cannot be set from a |modeline| or in the |sandbox|, for
8593 security reasons.
8594
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 *'term'* *E529* *E530* *E531*
8596'term' string (default is $TERM, if that fails:
8597 in the GUI: "builtin_gui"
8598 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008599 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008600 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 on Unix: "ansi"
8602 on VMS: "ansi"
8603 on Win 32: "win32")
8604 global
8605 Name of the terminal. Used for choosing the terminal control
8606 characters. Environment variables are expanded |:set_env|.
8607 For example: >
8608 :set term=$TERM
8609< See |termcap|.
8610
8611 *'termbidi'* *'tbidi'*
8612 *'notermbidi'* *'notbidi'*
8613'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 {only available when compiled with the |+arabic|
8616 feature}
8617 The terminal is in charge of Bi-directionality of text (as specified
8618 by Unicode). The terminal is also expected to do the required shaping
8619 that some languages (such as Arabic) require.
8620 Setting this option implies that 'rightleft' will not be set when
8621 'arabic' is set and the value of 'arabicshape' will be ignored.
8622 Note that setting 'termbidi' has the immediate effect that
8623 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8624 This option is reset when the GUI is started.
8625 For further details see |arabic.txt|.
8626
8627 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008628'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 Encoding used for the terminal. This specifies what character
8631 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008632 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008633 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008634 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008635 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8637 Any attempts to set a different value will be rejected, and an error
8638 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008639 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 because the Win32 system always passes Unicode characters.
8641 When empty, the same encoding is used as for the 'encoding' option.
8642 This is the normal value.
8643 Not all combinations for 'termencoding' and 'encoding' are valid. See
8644 |encoding-table|.
8645 The value for this option must be supported by internal conversions or
8646 iconv(). When this is not possible no conversion will be done and you
8647 will probably experience problems with non-ASCII characters.
8648 Example: You are working with the locale set to euc-jp (Japanese) and
8649 want to edit a UTF-8 file: >
8650 :let &termencoding = &encoding
8651 :set encoding=utf-8
8652< You need to do this when your system has no locale support for UTF-8.
8653
Bram Moolenaar938ae282023-02-20 20:44:55 +00008654 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008655'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8656 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008657 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008658 {not available when compiled without the
8659 |+termguicolors| feature}
8660 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008661 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008662
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008663 Requires a ISO-8613-3 compatible terminal. If setting this option
8664 does not work (produces a colorless UI) reading |xterm-true-color|
8665 might help.
8666
8667 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8668 is required. Use this check to find out: >
8669 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008670< This requires Vim to be built with the |+vtp| feature.
8671
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008672 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008673
8674 When using Vim with Windows Terminal, the background of Windows
8675 Terminal is normally filled with the Vim background color. Setting
8676 'termguicolors' and the guibg of the Normal highlight group to NONE
8677 will make the background transparent: >
8678 :hi Normal guibg=NONE
8679<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008680 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008681
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008682 *'termwinkey'* *'twk'*
8683'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008684 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008685 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008686 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008687 The key can be specified as a single character, a |key-notation| (e.g.
8688 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8689 :set twk=X
8690 :set twk=^I
8691 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008692< The string must be one key stroke but can be multiple bytes.
8693 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008694 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008695 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008696
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008697 *'termwinscroll'* *'twsl'*
8698'termwinscroll' 'twsl' number (default 10000)
8699 local to buffer
8700 {not available when compiled without the
8701 |+terminal| feature}
8702 Number of scrollback lines to keep. When going over this limit the
8703 first 10% of the scrollback lines are deleted. This is just to reduce
8704 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008705 Also used as a limit for text sent to the terminal in one write,
8706 multiplied by the number of columns times 3 (average number of bytes
8707 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008708
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008709 *'termwinsize'* *'tws'*
8710'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008711 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008712 Size used when opening the |terminal| window. Format:
8713 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008714 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008715 - When set with a "x" (e.g., "24x80") the terminal size is not
8716 adjusted to the window size. If the window is smaller only the
8717 top-left part is displayed.
8718 - When set with a "*" (e.g., "10*50") the terminal size follows the
8719 window size, but will not be smaller than the specified rows and/or
8720 columns.
8721 - When rows is zero then use the height of the window.
8722 - When columns is zero then use the width of the window.
8723 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008724 - Can be overruled in the |term_start()| options with "term_rows" and
8725 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008726
8727 Examples:
8728 "30x0" uses 30 rows and the current window width.
8729 "20*0" uses at least 20 rows and the current window width.
8730 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008731 Note that the command running in the terminal window may still change
8732 the size of the terminal. In that case the Vim window will be
8733 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008734
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008735 *'termwintype'* *'twt'*
8736'termwintype' 'twt' string (default "")
8737 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008738 {only available when compiled with the |terminal|
8739 feature on MS-Windows}
8740 Specify the virtual console (pty) used when opening the terminal
8741 window.
8742
8743 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008744 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008745 "winpty" use winpty, fail if not supported
8746 "conpty" use |ConPTY|, fail if not supported
8747
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008748 |ConPTY| support depends on the platform. Windows 10 October 2018
8749 Update is the first version that supports ConPTY, however it is still
8750 considered unstable. ConPTY might become stable in the next release
8751 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008752 supported then you cannot open a terminal window.
8753
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 *'terse'* *'noterse'*
8755'terse' boolean (default off)
8756 global
8757 When set: Add 's' flag to 'shortmess' option (this makes the message
8758 for a search that hits the start or end of the file not being
8759 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8760 shortens a lot of messages}
8761
8762 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8763'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 This option is obsolete. Use 'fileformats'.
8766 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8767 set to the default value for the current system. When 'textauto' is
8768 reset, 'fileformats' is made empty.
8769 NOTE: This option is set to the Vi default value when 'compatible' is
8770 set and to the Vim default value when 'compatible' is reset.
8771
8772 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008773'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 others: default off)
8775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 This option is obsolete. Use 'fileformat'.
8777 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8778 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8779 "unix".
8780
8781 *'textwidth'* *'tw'*
8782'textwidth' 'tw' number (default 0)
8783 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 Maximum width of text that is being inserted. A longer line will be
8785 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008786 this.
8787 'textwidth' is set to 0 when the 'paste' option is set and restored
8788 when 'paste' is reset.
8789 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008791 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 NOTE: This option is set to 0 when 'compatible' is set.
8793
8794 *'thesaurus'* *'tsr'*
8795'thesaurus' 'tsr' string (default "")
8796 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008798 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8799 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008800
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008801 This option is not used if 'thesaurusfunc' is set, either for the
8802 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008803
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008804 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008806 name. See |option-backslash| about using backslashes. The use of
8807 |:set+=| and |:set-=| is preferred when adding or removing directories
8808 from the list. This avoids problems when a future version uses
8809 another default. Backticks cannot be used in this option for security
8810 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008812 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008813'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008814 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008815 {not available when compiled without the |+eval|
8816 feature}
8817 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008818 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008819 The value can be the name of a function, a |lambda| or a |Funcref|.
8820 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008821
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008822 This option cannot be set from a |modeline| or in the |sandbox|, for
8823 security reasons.
8824
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8826'tildeop' 'top' boolean (default off)
8827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 When on: The tilde command "~" behaves like an operator.
8829 NOTE: This option is reset when 'compatible' is set.
8830
8831 *'timeout'* *'to'* *'notimeout'* *'noto'*
8832'timeout' 'to' boolean (default on)
8833 global
laburnumT3f7855a2023-12-05 18:37:03 +01008834
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008836'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 These two options together determine the behavior when part of a
8839 mapped key sequence or keyboard code has been received:
8840
8841 'timeout' 'ttimeout' action ~
8842 off off do not time out
8843 on on or off time out on :mappings and key codes
8844 off on time out on key codes
8845
8846 If both options are off, Vim will wait until either the complete
8847 mapping or key sequence has been received, or it is clear that there
8848 is no mapping or key sequence for the received characters. For
8849 example: if you have mapped "vl" and Vim has received 'v', the next
8850 character is needed to see if the 'v' is followed by an 'l'.
8851 When one of the options is on, Vim will wait for about 1 second for
8852 the next character to arrive. After that the already received
8853 characters are interpreted as single characters. The waiting time can
8854 be changed with the 'timeoutlen' option.
8855 On slow terminals or very busy systems timing out may cause
8856 malfunctioning cursor keys. If both options are off, Vim waits
8857 forever after an entered <Esc> if there are key codes that start
8858 with <Esc>. You will have to type <Esc> twice. If you do not have
8859 problems with key codes, but would like to have :mapped key
8860 sequences not timing out in 1 second, set the 'ttimeout' option and
8861 reset the 'timeout' option.
8862
8863 NOTE: 'ttimeout' is reset when 'compatible' is set.
8864
8865 *'timeoutlen'* *'tm'*
8866'timeoutlen' 'tm' number (default 1000)
8867 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008868
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008870'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 The time in milliseconds that is waited for a key code or mapped key
8873 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8874 when part of a command has been typed.
8875 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8876 different timeout value for key codes is desired set 'ttimeoutlen' to
8877 a non-negative number.
8878
8879 ttimeoutlen mapping delay key code delay ~
8880 < 0 'timeoutlen' 'timeoutlen'
8881 >= 0 'timeoutlen' 'ttimeoutlen'
8882
8883 The timeout only happens when the 'timeout' and 'ttimeout' options
8884 tell so. A useful setting would be >
8885 :set timeout timeoutlen=3000 ttimeoutlen=100
8886< (time out on mapping after three seconds, time out on key codes after
8887 a tenth of a second).
8888
8889 *'title'* *'notitle'*
8890'title' boolean (default off, on when title can be restored)
8891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 When on, the title of the window will be set to the value of
8893 'titlestring' (if it is not empty), or to:
8894 filename [+=-] (path) - VIM
8895 Where:
8896 filename the name of the file being edited
8897 - indicates the file cannot be modified, 'ma' off
8898 + indicates the file was modified
8899 = indicates the file is read-only
8900 =+ indicates the file is read-only and modified
8901 (path) is the path of the file being edited
8902 - VIM the server name |v:servername| or "VIM"
8903 Only works if the terminal supports setting window titles
8904 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008905 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8907 *X11*
8908 When Vim was compiled with HAVE_X11 defined, the original title will
8909 be restored if possible. The output of ":version" will include "+X11"
8910 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8911 works for the icon name |'icon'|.
8912 But: When Vim was started with the |-X| argument, restoring the title
8913 will not work (except in the GUI).
8914 If the title cannot be restored, it is set to the value of 'titleold'.
8915 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008916 When using an xterm from a remote machine you can use this command: >
8917
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008919 ssh -X machine_name xterm &
8920<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 then the WINDOWID environment variable should be inherited and the
8922 title of the window should change back to what it should be after
8923 exiting Vim.
8924
8925 *'titlelen'*
8926'titlelen' number (default 85)
8927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008929 title. When the title is longer, only the end of the path name is
8930 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 Using a percentage makes this adapt to the width of the window. But
8932 it won't work perfectly, because the actual number of characters
8933 available also depends on the font used and other things in the title
8934 bar. When 'titlelen' is zero the full path is used. Otherwise,
8935 values from 1 to 30000 percent can be used.
8936 'titlelen' is also used for the 'titlestring' option.
8937
8938 *'titleold'*
8939'titleold' string (default "Thanks for flying Vim")
8940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 This option will be used for the window title when exiting Vim if the
8942 original title cannot be restored. Only happens if 'title' is on or
8943 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008944 This option cannot be set from a |modeline| or in the |sandbox|, for
8945 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 *'titlestring'*
8947'titlestring' string (default "")
8948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 When this option is not empty, it will be used for the title of the
8950 window. This happens only when the 'title' option is on.
8951 Only works if the terminal supports setting window titles (currently
8952 Amiga console, Win32 console, all GUI versions and terminals with a
8953 non-empty 't_ts' option).
8954 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008955 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008956
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008958 expanded according to the rules used for 'statusline'. If it contains
8959 an invalid '%' format, the value is used as-is and no error or warning
8960 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008961 This option cannot be set in a modeline when 'modelineexpr' is off.
8962
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008964 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8966< The value of 'titlelen' is used to align items in the middle or right
8967 of the available space.
8968 Some people prefer to have the file name first: >
8969 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8970< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008971 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 separating space only when needed.
8973 NOTE: Use of special characters in 'titlestring' may cause the display
8974 to be garbled (e.g., when it contains a CR or NL character).
8975 {not available when compiled without the |+statusline| feature}
8976
8977 *'toolbar'* *'tb'*
8978'toolbar' 'tb' string (default "icons,tooltips")
8979 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008980 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008981 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 possible values are:
8983 icons Toolbar buttons are shown with icons.
8984 text Toolbar buttons shown with text.
8985 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008986 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 tooltips Tooltips are active for toolbar buttons.
8988 Tooltips refer to the popup help text which appears after the mouse
8989 cursor is placed over a toolbar button for a brief moment.
8990
8991 If you want the toolbar to be shown with icons as well as text, do the
8992 following: >
8993 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008994< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 will show icons if both are requested.
8996
8997 If none of the strings specified in 'toolbar' are valid or if
8998 'toolbar' is empty, this option is ignored. If you want to disable
8999 the toolbar, you need to set the 'guioptions' option. For example: >
9000 :set guioptions-=T
9001< Also see |gui-toolbar|.
9002
9003 *'toolbariconsize'* *'tbis'*
9004'toolbariconsize' 'tbis' string (default "small")
9005 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01009006 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009008 tiny Use tiny icons.
9009 small Use small icons (default).
9010 medium Use medium-sized icons.
9011 large Use large icons.
9012 huge Use even larger icons.
9013 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01009015 the current theme. Common dimensions are giant=48x48, huge=32x32,
9016 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017
9018 If 'toolbariconsize' is empty, the global default size as determined
9019 by user preferences or the current theme is used.
9020
9021 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
9022'ttybuiltin' 'tbi' boolean (default on)
9023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 When on, the builtin termcaps are searched before the external ones.
9025 When off the builtin termcaps are searched after the external ones.
9026 When this option is changed, you should set the 'term' option next for
9027 the change to take effect, for example: >
9028 :set notbi term=$TERM
9029< See also |termcap|.
9030 Rationale: The default for this option is "on", because the builtin
9031 termcap entries are generally better (many systems contain faulty
9032 xterm entries...).
9033
9034 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009035'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 Indicates a fast terminal connection. More characters will be sent to
9038 the screen for redrawing, instead of using insert/delete line
9039 commands. Improves smoothness of redrawing when there are multiple
9040 windows and the terminal does not support a scrolling region.
9041 Also enables the extra writing of characters at the end of each screen
9042 line for lines that wrap. This helps when using copy/paste with the
9043 mouse in an xterm and other terminals.
9044
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00009045 The default used to be set only for some terminal names, but these
9046 days nearly all terminals are fast, therefore the default is now "on".
9047 If you have a slow connection you may want to set this option off,
9048 e.g. depending on the host name: >
9049 if hostname() =~ 'faraway'
9050 set nottyfast
9051 endif
9052<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 *'ttymouse'* *'ttym'*
9054'ttymouse' 'ttym' string (default depends on 'term')
9055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 {only in Unix and VMS, doesn't work in the GUI; not
9057 available when compiled without |+mouse|}
9058 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00009059 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 *xterm-mouse*
9061 xterm xterm-like mouse handling. The mouse generates
9062 "<Esc>[Mscr", where "scr" is three bytes:
9063 "s" = button state
9064 "c" = column plus 33
9065 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02009066 This only works up to 223 columns! See "dec",
9067 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 xterm2 Works like "xterm", but with the xterm reporting the
9069 mouse position while the mouse is dragged. This works
9070 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00009071 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 work. See below for how Vim detects this
9073 automatically.
9074 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009075 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02009077 for the row and column. No other mouse events are
9078 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 *dec-mouse*
9080 dec DEC terminal mouse handling. The mouse generates a
9081 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00009082 This is also available for an Xterm, if it was
9083 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 *jsbterm-mouse*
9085 jsbterm JSB term mouse handling.
9086 *pterm-mouse*
9087 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009088 *urxvt-mouse*
9089 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02009090 The mouse works only if the terminal supports this
9091 encoding style, but it does not have 223 columns limit
9092 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02009093 *sgr-mouse*
9094 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02009095 mouse reporting. The mouse works even in columns
9096 beyond 223. This option is backward compatible with
9097 "xterm2" because it can also decode "xterm2" style
9098 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099
9100 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02009101 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
9102 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
9104 recognized, if enabled at compile time. DEC terminal mouse codes
9105 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02009106 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
9107 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02009109 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
9110 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
9111 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00009112 If the terminfo/termcap entry "XM" exists and the first number is
9113 "1006" then 'ttymouse' will be set to "sgr". This works for many
9114 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02009115 Additionally, if vim is compiled with the |+termresponse| feature and
9116 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02009117 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009119 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9120 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9121 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009122 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9123 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 :set t_RV=
9125<
9126 *'ttyscroll'* *'tsl'*
9127'ttyscroll' 'tsl' number (default 999)
9128 global
9129 Maximum number of lines to scroll the screen. If there are more lines
9130 to scroll the window is redrawn. For terminals where scrolling is
9131 very slow and redrawing is not slow this can be set to a small number,
9132 e.g., 3, to speed up displaying.
9133
9134 *'ttytype'* *'tty'*
9135'ttytype' 'tty' string (default from $TERM)
9136 global
9137 Alias for 'term', see above.
9138
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009139 *'undodir'* *'udir'*
9140'undodir' 'udir' string (default ".")
9141 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009142 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009143 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009144 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009145 "." means using the directory of the file. The undo file name for
9146 "file.txt" is ".file.txt.un~".
9147 For other directories the file name is the full path of the edited
9148 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009149 When writing: The first directory that exists is used. "." always
9150 works, no directories after "." will be used for writing.
9151 When reading all entries are tried to find an undo file. The first
9152 undo file that exists is used. When it cannot be read an error is
9153 given, no further entry is used.
9154 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009155 This option cannot be set from a |modeline| or in the |sandbox|, for
9156 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009157
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009158 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009159'undofile' 'udf' boolean (default off)
9160 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009161 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009162 When on, Vim automatically saves undo history to an undo file when
9163 writing a buffer to a file, and restores undo history from the same
9164 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009165 The directory where the undo file is stored is specified by 'undodir'.
9166 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009167 The undo file is not read when 'undoreload' causes the buffer from
9168 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009169 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009170 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009171
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009173'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009174 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009176 is kept in memory, higher numbers will cause more memory to be used.
9177 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9179 itself: >
9180 set ul=0
9181< But you can also get Vi compatibility by including the 'u' flag in
9182 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009183 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009184 Set to -1 for no undo at all. You might want to do this only for the
9185 current buffer: >
9186 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009188
9189 The local value is set to -123456 when the global value is to be used.
9190
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009191 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009193 *'undoreload'* *'ur'*
9194'undoreload' 'ur' number (default 10000)
9195 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009196 Save the whole buffer for undo when reloading it. This applies to the
9197 ":e!" command and reloading for when the buffer changed outside of
9198 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009199 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009200 of lines is smaller than the value of this option.
9201 Set this option to zero to disable undo for a reload.
9202
9203 When saving undo for a reload, any undo file is not read.
9204
9205 Note that this causes the whole buffer to be stored in memory. Set
9206 this option to a lower value if you run out of memory.
9207
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 *'updatecount'* *'uc'*
9209'updatecount' 'uc' number (default: 200)
9210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211 After typing this many characters the swap file will be written to
9212 disk. When zero, no swap file will be created at all (see chapter on
9213 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9214 Vim with the "-n" option, see |startup|. When editing in readonly
9215 mode this option will be initialized to 10000.
9216 The swapfile can be disabled per buffer with |'swapfile'|.
9217 When 'updatecount' is set from zero to non-zero, swap files are
9218 created for all buffers that have 'swapfile' set. When 'updatecount'
9219 is set to zero, existing swap files are not deleted.
9220 Also see |'swapsync'|.
9221 This option has no meaning in buffers where |'buftype'| is "nofile"
9222 or "nowrite".
9223
9224 *'updatetime'* *'ut'*
9225'updatetime' 'ut' number (default 4000)
9226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009227 If this many milliseconds nothing is typed the swap file will be
9228 written to disk (see |crash-recovery|). Also used for the
9229 |CursorHold| autocommand event.
9230
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009231 *'varsofttabstop'* *'vsts'*
9232'varsofttabstop' 'vsts' string (default "")
9233 local to buffer
9234 {only available when compiled with the |+vartabs|
9235 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009236 A list of the number of spaces that a <Tab> counts for while editing,
9237 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9238 width <Tab>s are being inserted, while in fact a mixture of spaces
9239 and <Tab>s is used. Tab widths are separated with commas, with the
9240 final value applying to all subsequent tabs.
9241
9242 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009243 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009244 to use the following: >
9245 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009246< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9247 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009248
9249 Note that the value of |'softtabstop'| will be ignored while
9250 'varsofttabstop' is set.
9251
9252 *'vartabstop'* *'vts'*
9253'vartabstop' 'vts' string (default "")
9254 local to buffer
9255 {only available when compiled with the |+vartabs|
9256 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009257 A list of the number of spaces that a <Tab> in the file counts for,
9258 separated by commas. Each value corresponds to one tab, with the
9259 final value applying to all subsequent tabs. For example: >
9260 :set vartabstop=4,20,10,8
9261< This will make the first tab 4 spaces wide, the second 20 spaces,
9262 the third 10 spaces, and all following tabs 8 spaces.
9263
9264 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9265 is set.
9266
Bram Moolenaar071d4272004-06-13 20:20:40 +00009267 *'verbose'* *'vbs'*
9268'verbose' 'vbs' number (default 0)
9269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270 When bigger than zero, Vim will give messages about what it is doing.
9271 Currently, these messages are given:
9272 >= 1 When the viminfo file is read or written.
9273 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009274 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009275 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 >= 8 Files for which a group of autocommands is executed.
9277 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009278 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279 >= 12 Every executed function.
9280 >= 13 When an exception is thrown, caught, finished, or discarded.
9281 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009282 >= 15 Every executed Ex command from a script (truncated at 200
9283 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009284 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285
9286 This option can also be set with the "-V" argument. See |-V|.
9287 This option is also set by the |:verbose| command.
9288
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009289 When the 'verbosefile' option is set then the verbose messages are not
9290 displayed.
9291
9292 *'verbosefile'* *'vfile'*
9293'verbosefile' 'vfile' string (default empty)
9294 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009295 When not empty all messages are written in a file with this name.
9296 When the file exists messages are appended.
9297 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009298 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009299 Setting 'verbosefile' to a new value is like making it empty first.
9300 The difference with |:redir| is that verbose messages are not
9301 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009302 This option cannot be set from a |modeline| or in the |sandbox|, for
9303 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009304
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009306'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009307 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009308 for Unix: "$HOME/.vim/view" or
9309 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009310 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009311 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009312 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 feature}
9314 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009315 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 This option cannot be set from a |modeline| or in the |sandbox|, for
9317 security reasons.
9318
9319 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009320'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009321 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009322 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009323 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009324 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009325 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 word save and restore ~
9327 cursor cursor position in file and in window
9328 folds manually created folds, opened/closed folds and local
9329 fold options
9330 options options and mappings local to a window or buffer (not
9331 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009332 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333 slash backslashes in file names replaced with forward
9334 slashes
9335 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009336 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009337 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009338
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009339 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009341 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342
9343 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009344'viminfo' 'vi' string (Vi default: "", Vim default for
9345 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009346 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9347 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009349 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009350 feature}
9351 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009352 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9353 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009354 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009355 consisting of a single character identifying the particular parameter,
9356 followed by a number or string which specifies the value of that
9357 parameter. If a particular character is left out, then the default
9358 value is used for that parameter. The following is a list of the
9359 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009361 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009362 ! When included, save and restore global variables that start
9363 with an uppercase letter, and don't contain a lowercase
9364 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009365 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009366 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009367 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009368 " Maximum number of lines saved for each register. Old name of
9369 the '<' item, with the disadvantage that you need to put a
9370 backslash before the ", otherwise it will be recognized as the
9371 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009372 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009373 % When included, save and restore the buffer list. If Vim is
9374 started with a file name argument, the buffer list is not
9375 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009376 buffer list is restored from the viminfo file. Quickfix
9377 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9378 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009379 When followed by a number, the number specifies the maximum
9380 number of buffers that are stored. Without a number all
9381 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009382 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 ' Maximum number of previously edited files for which the marks
9384 are remembered. This parameter must always be included when
9385 'viminfo' is non-empty.
9386 Including this item also means that the |jumplist| and the
9387 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009388 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009389 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009390 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009391 patterns are also saved. When not included, the value of
9392 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009393 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009394 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009395 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009396 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009397 < Maximum number of lines saved for each register. If zero then
9398 registers are not saved. When not included, all lines are
9399 saved. '"' is the old name for this item.
9400 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009401 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009403 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009404 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 c When included, convert the text in the viminfo file from the
9406 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009407 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009408 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009409 f Whether file marks need to be stored. If zero, file marks ('0
9410 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009411 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009412 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009413 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009414 h Disable the effect of 'hlsearch' when loading the viminfo
9415 file. When not included, it depends on whether ":nohlsearch"
9416 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009417 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009418 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009419 the 'n'. Must be at the end of the option! If the
9420 'viminfofile' option is set, that file name overrides the one
9421 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009422 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009423 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009424 r Removable media. The argument is a string (up to the next
9425 ','). This parameter can be given several times. Each
9426 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009427 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009428 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9429 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9430 ignored. Maximum length of each 'r' argument is 50
9431 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009432 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 s Maximum size of an item in Kbyte. If zero then registers are
9434 not saved. Currently only applies to registers. The default
9435 "s10" will exclude registers with more than 10 Kbyte of text.
9436 Also see the '<' item above: line count limit.
9437
9438 Example: >
9439 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9440<
9441 '50 Marks will be remembered for the last 50 files you
9442 edited.
9443 <1000 Contents of registers (up to 1000 lines each) will be
9444 remembered.
9445 s100 Registers with more than 100 Kbyte text are skipped.
9446 :0 Command-line history will not be saved.
9447 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9448 no / Since '/' is not specified, the default will be used,
9449 that is, save all of the search history, and also the
9450 previous search and substitute patterns.
9451 no % The buffer list will not be saved nor read back.
9452 no h 'hlsearch' highlighting will be restored.
9453
9454 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9455 load the contents of the file, this is not done automatically.
9456
9457 This option cannot be set from a |modeline| or in the |sandbox|, for
9458 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009459 NOTE: This option is set to the Vim default value when 'compatible'
9460 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009461
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009462 *'viminfofile'* *'vif'*
9463'viminfofile' 'vif' string (default: "")
9464 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009465 {not available when compiled without the |+viminfo|
9466 feature}
9467 When non-empty, overrides the file name used for viminfo.
9468 When equal to "NONE" no viminfo file will be read or written.
9469 This option can be set with the |-i| command line flag. The |--clean|
9470 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009471 This option cannot be set from a |modeline| or in the |sandbox|, for
9472 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009473
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 *'virtualedit'* *'ve'*
9475'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009476 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009477 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009478 block Allow virtual editing in Visual block mode.
9479 insert Allow virtual editing in Insert mode.
9480 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009481 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009482 none When used as the local value, do not allow virtual
9483 editing even when the global value is set. When used
9484 as the global value, "none" is the same as "".
9485 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009486
Bram Moolenaar071d4272004-06-13 20:20:40 +00009487 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009488 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009489 of the line. Useful for selecting a rectangle in Visual mode and
9490 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009491 "onemore" is not the same, it will only allow moving the cursor just
9492 after the last character of the line. This makes some commands more
9493 consistent. Previously the cursor was always past the end of the line
9494 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009495 break some plugins or Vim scripts. For example because |l| can move
9496 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009497 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009498 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009499 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009500 It doesn't make sense to combine "all" with "onemore", but you will
9501 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009502 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009503 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009504
9505 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9506'visualbell' 'vb' boolean (default off)
9507 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009508 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009509 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009510 use: >
9511 :set vb t_vb=
9512< If you want a short flash, you can use this on many terminals: >
9513 :set vb t_vb=[?5h$<100>[?5l
9514< Here $<100> specifies the time, you can use a smaller or bigger value
9515 to get a shorter or longer flash.
9516
9517 Note: Vim will limit the bell to once per half a second. This avoids
9518 having to wait for the flashing to finish when there are lots of
9519 bells, e.g. on key repeat. This also happens without 'visualbell'
9520 set.
9521
Bram Moolenaar071d4272004-06-13 20:20:40 +00009522 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9523 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9524 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009525
9526 Note: When the GUI starts, 't_vb' is reset to its default value. You
9527 might want to set it again in your |gvimrc|.
9528
Bram Moolenaar071d4272004-06-13 20:20:40 +00009529 Does not work on the Amiga, you always get a screen flash.
9530 Also see 'errorbells'.
9531
9532 *'warn'* *'nowarn'*
9533'warn' boolean (default on)
9534 global
9535 Give a warning message when a shell command is used while the buffer
9536 has been changed.
9537
9538 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9539'weirdinvert' 'wiv' boolean (default off)
9540 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009541 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009542 It is provided for backwards compatibility with version 4.x.
9543 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9544 vice versa. Has no effect when the GUI is running.
9545
9546 *'whichwrap'* *'ww'*
9547'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009549 Allow specified keys that move the cursor left/right to move to the
9550 previous/next line when the cursor is on the first/last character in
9551 the line. Concatenate characters to allow this for these keys:
9552 char key mode ~
9553 b <BS> Normal and Visual
9554 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009555 h "h" Normal and Visual (not recommended)
9556 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 < <Left> Normal and Visual
9558 > <Right> Normal and Visual
9559 ~ "~" Normal
9560 [ <Left> Insert and Replace
9561 ] <Right> Insert and Replace
9562 For example: >
9563 :set ww=<,>,[,]
9564< allows wrap only when cursor keys are used.
9565 When the movement keys are used in combination with a delete or change
9566 operator, the <EOL> also counts for a character. This makes "3h"
9567 different from "3dh" when the cursor crosses the end of a line. This
9568 is also true for "x" and "X", because they do the same as "dl" and
9569 "dh". If you use this, you may also want to use the mapping
9570 ":map <BS> X" to make backspace delete the character in front of the
9571 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009572 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009573 line (not an empty line) then it will not move to the next line. This
9574 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009575 NOTE: This option is set to the Vi default value when 'compatible' is
9576 set and to the Vim default value when 'compatible' is reset.
9577
9578 *'wildchar'* *'wc'*
9579'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009581 Character you have to type to start wildcard expansion in the
9582 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009583 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009584 The character is not recognized when used inside a macro. See
9585 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009586 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009587 <Esc> can be used, but hitting it twice in a row will still exit
9588 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009589 Although 'wc' is a number option, it can be specified as a number, a
9590 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9591 preceded with a caret (e.g. `^F` is CTRL-F): >
9592 :set wc=27
9593 :set wc=X
9594 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009595 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009596< NOTE: This option is set to the Vi default value when 'compatible' is
9597 set and to the Vim default value when 'compatible' is reset.
9598
9599 *'wildcharm'* *'wcm'*
9600'wildcharm' 'wcm' number (default: none (0))
9601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009602 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009603 recognized when used inside a macro. You can find "spare" command-line
9604 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009605 you'll never actually type 'wildcharm', just use it in mappings that
9606 automatically invoke completion mode, e.g.: >
9607 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009608 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009609< Then after typing :ss you can use CTRL-P & CTRL-N.
9610
9611 *'wildignore'* *'wig'*
9612'wildignore' 'wig' string (default "")
9613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009615 patterns is ignored when expanding |wildcards|, completing file or
9616 directory names, and influences the result of |expand()|, |glob()| and
9617 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9619 Also see 'suffixes'.
9620 Example: >
9621 :set wildignore=*.o,*.obj
9622< The use of |:set+=| and |:set-=| is preferred when adding or removing
9623 a pattern from the list. This avoids problems when a future version
9624 uses another default.
9625
h_east596a9f22023-11-21 21:24:23 +09009626 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009627'wildignorecase' 'wic' boolean (default off)
9628 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009629 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009630 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009631 Does not apply when the shell is used to expand wildcards, which
9632 happens when there are special characters.
9633
Bram Moolenaar071d4272004-06-13 20:20:40 +00009634 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009635'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637 When 'wildmenu' is on, command-line completion operates in an enhanced
9638 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009639 the possible matches are shown.
9640 When 'wildoptions' contains "pum", then the completion matches are
9641 shown in a popup menu. Otherwise they are displayed just above the
9642 command line, with the first match highlighted (overwriting the status
9643 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009644 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009645 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9646 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9647 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009648 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009649 If there are more matches than can fit in the line, a ">" is shown on
9650 the right and/or a "<" is shown on the left. The status line scrolls
9651 as needed.
9652 The "wildmenu" mode is abandoned when a key is hit that is not used
9653 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009654 While the "wildmenu" is active, the following keys have special
9655 meanings:
9656 CTRL-P - go to the previous entry
9657 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009658 <CR> - in menu completion, when the cursor is just after a
9659 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009660 CTRL-E - end completion, go back to what was there before
9661 selecting a match.
9662 CTRL-Y - accept the currently selected match and stop
9663 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009664
9665 When not using the popup menu for command line completion, the
9666 following keys have special meanings:
9667 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009668 <Up> - in filename/menu name completion: move up into
9669 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009670 <Down> - in filename/menu name completion: move into a
9671 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009672
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009673 When using the popup menu for command line completion, the following
9674 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009675 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009676 <PageUp> - select a match several entries back
9677 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009678 <Left> - in filename/menu name completion: move up into
9679 parent directory or parent menu.
9680 <Right> - in filename/menu name completion: move into a
9681 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009682
Bram Moolenaar071d4272004-06-13 20:20:40 +00009683 This makes the menus accessible from the console |console-menus|.
9684
9685 If you prefer the <Left> and <Right> keys to move the cursor instead
9686 of selecting a different match, use this: >
9687 :cnoremap <Left> <Space><BS><Left>
9688 :cnoremap <Right> <Space><BS><Right>
9689<
9690 The "WildMenu" highlighting is used for displaying the current match
9691 |hl-WildMenu|.
9692
9693 *'wildmode'* *'wim'*
9694'wildmode' 'wim' string (Vim default: "full")
9695 global
Girish Palyaeded3362025-04-12 18:03:32 +02009696 Completion mode used for the character specified with 'wildchar'.
9697 This option is a comma-separated list of up to four parts,
9698 corresponding to the first, second, third, and fourth presses of
9699 'wildchar'. Each part is a colon-separated list of completion
9700 behaviors, which are applied simultaneously during that phase.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009701
Girish Palyaeded3362025-04-12 18:03:32 +02009702 The possible behavior values are:
9703 "" Only complete (insert) the first match. No further
9704 matches are cycled or listed.
9705 "full" Complete the next full match. Cycles through all
9706 matches, returning to the original input after the
9707 last match. If 'wildmenu' is enabled, it will be
9708 shown.
9709 "longest" Complete to the longest common substring. If this
9710 doesn't extend the input, the next 'wildmode' part is
9711 used.
9712 "list" If multiple matches are found, list all of them.
9713 "lastused" When completing buffer names, sort them by most
9714 recently used (excluding the current buffer). Only
9715 applies to buffer name completion.
9716 "noselect" If 'wildmenu' is enabled, show the menu but do not
9717 preselect the first item.
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009718 If only one match exists, it is completed fully, unless "noselect" is
Girish Palyaeded3362025-04-12 18:03:32 +02009719 specified.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009720
Girish Palyaeded3362025-04-12 18:03:32 +02009721 Some useful combinations of colon-separated values:
9722 "longest:full" Start with the longest common string and show
9723 'wildmenu' (if enabled). Does not cycle
9724 through full matches.
9725 "list:full" List all matches and complete first match.
9726 "list:longest" List all matches and complete till the longest
9727 common prefix.
9728 "list:lastused" List all matches. When completing buffers,
9729 sort them by most recently used (excluding the
9730 current buffer).
9731 "noselect:lastused" Do not preselect the first item in 'wildmenu'
9732 if it is active. When completing buffers,
9733 sort them by most recently used (excluding the
9734 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009735
9736 Examples: >
9737 :set wildmode=full
Girish Palyaeded3362025-04-12 18:03:32 +02009738< Complete full match on every press (default behavior) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009739 :set wildmode=longest,full
Girish Palyaeded3362025-04-12 18:03:32 +02009740< First press: longest common substring
9741 Second press: cycle through full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009742 :set wildmode=list:full
Girish Palyaeded3362025-04-12 18:03:32 +02009743< First press: list all matches and complete the first one >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009744 :set wildmode=list,full
Girish Palyaeded3362025-04-12 18:03:32 +02009745< First press: list matches only
9746 Second press: complete full matches >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009747 :set wildmode=longest,list
Girish Palyaeded3362025-04-12 18:03:32 +02009748< First press: longest common substring
9749 Second press: list all matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009750 :set wildmode=noselect:full
Hirohito Higashifa8b7db2025-04-30 19:12:37 +02009751< First press: show 'wildmenu' without completing or selecting
9752 Second press: cycle full matches >
Girish Palya2bacc3e2025-03-02 22:55:57 +01009753 :set wildmode=noselect:lastused,full
Christian Brabandtf4b1a602025-04-13 18:06:49 +02009754< Same as above, but buffer matches are sorted by time last used
Bram Moolenaar446cb832008-06-24 21:56:24 +00009755 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009756
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009757 *'wildoptions'* *'wop'*
9758'wildoptions' 'wop' string (default "")
9759 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009760 A list of words that change how |cmdline-completion| is done.
9761 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009762 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009763 this value is specified, wildcard expansion will not
9764 be used for completion. The matches will be sorted by
9765 the "best match" rather than alphabetically sorted.
9766 This will find more matches than the wildcard
9767 expansion. Currently fuzzy matching based completion
9768 is not supported for file and directory names and
9769 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009770 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009771 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009772 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009773 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009774 is displayed per line. Often used tag kinds are:
9775 d #define
9776 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009777
Bram Moolenaar071d4272004-06-13 20:20:40 +00009778 *'winaltkeys'* *'wak'*
9779'winaltkeys' 'wak' string (default "menu")
9780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009781 {only used in Win32, Motif, GTK and Photon GUI}
9782 Some GUI versions allow the access to menu entries by using the ALT
9783 key in combination with a character that appears underlined in the
9784 menu. This conflicts with the use of the ALT key for mappings and
9785 entering special characters. This option tells what to do:
9786 no Don't use ALT keys for menus. ALT key combinations can be
9787 mapped, but there is no automatic handling. This can then be
9788 done with the |:simalt| command.
9789 yes ALT key handling is done by the windowing system. ALT key
9790 combinations cannot be mapped.
9791 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009792 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009793 keys can be mapped.
9794 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9795 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009796 This option is not used for <F10>; on Win32 and with GTK <F10> will
9797 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009798
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009799 *'wincolor'* *'wcr'*
9800'wincolor' 'wcr' string (default empty)
9801 local to window
9802 Highlight group name to use for this window instead of the Normal
9803 color |hl-Normal|.
9804
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009805 *'window'* *'wi'*
9806'window' 'wi' number (default screen height - 1)
9807 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009808 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9809 window and the value is smaller than 'lines' minus one. The screen
9810 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009811 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9812 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009813 When resizing the Vim window, and the value is smaller than 1 or more
9814 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009815 Note: Do not confuse this with the height of the Vim window, use
9816 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009817
Colin Kennedy21570352024-03-03 16:16:47 +01009818 *'winfixbuf'*
9819'winfixbuf' 'wfb' boolean (default off)
9820 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009821 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009822 For example, attempting to change the buffer with |:edit| will fail.
9823 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009824 also skip any window with 'winfixbuf' enabled. However if an Ex
9825 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009826
laburnumT3f7855a2023-12-05 18:37:03 +01009827 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9828'winfixheight' 'wfh' boolean (default off)
9829 local to window |local-noglobal|
9830 Keep the window height when windows are opened or closed and
9831 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9832 |preview-window| and |quickfix-window|.
9833 The height may be changed anyway when running out of room.
9834
9835 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9836'winfixwidth' 'wfw' boolean (default off)
9837 local to window |local-noglobal|
9838 Keep the window width when windows are opened or closed and
9839 'equalalways' is set. Also for |CTRL-W_=|.
9840 The width may be changed anyway when running out of room.
9841
Bram Moolenaar071d4272004-06-13 20:20:40 +00009842 *'winheight'* *'wh'* *E591*
9843'winheight' 'wh' number (default 1)
9844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009845 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009846 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009847 focus goes to a window that is smaller, its size is increased, at the
9848 cost of the height of other windows.
9849 Set 'winheight' to a small number for normal editing.
9850 Set it to 999 to make the current window fill most of the screen.
9851 Other windows will be only 'winminheight' high. This has the drawback
9852 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9853 to create only two windows, set the option after startup is done,
9854 using the |VimEnter| event: >
9855 au VimEnter * set winheight=999
9856< Minimum value is 1.
9857 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009858 height of the current window.
9859 'winheight' applies to the current window. Use 'winminheight' to set
9860 the minimal height for other windows.
9861
Bram Moolenaar071d4272004-06-13 20:20:40 +00009862 *'winminheight'* *'wmh'*
9863'winminheight' 'wmh' number (default 1)
9864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009865 The minimal height of a window, when it's not the current window.
9866 This is a hard minimum, windows will never become smaller.
9867 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9868 status bar) if necessary. They will return to at least one line when
9869 they become active (since the cursor has to have somewhere to go.)
9870 Use 'winheight' to set the minimal height of the current window.
9871 This option is only checked when making a window smaller. Don't use a
9872 large number, it will cause errors when opening more than a few
9873 windows. A value of 0 to 3 is reasonable.
9874
9875 *'winminwidth'* *'wmw'*
9876'winminwidth' 'wmw' number (default 1)
9877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009878 The minimal width of a window, when it's not the current window.
9879 This is a hard minimum, windows will never become smaller.
9880 When set to zero, windows may be "squashed" to zero columns (i.e. just
9881 a vertical separator) if necessary. They will return to at least one
9882 line when they become active (since the cursor has to have somewhere
9883 to go.)
9884 Use 'winwidth' to set the minimal width of the current window.
9885 This option is only checked when making a window smaller. Don't use a
9886 large number, it will cause errors when opening more than a few
9887 windows. A value of 0 to 12 is reasonable.
9888
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009889 *'winptydll'*
9890'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9891 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009892 {only available when compiled with the |terminal|
9893 feature on MS-Windows}
9894 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009895 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009896 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009897 a fallback.
9898 Environment variables are expanded |:set_env|.
9899 This option cannot be set from a |modeline| or in the |sandbox|, for
9900 security reasons.
9901
Bram Moolenaar071d4272004-06-13 20:20:40 +00009902 *'winwidth'* *'wiw'* *E592*
9903'winwidth' 'wiw' number (default 20)
9904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009905 Minimal number of columns for the current window. This is not a hard
9906 minimum, Vim will use fewer columns if there is not enough room. If
9907 the current window is smaller, its size is increased, at the cost of
9908 the width of other windows. Set it to 999 to make the current window
9909 always fill the screen. Set it to a small number for normal editing.
9910 The width is not adjusted after one of the commands to change the
9911 width of the current window.
9912 'winwidth' applies to the current window. Use 'winminwidth' to set
9913 the minimal width for other windows.
9914
9915 *'wrap'* *'nowrap'*
9916'wrap' boolean (default on)
9917 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009918 This option changes how text is displayed. It doesn't change the text
9919 in the buffer, see 'textwidth' for that.
9920 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009921 displaying continues on the next line. When off lines will not wrap
9922 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009923 moved to a part that is not shown, the screen will scroll
9924 horizontally.
9925 The line will be broken in the middle of a word if necessary. See
9926 'linebreak' to get the break at a word boundary.
9927 To make scrolling horizontally a bit more useful, try this: >
9928 :set sidescroll=5
9929 :set listchars+=precedes:<,extends:>
9930< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009931 This option can't be set from a |modeline| when the 'diff' option is
9932 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009933
9934 *'wrapmargin'* *'wm'*
9935'wrapmargin' 'wm' number (default 0)
9936 local to buffer
9937 Number of characters from the right window border where wrapping
9938 starts. When typing text beyond this limit, an <EOL> will be inserted
9939 and inserting continues on the next line.
9940 Options that add a margin, such as 'number' and 'foldcolumn', cause
9941 the text width to be further reduced. This is Vi compatible.
9942 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009943 This option is set to 0 when 'paste' is set and restored when 'paste'
9944 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009945 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009946
9947 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9948'wrapscan' 'ws' boolean (default on) *E384* *E385*
9949 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009950 Searches wrap around the end of the file. Also applies to |]s| and
9951 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009952
9953 *'write'* *'nowrite'*
9954'write' boolean (default on)
9955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009956 Allows writing files. When not set, writing a file is not allowed.
9957 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009958 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009959 argument. Filtering text is still possible, even though this requires
9960 writing a temporary file.
9961
9962 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9963'writeany' 'wa' boolean (default off)
9964 global
9965 Allows writing to any file with no need for "!" override.
9966
9967 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9968'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9969 otherwise)
9970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009971 Make a backup before overwriting a file. The backup is removed after
9972 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009973 also on.
9974 WARNING: Switching this option off means that when Vim fails to write
9975 your buffer correctly and then, for whatever reason, Vim exits, you
9976 lose both the original file and what you were writing. Only reset
9977 this option if your file system is almost full and it makes the write
9978 fail (and make sure not to exit Vim until the write was successful).
9979 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009980 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009981 Depending on 'backupcopy' the backup is a new file or the original
9982 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009983 NOTE: This option is set to the default value when 'compatible' is
9984 set.
9985
9986 *'writedelay'* *'wd'*
9987'writedelay' 'wd' number (default 0)
9988 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009989 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009990 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009991 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009992
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009993 *'xtermcodes'* *'noxtermcodes'*
9994'xtermcodes' boolean (default on)
9995 global
9996 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009997 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009998 key codes and number of colors from the terminal. This takes care of
9999 various configuration options of the terminal that cannot be obtained
10000 from the termlib/terminfo entry, see |xterm-codes|.
10001 A side effect may be that t_Co changes and Vim will redraw the
10002 display.
10003
10004
Bram Moolenaar91f84f62018-07-29 15:07:52 +020010005 vim:tw=78:ts=8:noet:ft=help:norl: